BETA ActionScript® 3.0 Reference for the Adobe® Flash® Platform
Home  |  Hide Packages and Classes List |  Packages  |  Classes  |  What's New  |  Index  |  Appendixes

Language Reference only
Filters: AIR 32.0 and earlier, Flash Player 32.0 and earlier, Flash Lite 4
None
Hide Filters
fl.video 

FLVPlayback  - AS3 Flash

Packagesx

Top Level
adobe.utils
air.desktop
air.net
air.update
air.update.events
coldfusion.air
coldfusion.air.errors
coldfusion.air.events
coldfusion.service
coldfusion.service.events
coldfusion.service.mxml
com.adobe.consulting.pst.vo
com.adobe.dct.event
com.adobe.dct.model
com.adobe.dct.service
com.adobe.dct.service.impl
com.adobe.dct.transfer
com.adobe.dct.util
com.adobe.exm.expression
com.adobe.exm.expression.error
com.adobe.exm.expression.event
com.adobe.exm.expression.impl
com.adobe.fiber.runtime.lib
com.adobe.fiber.services
com.adobe.fiber.services.wrapper
com.adobe.fiber.styles
com.adobe.fiber.util
com.adobe.fiber.valueobjects
com.adobe.icc.editors.events
com.adobe.icc.editors.handlers
com.adobe.icc.editors.managers
com.adobe.icc.editors.model
com.adobe.icc.editors.model.el
com.adobe.icc.editors.model.el.operands
com.adobe.icc.editors.model.el.operators
com.adobe.icc.enum
com.adobe.icc.obj
com.adobe.icc.services
com.adobe.icc.services.category
com.adobe.icc.services.config
com.adobe.icc.services.download
com.adobe.icc.services.export
com.adobe.icc.services.external
com.adobe.icc.services.fragmentlayout
com.adobe.icc.services.importexport
com.adobe.icc.services.layout
com.adobe.icc.services.letter
com.adobe.icc.services.locator
com.adobe.icc.services.module
com.adobe.icc.services.render
com.adobe.icc.services.submit
com.adobe.icc.services.user
com.adobe.icc.token
com.adobe.icc.vo
com.adobe.icc.vo.render
com.adobe.icomm.assetplacement.controller
com.adobe.icomm.assetplacement.controller.utils
com.adobe.icomm.assetplacement.model
com.adobe.livecycle.assetmanager.client
com.adobe.livecycle.assetmanager.client.event
com.adobe.livecycle.assetmanager.client.handler
com.adobe.livecycle.assetmanager.client.managers
com.adobe.livecycle.assetmanager.client.model
com.adobe.livecycle.assetmanager.client.model.cms
com.adobe.livecycle.assetmanager.client.service
com.adobe.livecycle.assetmanager.client.service.search
com.adobe.livecycle.assetmanager.client.service.search.cms
com.adobe.livecycle.assetmanager.client.utils
com.adobe.livecycle.rca.model
com.adobe.livecycle.rca.model.constant
com.adobe.livecycle.rca.model.document
com.adobe.livecycle.rca.model.participant
com.adobe.livecycle.rca.model.reminder
com.adobe.livecycle.rca.model.stage
com.adobe.livecycle.rca.service
com.adobe.livecycle.rca.service.core
com.adobe.livecycle.rca.service.core.delegate
com.adobe.livecycle.rca.service.process
com.adobe.livecycle.rca.service.process.delegate
com.adobe.livecycle.rca.token
com.adobe.mosaic.core
com.adobe.mosaic.core.events
com.adobe.mosaic.core.validators
com.adobe.mosaic.om.interfaces
com.adobe.mosaic.skins.aqua
com.adobe.mosaic.skins.aqua.organizer
com.adobe.mosaic.skins.aqua.tile
com.adobe.mosaic.skins.aqua.util
com.adobe.mosaic.skins.aqua.view
com.adobe.mosaic.skins.aqua.viewManager
com.adobe.mosaic.sparklib.editors
com.adobe.mosaic.sparklib.optionMenu
com.adobe.mosaic.sparklib.scrollableMenu
com.adobe.mosaic.sparklib.scrollableMenu.skins
com.adobe.mosaic.sparklib.tabLayout
com.adobe.mosaic.sparklib.tabLayout.events
com.adobe.mosaic.sparklib.tabLayout.layouts
com.adobe.mosaic.sparklib.tabLayout.skins
com.adobe.viewsource
fl.accessibility
fl.containers
fl.controls
fl.controls.dataGridClasses
fl.controls.listClasses
fl.controls.progressBarClasses
fl.core
fl.data
fl.display
fl.events
fl.ik
fl.lang
fl.livepreview
fl.managers
fl.motion
fl.motion.easing
fl.rsl
fl.text
fl.transitions
fl.transitions.easing
fl.video
flash.accessibility
flash.concurrent
flash.crypto
flash.data
flash.desktop
flash.display
flash.display3D
flash.display3D.textures
flash.errors
flash.events
flash.external
flash.filesystem
flash.filters
flash.geom
flash.globalization
flash.html
flash.media
flash.net
flash.net.dns
flash.net.drm
flash.notifications
flash.permissions
flash.printing
flash.profiler
flash.sampler
flash.security
flash.sensors
flash.system
flash.text
flash.text.engine
flash.text.ime
flash.ui
flash.utils
flash.xml
flashx.textLayout
flashx.textLayout.compose
flashx.textLayout.container
flashx.textLayout.conversion
flashx.textLayout.edit
flashx.textLayout.elements
flashx.textLayout.events
flashx.textLayout.factory
flashx.textLayout.formats
flashx.textLayout.operations
flashx.textLayout.utils
flashx.undo
ga.controls
ga.layouts
ga.model
ga.uiComponents
ga.util
ga.views
ga.wrappers
lc.foundation
lc.foundation.domain
lc.foundation.events
lc.foundation.ui
lc.foundation.util
lc.preloader
lc.procmgmt
lc.procmgmt.commands
lc.procmgmt.domain
lc.procmgmt.events
lc.procmgmt.formbridge
lc.procmgmt.impl
lc.procmgmt.ui.attachments
lc.procmgmt.ui.controls
lc.procmgmt.ui.controls.card
lc.procmgmt.ui.controls.renderer
lc.procmgmt.ui.endpoint
lc.procmgmt.ui.help
lc.procmgmt.ui.layout
lc.procmgmt.ui.presentationmodel
lc.procmgmt.ui.process
lc.procmgmt.ui.search
lc.procmgmt.ui.task
lc.procmgmt.ui.task.form
lc.procmgmt.ui.task.form.commands
lc.procmgmt.ui.tracking
mx.accessibility
mx.automation
mx.automation.air
mx.automation.delegates
mx.automation.delegates.advancedDataGrid
mx.automation.delegates.charts
mx.automation.delegates.containers
mx.automation.delegates.controls
mx.automation.delegates.controls.dataGridClasses
mx.automation.delegates.controls.fileSystemClasses
mx.automation.delegates.core
mx.automation.delegates.flashflexkit
mx.automation.events
mx.binding
mx.binding.utils
mx.charts
mx.charts.chartClasses
mx.charts.effects
mx.charts.effects.effectClasses
mx.charts.events
mx.charts.renderers
mx.charts.series
mx.charts.series.items
mx.charts.series.renderData
mx.charts.styles
mx.collections
mx.collections.errors
mx.containers
mx.containers.accordionClasses
mx.containers.dividedBoxClasses
mx.containers.errors
mx.containers.utilityClasses
mx.controls
mx.controls.advancedDataGridClasses
mx.controls.dataGridClasses
mx.controls.listClasses
mx.controls.menuClasses
mx.controls.olapDataGridClasses
mx.controls.scrollClasses
mx.controls.sliderClasses
mx.controls.textClasses
mx.controls.treeClasses
mx.controls.videoClasses
mx.core
mx.core.windowClasses
mx.data
mx.data.crypto
mx.data.errors
mx.data.events
mx.data.messages
mx.data.mxml
mx.data.offline.errors
mx.data.utils
mx.effects
mx.effects.easing
mx.effects.effectClasses
mx.events
mx.filters
mx.flash
mx.formatters
mx.geom
mx.graphics
mx.graphics.codec
mx.graphics.shaderClasses
mx.logging
mx.logging.errors
mx.logging.targets
mx.managers
mx.messaging
mx.messaging.channels
mx.messaging.config
mx.messaging.errors
mx.messaging.events
mx.messaging.management
mx.messaging.messages
mx.modules
mx.netmon
mx.olap
mx.olap.aggregators
mx.preloaders
mx.printing
mx.resources
mx.rpc
mx.rpc.events
mx.rpc.http
mx.rpc.http.mxml
mx.rpc.livecycle
mx.rpc.mxml
mx.rpc.remoting
mx.rpc.remoting.mxml
mx.rpc.soap
mx.rpc.soap.mxml
mx.rpc.wsdl
mx.rpc.xml
mx.skins
mx.skins.halo
mx.skins.spark
mx.skins.wireframe
mx.skins.wireframe.windowChrome
mx.states
mx.styles
mx.utils
mx.validators
org.osmf.containers
org.osmf.display
org.osmf.elements
org.osmf.events
org.osmf.layout
org.osmf.logging
org.osmf.media
org.osmf.metadata
org.osmf.net
org.osmf.net.dvr
org.osmf.net.httpstreaming
org.osmf.net.metrics
org.osmf.net.qos
org.osmf.net.rtmpstreaming
org.osmf.net.rules
org.osmf.traits
org.osmf.utils
spark.accessibility
spark.automation.delegates
spark.automation.delegates.components
spark.automation.delegates.components.gridClasses
spark.automation.delegates.components.mediaClasses
spark.automation.delegates.components.supportClasses
spark.automation.delegates.skins.spark
spark.automation.events
spark.collections
spark.components
spark.components.calendarClasses
spark.components.gridClasses
spark.components.mediaClasses
spark.components.supportClasses
spark.components.windowClasses
spark.core
spark.effects
spark.effects.animation
spark.effects.easing
spark.effects.interpolation
spark.effects.supportClasses
spark.events
spark.filters
spark.formatters
spark.formatters.supportClasses
spark.globalization
spark.globalization.supportClasses
spark.layouts
spark.layouts.supportClasses
spark.managers
spark.modules
spark.preloaders
spark.primitives
spark.primitives.supportClasses
spark.skins
spark.skins.mobile
spark.skins.mobile.supportClasses
spark.skins.spark
spark.skins.spark.mediaClasses.fullScreen
spark.skins.spark.mediaClasses.normal
spark.skins.spark.windowChrome
spark.skins.wireframe
spark.skins.wireframe.mediaClasses
spark.skins.wireframe.mediaClasses.fullScreen
spark.transitions
spark.utils
spark.validators
spark.validators.supportClasses

