FLVPlaybackCaptioning  - AS3

Legt fest, ob für die Anzeigetexte automatisch die FLVPlaybackCaptioning-Komponente verschoben und die Größe des TextField-Objekts geändert wird.

Wenn für die Eigenschaft autoLayout der Wert true festgelegt ist, wird die DisplayObject-Instanz oder das TextField-Objekt, das die Anzeigetexte enthält, 10 Pixel vom unteren Rand der FLVPlayback-Instanz angezeigt. Der Anzeigetextbereich deckt die Breite der FLVPlayback-Instanz ab, wobei ein Rand von 10 Pixel an jeder Seite berücksichtigt wird.

Wenn für diese Eigenschaft der Wert true festgelegt ist, wird die DisplayObject-Instanz oder das TextField-Objekt direkt über der FLVPlayback-Instanz angezeigt. Wenn Sie Ihr eigenes TextField-Objekt erstellen, sollten Sie für autoLayout den Wert false festlegen. Wenn wordWrap = false, wird der Textanzeigebereich zentriert über der FLVPlayback-Instanz angezeigt. Der Bereich kann breiter als die FLVPlayback-Instanz sein.

Um das Layout zu steuern, müssen Sie auf das Ereignis captionChange warten. Mit diesem Ereignis können Sie bestimmen, wann die TextField-Objektinstanz erstellt wird.

Der Standardwert ist true.

Verwandte API-Elemente

Definiert die captionButton FLVPlayback custom UI component-Instanz, die Wechselfunktionen zum Ein- und Ausschalten von Anzeigetexten bietet.

Die Eigenschaft captionButton funktioniert ähnlich wie die FLVPlayback-Eigenschaften playButton, pauseButton, muteButton usw.

Verwandte API-Elemente

Legt die DisplayObject-Instanz fest, in der die Anzeigetexte eingeblendet werden sollen.

Wenn Sie die Instanz als ein TextField-Objekt festlegen, wird es direkt angegeben. Wenn Sie die Instanz als einen DisplayObjectContainer festlegen, der mehrere TextField-Objekte enthält, werden die Anzeigetexte im TextField-Objekt mit dem niedrigsten Anzeigeindex eingeblendet.

Die Methode DisplayObjectContainer unterstützt ein Objekt, das einem Movieclip ähnlich ist, mit einem Hintergrund der Skalierung 9. Dieser Hintergrund kann skaliert werden, wenn sich die Größe des TextField-Objekts ändert.

Schreiben Sie für komplexere Skalierungen und Zeichnungen Code, in dem die Methode DisplayObjectContainer auf ein captionChange-Ereignis wartet.

Hinweis: Wenn die Eigenschaft captionTargetName oder captionTarget nicht festgelegt ist, erstellt die FLVPlaybackCaptioning-Instanz ein Textfeld, das von der Eigenschaft captionTarget festgelegt wird. Dieses Textfeld hat die folgende Formatierung:

• schwarzer Hintergrund (background = true; backgroundColor = 0x000000;)
• weißer Text (textColor = 0xFFFFFF)
• autoSize = TextFieldAutoSize.LEFT
• multiLine = true
• wordWrap = true
• font = "_sans"
• size = 12

Um diese Werte anzupassen, warten Sie auf das Ereignis captionTargetCreated.

Verwandte API-Elemente

Der Instanzenname des TextField-Objekts oder MovieClips, das/der ein TextField-Objekt umgibt, das die Anzeigetexte enthält.

Um kein Ziel anzugeben, legen Sie für diese Eigenschaft einen leeren String (d. h. kein Ziel angegeben) oder auto fest. Diese Eigenschaft wird hauptsächlich im Komponenteninspektor verwendet. Wenn Sie Code schreiben, sollten Sie stattdessen die Eigenschaft captionTarget verwenden.

Der Standardwert ist auto.

Verwandte API-Elemente

Legt die FLVPlayback-Instanz fest, die angezeigt werden soll. Die FLVPlayback-Instanz muss das gleiche übergeordnete Objekt wie die FLVPlaybackCaptioning-Instanz haben.

Wenn die Eigenschaft flvPlaybackName oder flvPlayback nicht festgelegt ist, sucht die FLVPlaybackCaptioning-Instanz nach einer FLVPlayback-Instanz mit dem gleichen übergeordneten Objekt. Das erste gefundene Objekt wird angezeigt.

Verwandte API-Elemente

Legt einen FLVPlayback-Instanznamen für die FLVPlayback-Instanz fest, zu der Sie einen Anzeigetext hinzufügen möchten.

Um kein Ziel anzugeben, legen Sie hierfür einen leeren String (d. h. kein Ziel angegeben) oder auto fest. Die FLVPlayback-Instanz muss das gleiche übergeordnete Objekt wie die FLVPlaybackCaptioning-Instanz haben.

Der FLVPlayback-Instanzname wird hauptsächlich im Komponenteninspektor verwendet. Wenn Sie Code schreiben, verwenden Sie die Eigenschaft flvPlayback.

