FLVPlaybackCaptioning  - AS3

Détermine si le composant FLVPlaybackCaptioning déplace et redimensionne de façon automatique l’objet TextField pour l’ajout de légendes.

Si la propriété autoLayout est définie sur true, l’occurrence de DisplayObject ou l’objet TextField qui contient les légendes s’affiche à une distance de 10 pixels par rapport à l’occurrence de FLVPlayback. Les légendes couvrent toute la largeur de l’occurrence FLVPlayback, tout en conservant une marge de 10 pixels de chaque côté.

Lorsque cette propriété est définie sur true, l’occurrence de DisplayObject ou l’objet TextField s’affiche directement au-dessus de l’occurrence de FLVPlayback. Lorsque vous créez votre propre objet TextField, vous devez définir autoLayout sur false. Si wordWrap = false, les légendes sont centrées sur l’occurrence de FLVPlayback et peuvent la dépasser légèrement.

Pour contrôler le clavier, vous devez écouter l’événement captionChange pour déterminer la date et l’heure de création de l’occurrence de l’objet TextField.

La valeur par défaut est true.

Eléments de l’API associés

Définit l’occurrence du composant d’interface personnalisé CaptionButton FLVPlayback, qui permet d’activer ou de désactiver les légendes.

La propriété captionButton fonctionne de la même façon que les propriétés FLVPlayback playButton, pauseButton, muteButton, etc.

Eléments de l’API associés

Définit l’occurrence DisplayObject dans laquelle les légendes doivent être affichées.

Si vous définissez cette occurrence en tant qu’objet TextField, elle est ciblée directement. Si vous définissez cette occurrence en tant qu’objet DisplayObjectContainer contenant au moins un objet TextField, les légendes s’affichent dans l’objet TextField avec l’index d’affichage le plus faible.

La méthode DisplayObjectContainer prend en charge un objet de type clip avec un arrière-plan « échelle 9 », qui peut être redimensionné en fonction des modifications de la taille de l’objet TextField.

Pour une mise à l’échelle et un dessin plus complexe, créez du code pour que la méthode DisplayObjectContainer écoute un événement captionChange.

Remarque : si la propriété captionTargetName ou captionTarget n’est pas définie, l’occurrence FLVPlaybackCaptioning crée un champ de texte défini par la propriété captionTarget avec le format suivant :

• arrière-plan noir (background = true ; backgroundColor = 0x000000)
• texte blanc (textColor = 0xFFFFFF)
• autoSize = TextFieldAutoSize.LEFT
• multiLine = true
• wordWrap = true
• font = "_sans"
• size = 12

Pour personnaliser ces valeurs, demandez l’écoute de l’événement captionTargetCreated.

Eléments de l’API associés

Le nom d’occurrence de l’objet TextField ou MovieClip qui englobe l’objet Textfield qui contient les légendes.

Pour ne spécifier aucune cible, définissez cette propriété sur une chaîne vide (aucune cible spécifiée) ou sur auto. Cette propriété concerne principalement l’inspecteur des composants. Si vous écrivez du code, utilisez la propriété captionTarget à la place.

La valeur par défaut est auto.

Eléments de l’API associés

Définit l’occurrence FLVPlayback devant recevoir une légende. L’occurrence FLVPlayback doit avoir le même parent que l’occurrence FLVPlaybackCaptioning.

Lorsque la propriété flvPlaybackName ou flvPlayback n’est not définie, l’occurrence FLVPlaybackCaptioning recherche une occurrence FLVPlayback avec le même parent et applique une légende à la première qu’il rencontre.

Eléments de l’API associés

Définit un nom d’occurrence FLVPlayback pour celle qui doit recevoir une légende.

Pour ne pas spécifier de cible, définissez ce paramètre sur une chaîne vide ou auto. L’occurrence FLVPlayback doit avoir le même parent que l’occurrence FLVPlaybackCaptioning.

Le nom de l’occurrence FLVPlayback concerne principalement l’inspecteur des composants. Si vous écrivez du code, utilisez la propriété flvPlayback.

Lorsque la propriété flvPlaybackName ou flvPlayback n’est pas définie ou est définie sur auto, l’occurrence de FLVPlaybackCaptioning recherche une occurrence de FLVPlayback possédant le même parent et crée des légendes pour la première qui est détectée.

La valeur par défaut est auto.

Eléments de l’API associés

Permet d’afficher les légendes ; true = afficher les légendes, false = ne pas afficher les légendes.

Si vous utilisez la propriété captionButton pour permettre à l’utilisateur d’activer et désactiver les légendes, définissez la propriété showCaptions sur false.

La valeur par défaut est true.

Eléments de l’API associés

Ce paramètre limite le formatage des instructions du fichier Timed Text lorsqu’il est défini sur true.