Language Elements

Global Constants
Global Functions
Operators
Statements, Keywords & Directives
Special Types

Appendixes

What's New
Compiler Errors
Compiler Warnings
Run-Time Errors
Migrating to ActionScript 3
Supported Character Sets
MXML Only Tags
Motion XML Elements
Timed Text Tags
List of deprecated elements
Accessibility Implementation Constants
How to Use ActionScript Examples
Legal notices
(Beta)
Packagefl.video
Classpublic class FLVPlayback
InheritanceFLVPlayback Inheritance Sprite Inheritance DisplayObjectContainer Inheritance InteractiveObject Inheritance DisplayObject Inheritance EventDispatcher Inheritance Object

Language Version: ActionScript 3.0
Product Version: Flash CS3
Runtime Versions: Flash Player 9.0.28.0, AIR 1.0

FLVPlayback extends the Sprite class and wraps a VideoPlayer object. NOTE: This documentation is intended for use with the FLVPlayback with Accessibility component.

It updates the ActionScript 3.0 Language and Components Reference for the FLVPlayback class to include the following properties and methods which were added to improve the component's keyboard and screenreader accessibility.

Make sure you are including the " with Accessibility" version of the component in your project before attempting to access the new properties or methods.

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

For Flash Player Update 3 (version 9.0.115.0) and later, the FLVPlayback component was updated to support high-definition MPEG-4 video formats that utilize industry standard H.264 encoding. For more information on the video formats supported by the FLVPlayback component, see Controlling web video with ActionScript 3 FLVPlayback programming.

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);

