Specifies whether the VideoDisplay control should use the built-in automatic bandwidth detection feature. When false, you do not require a main.asc file on Flash Media Server (FMS) 2 to connect to FMS. When true, you need to implement a main.asc and store it in the directory structure of FMS. The main.asc file must define the following functions:

•       application.onConnect = function(p_client, p_autoSenseBW)
        {
          //Add security code here.     
          this.acceptConnection(p_client);      
          if (p_autoSenseBW)
            this.calculateClientBw(p_client);
          else
            p_client.call("onBWDone");
        }

•       application.calculateClientBw = function(p_client)
        {
          // Add code to set the clients BandWidth.
          // Use p_client.getStats() which returns bytes_in 
          // and bytes_Out and check your bandWidth using 
          // p_client.call("onBWCheck", result, p_client.payload).
          p_client.call("onBWDone");
        }
        

•       Client.prototype.getStreamLength = function(p_streamName)
        {
          return Stream.length(p_streamName);
        }

The default value is false.

This property can be used as the source for data binding. When this property is modified, it dispatches the autoBandWidthDetection event.

Specifies whether the video should start playing immediately when the source property is set. If true, the video file immediately begins to buffer and play.

Even if autoPlay is set to false, Flex starts loading the video after the initialize() method is called. For Flash Media Server, this means creating the stream and loading the first frame to display (and loading more if autoSize or aspectRatio is set to true). In the case of an HTTP download, Flex starts downloading the stream and shows the first frame.

The default value is true.

Specifies whether the FLV file should be rewound to the first frame when play stops, either by calling the stop() method or by reaching the end of the stream. This property has no effect for live streaming video.

The default value is true.

This property can be used as the source for data binding. When this property is modified, it dispatches the autoRewindChanged event.

The border object for the control.

Returns an EdgeMetrics object that has four properties: left, top, right, and bottom. The value of each property is equal to the thickness of one side of the border around the control, in pixels.

Number of seconds of video to buffer in memory before starting to play the video file. For slow connections streaming over RTMP, it is important to increase this property from the default.

The default value is 0.1.

This property can be used as the source for data binding. When this property is modified, it dispatches the bufferTimeChanged event.

Number of bytes already loaded that are available for playing. The value is only useful for media loaded using HTTP.

Contains -1 when there is no input stream, when the stream is from Flash Media Server, or if the information is not yet available.

This property can be used as the source for data binding. When this property is modified, it dispatches the progress event.

Total number of bytes to load. The value is only useful for media loaded using HTTP.

Contains -1 when there is no input stream, when the stream is from Flash Media Server, or if the information is not yet available.

This property can be used as the source for data binding. When this property is modified, it dispatches the progress event.

The instance of the CuePointManager class associated with the VideoPlayer control. You can use this object to control cue points, or use the cuePoints property.

You use cue points to trigger cuePoint events when the playback of your video reaches a specified location. To set cue points, you use methods of the CuePointManager class.

Cue points embedded in the FLV are not available via cuePoints or cuePointManager. In order to retrieve them, you can access the metadata property or the metadataReceived event.

See also

Cue point manager to use. Set this to mx.controls.videoClasses.CuePointManager to enable cue point management.

See also

The Array of cue points associated with the control. You can use this property to control cue points, or use the cuePointManager property.

You use cue points to trigger cuePoint events when the playback of your video reaches a specified location. To set cue points, you pass an Array to the cuePoints property.

Cue points embedded in the FLV are not available via cuePoints or cuePointManager. In order to retrieve them, you can access the metadata property or the metadataReceived event.

Each element of the Array contains two fields:

• The name field contains an arbitrary name of the cue point.
• The time field contains the playhead location, in seconds, of the VideoDisplay control with which the cue point is associated.

This property can be used as the source for data binding. When this property is modified, it dispatches the cuePointsChanged event.

Specifies the amount of time, in milliseconds, that the connection is idle (playing is paused or stopped) before the connection to the Flash Media Server is stopped. This property has no effect on the HTTP download of FLV files. If this property is set when the stream is already idle, it restarts the idle timeout with a new value.

The default value is 300000 (five minutes).

Specifies whether the control is streaming a live feed. Set this property to true when streaming a live feed from Flash Media Server.

The default value is false.

Specifies whether the control should maintain the original aspect ratio while resizing the video.

The default value is true.

This property can be used as the source for data binding. When this property is modified, it dispatches the maintainAspectRatioChanged event.

An object that contains a metadata information packet that is received from a call to the NetStream.onMetaData() callback method, if available. Ready when the metadataReceived event is dispatched.

If the FLV file is encoded with the Flash 8 encoder, the metadata property contains the following information. Older FLV files contain only the height, width, and duration values.

This property can be used as the source for data binding. When this property is modified, it dispatches the metadataReceived event.

Playhead position, measured in seconds, since the video starting playing. The event object for many of the VideoPlay events include the playhead position so that you can determine the location in the video file where the event occurred.

Setting this property to a value in seconds performs a seek operation. If the video is currently playing, it continues playing from the new playhead position. If the video is paused, it seeks to the new playhead position and remains paused. If the video is stopped, it seeks to the new playhead position and enters the paused state. Setting this property has no effect with live video streams.

If the new playhead position is less than 0 or NaN, the control throws an exception. If the new playhead position is past the end of the video, or past the amount of the video file downloaded so far, then the control still attempts the seek.

