FLVPlayback  - AS3 Flash

A number that specifies which video player instance is affected by other application programming interfaces (APIs). Use this property to manage multiple FLV file streams.

This property does not make the video player visible; use the visibleVideoPlayerIndex property to do that.

A new video player is created the first time activeVideoPlayerIndex is set to a number. When the new video player is created, its properties are set to the value of the default video player (activeVideoPlayerIndex == 0) except for source, totalTime, and isLive, which are always set to the default values (empty string, NaN, and false, respectively), and autoPlay, which is always false (the default is true only for the default video player, 0). The cuePoints property has no effect, as it would have no effect on a subsequent load into the default video player.

APIs that control volume, positioning, dimensions, visibility, and UI controls are always global, and their behavior is not affected by setting activeVideoPlayerIndex. Specifically, setting the activeVideoPlayerIndex property does not affect the following properties and methods:

Note: The visibleVideoPlayerIndex property, not the activeVideoPlayerIndex property, determines which video player the skin controls. Additionaly, APIs that control dimensions do interact with the visibleVideoPlayerIndex property.

The remaining APIs target a specific video player based on the setting of activeVideoPlayerIndex.

To load a second FLV file in the background, set activeVideoPlayerIndex to 1 and call the load() method. When you are ready to show this FLV file and hide the first one, set visibleVideoPlayerIndex to 1.

The default value is 0.

Related API Elements

Specifies the video layout when the scaleMode property is set to VideoScaleMode.MAINTAIN_ASPECT_RATIO or VideoScaleMode.NO_SCALE. The video dimensions are based on the registrationX, registrationY, registrationWidth, and registrationHeight properties. When you set the align property, values come from the VideoAlign class. The default is VideoAlign.CENTER.

Related API Elements

A Boolean value that, if set to true, causes the FLV file to start playing automatically after the source property is set. If it is set to false, the FLV file loads but does not start playing until the play() or playWhenEnoughDownloaded() method is called.

Playback starts immediately when you are streaming an FLV file from Flash Media Server (FMS) and the autoPlay property is set to true. However, when loading an FLV file by progressive download, playback starts only when enough of the FLV file has download so that the FLV file can play from start to finish.

To force playback before enough of the FLV file has downloaded, call the play() method with no parameters. If playback has begun and you want to return to the state of waiting for enough to download and then automatically begin playback, call the pause() method, and then the playWhenEnoughDownloaded() method.

If you set the property to true between the loading of new FLV files, it has no effect until the source property is set.

Setting the autoPlay property to true and then setting the source property to a URL has the same effect as calling the play() method with that URL.

Calling the load() method with a URL has the same effect as setting the source property to that URL with the autoPlay property set to false.

The default value is true.

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.

BackButton playback control. Clicking calls the seekToPrevNavCuePoint() method.

Related API Elements

A number that specifies the bits per second at which to transfer the FLV file.

When streaming from a Flash Video Streaming service that supports native bandwidth detection, you can provide a SMIL file that describes how to switch between multiple streams based on the bandwidth. Depending on your FVSS, bandwidth may automatically be detected, and if this value is set, it is ignored.

When doing HTTP progressive download, you can use the same SMIL format, but you must set the bitrate as there is no automatic detection.

A Boolean value that is true if the video is in a buffering state.

Buffering bar control. This control is displayed when the FLV file is in a loading or buffering state.

If set to true, hides the SeekBar control and disables the Play, Pause, PlayPause, BackButton and ForwardButton controls while the FLV file is in the buffering state. This can be useful to prevent a user from using these controls to try to speed up playing the FLV file when it is downloading or streaming over a slow connection.

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.

The default value is 0.1.

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

An array that describes ActionScript cue points and disabled embedded FLV file cue points. This property is created specifically for use by the Component inspector and Property inspector. It does not work if it is set any other way. Its value has an effect only on the first FLV file loaded and only if it is loaded by setting the source property in the Component inspector or the Property inspector.

