VideoPlayer  - AS3 Flash

Specifies how the video is displayed relative to the registrationX, registrationY, registrationWidth and registrationHeight properties. The align property does this autolayout when the scaleMode property is set to VideoScaleMode.MAINTAIN_ASPECT_RATIO or VideoScaleMode.NO_SCALE. Changing this property after an FLV file is loaded causes an automatic layout to start immediately. Values come from the VideoAlign class.

The default value is VideoAlign.CENTER.

Related API Elements

A Boolean value that, if true, causes the FLV file to rewind to Frame 1 when play stops, either because the player reached the end of the stream or the stop() method was called. This property is meaningless for live streams.

The default value is false.

A number that specifies the number of seconds to buffer in memory before beginning to play a video stream. For FLV files streaming over RTMP, which are not downloaded and buffer only in memory, it can be important to increase this setting from the default value of 0.1. For a progressively downloaded FLV file over HTTP, there is little benefit to increasing this value although it could improve viewing a high-quality video on an older, slower computer.

For prerecorded (not live) video, do not set the bufferTime property to 0; use the default buffer time or increase the buffer time.

This property does not specify the amount of the FLV file to download before starting playback.

Related API Elements

A number that indicates the extent of downloading, in number of bytes, for an HTTP download. Returns 0 when there is no stream, when the stream is from Flash Media Server (FMS), or if the information is not yet available. The returned value is useful only for an HTTP download.

A number that specifies the total number of bytes downloaded for an HTTP download. Returns -1 when there is no stream, when the stream is from Flash Media Server (FMS), or if the information is not yet available. The returned value is useful only for an HTTP download.

A number that specifies the height of the VideoPlayer instance (in pixels).

Note: Do not confuse this property with the flash.media.Video.height property which is similar to the fl.video.VideoPlayer.videoHeight property.

Related API Elements

The amount of time, in milliseconds, before Flash terminates an idle connection to a video server, such as Flash Media Server, because playing paused or stopped. This property has no effect on an FLV file downloading over HTTP.

If this property is set when a video stream is already idle, it restarts the timeout period with the new value.

To make all VideoPlayer objects use your custom class as the default INCManager implementation, set the iNCManagerClass property to the class object or string name of your custom class. The FLVPlayback class includes the definition of the custom class; the video player does not.

The default value is "fl.video.NCManager" as a string.

A Boolean value that is true if the video stream is live. This property is effective only when streaming from a video server, such as Flash Media Server or other Flash Video Streaming Service. The value of this property is ignored for an HTTP download.

Set the isLive property to false when sending a prerecorded video stream to the video player and to true when sending real-time data such as a live broadcast. For better performance when you set the isLive property to false, do not set the bufferTime property to 0.

Related API Elements

A Boolean value that is true if the FLV file is streaming from Flash Media Server (FMS) using RTMP. Its value is false for any other FLV file source.

Related API Elements

An object that is a metadata information packet that is received from a call to the NetSteam.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.

Related API Elements

An INCManager object that provides access to an instance of the class implementing INCManager, which is an interface to the NCManager class.

You can use this property to implement a custom INCManager that requires custom initialization.

Related API Elements

Allows direct access to the NetConnection instance created by the video player.

Allows direct access to the NetStream instance created by the video player.

Registers a custom class for the NetStream's client property. By default, fl.video.VideoPlayerClient is used; this class handles the onMetaData() and onCuePoint() messages. To add custom handling for other messages, such as onImageData() and onTextData(), you can create your own class and set this property to the class.

The constructor for the class must take a VideoPlayer instance as its only parameter, and it must have a Boolean ready property. This property should be false while the Client is still waiting for any data messages expected at the beginning of the file. If the VideoPlayer does its resize autorewind before these messages are received, they may never be received. By default, fl.video.VideoPlayerClient will return true from the ready property as soon as onMetaData() is called.

You can set the property to the class object itself (as in the example below) or the string name of the class:

        import fl.video.
        VideoPlayer.netStreamClientClass = MyCustomClient;
        