View the examples

Related API Elements



Public Properties
 PropertyDefined By
 InheritedaccessibilityImplementation : AccessibilityImplementation
The current accessibility implementation (AccessibilityImplementation) for this InteractiveObject instance.
InteractiveObject
 InheritedaccessibilityProperties : 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
 Inheritedalpha : 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
 InheritedblendMode : String
A value from the BlendMode class that specifies which blend mode to use.
DisplayObject
 InheritedblendShader : Shader
[write-only] Sets a shader that is used for blending the foreground and background.
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
 InheritedbuttonMode : 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
 InheritedcacheAsBitmap : Boolean
If set to true, Flash runtimes cache an internal bitmap representation of the display object.
DisplayObject
 Inherited    cacheAsBitmapMatrix : Matrix
If non-null, this Matrix object defines how a display object is rendered when cacheAsBitmap is set to true.
DisplayObject
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
 InheritedcontextMenu : 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
 InheriteddoubleClickEnabled : Boolean
Specifies whether the object receives doubleClick events.
InteractiveObject
 InheriteddropTarget : DisplayObject
[read-only] Specifies the display object over which the sprite is being dragged, or on which the sprite was dropped.
Sprite
  endTabIndex : int
[read-only] Returns the next available tabIndex value after the FLVPlayback controls.
FLVPlayback
 Inheritedfilters : Array