Note: This property is not accessible in ActionScript. To access cue point information in ActionScript, use the metadata property.

To add, remove, enable or disable cue points with ActionScript, use the addASCuePoint(), removeASCuePoint(), or setFLVCuePointEnabled() methods.

Related API Elements

Returns the next available tabIndex value after the FLVPlayback controls. The value is set after the assignTabIndexes method is called.

Related API Elements

Forward button control. Clicking calls the seekToNextNavCuePoint() method.

Related API Elements

Background color used when in full-screen takeover mode. This color is visible if the video does not cover the entire screen based on the scaleMode property value.

The default value is 0x000000.

FullScreen button control.

Specifies the delay time in milliseconds to hide the skin. When in full-screen takeover mode, if the skinAutoHide property is true, autohiding is triggered when the user doesn't move the mouse for more than the seconds indicated by the fullScreenSkinDelay property. If the mouse is over the skin itself, autohiding is not triggered.

The default value is 3000 milliseconds (3 seconds).

When the stage enters full-screen mode, the FLVPlayback component is on top of all content and takes over the entire screen. When the stage exits full-screen mode, the screen returns to how it was before.

The recommended settings for full-screen takeover mode are scaleMode = VideoScaleMode.MAINTAIN_ASPECT_RATIO and align = VideoAlign.CENTER.

If the SWF file with the FLVPlayback component is loaded and does not have access to the stage because of security restrictions, full-screen takeover mode does not function. No errors are thrown.

The default value is true.

A number that specifies the height of the FLVPlayback instance. This property affects only the height of the FLVPlayback instance and does not include the height of a skin SWF file that might be loaded. Setting the height property also sets the registrationHeight property to the same value.

Related API Elements

The amount of time, in milliseconds, before Flash terminates an idle connection to Flash Media Server (FMS) 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.

The default value is 300,000 milliseconds (5 minutes).

Related API Elements

A Boolean value that is true if the video stream is live. This property is effective only when streaming from Flash Media Server (FMS) or other Flash Video Streaming Service (FVSS). The value of this property is ignored for an HTTP download.

If you set this property between loading new FLV files, it has no effect until the source property is set for the new FLV file.

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.

Learn more

Related API Elements

A Boolean value that is true if a metadata packet has been encountered and processed or if the FLV file was encoded without the metadata packet. In other words, the value is true if the metadata is received, or if you are never going to get any metadata. So, you know whether you have the metadata; and if you don't have the metadata, you know not to wait around for it. If you just want to know whether or not you have metadata, you can check the value with:

FLVPlayback.metadata != null

Use this property to check whether you can retrieve useful information with the methods for finding and enabling or disabling cue points (findCuePoint, findNearestCuePoint, findNextCuePointWithName, isFLVCuePointEnabled).

Related API Elements

Mute button control.

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

Pause button control.

A Boolean value that is true if the FLV file is in a paused state.

Play button control.

A number that specifies the current playheadTime as a percentage of the totalTime property. If you access this property, it contains the percentage of playing time that has elapsed. If you set this property, it causes a seek operation to the point representing that percentage of the FLV file's playing time.

The value of this property is relative to the value of the totalTime property.

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 occurs 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 you call one of the seek methods or set 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 Boolean value that is true if the FLV file is in the playing state.

Play/pause button control.

A number that specifies the height of the source FLV file. This information is not valid immediately upon calling the play() or load() methods. It is valid when the ready event starts. If the value of the scaleMode property is VideoScaleMode.MAINTAIN_ASPECT_RATIO or VideoScaleMode.NO_SCALE, it is best to read the value after the layout event is dispatched. This property returns -1 if no information is available yet.

Related API Elements

