Configuring the FLVPlayback Component
Configuring the FLVPlayback component involves three steps:
- With the component selected, open the Property inspector (Windows > Properties) and enter an instance name.
- Select the Parameters tab in the Property inspector or open the Component inspector (Windows > Components).
- Enter values for parameters or use default settings (See Figure 6).
Figure 6 FLVPlayback component parameters in the Property inspector
For each FLVPlayback component instance, you can set the following parameters in the Property inspector or Component inspector:
- autoPlay: This is a Boolean value that determines how to play the FLV. If true, the FLV plays immediately when it is loaded. If false, it loads the first frame and pauses. The default value is true.
- autoRewind: This is a Boolean value that determines whether the FLV is automatically rewound. If true, the Video component automatically rewinds the FLV to the beginning when the playhead reaches the end or when the user clicks the stop button. If false, the Video component does not automatically rewind the FLV. The default value is true.
- autoSize: A Boolean value that, if true, resizes the component at runtime to use the source FLV dimensions. The default value is false.
- bufferTime: This sets the number of seconds to buffer before beginning playback. The default value is 0.
- contentPath: This is a string that specifies the URL to an FLV or to an XML file that describes how to play the FLV. Double-click the Value cell for this parameter to activate 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" in Flash Help.
- isLive: This is a Boolean value that, if true, specifies that the FLV is streaming live from FCS. The default value is false.
- cuePoints: This is a string that specifies the cue points for the FLV. Cue points enable you to synchronize specific points in the FLV with Flash animation, graphics, or text. The default value is an empty string.
- maintainAspectRatio: A Boolean value that, if true, resizes the video player within the FLVPlayback component to retain the source FLV aspect ratio; the source FLV will still be scaled and the FLVPlayback component itself will not be resized. The autoSize parameter takes precedence over this parameter. The default value is true.
- skin: A parameter that opens the Select Skin dialog box and
enables you to choose a skin for the component (See Figure 7). The default skin
is ClearOverPlaySeekMute.swf. If you choose None, the FLVPlayback instance will
not have control elements that allow the user to play, stop, or rewind the FLV;
or take other actions that the controls make possible. If the autoPlay parameter
is set to true, the FLV plays automatically. For more information, see
"Selecting a Predesigned skin in
FLVPlayback Component (Flash Professional Only)"
in the Flash Help section labeled "Components Language
Figure 7 The Select Skin dialog box for choosing a skin for the FLVPlayback component
- totalTime: The total number of seconds in the source FLV file. The default value is 0. If you use progressive download, Flash can use this value for a variety of tasks as long as it is set to a value greater than zero. Otherwise, Flash tries to take the time from metadata.
- volume: A number from 0 to 100 that represents the percentage of maximum volume at which to set the volume control interface.
Providing an easy-to-use yet full-featured set of playback controls is an important element of any video implementation. Although Flash provides several options for video playback control, your best option is probably to use the new FLVPlayback component. Not only is the FLVPlayback component the most full-featured and easiest option to implement, it is also the most customizable.
The next article of this series explores this customization capability in more detail with a review of the various methods available for customizing the FLVPlayback component.