An indexed array that contains each filter object currently associated with the display object.
DisplayObject
 InheritedfocusRect : 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
 Inheritedgraphics : Graphics
[read-only] Specifies the Graphics object that belongs to this sprite where vector drawing commands can occur.
Sprite
  height : Number
[override] A number that specifies the height of the FLVPlayback instance.
FLVPlayback
 InheritedhitArea : 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
 InheritedloaderInfo : LoaderInfo
[read-only] Returns a LoaderInfo object containing information about loading the file to which this display object belongs.
DisplayObject
 Inheritedmask : 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
 InheritedmetaData : Object
Obtains the meta data object of the DisplayObject instance if meta data was stored alongside the the instance of this DisplayObject in the SWF file through a PlaceObject4 tag.
DisplayObject
  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
 InheritedmouseChildren : Boolean
Determines whether or not the children of the object are mouse, or user input device, enabled.
DisplayObjectContainer
 InheritedmouseEnabled : Boolean
Specifies whether this object receives mouse, or other user input, messages.
InteractiveObject
 InheritedmouseX : Number
[read-only] Indicates the x coordinate of the mouse or user input device position, in pixels.
DisplayObject
 InheritedmouseY : Number
[read-only] Indicates the y coordinate of the mouse or user input device position, in pixels.
DisplayObject
  muteButton : Sprite
Mute button control.
FLVPlayback
 Inheritedname : 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
 InheritedneedsSoftKeyboard : Boolean
Specifies whether a virtual keyboard (an on-screen, software keyboard) should display when this InteractiveObject instance receives focus.
InteractiveObject
 InheritednumChildren : int
[read-only] Returns the number of children of this object.
DisplayObjectContainer
 InheritedopaqueBackground : Object
Specifies whether the display object is opaque with a certain background color.
DisplayObject
 Inheritedparent : 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
  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
 Inheritedroot : 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
 Inheritedrotation : Number
Indicates the rotation of the DisplayObject instance, in degrees, from its original orientation.
DisplayObject
 InheritedrotationX : Number
Indicates the x-axis rotation of the DisplayObject instance, in degrees, from its original orientation relative to the 3D parent container.
DisplayObject
 InheritedrotationY : Number
Indicates the y-axis rotation of the DisplayObject instance, in degrees, from its original orientation relative to the 3D parent container.
DisplayObject
 InheritedrotationZ : Number
Indicates the z-axis rotation of the DisplayObject instance, in degrees, from its original orientation relative to the 3D parent container.
DisplayObject
 Inheritedscale9Grid : Rectangle
The current scaling grid that is in effect.
DisplayObject
  scaleMode : String
Specifies how the video will resize after loading.
FLVPlayback
  scaleX : Number
[override] A number that is the horizontal scale.
FLVPlayback
  scaleY : Number
[override] A number that is the vertical scale.
FLVPlayback
 InheritedscaleZ : Number
Indicates the depth scale (percentage) of an object as applied from the registration point of the object.
DisplayObject
 InheritedscrollRect : 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
 Inherited    softKeyboard : String
Controls the appearance of the soft keyboard.
InteractiveObject
 InheritedsoftKeyboardInputAreaOfInterest : Rectangle
Defines the area that should remain on-screen when a soft keyboard is displayed (not available on iOS).
InteractiveObject
  soundTransform : flash.media:SoundTransform
[override] 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
 Inheritedstage : Stage
[read-only] The Stage of the display object.
DisplayObject
  startTabIndex : int
[read-only] Returns the first tabIndex value for the FLVPlayback controls.
FLVPlayback
  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
 InheritedtabChildren : Boolean
Determines whether the children of the object are tab enabled.
DisplayObjectContainer
 InheritedtabEnabled : Boolean
Specifies whether this object is in the tab order.
InteractiveObject
 InheritedtabIndex : int
Specifies the tab ordering of objects in a SWF file.
InteractiveObject
 InheritedtextSnapshot : flash.text: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
 Inheritedtransform : flash.geom:Transform
An object with properties pertaining to a display object's matrix, color transform, and pixel bounds.
DisplayObject
 InheriteduseHandCursor : Boolean
A Boolean value that indicates whether the pointing hand (hand cursor) appears when the pointer rolls over a sprite in which the buttonMode property is set to true.
Sprite
 Inheritedvisible : 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
[override] A number that specifies the width of the FLVPlayback instance on the Stage.
FLVPlayback
  x : Number
