FLVPlayback component parameters

For each instance of the FLVPlayback component, you can set the following parameters in the Component inspector or the Property inspector:

autoPlay A Boolean value that determines how to play the FLV file. If true, the component plays the FLV file immediately when it is loaded. If false, the component loads the first frame and pauses. The default value is true for the default video player (0) and false for others. For more information about using multiple video players in a single FLVPlayback instance, see Playing multiple FLV files.

autoRewind A Boolean value that determines whether the FLV file will rewind automatically when it finishes playing. If true, the FLVPlayback component automatically rewinds the FLV file to the beginning when the playhead reaches the end or when the user clicks the Stop button. If false, the component stops play on the last frame of the FLV file and does not rewind automatically. The default value is true.

autoSize A Boolean value that, if true, resizes the component at runtime to use the source FLV file dimensions. These dimensions are encoded in the FLV file and are different than the default dimensions of the FLVPlayback component. The default value is false. For more information, see FLVPlayback.autoSize.

bufferTime The number of seconds to buffer the FLV file in memory before beginning playback. This parameter affects streaming FLV files, which are buffered in memory but not downloaded. For an FLV file that is progressively downloaded over HTTP, there is little advantage to increasing this value, although it can improve viewing a high-quality video on an older, slower computer. The default value is 0.1 For more information, see FLVPlayback.bufferTime.

NOTE

Setting this parameter does not guarantee that a certain amount of the FLV file will download before playback begins.

contentPath A string that specifies the URL to an FLV file or an XML file that describes how to play one or more FLV files. You can specify a path on your local computer, an HTTP path, or a Real-Time Messaging Protocol (RTMP) path. Double-click the value cell for this parameter to open the Content Path dialog box. The default is an empty string.

If you do not specify a value for the contentPath parameter, nothing happens when Flash executes the FLVPlayback instance. For more information, see Specifying the contentPath parameter.

cuePoints A string that describes the cue points for the FLV file. Cue points allow you to synchronize specific points in the FLV file with Flash animation, graphics, or text. The default value is an empty string. For more information, see Using cue points.

isLive A Boolean value that, if true, specifies that the FLV file is streaming live from Flash Media Server. One example of a live stream is a video of news events as they are taking place. The default value is false. For more information, see FLVPlayback.isLive.

maintainAspectRatio A Boolean value that, if true, resizes the video player within the FLVPlayback component to retain the aspect ratio of the source FLV file; the source FLV file is scaled to the dimensions of the FLVPlayback component on the Stage. The autoSize parameter takes precedence over this parameter. The default value is true. For more information, see FLVPlayback.maintainAspectRatio.

skin A parameter that opens the Select Skin dialog box from which you can select a skin for the component. The default value is initially a predesigned skin, but it subsequently becomes the last selected skin. If you select None, the FLVPlayback instance does not have control elements to operate the FLV file. If the autoPlay parameter is set to true, the FLV file plays automatically. For more information, see Customizing the FLVPlayback component.

skinAutoHide A Boolean value that, if true, hides the skin when the mouse is not over the FLV file or the skin region, if it is an external skin that is not on the FLV file viewing area. The default value is false. For more information, see FLVPlayback.skin.

totalTime The total number of seconds, to a precision of milliseconds, in the source FLV file. The default value is 0.

If you use FMS or FVSS, the component always takes the total time from the server.

If you use progressively download over HTTP, the component uses this number if it is set to a value greater than zero. Otherwise, it tries to take the time from the FLV file metadata. For more information, see FLVPlayback.totalTime.

volume A number from 0 to 100 that represents a percentage of the maximum volume (100). For more information, see FLVPlayback.volume.

Each of these parameters has an equivalent property in the FLVPlayback class. Setting the property overrides the parameter setting in the Component inspector or the Property inspector.

View comments on LiveDocs