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.

See also

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.

See also

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.

See also

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.

See also

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.

See also

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.

See also

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.

See also

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.

Player Version: Flash Player 9 Update 3.

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.

See also

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.

See also

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.

See also

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.

See also

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.

See also

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.

See also

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.

See also

A number that is the horizontal scale.

The default value is 1.

See also

A number that is the vertical scale.

The default value is 1.

See also

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.

See also

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. Alternativel