[override] A number that specifies the horizontal position (in pixels) of the video player.
FLVPlayback
  y : Number
[override] A number that specifies the vertical position (in pixels) of the video player.
FLVPlayback
 Inheritedz : Number
Indicates the z coordinate position along the z-axis of the DisplayObject instance relative to the 3D parent container.
DisplayObject
Public Methods
 MethodDefined By
  
Creates a new FLVPlayback instance.
FLVPlayback
  
addASCuePoint(timeOrCuePoint:*, name:String = null, parameters:Object = null):Object
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
 Inherited
Adds a child DisplayObject instance to this DisplayObjectContainer instance.
DisplayObjectContainer
 Inherited
Adds a child DisplayObject instance to this DisplayObjectContainer instance.
DisplayObjectContainer
 Inherited
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
 Inherited
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
  
assignTabIndexes(startTabIndex:int):int
Assigns a tabIndex value to each of the FLVPlayback controls by sorting them by position horizontally left to right.
FLVPlayback
  
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
 Inherited
Determines whether the specified display object is a child of the DisplayObjectContainer instance or the instance itself.
DisplayObjectContainer
 Inherited
Dispatches an event into the event flow.
EventDispatcher
  
Sets the FLVPlayback video player to full screen.
FLVPlayback
  
findCuePoint(timeNameOrCuePoint:*, type:String):Object
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
  
findNearestCuePoint(timeNameOrCuePoint:*, type:String):Object
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
 Inherited
getBounds(targetCoordinateSpace:DisplayObject):Rectangle
Returns a rectangle that defines the area of the display object relative to the coordinate system of the targetCoordinateSpace object.
DisplayObject
 Inherited
Returns the child display object instance that exists at the specified index.
DisplayObjectContainer
 Inherited
Returns the child display object that exists with the specified name.
DisplayObjectContainer
 Inherited
Returns the index position of a child DisplayObject instance.
DisplayObjectContainer
 Inherited
Returns an array of objects that lie under the specified point and are children (or grandchildren, and so on) of this DisplayObjectContainer instance.
DisplayObjectContainer
 Inherited
getRect(targetCoordinateSpace:DisplayObject):Rectangle
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
 Inherited
Converts the point object from the Stage (global) coordinates to the display object's (local) coordinates.
DisplayObject
 Inherited
Converts a two-dimensional point from the Stage (global) coordinates to a three-dimensional display object's (local) coordinates.
DisplayObject
 Inherited
Checks whether the EventDispatcher object has any listeners registered for a specific type of event.
EventDispatcher
 Inherited
Indicates whether an object has a specified property defined.
Object
 Inherited
Evaluates the bounding box of the display object to see if it overlaps or intersects with the bounding box of the obj display object.
DisplayObject
 Inherited
hitTestPoint(x:Number, y:Number, shapeFlag:Boolean = false):Boolean
Evaluates the display object to see if it overlaps or intersects with the point specified by the x and y parameters.
DisplayObject
  
isFLVCuePointEnabled(timeNameOrCuePoint:*):Boolean
Returns false if the FLV file embedded cue point is disabled.
FLVPlayback
 Inherited
Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.
Object
  
load(source:String, totalTime:Number = NaN, isLive:Boolean = false):void
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
 Inherited
Converts a three-dimensional point of the three-dimensional display object's (local) coordinates to a two-dimensional point in the Stage (global) coordinates.
DisplayObject
 Inherited
Converts the point object from the display object's (local) coordinates to the Stage (global) coordinates.
DisplayObject
  
Pauses playing the video stream.
FLVPlayback
  
play(source:String = null, totalTime:Number = NaN, isLive:Boolean = false):void
Plays the video stream.
FLVPlayback
  
Plays the FLV file when enough of it has downloaded.
FLVPlayback
 Inherited
Indicates whether the specified property exists and is enumerable.
Object
  
removeASCuePoint(timeNameOrCuePoint:*):Object
Removes an ActionScript cue point from the currently loaded FLV file.
FLVPlayback
 Inherited
Removes the specified child DisplayObject instance from the child list of the DisplayObjectContainer instance.
DisplayObjectContainer
 Inherited
Removes a child DisplayObject from the specified index position in the child list of the DisplayObjectContainer.
DisplayObjectContainer
 Inherited
removeChildren(beginIndex:int = 0, endIndex:int = 0x7fffffff):void
Removes all child DisplayObject instances from the child list of the DisplayObjectContainer instance.
DisplayObjectContainer
 Inherited
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
Removes a listener from the EventDispatcher object.
EventDispatcher
 Inherited
Raises a virtual keyboard.
InteractiveObject
  
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
  