Gives the width of the source FLV file. This information is not valid immediately when the play() or load() methods are called; it is valid after the ready event is dispatched. If the value of the scaleMode property is VideoScaleMode.MAINTAIN_ASPECT_RATIO or VideoScaleMode.NO_SCALE, it is best to read the value after the layout event is dispatched. This property returns -1 if no information is available yet.

Related API Elements

Only for live preview. Reads in a PNG file for the preview.

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 default value is 250.

Related API Elements

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.

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.

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.

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.

Specifies how the video will resize 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 standard scale is 1.

Related API Elements

A number that is the vertical scale. The standard scale is 1.

Related API Elements

A Boolean value that is true if the user is scrubbing with the SeekBar and false otherwise.

Scrubbing refers to grabbing the handle of the SeekBar and dragging it in either direction to locate a particular scene in the FLV file.

The SeekBar control.

A number that specifies, in milliseconds, how often to check the SeekBar handle when scrubbing.

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

The default value is 250.

A number that specifies how far a user can move the SeekBar handle before an update occurs. The value is specified as a percentage, ranging from 1 to 100.

The default value is 5.

The number of seconds that the seekToPrevNavCuePoint() method uses when it compares its time against the previous cue point. The method uses this value to ensure that, if you are just ahead of a cue point, you can hop over it to the previous one and avoid going to the same cue point that just occurred.

The default value is 1.

A string that specifies the URL to a skin SWF file. This string could contain a file name, a relative path such as Skins/MySkin.swf, or an absolute URL such as http://www.%somedomain%.com/MySkin.swf.

A Boolean value that, if true, hides the component skin when the mouse is not over the video. This property affects only skins that are loaded by setting the skin property and not a skin that you create from the FLVPlayback Custom UI components.

When the component is in full-screen takeover mode and the skin is one that does not lay over the video, then skinAutoHide mode is turned on automatically. Setting skinAutoHide = false after you enter full-screen mode overrides this behavior. Also when the component is in full-screen takeover mode, autohiding is triggered if the user doesn't move the mouse for more than fullScreenSkinDelay seconds, unless the mouse is over the skin itself.

The default value is false.

The alpha for the background of the skin. The skinBackgroundAlpha property works only with SWF files that have skins loaded by using the skin property and with skins that support setting the color and alpha. You can set the skinBackgroundAlpha property to a number between 0.0 and 1.0. The default is the last value chosen by the user as the default.

To get the skin colors that come with the ActionScript 2.0 FLVPlayback component, use the following values for the skinBackgroundAlpha and skinBackgroundColor properties: Arctic - 0.85, 0x47ABCB; Clear - 0.20, 0xFFFFFF; Mojave - 0.85, 0xBFBD9F; Steel - 0.85, 0x666666. The default is .85.

Related API Elements

The color for the background of the skin (0xRRGGBB). The skinBackgroundColor property works only with SWF files that have skins loaded by using the skin property and with skins that support setting the color and alpha. The default is the last value chosen by the user as the default.

To get the skin colors that come with the ActionScript 2.0 FLVPlayback component, use the following values for the skinBackgroundAlpha and skinBackgroundColor properties: Arctic - 0.85, 0x47ABCB; Clear - 0.20, 0xFFFFFF; Mojave - 0.85, 0xBFBD9F; Steel - 0.85, 0x666666. The default is 0x47ABCB.

Related API Elements

The amount of time in milliseconds that it takes for the skin to fade in or fade out when hiding or showing. Hiding and showing occurs because the skinAutoHide property is set to true. Set the skinFadeTime property to 0 to eliminate the fade effect.

The default value is 500 milliseconds (.5 seconds).

This property specifies the largest multiple that FLVPlayback will use to scale up its skin when it enters full screen mode with a Flash Player that supports hardware acceleration. With hardware acceleration, the video and the skin are scaled by the same factor. By default, FLVPlayback renders the video at its native dimensions and allows hardware acceleration to do the rest of the scaling. If, for example, your video has dimensions of 640 x 512 and it goes to full screen size on a monitor with a resolution of 1280 x 1024, the video and the skin will be scaled up to twice their size.