Note that setting it to the string name of the class is not enough by itself to force the class to be compiled into the SWF. The default value is the class object fl.video.VideoPlayerClient, not the string name.

It is strongly recommended that any custom implementation should subclass fl.video.VideoPlayer. To do otherwise risks breaking the metadata and cue point handling built into the VideoPlayer and the FLVPlayback component.

The default value is fl.video.VideoPlayerClient.

A number that is the current playhead time or position, measured in seconds, which can be a fractional value. Setting this property triggers a seek and has all the restrictions of a seek.

When the playhead time changes, which includes once every .25 seconds while the FLV file plays, the component dispatches the playheadUpdate event.

For several reasons, the playheadTime property might not have the expected value immediately after calling one of the seek methods or setting playheadTime to cause seeking. First, for a progressive download, you can seek only to a keyframe, so a seek takes you to the time of the first keyframe after the specified time. (When streaming, a seek always goes to the precise specified time even if the source FLV file doesn't have a keyframe there.) Second, seeking is asynchronous, so if you call a seek method or set the playheadTime property, playheadTime does not update immediately. To obtain the time after the seek is complete, listen for the seek event, which does not fire until the playheadTime property has updated.

Related API Elements

A number that is the amount of time, in milliseconds, between each playheadUpdate event. Setting this property while the FLV file is playing restarts the timer.

Because ActionScript cue points start on playhead updates, lowering the value of the playheadUpdateInterval property can increase the accuracy of ActionScript cue points.

Because the playhead update interval is set by a call to the global setInterval() method, the update cannot fire more frequently than the SWF file frame rate, as with any interval that is set this way. So, as an example, for the default frame rate of 12 frames per second, the lowest effective interval that you can create is approximately 83 milliseconds, or one second (1000 milliseconds) divided by 12.

The default value is 250.

Related API Elements

A number that is the amount of time, in milliseconds, between each progress event. If you set this property while the video stream is playing, the timer restarts.

The height used to align the video content when autoresizing. Do not confuse the registrationHeight property with the height property. The height property reflects the actual height of the video content.

Example 1, load an 80x80 FLV file with the following settings:

• registrationX = 100
• registrationY = 100
• registrationWidth = 60
• registrationHeight = 40
• align = VideoAlign.CENTER
• scaleMode = VideoScaleMode.NO_SCALE

• x = 90
• y = 80
• width = 80
• height = 80

Example 2, load the same scenario as example 1 but with the following settings:

• scaleMode = VideoScaleMode.MAINTAIN_ASPECT_RATIO

• x = 110
• y = 100
• width = 40
• height = 80

Example 3, load the same scenario as example 2 but with the following settings:

• scaleMode = VideoScaleMode.EXACT_FIT

• x = 100
• y = 100
• width = 60
• height = 40

Setting the registrationHeight property is equivalent to setting the height property and vice versa. Setting any other property or calling any method that alters the height, such as scaleX, setSize, and setScale, setting keeps height and registrationHeight in sync.

Related API Elements

The width used to align the video content when autoresizing. Do not confuse the registrationWidth property with the width property. The width property reflects the actual width of the video content.

Example 1, load an 80x80 FLV file with the following settings:

• registrationX = 100
• registrationY = 100
• registrationWidth = 60
• registrationHeight = 40
• align = VideoAlign.CENTER
• scaleMode = VideoScaleMode.NO_SCALE

• x = 90
• y = 80
• width = 80
• height = 80

Example 2, load the same scenario as example 1 but with the following settings:

• scaleMode = VideoScaleMode.MAINTAIN_ASPECT_RATIO

• x = 110
• y = 100
• width = 40
• height = 80

Example 3, load the same scenario as example 2 but with the following settings:

• scaleMode = VideoScaleMode.EXACT_FIT

• x = 100
• y = 100
• width = 60
• height = 40

Setting the registrationWidth property is equivalent to setting the width property and vice versa. Setting any other property or calling any method that alters the width, such as scaleX, setSize, and setScale, also keeps width and registrationWidth in sync.

Related API Elements

The x coordinate used to align the video content when autoresizing. Do not confuse with the x property, which reflects the actual location of the video content.

Example 1, load an 80x80 FLV file with the following settings:

• registrationX = 100
• registrationY = 100
• registrationWidth = 60
• registrationHeight = 40
• align = VideoAlign.CENTER
• scaleMode = VideoScaleMode.NO_SCALE

• x = 90
• y = 80
• width = 80
• height = 80

Example 2, load the same scenario as example 1 but with the following settings:

• scaleMode = VideoScaleMode.MAINTAIN_ASPECT_RATIO

• x = 110
• y = 100
• width = 40
• height = 80

Example 3, load the same scenario as example 2 but with the following settings:

• scaleMode = VideoScaleMode.EXACT_FIT

• x = 100
• y = 100
• width = 60
• height = 40

When either the x or registrationX property is set, the second property is changed to maintain its offset from the first. For example, if x = 10 and registrationX = 20, setting x = 110 also sets registrationX = 120.

Related API Elements

The y coordinate used to align the video content when autoresizing. Do not confuse with the y property, which reflects the actual location of the video content.

Example 1, load an 80x80 FLV file with the following settings:

• registrationX = 100
• registrationY = 100
• registrationWidth = 60
• registrationHeight = 40
• align = VideoAlign.CENTER
• scaleMode = VideoScaleMode.NO_SCALE

• x = 90
• y = 80
• width = 80
• height = 80

Example 2, load the same scenario as example 1 but with the following settings:

• scaleMode = VideoScaleMode.MAINTAIN_ASPECT_RATIO

• x = 110
• y = 100
• width = 40
• height = 80

Example 3, load the same scenario as example 2 but with the following settings:

• scaleMode = VideoScaleMode.EXACT_FIT

• x = 100
• y = 100
• width = 60
• height = 40

When either the y or registrationY property is set, the second property is changed to maintain its offset from the first. For example, if y = 10 and registrationY = 20, setting y = 110 also sets registrationY = 120.

Related API Elements

Specifies how the video resizes after loading. If set to VideoScaleMode.MAINTAIN_ASPECT_RATIO, maintains the video aspect ratio within the rectangle defined by registrationX, registrationY, registrationWidth and registrationHeight. If set to VideoScaleMode.NO_SCALE, causes the video to size automatically to the dimensions of the source FLV file. If set to VideoScaleMode.EXACT_FIT, causes the dimensions of the source FLV file to be ignored and the video is stretched to fit the rectangle defined by registrationX, registrationY, registrationWidth and registrationHeight. If this is set after an FLV file has been loaded an automatic layout will start immediately. Values come from VideoScaleMode.

The default value is VideoScaleMode.MAINTAIN_ASPECT_RATIO.

Related API Elements

A number that is the horizontal scale.

The default value is 1.

Related API Elements

A number that is the vertical scale.

The default value is 1.

Related API Elements

Provides direct access to the NetStream.soundTransform property to expose more sound control. Set the property to change the settings; use the getter accessor method of the property to retrieve the current settings.

Related API Elements

A string that specifies the URL of the FLV file to stream and how to stream it. The URL can be an HTTP URL to an FLV file, an RTMP URL to a stream, or an HTTP URL to an XML file.

If you set this property through the Component inspector or the Property inspector, the FLV file begins loading and playing at the next enterFrame event. The delay provides time to set the isLive, autoPlay, and cuePoints properties, among others, which affect loading. It also allows ActionScript that is placed on the first frame to affect the FLVPlayback component before it starts playing.

If you set this property through ActionScript, it immediately calls the VideoPlayer.load() method when the autoPlay property is set to false. Alternatively, it calls the VideoPlayer.play() method when the autoPlay property is set to true. The autoPlay, totalTime, and isLive properties affect how the new FLV file is loaded, so if you set these properties, you must set them before setting the source property.

Set the autoPlay property to false to prevent the new FLV file from playing automatically.

Related API Elements

A string that specifies the state of the component. This property is set by the load(), play(), stop(), pause(), and seek() methods.

The possible values for the state property are: buffering, connectionError, disconnected, loading, paused, playing, rewinding, seeking, and stopped. You can use the FLVPlayback class properties to test for these states.

Related API Elements

A Boolean value that is true if the state is responsive. If the state is unresponsive, calls to the play(), load(), stop(), pause(), and seek() methods are queued and executed later, when the state changes to a responsive one. Because these calls are queued and executed later, it is usually not necessary to track the value of the stateResponsive property. The responsive states are: stopped, playing, paused, and buffering.

Related API Elements

A number that is the total playing time for the video in seconds.

When streaming from Flash Media Server (FMS) and using the default NCManager, this value is determined automatically by server-side application programming interfaces (APIs), and that value overrides anything set through this property or gathered from metadata. The property is ready for reading when the stopped or playing state is reached after setting the source property. This property is meaningless for live streams from an FMS.

With an HTTP download, the value is determined automatically if the FLV file has metadata embedded; otherwise, set it explicitly, or it will be NaN. If you set it explicitly, the metadata value in the stream is ignored.

When you set this property, the value takes effect for the next FLV file that is loaded by setting source. It has no effect on an FLV file that has already loaded. Also, this property does not return the new value passed in until an FLV file is loaded.

Playback still works if this property is never set (either explicitly or automatically), but it can cause problems with seek controls.

Unless set explicitly, the value will be NaN until it is set to a valid value from metadata.

Related API Elements

The source width of the loaded FLV file. This property returns -1 if no information is available yet.

Related API Elements

The source width of the loaded FLV file. This property returns -1 if no information is available yet.

Related API Elements

A Boolean value that, if true, makes the VideoPlayer instance visible. If false, it makes the instance invisible.

The default value is true.

A number in the range of 0 to 1 that indicates the volume control setting.

The default value is 1.

Related API Elements

A number that specifies the width of the VideoPlayer instance on the Stage.

Note: The flash.media.Video.width property is similar to the fl.video.VideoPlayer.videoWidth property.

Related API Elements

A number that specifies the horizontal position (in pixels) of the video player.

Setting the x property also affects the registrationX property. When either the x or registrationX property is set, the second property is changed to maintain its offset from the first. For example, if x = 10 and registrationX = 20, setting x = 110 also sets registrationX = 120.

Related API Elements

A number that specifies the vertical position (in pixels) of the video player.

Setting the y property also affects the registrationY property. When either the y or registrationY property is set, the second property is changed to maintain its offset from the first. For example, if y = 10 and registrationY = 20, setting y = 110 also sets registrationY = 120.

Related API Elements

Creates a VideoPlayer object with a specified width and height.

Related API Elements

Forces the video stream and Flash Media Server connection to close. This method triggers the close event. You usually do not need to call this method directly, because the idle timeout functionality takes care of closing the stream.

Related API Elements

Similar to the play() method, but causes the FLV file to load without playing. Autoresizing occurs if appropriate, and the first frame of the FLV file is shown. After initial loading and autolayout, the state is VideoState.PAUSED.

This method takes the same parameters as the play() method, but you cannot call the load() method without a URL. If you do, an error is thrown. If the video player is in an unresponsive state, the load() method queues the request.

Parameters

Related API Elements

Called by INCManager after the connection is complete or failed after a call to the INCManager.connectToURL() method. If the connection failed, set the INCManager.netConnection property to null or undefined before calling.

Related API Elements

Called by INCManager after the reconnection is complete or has failed after a call to the INCManager.reconnect() method. If the connection fails, set the INCManager.netconnection property to null before you call it.

Related API Elements

Pauses video playback. If video is paused or stopped, has no effect. To start playback again, call play(). Takes no parameters.

If player is in an unresponsive state, the pause() method queues the request.

Throws an exception if called when no stream is connected. Use the stateChange event and connected property to determine when it is safe to call this method.

If the player is in a stopped state, a call to the pause() method has no effect and the player remains in a stopped state.

Related API Elements

Causes the video to play. Can be called while the video is paused or stopped, or while the video is already playing. Call this method with no arguments to play an already loaded video or pass in a URL to load a new stream.

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

Throws an exception if called with no arguments at a time when no stream is connected. Use the stateChange event and the connected property to determine when it is safe to call this method.

Parameters

Related API Elements

Plays the FLV file when enough of it has downloaded. If the FLV file has downloaded or you are streaming from Flash Media Server (FMS), then calling the playWhenEnoughDownloaded() method is identical to the play() method with no parameters. Calling this method does not pause playback, so in many cases, you may want to call the pause() method before you call this method.

Seeks to a given time in the file, specified in seconds, with a precision of three decimal places (milliseconds). If a video is playing, the video continues to play from that point. If a video is paused, the video seeks to that point and remains paused. If a video is stopped, the video seeks to that point and enters the paused state. Has no effect with live streams.

The playheadTime property might not have the expected value immediately after you call one of the seek methods or set playheadTime to cause seeking. For a progressive download, you can seek only to a keyframe; therefore, a seek takes you to the time of the first keyframe after the specified time.

Note: When streaming, a seek always goes to the precise specified time even if the source FLV file doesn't have a keyframe there.

Seeking is asynchronous, so if you call a seek method or set the playheadTime property, playheadTime does not update immediately. To obtain the time after the seek is complete, listen for the seek event, which does not start until the playheadTime property is updated.

Throws an exception if called when no stream is connected. Use the stateChange event and the connected property to determine when it is safe to call this method.

Parameters

Related API Elements

Sets the scaleX and scaleY properties simultaneously. Setting the scaleX or scaleY individually triggers two autolayout events whereas calling the setScale() method causes only one autolayout event.

If the scaleMode property is VideoScaleMode.MAINTAIN_ASPECT_RATIO or VideoScaleMode.NO_SCALE, calling this method causes an immediate autolayout event.

Parameters

Related API Elements

Sets the width and height properties simultaneously. Setting the width or height individually triggers two autolayout events whereas calling the setSize() method causes only one autolayout event.

If the scaleMode property is VideoScaleMode.MAINTAIN_ASPECT_RATIO or VideoScaleMode.NO_SCALE then calling this method triggers an immediate autolayout event.

Parameters

Related API Elements

Stops video playback. If autoRewind is set to true, rewinds to first frame. If video is already stopped, has no effect. To start playback again, call play(). Takes no parameters.

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

Throws an exception if called when no stream is connected. Use the stateChange event and connected property to determine when it is safe to call this method.

Related API Elements

Dispatched when the playhead is moved to the start of the video player because the autoRewind property is set to true.

The autoRewound event is of type VideoEvent and has the constant VideoEvent.AUTO_REWOUND.

This event has the following properties:

Related API Elements

Dispatched by the VideoPlayer instance when it closes the NetConnection by timing out or through a call to the close() method, or when you call the load() or play() methods or set the source property and cause the RTMP connection to close as a result. The FLVPlayback instance dispatches this event only when streaming from Flash Media Server (FMS) or other Flash Video Streaming Service (FVSS).

The close event is of type VideoEvent and has the constant VideoEvent.CLOSE.

This event has the following properties:

Related API Elements

Dispatched when playing completes because the player reached the end of the FLV file. The component does not dispatch the event if you call the stop() or pause() methods or click the corresponding controls.

When the application uses progressive download, it does not set the totalTime property explicitly, and it downloads an FLV file that does not specify the duration in the metadata. The video player sets the totalTime property to an approximate total value before it dispatches this event.

The video player also dispatches the stateChange and stopped events.

The complete event is of type VideoEvent and has the constant VideoEvent.COMPLETE.

This event has the following properties:

Related API Elements

Dispatched when a cue point is reached. The event object has an info property that contains the info object received by the NetStream.onCuePoint event callback for FLV file cue points. For ActionScript cue points, it contains the object that was passed into the ActionScript cue point methods or properties.

The cuePoint event is of type MetadataEvent and has the constant MetadataEvent.CUE_POINT.

This event has the following properties:

Related API Elements

drmAuthenticate event

drmError event

drmError event

Dispatched when the video player is resized or laid out. Here are two layout scenarios:

• If the video player is laid out by either using the autoLayout event or calling the setScale() or setSize() methods or changing the width, height, scaleX, and scaleY properties.
• If there are two video players of different sizes and the visibleVideoPlayerIndex property is switched from one video player to another.

The layout event is of type LayoutEvent and has the constant LayoutEvent.LAYOUT.

This event has the following properties:

Related API Elements

Dispatched the first time the FLV file's metadata is reached. The event object has an info property that contains the info object received by the NetStream.onMetaData event callback.

The metadataReceived event is of type MetadataEvent and has the constant MetadataEvent.METADATA_RECEIVED.

This event has the following properties:

Related API Elements

Dispatched while the FLV file is playing at the frequency specified by the playheadUpdateInterval property or when rewinding starts. The component does not dispatch this event when the video player is paused or stopped unless a seek occurs.

The playheadUpdate event is of type VideoEvent and has the constant VideoEvent.PLAYHEAD_UPDATE.

This event has the following properties:

Related API Elements

Indicates progress made in number of bytes downloaded. Dispatched at the frequency specified by the progressInterval property, starting when the load begins and ending when all bytes are loaded or there is a network error. The default is every 0.25 seconds starting when load is called and ending when all bytes are loaded or if there is a network error. Use this event to check bytes loaded or number of bytes in the buffer.

Dispatched only for a progressive HTTP download. Indicates progress in number of downloaded bytes. The event object has the bytesLoaded and bytesTotal properties, which are the same as the FLVPlayback properties of the same names.

The progress event is of type VideoProgressEvent and has the constant VideoProgressEvent.PROGRESS.

This event has the following properties:

Related API Elements

Event dispatched when an FLV file is loaded and ready to display. It starts the first time you enter a responsive state after you load a new FLV file with the play() or load() method. It starts only once for each FLV file that is loaded.

The ready event is of type VideoEvent and has the constant VideoEvent.READY.

This event has the following properties:

Related API Elements

Dispatched when the playback state changes. When an autoRewind call is completed the stateChange event is dispatched with the rewinding state. The stateChange event does not start until rewinding has completed.

This event can be used to track when playback enters or leaves unresponsive states such as in the middle of connecting, resizing, or rewinding. The play(), pause(), stop() and seek() methods queue the requests to be executed when the player enters a responsive state.

The stateChange event is of type VideoEvent and has the constant VideoEvent.STATE_CHANGE.

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 code trace into the FLA file:

FLVPlayback.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.11.

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 code trace into the FLA file:

FLVPlayback.VERSION

The VERSION variable includes the major and minor version numbers as well as the revision and build numbers, for example, 2.0.0.11. 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. Add the FLVPlayback component in the library.
2. Replace testVideoPath with an absolute or relative path to an FLV file.
3. Save this code as VideoPlayerExample.as in the same directory as your FLA file.
4. Set the Document class in the FLA file to VideoPlayerExample.

package
{
    import fl.video.VideoPlayer;
    import flash.display.Sprite;
    import flash.filters.BlurFilter;

    public class VideoPlayerExample extends Sprite 
    {
        private var videoPath:String = "http://www.helpexamples.com/flash/video/sheep.flv"
        private var player:VideoPlayer;
        private var blurryPlayer:VideoPlayer;
        
        public function VideoPlayerExample() {
            player = new VideoPlayer();
            player.play(videoPath);
            player.setScale(0.75, 0.75);
            addChild(player);
            
            blurryPlayer = new VideoPlayer();
            blurryPlayer.play(videoPath);
            blurryPlayer.setScale(0.75,0.75);
            blurryPlayer.filters = [ new BlurFilter(8, 8, 1) ];
            blurryPlayer.x = 250;
            addChild(blurryPlayer);            
        }
    }
}