Les styles suivants ne sont pas pris en charge si la propriété simpleFormatting est définie sur true :

• tts:backgroundColor
• tts:color
• tts:fontSize
• tts:fontFamily
• tts:wrapOption

Les styles suivants sont pris en charge si la propriété simpleFormatting est définie sur true :

• tts:fontStyle
• tts:fontWeight
• tts:textAlign

URL du fichier XML Timed Text contenant des informations de légende (propriété obligatoire).

Prise en charge de pistes avec plusieurs langues.

La meilleure utilisation de la propriété track consiste à prendre en charge plusieurs pistes de langue comportant des points de repère intégrés.

Vous devez suivre les formats pris en charge pour les points de repère FLVPlaybackCaptioning.

Lorsque la propriété track est définie sur une valeur différente de 0, le composant FLVPlaybackCaptioning recherche une propriété text<n> sur le point de repère, où n correspond à la valeur de track.

Par exemple, si track == 1, le composant FLVPlayBackCaptioning recherche le paramètre text1 sur le point de repère. Si aucun paramètre correspondant n’est trouvé, la propriété text du paramètre du point de repère s’applique.

La valeur par défaut est 0.

Connecte la légende à une occurrence spécifique de VideoPlayer dans le composant FLVPlayback.

Si vous souhaitez afficher des légendes dans plusieurs lecteurs vidéo (à l’aide des propriétés activeVideoPlayerIndex et visibleVideoPlayerIndex du composant FLVPlayback), vous devez créer une occurrence du composant FLVPlaybackCaptioning pour chaque composant VideoPlayer à utiliser et définir cette propriété en fonction de l’index.

L’index de VideoPlayer est de 0 par défaut si un seul lecteur vidéo est utilisé.

Eléments de l’API associés

Crée une occurrence de FLVPlaybackCaptioning.

Renvoie un tableau de points de repère du composant FLVPlayback dont le texte de légende contient la chaîne à rechercher.

Paramètres

Renvoie un tableau des points de repère du composant FLVPlayback qui contient les légendes.

Renvoie une chaîne contenant toutes les légendes en tant que transcription au format HTML.

Chaque légende est contenue dans une balise p avec l’attribut class appelé "fl_video_caption", un attribut id unique commençant par la chaîne "fl_video_caption_2_0_" et un attribut title indiquant le code temporel où la légende apparaît dans la vidéo.

Voici un bref exemple du code HTML renvoyé :

		 <div id="fl_video_transcript" class="fl_video_transcript">
		 	<p class="fl_video_caption" id="fl_video_caption_2_0_1" title="0:00.50"><i>( speaking French ): </i><br/><b>George: </b> Bonjour, Marie.</p>
		 	<p class="fl_video_caption" id="fl_video_caption_2_0_2" title="0:01.75"><b>Marie: </b> Bonjour, George.</p>
		 	<p class="fl_video_caption" id="fl_video_caption_2_0_3" title="0:03.75">VoilÀ une sucette.</p>
		 	<p class="fl_video_caption" id="fl_video_caption_2_0_4" title="0:05.50"><b>George: </b> C'est pour moi?</p>
		 	<p class="fl_video_caption" id="fl_video_caption_2_0_5" title="0:06.50"><b>Marie: </b> Oui, c'est pour toi.</p>
		 	<p class="fl_video_caption" id="fl_video_caption_2_0_6" title="0:08.00"><b>George: </b> Merci, Marie!</p>
		 	<p class="fl_video_caption" id="fl_video_caption_2_0_7" title="0:09.50"><b>Marie: </b> De rien, George.</p>
		 </div>
		 

Paramètres

Renvoie un nombre de secondes en tant que chaîne de code temporel.

Paramètres

Distribué chaque fois qu’une légende est ajoutée ou supprimée dans son champ de légende cible.

Cet événement est également distribué lorsque les conditions suivantes ont la valeur true :

• La propriété captionTargetName n’est pas définie.
• La propriété captionTarget n’est pas définie.
• L’occurrence FLVPlaybackCaptioning crée un objet TextField de façon automatique pour les légendes.

L’événement captionChange dispose de la constante CaptionChangeEvent.CAPTION_CHANGE.

Les propriétés de cet événement sont les suivantes :

Eléments de l’API associés

Distribué après la création de la propriété captionTarget, mais avant l’ajout de légendes (la propriété captionTarget est vide).

Si la propriété captionTarget est définie avec un objet DisplayObject personnalisé, ou si la propriété captionTargetName est définie, cet événement n’est pas distribué.

Demandez l’écoute de cet événement si vous personnalisez les propriétés de l’objet TextField, par exemple, la propriété defaultTextFormat.

L’événement captionTargetCreated dispose de la constante CaptionTargetEvent.CAPTION_TARGET_CREATED.

Les propriétés de cet événement sont les suivantes :