This property enables you to restrict scaling of the skin when hardware acceleration is used, based on the specific content that is being scaled and your aesthetic tastes regarding the appearance of large skins. To limit scaling of the skin to the specified multiplier, FLVPlayback uses a mix of software and hardware scaling for the skin, which can have a negative impact on the performance of video playback and the appearance of the FLV.

For example, if this property was set to 5.0 or greater, going to full screen on a monitor that has a resolution of 1600 x 1200 with a video that has dimensions of 320 x 240 would scale the skin five times. If this property was set to 2.5, the player would render the video (but not the skin) at 640 x 480, twice it's original size, and hardware acceleration would do the remainder of the scaling (640 x 2.5 = 1600 and 480 x 2.5 = 1200).

Setting this property after full screen mode has already been entered has no effect until the next time FLVPlayback enters full screen mode.

If the FLV is large (for example, 640 pixels wide or more, 480 pixels tall or more) you should not set this property to a small value because it could cause noticeable performance problems on large monitors.

The default value is 4.0.

Related API Elements

// Requires FLVPlayback component in library
// Requires SkinOverPlayFullscreen.swf to be in the same folder as the .fla file.
  
import fl.video.FLVPlayback;

var myFLVPlybk:FLVPlayback = new FLVPlayback();

addChild(myFLVPlybk);
myFLVPlybk.skin = "SkinOverPlayFullscreen.swf";
myFLVPlybk.skinScaleMaximum = 2.5;
myFLVPlybk.source = "http://helpexamples.com/flash/video/water.flv";

Provides direct access to the VideoPlayer.soundTransform property to expose more sound control. You need to set this property for changes to take effect, or you can get the value of this property to get a copy of 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 or 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

Returns the first tabIndex value for the FLVPlayback controls. The value is set after the assignTabIndexes method is called.

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

The Stop button control.

A Boolean value that is true if the state of the FLVPlayback instance is stopped.

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 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 a 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 the source property. 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

A number that you can use to manage multiple FLV file streams. Sets which video player instance is visible, audible, and controlled by the skin or playback controls, while the rest of the video players are hidden and muted. It does not make the video player the target for most APIs; use the activeVideoPlayerIndex property to do that.

Methods and properties that control dimensions interact with this property. The methods and properties that set the dimensions of the video player (setScale(), setSize(), width, height, scaleX, scaleY) can be used for all video players. However, depending on the value of the scaleMode property on those video players, they might have different dimensions. Reading the dimensions using the width, height, scaleX, and scaleY properties gives you the dimensions only of the visible video player. Other video players might have the same dimensions or might not.

To get the dimensions of various video players when they are not visible, listen for the layout event, and store the size value.

This property does not have any implications for visibility of the component as a whole, only which video player is visible when the component is visible. To set visibility for the entire component, use the visible property.

The default value is 0.

Related API Elements

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

The default value is 1.

Related API Elements

The volume bar control.

A number that specifies, in milliseconds, how often to check the volume bar handle location when scrubbing.

The default value is 250.

A number that specifies how far a user can move the volume bar handle before an update occurs. The value is expressed as a percentage from 1 to 100. Set to 0 to indicate no scrub tolerance. Always update the volume on the volumeBarInterval property regardless of how far the user moved the handle.

The default value is 0.

A number that specifies the width of the FLVPlayback instance on the Stage. This property affects only the width of the FLVPlayback instance and does not include the width of a skin SWF file that might be loaded. Use the FLVPlayback width property and not the DisplayObject.width property because the width property might give a different value if a skin SWF file is loaded. Setting the width property also sets the registrationWidth property to the same value.

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.

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.

Creates a new FLVPlayback instance. After creating the FLVPlayback instance, call the addChild() or addChildAt() method to place the instance on the Stage or another display object container.