Wenn die Eigenschaft flvPlaybackName oder flvPlayback nicht festgelegt oder auf auto gesetzt ist, sucht die FLVPlaybackCaptioning-Instanz nach einer FLVPlayback-Instanz mit dem gleichen übergeordneten Objekt. Das erste gefundene Objekt wird angezeigt.

Der Standardwert ist auto.

Verwandte API-Elemente

Wird zum Anzeigen von Anzeigetexten verwendet: true = Anzeigetexte anzeigen, false = keine Anzeigetexte anzeigen.

Wenn Sie die Eigenschaft captionButton verwenden, um dem Benutzer zu ermöglichen, Anzeigetexte zu aktivieren oder zu deaktivieren, stellen Sie die Eigenschaft showCaptions auf false ein.

Der Standardwert ist true.

Verwandte API-Elemente

Beschränkt die Formatierungsanweisungen aus der Datei im Timed Text-Format, wenn dieser Wert auf true gesetzt ist.

Die folgenden Stile werden nicht unterstützt, wenn für die Eigenschaft simpleFormatting der Wert true festgelegt ist:

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

Die folgenden Stile werden unterstützt, wenn für die Eigenschaft simpleFormatting der Wert true festgelegt ist:

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

URL der XML-Datei im Timed Text-Format, die Informationen zum Anzeigetext enthält (erforderliche Eigenschaft).

Unterstützung für mehrsprachige Titel.

Die Eigenschaft track wird am besten zur Unterstützung mehrsprachiger Titel mit eingebetteten Cue-Points verwendet.

Sie müssen den unterstützten Formaten für FLVPlayback-Captioning-Cue-Points folgen.

Wenn für die Eigenschaft track nicht 0 festgelegt ist, sucht die FLVPlaybackCaptioning-Komponente nach einer text<n>-Eigenschaft auf dem Cue-Point, wobei n dem Wert des Titels entspricht.

Beispiel: Wenn track == 1 ist, dann sucht die FLVPlayBackCaptioning-Komponente nach dem Parameter text1 auf dem Cue-Point. Wenn kein übereinstimmender Parameter gefunden wird, wird die Texteigenschaft im Cue-Point-Parameter verwendet.

Der Standardwert ist 0.

Verbindet den Anzeigetext mit einem bestimmten VideoPlayer in der FLVPlayback-Komponente.

Wenn Sie Anzeigetexte in mehreren Video-Playern verwenden möchten (mit den Eigenschaften activeVideoPlayerIndex und visibleVideoPlayerIndex der FLVPlayback-Komponente), sollten Sie eine Instanz der FLVPlaybackCaptioning-Komponente für jeden VideoPlayer erstellen, den Sie verwenden werden. Legen Sie diese Eigenschaft so fest, dass sie dem Index entspricht.

Der Standardwert für den VideoPlayer-Index ist "0", wenn nur ein Video-Player verwendet wird.

Verwandte API-Elemente

Erstellt eine neue FLVPlaybackCaptioning-Instanz.

Gibt ein Array von Cue-Points der FLVPlayback-Komponente zurück, deren Untertiteltext den gesuchten String enthält.

Parameter

Gibt ein Array von Cue-Points einer FLVPlayback-Komponente zurück, die die Untertitel enthalten.

Gibt einen String mit allen Untertiteln als HTML-formatiertes Transkript zurück.

Jeder Untertitel befindet sich in einem p-Tag mit dem class-Attribut "fl_video_caption", einem eindeutigen id-Attribut beginnend mit dem String "fl_video_caption_2_0_" und einem title-Attribut, das den Zeitcode angibt, bei dem der Untertitel im Video erscheint.

Folgendes ist ein kurzes Beispiel des zurückgegebenen HTML-Codes:

		 <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>
		 

Parameter

Gibt eine Anzahl von Sekunden als Zeitcodestring zurück.

Parameter

Wird ausgelöst, wenn im Beschriftungsziel-Textfeld eine Beschriftung hinzugefügt oder entfernt wird.

Das Ereignis wird auch ausgelöst, wenn die folgenden Bedingungen wahr sind:

• die Eigenschaft captionTargetName ist nicht festgelegt;
• die Eigenschaft captionTarget ist nicht festgelegt;
• die FLVPlaybackCaptioning-Instanz erstellt automatisch ein TextField-Objekt für den Anzeigetext.

Das Ereignis captionChange verfügt über die Konstante CaptionChangeEvent.CAPTION_CHANGE.

Dieses Ereignis verfügt über die folgenden Eigenschaften:

Verwandte API-Elemente

Wird ausgelöst, nachdem die captionTarget-Eigenschaft erstellt, jedoch bevor eine Beschriftung hinzugefügt wurde (captionTarget-Eigenschaft ist leer).

Wenn die Eigenschaft captionTarget mit einem benutzerdefinierten DisplayObject festgelegt wird oder wenn die Eigenschaft captionTargetName festgelegt ist, wird dieses Ereignis nicht ausgelöst.