seekToNavCuePoint(timeNameOrCuePoint:*):void
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
 Inherited
Changes the position of an existing child in the display object container.
DisplayObjectContainer
  
setFLVCuePointEnabled(enabled:Boolean, timeNameOrCuePoint:*):Number
Enables or disables one or more FLV file cue points.
FLVPlayback
 Inherited
Sets the availability of a dynamic property for loop operations.
Object
  
setScale(scaleX:Number, scaleY:Number):void
Sets the scaleX and scaleY properties simultaneously.
FLVPlayback
  
setSize(width:Number, height:Number):void
Sets width and height simultaneously.
FLVPlayback
 Inherited
startDrag(lockCenter:Boolean = false, bounds:Rectangle = null):void
Lets the user drag the specified sprite.
Sprite
 Inherited
startTouchDrag(touchPointID:int, lockCenter:Boolean = false, bounds:Rectangle = null):void
Lets the user drag the specified sprite on a touch-enabled device.
Sprite
  
Stops the video from playing.
FLVPlayback
 Inherited
Recursively stops the timeline execution of all MovieClips rooted at this object.
DisplayObjectContainer
 Inherited
Ends the startDrag() method.
Sprite
 Inherited
stopTouchDrag(touchPointID:int):void
Ends the startTouchDrag() method, for use with touch-enabled devices.
Sprite
 Inherited
Swaps the z-order (front-to-back order) of the two specified child objects.
DisplayObjectContainer
 Inherited
swapChildrenAt(index1:int, index2:int):void
Swaps the z-order (front-to-back order) of the child objects at the two specified index positions in the child list.
DisplayObjectContainer
 Inherited
Returns the string representation of this object, formatted according to locale-specific conventions.
Object
 Inherited
Returns the string representation of the specified object.
Object
 Inherited
Returns the primitive value of the specified object.
Object
 Inherited
Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type.
EventDispatcher
Events
 Event Summary Defined By
 Inherited[broadcast event] Dispatched when the Flash Player or AIR application gains operating system focus and becomes active.EventDispatcher
 InheritedDispatched when a display object is added to the display list.DisplayObject
 InheritedDispatched 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
 InheritedDispatched when the user selects 'Clear' (or 'Delete') from the text context menu.InteractiveObject
 InheritedDispatched 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
 Inherited
    contextMenu