Related API Elements

Adds an ActionScript cue point and has the same effect as adding an ActionScript cue point using the Cue Points dialog box, except that it occurs when an application executes rather than during application development.

Cue point information is wiped out when the source property is set. To set cue point information for the next FLV file to be loaded, set the source property first.

It is valid to add multiple ActionScript cue points with the same name and time. When you remove ActionScript cue points with the removeASCuePoint() method, all cue points with the same name and time are removed.

Parameters

Related API Elements

Assigns a tabIndex value to each of the FLVPlayback controls by sorting them by position horizontally left to right. This method returns the next available tabIndex value.

If you call assignTabIndexes with NaN as the startTabbing parameter and the FLVPlayback component instance has a tabIndex value assigned to it, the method will use the FLVPlayback component instance's assigned tabIndex as the startTabIndex.

When an FLVPlayback skin is specified, you should wait a frame after the FLVPlayback.SKIN_LOADED event to allow the skin controls to initialize before calling this method.

When using custom controls, wait a frame after the FLVPlayback.READY event to allow the custom controls to initialize befor calling this method.

Parameters

Related API Elements

Brings a video player to the front of the stack of video players. Useful for custom transitions between video players. The default stack order is the same as it is for the activeVideoPlayerIndex property: 0 is on the bottom, 1 is above it, 2 is above 1, and so on. However, when you call the bringVideoPlayerToFront() method this order may change. For example, 2 may be the bottom.

Parameters

Related API Elements

Closes NetStream and deletes the video player specified by the index parameter. If the closed video player is the active or visible video player, the FLVPlayback instance sets the active and or visible video player to the default player (with index 0). You cannot close the default player, and trying to do so causes the component to throw an error.

Parameters

Related API Elements

Sets the FLVPlayback video player to full screen. Calling this method has the same effect as clicking the full screen toggle button that's built into some FLVPlayback skins and is also available as the FullScreenButton in the Video section of the Components panel.

This method supports hardware acceleration in Flash Player for full screen video. If the user's version of Flash Player does not support hardware acceleration, this method still works and full screen video will work the same as it does without hardware acceleration support.

Because a call to this method sets the displayState property of the Stage class to StageDisplayState.FULL_SCREEN, it has the same restrictions as the displayState property. If, instead of calling this method, you implement full screen mode by directly setting the stage.displayState property to StageDisplayState.FULL_SCREEN, hardware acceleration is not used.

Full screen support occurs only if the fullScreenTakeOver property is set to true, which it is by default.

Related API Elements

// Requires Button and FLVPlayback components in library.
 
import fl.video.FLVPlayback;
import fl.controls.Button;
var myButton:Button = new Button();
var myFLVPlybk:FLVPlayback = new FLVPlayback();
myButton.move(100, 240);
myButton.label = "Full Screen";
addChild(myButton);
addChild(myFLVPlybk);
 
myFLVPlybk.source = "http://helpexamples.com/flash/video/water.flv";
myButton.addEventListener(MouseEvent.CLICK, handleClick);
function handleClick(e:MouseEvent):void {
    myFLVPlybk.enterFullScreenDisplayState();
}

Finds the cue point of the type specified by the type parameter and having the time, name, or combination of time and name that you specify through the parameters.

If you do not provide a value for either the time or name of the cue point, or if the time is null, undefined, or less than zero and the name is null or undefined, the method throws VideoError error 1002.

The method includes disabled cue points in the search. Use the isFLVCuePointEnabled() method to determine whether a cue point is disabled.

Parameters

Related API Elements

Finds a cue point of the specified type that matches or is earlier than the time that you specify. If you specify both a time and a name and no earlier cue point matches that name, it finds a cue point that matches the name that you specify. Otherwise, it returns null. Default is to search all cue points.

The method includes disabled cue points in the search. Use the isFLVCuePointEnabled() method to determine whether a cue point is disabled.

Parameters