Warten Sie auf dieses Ereignis, wenn Sie die Eigenschaften des TextField-Objekts benutzerspezifisch anpassen, z. B. die Eigenschaft defaultTextFormat.

Das Ereignis captionTargetCreated verfügt über die Konstante CaptionTargetEvent.CAPTION_TARGET_CREATED.

Dieses Ereignis verfügt über die folgenden Eigenschaften:

Verwandte API-Elemente

Wird ausgelöst, nachdem alle XML-Daten im Timed Text-Format geladen wurden.

Dieses Ereignis verfügt über die folgenden Eigenschaften:

Verwandte API-Elemente

Wird ausgelöst, wenn bei einem Aufruf des URLLoader.load()-Ereignisses versucht wird, über HTTP auf eine XML-Datei im Timed Text-Format zuzugreifen, und die aktuelle Flash Player-Umgebung den Statuscode für die Anforderung erkennen und zurückgeben kann.

Dieses Ereignis verfügt über die folgenden Eigenschaften:

Verwandte API-Elemente

Wird ausgelöst, wenn bei einem Aufruf des URLLoader.load()-Ereignisses ein schwerwiegender Fehler auftritt, durch den der Download der XML-Datei im Timed Text-Format abgebrochen wird.

Wird dieses Ereignis nicht verarbeitet, wird ein Fehler ausgegeben.

Dieses Ereignis verfügt über die folgenden Eigenschaften:

Verwandte API-Elemente

Wird ausgelöst, wenn nach einem Aufruf der URLLoader.load()-Methode der Download-Vorgang zum Laden der XML-Datei im Timed Text-Format gestartet wird.

Dieses Ereignis verfügt über die folgenden Eigenschaften:

Verwandte API-Elemente

Wird ausgelöst, wenn während des Downloads der XML-Datei im Timed Text-Format Daten empfangen werden.

Dieses Ereignis verfügt über die folgenden Eigenschaften:

Verwandte API-Elemente

Wird ausgelöst, wenn bei einem Aufruf des URLLoader.load()-Ereignisses versucht wird, eine XML-Datei im Timed Text-Format von einem Server außerhalb der Sicherheits-Sandbox zu laden.

Wird dieses Ereignis nicht verarbeitet, wird ein Fehler ausgegeben.

Dieses Ereignis verfügt über die folgenden Eigenschaften:

Verwandte API-Elemente

Statusvariable, die die kurze Versionsnummer der Komponente angibt. Die Versionsnummer ist nützlich, wenn Sie eine FLA-Datei haben und wissen müssen, um welche Version der Komponente es sich handelt. Geben Sie zur Bestimmung der Komponentenversion die folgende Ablaufverfolgung in die FLA-Datei ein:

trace (FLVPlaybackCaptioning.SHORT_VERSION);

Die Variable SHORT_VERSION umfasst nur die Haupt- und Unterversionen, z. B. 2.0. Die Variable version umfasst die Haupt- und Unterversionen sowie die Änderungs- und Buildnummern, z. B. 2.0.0.xx.

Verwandte API-Elemente

Statusvariable, die die lange Versionsnummer der Komponente angibt. Die Versionsnummer ist nützlich, wenn Sie eine FLA-Datei haben und wissen müssen, um welche Version der Komponente es sich handelt. Geben Sie zur Bestimmung der Komponentenversion die folgende Ablaufverfolgung in die FLA-Datei ein:

trace (FLVPlaybackCaptioning.VERSION);

Die Variable VERSION umfasst die Haupt- und Unterversionen sowie die Änderungs- und Buildnummern, z. B. 2.0.0.xx. Die Variable SHORT_VERSION umfasst nur die Haupt- und Unterversionen, z. B. 2.0.

Verwandte API-Elemente

Gehen Sie wie folgt vor, um das Beispiel auszuführen:

1. Öffnen Sie eine neue Flash-Datei (ActionScript 3.0).
2. Platzieren Sie die FLVPlayback-Komponente auf der Bühne an Position 0,0, und geben Sie den Instanznamen „player“ an.
3. Platzieren Sie die FLVPlaybackCaptioning-Komponente auf der Bühne an Position 0,0 und geben Sie den Instanznamen „captioning“ an.
4. Platzieren Sie die CaptionButton-Komponente auf der Bühne.
5. Speichern Sie die FLA-Datei und geben Sie ihr einen Namen, zum Beispiel „captionEx“.
6. Öffnen Sie eine neue ActionScript-Datei.
7. Fügen Sie den folgenden Klassenbeispielcode in eine neue ActionScript-Datei ein und speichern Sie diese als „FLVPlaybackCaptioningExample.as“ im selben Verzeichnis wie die FLA-Datei.
8. Legen Sie in der FLA-Datei (z. B. „captionEx“) im Eigenschafteninspektor den Dokumentklasse als „FLVPlaybackCaptioningExample“ fest.
9. Wählen Sie „Steuerung“ > „Film testen“.

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;            
        }
    }
}