Dispatched when a user gesture triggers the context menu associated with this interactive object in an AIR application.InteractiveObject
 InheritedDispatched when the user activates the platform-specific accelerator key combination for a copy operation or selects 'Copy' from the text context menu.InteractiveObject
  Dispatched when a cue point is reached.FLVPlayback
 InheritedDispatched when the user activates the platform-specific accelerator key combination for a cut operation or selects 'Cut' from the text context menu.InteractiveObject
 Inherited[broadcast event] Dispatched when the Flash Player or AIR application operating loses system focus and is becoming inactive.EventDispatcher
 InheritedDispatched 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
 Inherited[broadcast event] Dispatched when the playhead is entering a new frame.DisplayObject
 Inherited[broadcast event] Dispatched when the playhead is exiting the current 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
 InheritedDispatched after a display object gains focus.InteractiveObject
 InheritedDispatched after a display object loses focus.InteractiveObject
 Inherited[broadcast event] Dispatched after the constructors of frame display objects have run but before frame scripts have run.DisplayObject
 InheritedDispatched when the user creates a point of contact along the edge of the touch surface with an InteractiveObject instance, (such as tapping along the edge of the touch surface on Siri Remote for Apple TV) Some devices might also interpret this contact as a combination of several touch events, as well.InteractiveObject
 InheritedDispatched when the user presses two points of contact over the same InteractiveObject instance on a touch-enabled device (such as presses and releases two fingers over a display object on a mobile phone or tablet with a touch screen).InteractiveObject
 InheritedDispatched when the user moves a point of contact over the InteractiveObject instance on a touch-enabled device (such as moving a finger from left to right over a display object on a mobile phone or tablet with a touch screen).InteractiveObject
 InheritedDispatched when the user performs a rotation gesture at a point of contact with an InteractiveObject instance (such as touching two fingers and rotating them over a display object on a mobile phone or tablet with a touch screen).InteractiveObject
 InheritedDispatched when the user performs a swipe gesture at a point of contact with an InteractiveObject instance (such as touching three fingers to a screen and then moving them in parallel over a display object on a mobile phone or tablet with a touch screen).InteractiveObject
 InheritedDispatched when the user creates a point of contact with an InteractiveObject instance, then taps on a touch-enabled device (such as placing several fingers over a display object to open a menu and then taps one finger to select a menu item on a mobile phone or tablet with a touch screen).InteractiveObject
 InheritedDispatched when the user performs a zoom gesture at a point of contact with an InteractiveObject instance (such as touching two fingers to a screen and then quickly spreading the fingers apart over a display object on a mobile phone or tablet with a touch screen).InteractiveObject
 InheritedThis event is dispatched to any client app that supports inline input with an IMEInteractiveObject
 InheritedDispatched when the user presses a key.InteractiveObject
 InheritedDispatched when the user attempts to change focus by using keyboard navigation.InteractiveObject
 InheritedDispatched 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
 InheritedDispatched when a user presses and releases the middle button of the user's pointing device over the same InteractiveObject.InteractiveObject
 InheritedDispatched when a user presses the middle pointing device button over an InteractiveObject instance.InteractiveObject
 InheritedDispatched when a user releases the pointing device button over an InteractiveObject instance.InteractiveObject
 InheritedDispatched when a user presses the pointing device button over an InteractiveObject instance.InteractiveObject
 InheritedDispatched when the user attempts to change focus by using a pointer device.InteractiveObject
 InheritedDispatched when a user moves the pointing device while it is over an InteractiveObject.InteractiveObject
 InheritedDispatched when the user moves a pointing device away from an InteractiveObject instance.InteractiveObject
 InheritedDispatched when the user moves a pointing device over an InteractiveObject instance.InteractiveObject
 InheritedDispatched when a user releases the pointing device button over an InteractiveObject instance.InteractiveObject
 InheritedDispatched when a mouse wheel is spun over an InteractiveObject instance.InteractiveObject
 InheritedDispatched by the drag initiator InteractiveObject when the user releases the drag gesture.InteractiveObject
 InheritedDispatched 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
 InheritedDispatched by an InteractiveObject when a drag gesture enters its boundary.InteractiveObject
 InheritedDispatched by an InteractiveObject when a drag gesture leaves its boundary.InteractiveObject
 InheritedDispatched by an InteractiveObject continually while a drag gesture remains within its boundary.InteractiveObject
 InheritedDispatched at the beginning of a drag operation by the InteractiveObject that is specified as the drag initiator in the DragManager.doDrag() call.InteractiveObject
 InheritedDispatched during a drag operation by the InteractiveObject that is specified as the drag initiator in the DragManager.doDrag() call.InteractiveObject
 InheritedDispatched when the user activates the platform-specific accelerator key combination for a paste operation or selects 'Paste' from the text context menu.InteractiveObject
  Dispatched when the player enters the paused state.FLVPlayback
  Dispatched while the FLV file is playing at the frequency specified by the playheadUpdateInterval property or when rewinding starts.FLVPlayback
  Dispatched when the playing state is entered.FLVPlayback
  Indicates progress made in number of bytes downloaded.FLVPlayback
 InheritedDispatched when the user lowers an active stylus past the proximity detection threshold of the screen.InteractiveObject
 Inherited
    proximityEnd
Dispatched when the user lifts an active stylus above the proximity detection threshold of the screen.InteractiveObject
 InheritedDispatched when the user moves an active stylus over the screen while remaining within the proximity detection threshold.InteractiveObject
 Inherited
    proximityOut
