| Package | fl.video |
| Class | public class FLVPlayback |
| Inheritance | FLVPlayback Sprite DisplayObjectContainer InteractiveObject DisplayObject EventDispatcher Object |
| Language Version : | ActionScript 3.0 |
| Runtime Versions : | AIR 1.0, Flash Player 9.0.28.0 |
The FLVPlayback class allows you to include a video player in your application to play progressively downloaded video (FLV) files over HTTP, or play streaming FLV files from Flash Media Server (FMS) or other Flash Video Streaming Service (FVSS).
Unlike other ActionScript 3.0 components, the FLVPlayback component does not extend UIComponent; therefore, it does not support the methods and properties of that class.
To access the properties, methods, and events of the FLVPlayback class, you must import the
class to your application either by dragging the FLVPlayback component to the Stage in your Flash
application, or by explicitly importing it in ActionScript using the import statement.
The following statement imports the FLVPlayback class:
import fl.video.FLVPlayback;The FLVPlayback class has a VERSION constant, which is a class property. Class properties are
available only on the class itself. The VERSION constant returns a string that indicates the
version of the component. The following code shows the version in the Output panel:
import fl.video.FLVPlayback;
trace(FLVPlayback.VERSION);See also
| Property | Defined By | ||
|---|---|---|---|
![]() | accessibilityProperties : AccessibilityProperties
The current accessibility options for this display object. | DisplayObject | |
| activeVideoPlayerIndex : uint
A number that specifies which video player instance is affected by other application
programming interfaces (APIs). | FLVPlayback | ||
| align : String
Specifies the video layout when the scaleMode property is set to
VideoScaleMode.MAINTAIN_ASPECT_RATIO or VideoScaleMode.NO_SCALE. | FLVPlayback | ||
![]() | alpha : Number
Indicates the alpha transparency value of the object specified. | DisplayObject | |
| autoPlay : Boolean
A Boolean value that, if set to true, causes the FLV file to start
playing automatically after the source property is set. | FLVPlayback | ||
| autoRewind : Boolean
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. | FLVPlayback | ||
| backButton : Sprite
BackButton playback control. | FLVPlayback | ||
| bitrate : Number
A number that specifies the bits per second at which to transfer the FLV file. | FLVPlayback | ||
![]() | blendMode : String
A value from the BlendMode class that specifies which blend mode to use. | DisplayObject | |
| buffering : Boolean [read-only]
A Boolean value that is true if the video is in a buffering state. | FLVPlayback | ||
| bufferingBar : Sprite
Buffering bar control. | FLVPlayback | ||
| bufferingBarHidesAndDisablesOthers : Boolean
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. | FLVPlayback | ||
| bufferTime : Number
A number that specifies the number of seconds to buffer in memory before
beginning to play a video stream. | FLVPlayback | ||
![]() | buttonMode : Boolean
Specifies the button mode of this sprite. | Sprite | |
| bytesLoaded : uint [read-only]
A number that indicates the extent of downloading, in number of bytes, for an
HTTP download. | FLVPlayback | ||
| bytesTotal : uint [read-only]
A number that specifies the total number of bytes downloaded for an HTTP download. | FLVPlayback | ||
![]() | cacheAsBitmap : Boolean
If set to true, Flash Player or Adobe AIR caches an internal bitmap representation of the
display object. | DisplayObject | |
![]() | constructor : Object
A reference to the class object or constructor function for a given object instance. | Object | |
![]() | contextMenu : NativeMenu
Specifies the context menu associated with this object. | InteractiveObject | |
| cuePoints : Array [write-only]
An array that describes ActionScript cue points and disabled embedded
FLV file cue points. | FLVPlayback | ||
![]() | doubleClickEnabled : Boolean
Specifies whether the object receives doubleClick events. | InteractiveObject | |
![]() | dropTarget : DisplayObject [read-only]
Specifies the display object over which the sprite is being dragged, or on
which the sprite was dropped. | Sprite | |
![]() | filters : Array
An indexed array that contains each filter object currently associated with the display object. | DisplayObject | |
![]() | focusRect : Object
Specifies whether this object displays a focus rectangle. | InteractiveObject | |
| forwardButton : Sprite
Forward button control. | FLVPlayback | ||
| fullScreenBackgroundColor : uint
Background color used when in full-screen takeover
mode. | FLVPlayback | ||
| fullScreenButton : Sprite
FullScreen button control. | FLVPlayback | ||
| fullScreenSkinDelay : int
Specifies the delay time in milliseconds to hide the skin. | FLVPlayback | ||
| fullScreenTakeOver : Boolean
When the stage enters full-screen mode, the
FLVPlayback component is on top of all
content and takes over the entire screen. | FLVPlayback | ||
![]() | graphics : Graphics [read-only]
Specifies the Graphics object that belongs to this sprite where vector
drawing commands can occur. | Sprite | |
| height : Number
A number that specifies the height of the FLVPlayback instance. | FLVPlayback | ||
![]() | hitArea : Sprite
Designates another sprite to serve as the hit area for a sprite. | Sprite | |
| idleTimeout : Number
The amount of time, in milliseconds, before Flash terminates an idle connection
to Flash Media Server (FMS) because playing paused or stopped. | FLVPlayback | ||
| isLive : Boolean
A Boolean value that is true if the video stream is live. | FLVPlayback | ||
| isRTMP : Boolean [read-only]
A Boolean value that is true if the FLV file is streaming from
Flash Media Server (FMS) using RTMP. | FLVPlayback | ||
![]() | loaderInfo : LoaderInfo [read-only]
Returns a LoaderInfo object containing information about loading the file
to which this display object belongs. | DisplayObject | |
![]() | mask : DisplayObject
The calling display object is masked by the specified mask object. | DisplayObject | |
| metadata : Object [read-only]
An object that is a metadata information packet that is received from a call to
the NetSteam.onMetaData() callback method, if available. | FLVPlayback | ||
| metadataLoaded : Boolean [read-only]
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. | FLVPlayback | ||
![]() | mouseChildren : Boolean
Determines whether or not the children of the object are mouse enabled. | DisplayObjectContainer | |
![]() | mouseEnabled : Boolean
Specifies whether this object receives mouse messages. | InteractiveObject | |
![]() | mouseX : Number [read-only]
Indicates the x coordinate of the mouse position, in pixels. | DisplayObject | |
![]() | mouseY : Number [read-only]
Indicates the y coordinate of the mouse position, in pixels. | DisplayObject | |
| muteButton : Sprite
Mute button control. | FLVPlayback | ||
![]() | name : String
Indicates the instance name of the DisplayObject. | DisplayObject | |
| ncMgr : INCManager [read-only]
An INCManager object that provides access to an instance of the class implementing
INCManager, which is an interface to the NCManager class. | FLVPlayback | ||
![]() | numChildren : int [read-only]
Returns the number of children of this object. | DisplayObjectContainer | |
![]() | opaqueBackground : Object
Specifies whether the display object is opaque with a certain background color. | DisplayObject | |
![]() | parent : DisplayObjectContainer [read-only]
Indicates the DisplayObjectContainer object that contains this display object. | DisplayObject | |
| pauseButton : Sprite
Pause button control. | FLVPlayback | ||
| paused : Boolean [read-only]
A Boolean value that is true if the FLV file is in a paused state. | FLVPlayback | ||
| playButton : Sprite
Play button control. | FLVPlayback | ||
| playheadPercentage : Number
A number that specifies the current playheadTime as a percentage of the
totalTime property. | FLVPlayback | ||
| playheadTime : Number
A number that is the current playhead time or position, measured in seconds,
which can be a fractional value. | FLVPlayback | ||
| playheadUpdateInterval : Number
A number that is the amount of time, in milliseconds, between each
playheadUpdate event. | FLVPlayback | ||
| playing : Boolean [read-only]
A Boolean value that is true if the FLV file is in the playing state. | FLVPlayback | ||
| playPauseButton : Sprite
Play/pause button control. | FLVPlayback | ||
| preferredHeight : int [read-only]
A number that specifies the height of the source FLV file. | FLVPlayback | ||
| preferredWidth : int [read-only]
Gives the width of the source FLV file. | FLVPlayback | ||
| preview : String [write-only]
Only for live preview. | FLVPlayback | ||
| progressInterval : Number
A number that is the amount of time, in milliseconds, between each progress
event. | FLVPlayback | ||
![]() | prototype : Object [static]
A reference to the prototype object of a class or function object. | Object | |
| registrationHeight : Number
The height used to align the video content when autoresizing. | FLVPlayback | ||
| registrationWidth : Number
The width used to align the video content when autoresizing. | FLVPlayback | ||
| registrationX : Number
The x coordinate used to align the video content when
autoresizing. | FLVPlayback | ||
| registrationY : Number
The y coordinate used to align the video content when
autoresizing. | FLVPlayback | ||
![]() | root : DisplayObject [read-only]
For a display object in a loaded SWF file, the root property is the
top-most display object in the portion of the display list's tree structure represented by that SWF file. | DisplayObject | |
![]() | rotation : Number
Indicates the rotation of the DisplayObject instance, in degrees, from its original orientation. | DisplayObject | |
![]() | scale9Grid : Rectangle
The current scaling grid that is in effect. | DisplayObject | |
| scaleMode : String
Specifies how the video will resize after loading. | FLVPlayback | ||
| scaleX : Number
A number that is the horizontal scale. | FLVPlayback | ||
| scaleY : Number
A number that is the vertical scale. | FLVPlayback | ||
![]() | scrollRect : Rectangle
The scroll rectangle bounds of the display object. | DisplayObject | |
| scrubbing : Boolean [read-only]
A Boolean value that is true if the user is scrubbing with the SeekBar
and false otherwise. | FLVPlayback | ||
| seekBar : Sprite
The SeekBar control. | FLVPlayback | ||
| seekBarInterval : Number
A number that specifies, in milliseconds, how often to check the SeekBar handle
when scrubbing. | FLVPlayback | ||
| seekBarScrubTolerance : Number
A number that specifies how far a user can move the SeekBar handle before an
update occurs. | FLVPlayback | ||
| seekToPrevOffset : Number
The number of seconds that the seekToPrevNavCuePoint() method uses
when it compares its time against the previous cue point. | FLVPlayback | ||
| skin : String
A string that specifies the URL to a skin SWF file. | FLVPlayback | ||
| skinAutoHide : Boolean
A Boolean value that, if true, hides the component skin when the mouse
is not over the video. | FLVPlayback | ||
| skinBackgroundAlpha : Number
The alpha for the background of the skin. | FLVPlayback | ||
| skinBackgroundColor : uint
The color for the background of the skin (0xRRGGBB). | FLVPlayback | ||
| skinFadeTime : int
The amount of time in milliseconds that it takes for the skin to fade in or fade out when
hiding or showing. | FLVPlayback | ||
| skinScaleMaximum : Number
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. | FLVPlayback | ||
| soundTransform : SoundTransform
Provides direct access to the
VideoPlayer.soundTransform property to expose
more sound control. | FLVPlayback | ||
| source : String
A string that specifies the URL of the FLV file to stream and how to stream it. | FLVPlayback | ||
![]() | stage : Stage [read-only]
The Stage of the display object. | DisplayObject | |
| state : String [read-only]
A string that specifies the state of the component. | FLVPlayback | ||
| stateResponsive : Boolean [read-only]
A Boolean value that is true if the state is responsive. | FLVPlayback | ||
| stopButton : Sprite
The Stop button control. | FLVPlayback | ||
| stopped : Boolean [read-only]
A Boolean value that is true if the state of the FLVPlayback instance is stopped. | FLVPlayback | ||
![]() | tabChildren : Boolean
Determines whether the children of the object are tab enabled. | DisplayObjectContainer | |
![]() | tabEnabled : Boolean
Specifies whether this object is in the tab order. | InteractiveObject | |
![]() | tabIndex : int
Specifies the tab ordering of objects in a SWF file. | InteractiveObject | |
![]() | textSnapshot : TextSnapshot [read-only]
Returns a TextSnapshot object for this DisplayObjectContainer instance. | DisplayObjectContainer | |
| totalTime : Number
A number that is the total playing time for the video in seconds. | FLVPlayback | ||
![]() | transform : Transform
An object with properties pertaining to a display object's matrix, color transform, and pixel bounds. | DisplayObject | |
![]() | useHandCursor : Boolean
A Boolean value that indicates whether the pointing hand (hand cursor) appears when the mouse rolls
over a sprite in which the buttonMode property is set to true. | Sprite | |
![]() | visible : Boolean
Whether or not the display object is visible. | DisplayObject | |
| visibleVideoPlayerIndex : uint
A number that you can use to manage multiple FLV file streams. | FLVPlayback | ||
| volume : Number
A number in the range of 0 to 1 that indicates the volume control setting. | FLVPlayback | ||
| volumeBar : Sprite
The volume bar control. | FLVPlayback | ||
| volumeBarInterval : Number
A number that specifies, in milliseconds, how often
to check the volume bar handle location when scrubbing. | FLVPlayback | ||
| volumeBarScrubTolerance : Number
A number that specifies how far a user can move the volume bar handle before
an update occurs. | FLVPlayback | ||
| width : Number
A number that specifies the width of the FLVPlayback instance on the Stage. | FLVPlayback | ||
| x : Number
A number that specifies the horizontal position (in pixels) of the video player. | FLVPlayback | ||
| y : Number
A number that specifies the vertical position (in pixels) of the video player. | FLVPlayback | ||
| Method | Defined By | ||
|---|---|---|---|
Creates a new FLVPlayback instance. | FLVPlayback | ||
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. | FLVPlayback | ||
![]() |
Adds a child DisplayObject instance to this DisplayObjectContainer instance. | DisplayObjectContainer | |
![]() |
Adds a child DisplayObject instance to this DisplayObjectContainer
instance. | DisplayObjectContainer | |
![]() | addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
Registers an event listener object with an EventDispatcher object so that the listener
receives notification of an event. | EventDispatcher | |
![]() |
Indicates whether the security restrictions
would cause any display objects to be omitted from the list returned by calling
the DisplayObjectContainer.getObjectsUnderPoint() method
with the specified point point. | DisplayObjectContainer | |
Brings a video player to the front of the stack of video players. | FLVPlayback | ||
Closes NetStream and deletes the video player specified by the index
parameter. | FLVPlayback | ||
![]() |
Determines whether the specified display object is a child of the DisplayObjectContainer instance or
the instance itself. | DisplayObjectContainer | |
![]() |
Dispatches an event into the event flow. | EventDispatcher | |
Sets the FLVPlayback video player to full screen. | FLVPlayback | ||
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. | FLVPlayback | ||
Finds a cue point of the specified type that matches or is
earlier than the time that you specify. | FLVPlayback | ||
Finds the next cue point in my_cuePoint.array that has the same name as
my_cuePoint.name. | FLVPlayback | ||
![]() |
Returns a rectangle that defines the area of the display object relative to the coordinate system
of the targetCoordinateSpace object. | DisplayObject | |
![]() |
Returns the child display object instance that exists at the specified index. | DisplayObjectContainer | |
![]() |
Returns the child display object that exists with the specified name. | DisplayObjectContainer | |
![]() |
Returns the index position of a child DisplayObject instance. | DisplayObjectContainer | |
![]() |
Returns an array of objects that lie under the specified point and are children
(or grandchildren, and so on) of this DisplayObjectContainer instance. | DisplayObjectContainer | |
![]() |
Returns a rectangle that defines the boundary of the display object,
based on the coordinate system defined by the targetCoordinateSpace
parameter, excluding any strokes on shapes. | DisplayObject | |
Gets the video player specified by the index parameter. | FLVPlayback | ||
![]() |
Converts the point object from the Stage (global) coordinates
to the display object's (local) coordinates. | DisplayObject | |
![]() |
Checks whether the EventDispatcher object has any listeners registered for a specific type
of event. | EventDispatcher | |
![]() |
Indicates whether an object has a specified property defined. | Object | |
![]() |
Evaluates the display object to see if it overlaps or intersects with the
obj display object. | DisplayObject | |
![]() |
Evaluates the display object to see if it overlaps or intersects with the
point specified by the x and y parameters. | DisplayObject | |
Returns false if the FLV file embedded cue point is disabled. | FLVPlayback | ||
![]() |
Indicates whether an instance of the Object class is in the prototype chain of the object specified
as the parameter. | Object | |
Begins loading the FLV file and provides a shortcut for setting the
autoPlay property to false and setting the
source, totalTime, and isLive
properties, if given. | FLVPlayback | ||
![]() |
Converts the point object from the display object's (local) coordinates to the
Stage (global) coordinates. | DisplayObject | |
Pauses playing the video stream. | FLVPlayback | ||
Plays the video stream. | FLVPlayback | ||
Plays the FLV file when enough of it has downloaded. | FLVPlayback | ||
![]() |
Indicates whether the specified property exists and is enumerable. | Object | |
Removes an ActionScript cue point from the currently loaded FLV file. | FLVPlayback | ||
![]() |
Removes the specified child DisplayObject instance from the child list of the DisplayObjectContainer instance. | DisplayObjectContainer | |
![]() |
Removes a child DisplayObject from the specified index position in the child list of
the DisplayObjectContainer. | DisplayObjectContainer | |
![]() |
Removes a listener from the EventDispatcher object. | EventDispatcher | |
Seeks to a given time in the file, specified in seconds,
with a precision of three decimal places (milliseconds). | FLVPlayback | ||
Seeks to a percentage of the file and places the playhead there. | FLVPlayback | ||
Seeks to a given time in the file, specified in seconds, with a precision up to
three decimal places (milliseconds). | FLVPlayback | ||
Seeks to a navigation cue point that matches the specified time, name, or
time and name. | FLVPlayback | ||
Seeks to the next navigation cue point, based on the current value of the
playheadTime property. | FLVPlayback | ||
Seeks to the previous navigation cue point, based on the current
value of the playheadTime property. | FLVPlayback | ||
![]() |
Changes the position of an existing child in the display object container. | DisplayObjectContainer | |
Enables or disables one or more FLV file cue points. | FLVPlayback | ||
![]() |
Sets the availability of a dynamic property for loop operations. | Object | |
Sets the scaleX and scaleY properties simultaneously. | FLVPlayback | ||
Sets width and height simultaneously. | FLVPlayback | ||
![]() |
Lets the user drag the specified sprite. | Sprite | |
Stops the video from playing. | FLVPlayback | ||
![]() |
Ends the startDrag() method. | Sprite | |
![]() |
Swaps the z-order (front-to-back order) of the two specified child objects. | DisplayObjectContainer | |
![]() |
Swaps the z-order (front-to-back order) of the child objects at the two specified index positions in the
child list. | DisplayObjectContainer | |
![]() |
Returns the string representation of the specified object. | Object | |
![]() |
Returns the primitive value of the specified object. | Object | |
![]() |
Checks whether an event listener is registered with this EventDispatcher object or any of
its ancestors for the specified event type. | EventDispatcher | |
| Event | Summary | Defined By | ||
|---|---|---|---|---|
![]() | Dispatched when Flash Player or an AIR application gains operating system focus and becomes active. | EventDispatcher | ||
![]() | Dispatched when a display object is added to the display list. | DisplayObject | ||
![]() | Dispatched when a display object is added to the on stage display list, either directly or through the addition of a sub tree in which the display object is contained. | DisplayObject | ||
| Dispatched when the video player is resized or laid out automatically. | FLVPlayback | |||
| Dispatched when the playhead is moved to the start of the video player because the autoRewind property is set to true. | FLVPlayback | |||
| Dispatched when the FLVPlayback instance enters the buffering state. | FLVPlayback | |||
![]() | Dispatched when a user presses and releases the main button of the user's pointing device over the same InteractiveObject. | InteractiveObject | ||
| Dispatched when the event object closes the NetConnection, by timing out or through a call to the closeVideoPlayer() 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. | FLVPlayback | |||
| Dispatched when playing completes because the player reached the end of the FLV file. | FLVPlayback | |||
![]() | Dispatched when the user selects the context menu associated with this interactive object in an AIR application. | InteractiveObject | ||
| Dispatched when a cue point is reached. | FLVPlayback | |||
![]() | Dispatched when Flash Player or an AIR application loses operating system focus and is becoming inactive. | EventDispatcher | ||
![]() | Dispatched when a user presses and releases the main button of a pointing device twice in rapid succession over the same InteractiveObject when that object's doubleClickEnabled flag is set to true. | InteractiveObject | ||
![]() | Dispatched when the playhead is entering a new frame. | DisplayObject | ||
| Dispatched when the location of the playhead moves forward by a call to the seek() method or by clicking the ForwardButton control. | FLVPlayback | |||
![]() | Dispatched after a display object gains focus. | InteractiveObject | ||
![]() | Dispatched after a display object loses focus. | InteractiveObject | ||
![]() | Dispatched when the user presses a key. | InteractiveObject | ||
![]() | Dispatched when the user attempts to change focus by using keyboard navigation. | InteractiveObject | ||
![]() | Dispatched when the user releases a key. | InteractiveObject | ||
| Dispatched when the video player is resized or laid out. | FLVPlayback | |||
| Dispatched the first time the FLV file's metadata is reached. | FLVPlayback | |||
![]() | Dispatched when a user presses and releases the middle button of the user's pointing device over the same InteractiveObject. | InteractiveObject | ||
![]() | Dispatched when a user presses the middle pointing device button over an InteractiveObject instance. | InteractiveObject | ||
![]() | Dispatched when a user releases the pointing device button over an InteractiveObject instance. | InteractiveObject | ||
![]() | Dispatched when a user presses the pointing device button over an InteractiveObject instance. | InteractiveObject | ||
![]() | Dispatched when the user attempts to change focus by using a pointer device. | InteractiveObject | ||
![]() | Dispatched when a user moves the pointing device while it is over an InteractiveObject. | InteractiveObject | ||
![]() | Dispatched when the user moves a pointing device away from an InteractiveObject instance. | InteractiveObject | ||
![]() | Dispatched when the user moves a pointing device over an InteractiveObject instance. | InteractiveObject | ||
![]() | Dispatched when a user releases the pointing device button over an InteractiveObject instance. | InteractiveObject | ||
![]() | Dispatched when a mouse wheel is spun over an InteractiveObject instance. | InteractiveObject | ||
![]() | Dispatched by the drag initiator InteractiveObject when the user releases the drag gesture. | InteractiveObject | ||
![]() | Dispatched by the target InteractiveObject when a dragged object is dropped on it and the drop has been accepted with a call to DragManager.acceptDragDrop(). | InteractiveObject | ||
![]() | Dispatched by an InteractiveObject when a drag gesture enters its boundary. | InteractiveObject | ||
![]() | Dispatched by an InteractiveObject when a drag gesture leaves its boundary. | InteractiveObject | ||