FLVPlaybackCaptioning  - AS3

Avgör om komponenten FLVPlaybackCaptioning automatiskt flyttar och ändrar storlek på objektet TextField för bildtexter.

Om egenskapen autoLayout är inställd på true visar DisplayObject-instansen eller TextField-objektet som innehåller bildtexten 10 pixlar från FLVPlayback-instansens nedre del. Bildtextområdet täcker FLVPlayback-instansens bredd, och behåller en marginal på 10 pixlar på varje sida.

När den här egenskapen är inställd på true, visas DisplayObject-instansen eller TextField-objektet direkt över FLVPlayback-instansen. Om du skapar ditt eget TextField-objekt bör du ställa in autoLayout på false. Om wordWrap = false centreras bildtextområdet över FLVPlayback-instansen men det kan vara bredare än FLVPlayback-instansen.

Om du vill styra layouten måste du avlyssna captionChange-händelsen och fastställa när TextField-objektinstansen skapas.

Standardvärdet är true.

Relaterade API-element

Definierar den anpassade instansen av gränssnittskomponenten captionButton FLVPlayback som ger den toggle-funktion som gör att bildtexter kan aktiveras och avaktiveras.

Egenskapen captionButton fungerar ungefär som FLVPlayback-egenskaperna playButton, pauseButton, muteButton och så vidare

Relaterade API-element

Ställer in DisplayObject-instansen som bildtexterna ska visas i.

Om du stället in instansen som ett TextField-objekt, anges det direkt som mål. Om du anger instansen som ett DisplayObjectContainer, som innehåller ett eller flera TextField-objekt, visas bildtexterna i TextField-objektet med lägsta visningsindexvärdet.

Metoden DisplayObjectContainer stöder ett filmklippsobjekt som har en bakgrund med skalning med nio segment, som kan skalas när storleken på TextField-objektet ändras.

Mer avancerad skalning och ritning får du om du skriver kod så att metoden DisplayObjectContainer avlyssnar en captionChange-händelse.

Obs! Om egenskapen captionTargetName eller captionTarget inte är inställd, skapar FLVPlaybackCaptioning-instansen ett textfält som anges in av egenskapen captionTarget med följande formatering:

• svart bakgrund (background = true; backgroundColor = 0x000000;)
• vi text (textColor = 0xFFFFFF)
• autoSize = TextFieldAutoSize.LEFT
• multiLine = true
• wordWrap = true
• font = "_sans"
• size = 12

Du kan anpassa värdena genom att avlyssna captionTargetCreated-händelsen.

Relaterade API-element

Instansnamnet för TextField-objektet eller det filmklipp som innehåller ett TextField-objekt som innehåller bildtexterna.

Om du inte vill ange något mål ställer du in egenskapen på tom sträng (dvs. inget angivet mål) eller auto. Egenskapen används främst i komponentinspektören. Om du skriver kod bör du i stället använda egenskapen captionTarget.

Standardvärdet är auto.

Relaterade API-element

Ställer in FLVPlayback-instansen till bildtext. FLVPlayback-instansen måste ha samma överordnade som FLVPlaybackCaptioning-instansen.

Om egenskapen flvPlaybackName eller flvPlayback inte är inställda, söker FLVPlaybackCaptioning-instansen efter en FLVPlayback-instans med samma överordnade och fångar den första som hittas.

Relaterade API-element

Ställer in ett FLVPlayback-instansnamn för FLVPlayback-instansen som du vill ange bildtext för.

Om du inte vill ange något mål anger du tom sträng eller auto. FLVPlayback-instansen måste ha samma överordnade som FLVPlaybackCaptioning-instansen.

FLVPlayback-instansnamnet används främst i komponentinspektören. Om du skriver kod använder du egenskapen flvPlayback.

Om egenskapen flvPlaybackName eller flvPlayback inte är inställda eller inställda på auto söker FLVPlaybackCaptioning-instansen efter en FLVPlayback-instans med samma överordnade och fångar den första som hittas.

Standardvärdet är auto.

Relaterade API-element

Används för att visa bildtexter. true = bildtexter visas, false = bildtexter visas inte.

Om du använder egenskapen captionButton för att tillåta användaren att aktivera och inaktivera bildtexter, ställer du in egenskapen showCaptions på false.

Standardvärdet är true.

Relaterade API-element

Begränsar formateringsinstruktionerna från Timed Text-filen när true är inställt på true.

För följande format finns inte stöd om egenskapen simpleFormatting är inställd på true:

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

För följande format finns stöd om egenskapen simpleFormatting är inställd på true:

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

URL till TT-XML-filen som innehåller bildtextsinformation (obligatorisk egenskap).

Stöd för flera språkspår.

Det bästa användningen av egenskapen track är att hantera flera språkspår med inbäddade referenspunkter.

Du måste följa följa de format som stöds för FLVPlaybackCaptioning-referenspunkter.

Om egenskapen track är inställd på något annat än 0, söker FLVPlaybackCaptioning-komponenten efter en text<n>-egenskap på referenspunkten, där n är spårvärdet.

Om exempelvis track == 1 söker FLVPlayBackCaptioning-komponenten efter parametern text1 på referenspunkten. Om det inte finns någon matchande parameter används text-egenskapen i referenspunktsparametrarna.

Standardvärdet är 0.

Ansluter den textade versionen till en specifik VideoPlayer i FLVPlayback-komponenten.