For an FLV file, setting the playheadTime property seeks to the keyframe closest to the specified position, where keyframes are specified in the FLV file at the time of encoding. Therefore, you might not seek to the exact time if there is no keyframe specified at that position.

If player is in an unresponsive state, it queues the request.

This property throws an exception if set when no stream is connected. Use the stateChange event and the connected property to determine when it is safe to set this property.

The default value is NaN.

This property can be used as the source for data binding. When this property is modified, it dispatches the playheadUpdate event.

Specifies the amount of time, in milliseconds, between each playheadUpdate event.

If you set this property when the video is playing, the timer restarts at 0, and the next playheadUpdate event occurs after the new time interval.

The default value is 250.

If true, the media is currently playing.

This property can be used as the source for data binding. When this property is modified, it dispatches the stateChange event.

Specifies the amount of time, in milliseconds, between each progress event. The progress event occurs continuously until the video file downloads completely.

If you set this property when the video is downloading, the timer restarts at 0, and the next progress event occurs after the new time interval.

The default value is 250.

Relative path and filename of the FLV file to stream.

This property can be used as the source for data binding. When this property is modified, it dispatches the sourceChanged event.

The current state of the VideoDisplay control. You set this property by calls to the load(), play(), stop(), and pause() methods, and setting the playHeadTime property.

This property can have the following values defined in the VideoEvent class: VideoEvent.BUFFERING, VideoEvent.CONNECTION_ERROR, VideoEvent.DISCONNECTED, VideoEvent.EXEC_QUEUED_CMD, VideoEvent.LOADING, VideoEvent.PAUSED, VideoEvent.PLAYING, VideoEvent.RESIZING, VideoEvent.REWINDING, VideoEvent.SEEKING, and VideoEvent.STOPPED.

The default value is VideoEvent.DISCONNECTED.

This property can be used as the source for data binding. When this property is modified, it dispatches the stateChange event.

See also

Specifies whether the VideoDisplay control is in a responsive state, true, or in the unresponsive state, false. The control enters the unresponsive state when video is being loaded or is rewinding.

The control is also in a responsive state when the state property is: VideoEvent.CONNECTION_ERROR, VideoEvent.EXEC_QUEUED_CMD, or VideoEvent.RESIZING.

If the control is unresponsive, calls to the play(), load(), stop(), and pause() methods are queued, and then executed when the control changes to the responsive state.

This property can be used as the source for data binding. When this property is modified, it dispatches the stateChange event.

Total length of the media, in seconds. For FLV 1.0 video files, you manually set this property. For FLV 1.1 and later, the control calculates this value automatically.

This property can be used as the source for data binding. When this property is modified, it dispatches the metadataReceived event.

Height of the loaded FLV file. -1 if no FLV file loaded yet.

This property can be used as the source for data binding. When this property is modified, it dispatches the resize event.

Width of the loaded FLV file. -1 if no FLV file loaded yet.

This property can be used as the source for data binding. When this property is modified, it dispatches the resize event.

The volume level, specified as an value between 0 and 1.

The default value is 0.75.

This property can be used as the source for data binding. When this property is modified, it dispatches the volumeChanged event.

Constructor.

Specifies to play a video stream from a camera. The video is displayed within the boundaries of the control in the application window. Do not call the play() method when displaying a stream from a camera.

Parameters

Forces the close of an input stream and connection to Flash Media Server. Calling this method dispatches the close event. Typically calling this method directly is not necessary because the connection is automatically closed when the idle period times out, as defined by the idleTimeout property.

Creates the border for this component. Normally the border is determined by the borderStyle and borderSkin styles. It must set the border property to the instance of the border.

Responds to size changes by setting the positions and sizes of the borders.

The VideoDisplay.layoutChrome() method sets the position and size of the VideoDisplay's border. In every subclass of VideoDisplay, the subclass's layoutChrome() method should call the super.layoutChrome() method, so that the border is positioned properly.

Parameters

Loads the media file without playing it.

This method is similar to the play() method, but it causes the file to be loaded without playing. Autoresizing will occur if appropriate. After the load and autoresize, the state of the control is set to VideoEvent.PAUSED.

Pauses playback without moving the playhead. If playback is already is paused or is stopped, this method has no effect.

To start playback again, call the play() method.

If the control is in an unresponsive state, the request is queued.

Plays the media file. If the file has not been loaded, it loads it. You can call this method while playback is paused, stopped, or while the control is playing.

If the control is in an unresponsive state, the request is queued.

To stream video from a camera, call the attachCamera() method, instead of the play() method.

Stops playback. If the autoRewind property is set to true, rewind to the first frame.

To start playback again, call the play() method.

If playback is already stopped, this method has no effect. If the control is in an unresponsive state, the request is queued.

Dispatched when the NetConnection object is closed, whether by timing out or by calling the close() method. You use this event when working with Flash Media Server.

The properties of the event object have the following values:

Dispatched when the playhead reaches the end of the FLV file.

The properties of the event object have the following values:

Dispatched when the value of a cue point's time property is equal to the current playhead location.

The properties of the event object have the following values:

Dispatched the first time metadata in the FLV file is reached.

This event has the following properties:

Dispatched continuosly while the video is playing. The interval between events, in milliseconds, is specified by the playheadUpdateInterval property, which defaults to 250 ms. This event is not dispatched when the video is in a paused or stopped state.

The properties of the event object have the following values: