Using ActionScript 3.0 Components |
|
|
|
| Using the FLVPlayback Captioning Component > Using cue points with captioning > Understanding FLVPlaybackCaptioning cue point standards | |||
Within the FLV file's metadata, a cue point is represented as an object with the following properties: name, time, type, and parameters. FLVPlaybackCaptioning ActionScript cue points have the following attributes:
name property is a string that contains the assigned name of the cue point. The name property must start with the fl.video.caption.2.0. prefix and follow the prefix with a string. The string is a series of positive integers that increment each time to keep each name unique. The prefix includes the version number that also matches the FLVPlayback version number. For Adobe Flash CS3, you must set the version number to 2.0.time property is the time when the caption should display. type property is a string whose value is "event".parameters property is an array that supports the following name-and-value pairs:
text:String. The HTML-formatted text for the caption. This text is passed to the TextField.htmlText property directly. The FLVPlaybackCaptioning component supports an optional text:n property, which supports the use of multiple language tracks. For more information, see Supporting multiple language tracks with embedded cue points.endTime:Number. The time when the caption should disappear. If you do not specify this property, the FLVPlaybackCaptioning component assumes it is not a number (NaN), and the caption is displayed until the FLV file completes (the FLVPlayback instance dispatches the VideoEvent.COMPLETE event). Specify the endTime:Number property in seconds.backgroundColor:uint.This parameter sets the TextField.backgroundColor. This property is optional.backgroundColorAlpha:Boolean. If the backgroundColor has an alpha of 0%, then the parameter sets TextField.background = !backgroundColor. This property is optional.wrapOption:Boolean. This parameter sets the TextField.wordWrap. This property is optional.
|
|
|
|