Om du vill använda en textad version i flera videospelare (med egenskaperna activeVideoPlayerIndex och visibleVideoPlayerIndex i FLVPlayback-komponenten) skapar du en instans av FLVPlaybackCaptioning-komponenten för varje VideoPlayer som du kommer att använda. Ställ sedan in den här egenskapen så att den motsvarar indexvärdet.

VideoPlayer-indexvärdet är som standard 0 när bara en videospelare används.

Relaterade API-element

Skapar en ny FLVPlaybackCaptioning-instans.

Returnerar en array med FLVPlayback-komponentens referenspunkter vars textningar innehåller söksträngen.

Parametrar

Returnerar en array med FLVPlayback-komponentens referenspunkter som innehåller textningarna.

Returnerar en sträng som innehåller alla textningar som en HTML-formaterad avskrift.

Varje textning är innesluten inuti en p-tagg med class-attributet "fl_video_caption", ett unikt id-attribut som inleds med strängen "fl_video_caption_2_0_," och ett title-attribut som visar den tidskod där textningen visas i videon.

Det följande är ett kortfattat exempel på returnerad HTML:

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

Parametrar

Returnerar antalet sekunder som en tidskodad sträng.

Parametrar

Skickas när en bildtext läggs till eller tas bort från måltextfältet för bildtext.

Händelsen skickas också när följande villkor uppfylls:

• captionTargetName-egenskapen är inte inställd
• captionTarget-egenskapen är inte inställd
• FLVPlaybackCaptioning-instansen skapar automatiskt ett TextField-objekt för bildtexter.

captionChange-händelsen har konstanten CaptionChangeEvent.CAPTION_CHANGE.

Den här händelsen har följande egenskaper:

Relaterade API-element

Skickas när egenskapen captionTarget har skapats, men innan några bildtexter läggs till (egenskapen captionTarget är tom).

Händelsen skickas inte om egenskapen captionTarget är inställd med ett anpassat DisplayObject, eller om egenskapen captionTargetName är inställd.

Avlyssna den här händelsen om du anpassar egenskaperna i TextField-objektet, till exempel egenskapen defaultTextFormat.

captionTargetCreated-händelsen har konstanten CaptionTargetEvent.CAPTION_TARGET_CREATED.

Den här händelsen har följande egenskaper:

Relaterade API-element

Skickas när alla Timed Text XML-data har lästs in.

Den här händelsen har följande egenskaper:

Relaterade API-element

Skickas om ett anrop till händelsen URLLoader.load() försöker få åtkomst till en Timed Text XML-fil via HTTP och Flash Player-miljön känner av och returnerar statuskoden för begäran.

Den här händelsen har följande egenskaper:

Relaterade API-element

Skickas om ett anrop till URLLoader.load() resulterar i ett allvarligt fel som gör att nedladdningen av Timed Text XML-filen avbryts.

Om händelsen inte hanteras utlöses ett fel.

Den här händelsen har följande egenskaper:

Relaterade API-element

Skickas när nedladdningsåtgärden för att läsa in Timed Text XML-filen påbörjas efter anropet till metoden URLLoader.load().

Den här händelsen har följande egenskaper:

Relaterade API-element

Skickas när data tas emot under nedladdningen av Timed Text XML-filen.

Den här händelsen har följande egenskaper:

Relaterade API-element

Skickas om ett anrop till URLLoader.load() försöker läsa in en Timed Text XML-fil från en server utanför säkerhetssandlådan.

Om händelsen inte hanteras utlöses ett fel.

Den här händelsen har följande egenskaper:

Relaterade API-element

En lägesvariabel som visar komponentens korta versionsnummer. Versionsnumret är användbart när du har en FLA-fil och behöver ta reda på komponentversionen. Du fastställer komponentversion genom att skriva följande i FLA-filen:

trace (FLVPlaybackCaptioning.SHORT_VERSION);

Variabeln SHORT_VERSION innehåller endast huvud och delversionsnummer, t.ex. 2.0. Variabeln version omfattar huvud- och delversionsnummer liksom reviderings- och build-nummer, t.ex. 2.0.0.xx.

Relaterade API-element

En lägesvariabel som visar komponentens långa versionsnummer. Versionsnumret är användbart när du har en FLA-fil och behöver ta reda på komponentversionen. Du fastställer komponentversion genom att skriva följande i FLA-filen:

trace (FLVPlaybackCaptioning.VERSION);

Variabeln VERSION omfattar huvud- och delversionsnummer liksom reviderings- och build-nummer, t.ex. 2.0.0.xx. Variabeln SHORT_VERSION innehåller endast huvud och delversionsnummer, t.ex. 2.0.

Relaterade API-element

Följ stegen nedan:

1. Öppna en ny Flash-fil (ActionScript 3.0).
2. Placera FLVPlayback-komponenten på scenen vid 0,0 och ange instansnamnet: -spelare
3. Placera FLVPlaybackCaptioning-komponenten på scenen vid 0,0 och ange instansnamnet: text.
4. Placera komponenten CaptionButton på scenen.
5. Spara FLA-filen och ge den ett namn, till exempel captionEx.
6. Öppna en ny ActionScript-fil.
7. Klistra in följande klassexempelkod i en ny ActionScript-fil och spara den som FLVPlaybackCaptioningExample.as i samma katalog som din FLA-fil.
8. I FLA-filen (till exempel captionEx) ställer du i Egenskapsinspektören in dokumentklassen till FLVPlaybackCaptioningExample.
9. Välj Kontroll > Testa filmen.

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