Eléments de l’API associés

Distribué après le chargement de toutes les données Timed Text XML.

Les propriétés de cet événement sont les suivantes :

Eléments de l’API associés

Distribué si un appel à la méthode URLLoader.load() tente d’accéder à un fichier Timed Text XML via HTTP et si l’environnement Flash Player est capable de détecter et de renvoyer le code d’état de la requête.

Les propriétés de cet événement sont les suivantes :

Eléments de l’API associés

Distribué si un appel à la méthode URLLoader.load() provoque une erreur fatale qui met fin au chargement du fichier Timed Text XML.

Cet événement renvoie une erreur s’il n’est pas traité.

Les propriétés de cet événement sont les suivantes :

Eléments de l’API associés

Distribué au début d’une opération de chargement du fichier Timed Text XML, à la suite d’un appel à la méthode URLLoader.load().

Les propriétés de cet événement sont les suivantes :

Eléments de l’API associés

Distribué à la réception de données au fur et à mesure de la progression du chargement du fichier Timed Text XML.

Les propriétés de cet événement sont les suivantes :

Eléments de l’API associés

Distribué si un appel à la méthode URLLoader.load() tente de charger un fichier Timed Text XML depuis un serveur situé hors du sandbox de sécurité.

Cet événement renvoie une erreur s’il n’est pas traité.

Les propriétés de cet événement sont les suivantes :

Eléments de l’API associés

Déclare une variable indiquant le numéro de version court du composant. Le numéro de version est utile lorsque vous disposez d’un fichier FLA et devez connaître la version du composant. Pour déterminer la version du composant, tapez le code de suivi ci-dessous dans le fichier FLA :

trace (FLVPlaybackCaptioning.SHORT_VERSION);

La variable SHORT_VERSION inclut uniquement la version majeure et secondaire, par exemple, 2.0. La variable version inclut les numéros de version majeure et secondaire, ainsi que la révision et les numéros, par exemple, 2.0.0.xx.

Eléments de l’API associés

Déclare une variable indiquant le numéro de version long du composant. Le numéro de version est utile lorsque vous disposez d’un fichier FLA et devez connaître la version du composant. Pour déterminer la version du composant, tapez le code de suivi ci-dessous dans le fichier FLA :

trace (FLVPlaybackCaptioning.VERSION);

La variable VERSION inclut les numéros de version majeure et secondaire, ainsi que la révision et les numéros, par exemple, 2.0.0.xx. La variable SHORT_VERSION inclut uniquement la version majeure et secondaire, par exemple, 2.0.

Eléments de l’API associés

Pour exécuter l’exemple, suivez ces étapes :

1. Ouvrez un nouveau fichier Flash (ActionScript 3.0).
2. Placez le composant FLVPlayback sur la scène à la position 0,0 et donnez-lui le nom d’occurrence player.
3. Placez le composant FLVPlaybackCaptioning sur la scène à la position 0,0 et donnez-lui le nom d’occurrence captioning.
4. Placez le composant CaptionButton sur la scène.
5. Enregistrez le fichier FLA et donnez-lui un nom, par exemple captionEx.
6. Ouvrez un nouveau fichier ActionScript.
7. Collez l’exemple de code suivant dans un nouveau fichier ActionScript et enregistrez-le sous le nom FLVPlaybackCaptioningExample.as dans le même répertoire que votre fichier FLA.
8. Dans le fichier FLA (par exemple captionEx), dans l’inspecteur des propriétés, définissez l’entrée de la classe Document sur FLVPlaybackCaptioningExample.
9. Sélectionnez Contrôle > Tester l’animation.

package
{
    import fl.video.CaptionChangeEvent;
    import fl.video.FLVPlayback;
    import fl.video.FLVPlaybackCaptioning;
    import flash.display.Sprite;
    import flash.text.TextField;
    
    public class FLVPlaybackCaptioningExample extends Sprite {

        private var videoPath:String = "http://www.helpexamples.com/flash/video/caption_video.flv";
        private var captioningPath:String = "http://www.helpexamples.com/flash/video/caption_video.xml";
        
        public function FLVPlaybackCaptioningExample() {
            player.source = videoPath;
            player.skin = "SkinOverAllNoCaption.swf";
            player.skinBackgroundColor = 0x666666;
            player.skinBackgroundAlpha = 0.5;

            captioning.flvPlayback = player;
            captioning.source = captioningPath;
            captioning.autoLayout = false;            
            captioning.addEventListener(CaptionChangeEvent.CAPTION_CHANGE, onCaptionChange);
        }

        private function onCaptionChange(e:CaptionChangeEvent):void {
            var tf:* = e.target.captionTarget;
            var player:FLVPlayback = e.target.flvPlayback;

            // move the caption below the video
            tf.y = 210;            
        }
    }
}