Dispatched when the user moves an active stylus away from this InteractiveObject while remaining within the proximity detection threshold of the screen.InteractiveObject
 InheritedDispatched when the user moves an active stylus directly above this InteractiveObject while remaining within the proximity detection threshold of the screen.InteractiveObject
 InheritedDispatched when the user moves an active stylus away from this InteractiveObject and any of its children while remaining within the proximity detection threshold of the screen.InteractiveObject
 InheritedDispatched when the user moves an active stylus over this InteractiveObject from outside the object's tree of descendents in the display list (while remaining within the proximity detection threshold of the screen).InteractiveObject
  Dispatched when an FLV file is loaded and ready to display.FLVPlayback
 InheritedDispatched when a user releases the button on the pointing device after the user first pressed the button over an InteractiveObject instance and then moved the pointing device off of the InteractiveObject instance.InteractiveObject
 InheritedDispatched when a display object is about to be removed from the display list.DisplayObject
 InheritedDispatched when a display object is about to be removed from the display list, either directly or through the removal of a sub tree in which the display object is contained.DisplayObject
 Inherited[broadcast event] Dispatched when the display list is about to be updated and rendered.DisplayObject
  Dispatched when the location of the playhead moves backward by a call to seek() or when an autoRewind call is completed.FLVPlayback
 InheritedDispatched when a user presses and releases the right button of the user's pointing device over the same InteractiveObject.InteractiveObject
 InheritedDispatched when a user presses the pointing device button over an InteractiveObject instance.InteractiveObject
 InheritedDispatched when a user releases the pointing device button over an InteractiveObject instance.InteractiveObject
 InheritedDispatched when the user moves a pointing device away from an InteractiveObject instance.InteractiveObject
 InheritedDispatched when the user moves a pointing device over an InteractiveObject instance.InteractiveObject
  Dispatched when the user stops scrubbing the FLV file with the seek bar.FLVPlayback
  Dispatched when the user begins scrubbing the FLV file with the seek bar.FLVPlayback
  Dispatched when the location of the playhead is changed by a call to seek() or by setting the playheadTime property or by using the SeekBar control.FLVPlayback
 InheritedDispatched when the user activates the platform-specific accelerator key combination for a select all operation or selects 'Select All' from the text context menu.InteractiveObject
  Dispatched when an error occurs loading a skin SWF file.FLVPlayback
  Dispatched when a skin SWF file is loaded.FLVPlayback
 InheritedDispatched immediately after the soft keyboard is raised.InteractiveObject
 InheritedDispatched immediately before the soft keyboard is raised.InteractiveObject
 InheritedDispatched immediately after the soft keyboard is lowered.InteractiveObject
  Dispatched when sound changes by the user either moving the handle of the volumeBar control or setting the volume or soundTransform property.FLVPlayback
  Dispatched when the playback state changes.FLVPlayback
  Dispatched when entering the stopped state.FLVPlayback
 InheritedDispatched when the value of the object's tabChildren flag changes.InteractiveObject
 InheritedDispatched when the object's tabEnabled flag changes.InteractiveObject
 InheritedDispatched when the value of the object's tabIndex property changes.InteractiveObject
 InheritedDispatched when a user enters one or more characters of text.InteractiveObject
 InheritedDispatched when the user first contacts a touch-enabled device (such as touches a finger to a mobile phone or tablet with a touch screen).InteractiveObject
 InheritedDispatched when the user removes contact with a touch-enabled device (such as lifts a finger off a mobile phone or tablet with a touch screen).InteractiveObject
 InheritedDispatched when the user touches the device, and is continuously dispatched until the point of contact is removed.InteractiveObject
 InheritedDispatched when the user moves the point of contact away from InteractiveObject instance on a touch-enabled device (such as drags a finger from one display object to another on a mobile phone or tablet with a touch screen).InteractiveObject
 InheritedDispatched when the user moves the point of contact over an InteractiveObject instance on a touch-enabled device (such as drags a finger from a point outside a display object to a point over a display object on a mobile phone or tablet with a touch screen).InteractiveObject
 InheritedDispatched when the user moves the point of contact away from an InteractiveObject instance on a touch-enabled device (such as drags a finger from over a display object to a point outside the display object on a mobile phone or tablet with a touch screen).InteractiveObject
 InheritedDispatched when the user moves the point of contact over an InteractiveObject instance on a touch-enabled device (such as drags a finger from a point outside a display object to a point over a display object on a mobile phone or tablet with a touch screen).InteractiveObject
 InheritedDispatched when the user lifts the point of contact over the same InteractiveObject instance on which the contact was initiated on a touch-enabled device (such as presses and releases a finger from a single point over a display object on a mobile phone or tablet with a touch screen).InteractiveObject
Public Constants
 ConstantDefined By
  SHORT_VERSION : String = "2.1"
[static] State variable indicating the short version number of the component.
FLVPlayback
  VERSION : String = "2.1.0.23"
[static] State variable indicating the long version number of the component.
FLVPlayback
Property Detail
Constructor Detail
Method Detail
Event Detail
Constant Detail
FLVPlaybackExample.as

This example dynamically creates an FLVPlayback instance.

To run the example, follow these steps:

  1. Place the FLVPlayback component on the Stage at 0,0 and provide the instance name player.
  2. Replace videoPath with an absolute or relative path to an FLV file.
  3. Save this code as FLVPlaybackExample.as in the same directory as your FLA file.
  4. Set the Document class in the FLA file to FLVPlaybackExample.
package
{
    import fl.video.FLVPlayback;
    import flash.display.Sprite;
    
    public class FLVPlaybackExample extends Sprite {

        private var videoPath:String = "http://www.helpexamples.com/flash/video/caption_video.flv";
        
        public function FLVPlaybackExample() {
            player.source = videoPath;
            player.skinBackgroundColor = 0x666666;
            player.skinBackgroundAlpha = 0.5;
        }
    }
}