FLVPlaybackCaptioning  - AS3

Determines whether the FLVPlaybackCaptioning component automatically moves and resizes the TextField object for captioning.

If the autoLayout property is set to true, the DisplayObject instance or the TextField object containing the captions displays 10 pixels from the bottom of the FLVPlayback instance. The captioning area covers the width of the FLVPlayback instance, maintaining a margin of 10 pixels on each side.

When this property is set to true, the DisplayObject instance or TextField object displays directly over the FLVPlayback instance. If you are creating your own TextField object, you should set autoLayout to false. If wordWrap = false, the captioning area centers over the FLVPlayback instance, but it can be wider than the FLVPlayback instance.

To control layout, you need to listen for the captionChange event to determine when the TextField object instance is created.

The default value is true.

Related API Elements

Defines the captionButton FLVPlayback custom UI component instance which provides toggle capabilities to turn captioning on and off.

The captionButton property functions similarly to the FLVPlayback properties playButton, pauseButton, muteButton, and so on.

Related API Elements

Sets the DisplayObject instance in which to display captions.

If you set the instance as a TextField object, it is targeted directly. If you set the instance as a DisplayObjectContainer containing one or more TextField objects, the captions display in the TextField object with the lowest display index.

The DisplayObjectContainer method supports a movie-clip like object with a scale-9 background, which can be scaled when the TextField object size changes.

For more complex scaling and drawing, write code to have the DisplayObjectContainer method listen for a captionChange event.

Note If the captionTargetName or the captionTarget property is not set, the FLVPlaybackCaptioning instance creates a text field set by the captionTarget property with this formatting:

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

To customize these values, listen for the captionTargetCreated event.

Related API Elements

The instance name of the TextField object or MovieClip enclosing a Textfield object that contains the captions.

To specify no target, set this property to an empty string (that is, no target specified) or auto. This property is primarily used in the Component inspector. If you are writing code, use the captionTarget property instead.

The default value is auto.

Related API Elements

Sets the FLVPlayback instance to caption. The FLVPlayback instance must have the same parent as the FLVPlaybackCaptioning instance.

If the flvPlaybackName or flvPlayback property is not set, the FLVPlaybackCaptioning instance will look for a FLVPlayback instance with the same parent and caption the first one it finds.

Related API Elements

Sets an FLVPlayback instance name for the FLVPlayback instance that you want to caption.

To specify no target, set this to an empty string or auto. The FLVPlayback instance must have the same parent as the FLVPlaybackCaptioning instance.

The FLVPlayback instance name is primarily used in the Component inspector. If you are writing code, use the flvPlayback property.

If the flvPlaybackName or the flvPlayback property is not set or set to auto, the FLVPlaybackCaptioning instance searches for a FLVPlayback instance with the same parent and captions the first one it finds.

The default value is auto.

Related API Elements

Used to display captions; true = display captions, false = do not display captions.

If you use the captionButton property to allow the user to turn captioning on and off, set the showCaptions property to false.

The default value is true.

Related API Elements

Limits formatting instructions from the Timed Text file when set to true.

The following styles are not supported if the simpleFormatting property is set to true:

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

The following styles are supported if the simpleFormatting property is set to true:

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

URL of the Timed Text XML file that contains caption information (required property).

Support for multiple language tracks.

The best utilization of the track property is to support multiple language tracks with embedded cue points.

You must follow the supported formats for FLVPlaybackCaptioning cue points.

If the track property is set to something other than 0, the FLVPlaybackCaptioning component searches for a text<n> property on the cue point, where n is the track value.

For example, if track == 1, then the FLVPlayBackCaptioning component searches for the parameter text1 on the cue point. If no matching parameter is found, the text property in the cue point parameter is used.

The default value is 0.

Connects the captioning to a specific VideoPlayer in the FLVPlayback component.

If you want to use captioning in multiple video players (using the activeVideoPlayerIndex and visibleVideoPlayerIndex properties in the FLVPlayback component), you should create one instance of the FLVPlaybackCaptioning component for each VideoPlayer that you will be using and set this property to correspond to the index.

The VideoPlayer index defaults to 0 when only one video player is used.

Related API Elements

Creates a new FLVPlaybackCaptioning instance.

Returns an array of FLVPlayback component cuepoints whose caption text contains the search string.

Parameters

Returns an array of FLVPlayback component cuepoints that contain the captions.

Returns a string containing all captions as an HTML-formatted transcript.

Each caption is contained within a p tag with the class attribute "fl_video_caption," a unique id attribute starting with the string "fl_video_caption_2_0_," and a title attribute indicating the timecode at which the caption appears in the video.

Following is a brief example of the HTML returned:

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

Parameters

Returns a number of seconds as a timecode string.

Parameters

Dispatched when a caption is added or removed from the caption target text field.

The event is also dispatched when the following conditions are true:

• the captionTargetName property is not set
• the captionTarget property is not set
• the FLVPlaybackCaptioning instance creates a TextField object automatically for captioning.

The captionChange event has the constant CaptionChangeEvent.CAPTION_CHANGE.

This event has the following properties:

Related API Elements

Dispatched after the captionTarget property is created, but before any captions are added (the captionTarget property is empty).

If the captionTarget property is set with a custom DisplayObject, or if the captionTargetName property is set, this event does not dispatch.

Listen for this event if you are customizing the properties of the TextField object, for example, the defaultTextFormat property.

The captionTargetCreated event has the constant CaptionTargetEvent.CAPTION_TARGET_CREATED.

This event has the following properties:

Related API Elements

Dispatched after all of the Timed Text XML data is loaded.

This event has the following properties:

Related API Elements

Dispatched if a call to the URLLoader.load() event attempts to access a Timed Text XML file over HTTP and the current Flash Player environment is able to detect and return the status code for the request.

This event has the following properties:

Related API Elements

Dispatched if a call to the URLLoader.load() event results in a fatal error that terminates the download of the Timed Text XML file.

If this event is not handled, it will throw an error.

This event has the following properties:

Related API Elements

Dispatched when the download operation to load the Timed Text XML file begins, following a call to the URLLoader.load() method.

This event has the following properties:

Related API Elements

Dispatched when data is received as the download of the Timed Text XML file progresses.

This event has the following properties:

Related API Elements

Dispatched if a call to the URLLoader.load() event attempts to load a Timed Text XML file from a server outside the security sandbox.

If this event is not handled, it will throw an error.

This event has the following properties:

Related API Elements

State variable indicating the short version number of the component. The version number is useful when you have a FLA file and need to know the component version. To determine the component version, type the following trace into the FLA file:

trace (FLVPlaybackCaptioning.SHORT_VERSION);

The SHORT_VERSION variable includes only the major and minor version numbers, for example, 2.0. The version variable includes the major and minor version numbers as well as the revision and build numbers, for example, 2.0.0.xx.

Related API Elements

State variable indicating the long version number of the component. The version number is useful when you have a FLA file and need to know the component version. To determine the component version, type the following trace into the FLA file:

trace (FLVPlaybackCaptioning.VERSION);

The VERSION variable includes the major and minor version numbers as well as the revision and build numbers, for example, 2.0.0.xx. The SHORT_VERSION variable includes only the major and minor version numbers, for example, 2.0.

Related API Elements

To run the example, follow these steps:

1. Open a new Flash File (ActionScript 3.0).
2. Place the FLVPlayback component on the Stage at 0,0 and provide the instance name: player.
3. Place the FLVPlaybackCaptioning component on the stage at 0,0 and provide the instance name: captioning.
4. Place the CaptionButton component on the Stage.
5. Save the FLA file and give it a name - e.g. captionEx.
6. Open a new ActionScript file.
7. Paste the following class example code into a new ActionScript file and save it as FLVPlaybackCaptioningExample.as in the same directory as your FLA file.
8. In the FLA file (e.g. captionEx), in the Properties inspector set the Document class entry to FLVPlaybackCaptioningExample.
9. Select Control > Test Movie.

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