FLVPlayback

(Beta)

Package	fl.video
Class	public class FLVPlayback
Inheritance	FLVPlayback Sprite DisplayObjectContainer InteractiveObject DisplayObject EventDispatcher 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:

Copy

     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:

Copy

     import fl.video.FLVPlayback;
     trace(FLVPlayback.VERSION);

View the examples

Related API Elements

AutoLayoutEvent
FLVPlaybackCaptioning
MetadataEvent
NCManager
LayoutEvent
SoundEvent
VideoPlayer
VideoError
VideoEvent
VideoProgressEvent

Public Properties

Hide Inherited Public Properties

Show Inherited Public Properties

	Property		Defined By
		accessibilityImplementation : AccessibilityImplementation The current accessibility implementation (AccessibilityImplementation) for this InteractiveObject instance.	InteractiveObject
		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
		blendShader : 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
		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 runtimes cache an internal bitmap representation of the display object.	DisplayObject
		cacheAsBitmapMatrix : Matrix If non-null, this Matrix object defines how a display object is rendered when cacheAsBitmap is set to true.	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
		endTabIndex : int [read-only] Returns the next available tabIndex value after the FLVPlayback controls.	FLVPlayback
		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 [override] 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
		metaData : 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
		mouseChildren : Boolean Determines whether or not the children of the object are mouse, or user input device, enabled.	DisplayObjectContainer
		mouseEnabled : Boolean Specifies whether this object receives mouse, or other user input, messages.	InteractiveObject
		mouseX : Number [read-only] Indicates the x coordinate of the mouse or user input device position, in pixels.	DisplayObject
		mouseY : Number [read-only] Indicates the y coordinate of the mouse or user input device 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
		needsSoftKeyboard : Boolean Specifies whether a virtual keyboard (an on-screen, software keyboard) should display when this InteractiveObject instance receives focus.	InteractiveObject
		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
		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
		rotationX : Number Indicates the x-axis rotation of the DisplayObject instance, in degrees, from its original orientation relative to the 3D parent container.	DisplayObject
		rotationY : Number Indicates the y-axis rotation of the DisplayObject instance, in degrees, from its original orientation relative to the 3D parent container.	DisplayObject
		rotationZ : Number Indicates the z-axis rotation of the DisplayObject instance, in degrees, from its original orientation relative to the 3D parent container.	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 [override] A number that is the horizontal scale.	FLVPlayback
		scaleY : Number [override] A number that is the vertical scale.	FLVPlayback
		scaleZ : Number Indicates the depth scale (percentage) of an object as applied from the registration point of the object.	DisplayObject
		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
		softKeyboard : String Controls the appearance of the soft keyboard.	InteractiveObject
		softKeyboardInputAreaOfInterest : 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
		stage : 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
		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 : 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
		transform : flash.geom: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 pointer 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 [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
		z : Number Indicates the z coordinate position along the z-axis of the DisplayObject instance relative to the 3D parent container.	DisplayObject

Public Methods

Hide Inherited Public Methods

Show Inherited Public Methods

	Method		Defined By
		FLVPlayback() 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
		addChild(child:DisplayObject):DisplayObject Adds a child DisplayObject instance to this DisplayObjectContainer instance.	DisplayObjectContainer
		addChildAt(child:DisplayObject, index:int):DisplayObject 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
		areInaccessibleObjectsUnderPoint(point:Point):Boolean 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
		bringVideoPlayerToFront(index:uint):void Brings a video player to the front of the stack of video players.	FLVPlayback
		closeVideoPlayer(index:uint):void Closes NetStream and deletes the video player specified by the index parameter.	FLVPlayback
		contains(child:DisplayObject):Boolean Determines whether the specified display object is a child of the DisplayObjectContainer instance or the instance itself.	DisplayObjectContainer
		dispatchEvent(event:Event):Boolean Dispatches an event into the event flow.	EventDispatcher
		enterFullScreenDisplayState():void 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
		findNextCuePointWithName(cuePoint:Object):Object Finds the next cue point in my_cuePoint.array that has the same name as my_cuePoint.name.	FLVPlayback
		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
		getChildAt(index:int):DisplayObject Returns the child display object instance that exists at the specified index.	DisplayObjectContainer
		getChildByName(name:String):DisplayObject Returns the child display object that exists with the specified name.	DisplayObjectContainer
		getChildIndex(child:DisplayObject):int Returns the index position of a child DisplayObject instance.	DisplayObjectContainer
		getObjectsUnderPoint(point:Point):Array Returns an array of objects that lie under the specified point and are children (or grandchildren, and so on) of this DisplayObjectContainer instance.	DisplayObjectContainer
		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
		getVideoPlayer(index:Number):VideoPlayer Gets the video player specified by the index parameter.	FLVPlayback
		globalToLocal(point:Point):Point Converts the point object from the Stage (global) coordinates to the display object's (local) coordinates.	DisplayObject
		globalToLocal3D(point:Point):Vector3D Converts a two-dimensional point from the Stage (global) coordinates to a three-dimensional display object's (local) coordinates.	DisplayObject
		hasEventListener(type:String):Boolean Checks whether the EventDispatcher object has any listeners registered for a specific type of event.	EventDispatcher
		hasOwnProperty(name:String):Boolean Indicates whether an object has a specified property defined.	Object
		hitTestObject(obj:DisplayObject):Boolean 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
		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
		isPrototypeOf(theClass:Object):Boolean 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
		local3DToGlobal(point3d:Vector3D):Point 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
		localToGlobal(point:Point):Point Converts the point object from the display object's (local) coordinates to the Stage (global) coordinates.	DisplayObject
		pause():void Pauses playing the video stream.	FLVPlayback
		play(source:String = null, totalTime:Number = NaN, isLive:Boolean = false):void Plays the video stream.	FLVPlayback
		playWhenEnoughDownloaded():void Plays the FLV file when enough of it has downloaded.	FLVPlayback
		propertyIsEnumerable(name:String):Boolean 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
		removeChild(child:DisplayObject):DisplayObject Removes the specified child DisplayObject instance from the child list of the DisplayObjectContainer instance.	DisplayObjectContainer
		removeChildAt(index:int):DisplayObject Removes a child DisplayObject from the specified index position in the child list of the DisplayObjectContainer.	DisplayObjectContainer
		removeChildren(beginIndex:int = 0, endIndex:int = 0x7fffffff):void Removes all child DisplayObject instances from the child list of the DisplayObjectContainer instance.	DisplayObjectContainer
		removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void Removes a listener from the EventDispatcher object.	EventDispatcher
		requestSoftKeyboard():Boolean Raises a virtual keyboard.	InteractiveObject
		seek(time:Number):void Seeks to a given time in the file, specified in seconds, with a precision of three decimal places (milliseconds).	FLVPlayback
		seekPercent(percent:Number):void Seeks to a percentage of the file and places the playhead there.	FLVPlayback
		seekSeconds(time:Number):void 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
		seekToNextNavCuePoint(time:Number = NaN):void Seeks to the next navigation cue point, based on the current value of the playheadTime property.	FLVPlayback
		seekToPrevNavCuePoint(time:Number = NaN):void Seeks to the previous navigation cue point, based on the current value of the playheadTime property.	FLVPlayback
		setChildIndex(child:DisplayObject, index:int):void 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
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void 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
		startDrag(lockCenter:Boolean = false, bounds:Rectangle = null):void Lets the user drag the specified sprite.	Sprite
		startTouchDrag(touchPointID:int, lockCenter:Boolean = false, bounds:Rectangle = null):void Lets the user drag the specified sprite on a touch-enabled device.	Sprite
		stop():void Stops the video from playing.	FLVPlayback
		stopAllMovieClips():void Recursively stops the timeline execution of all MovieClips rooted at this object.	DisplayObjectContainer
		stopDrag():void Ends the startDrag() method.	Sprite
		stopTouchDrag(touchPointID:int):void Ends the startTouchDrag() method, for use with touch-enabled devices.	Sprite
		swapChildren(child1:DisplayObject, child2:DisplayObject):void Swaps the z-order (front-to-back order) of the two specified child objects.	DisplayObjectContainer
		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
		toLocaleString():String Returns the string representation of this object, formatted according to locale-specific conventions.	Object
		toString():String Returns the string representation of the specified object.	Object
		valueOf():Object Returns the primitive value of the specified object.	Object
		willTrigger(type:String):Boolean Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type.	EventDispatcher

Events

Click for more information on events

Hide Inherited Events

Show Inherited Events

	Summary	Defined By
activate	[broadcast event] Dispatched when the Flash Player or AIR application gains operating system focus and becomes active.	EventDispatcher
added	Dispatched when a display object is added to the display list.	DisplayObject
addedToStage	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
autoLayout	Dispatched when the video player is resized or laid out automatically.	FLVPlayback
autoRewound	Dispatched when the playhead is moved to the start of the video player because the autoRewind property is set to true.	FLVPlayback
bufferingStateEntered	Dispatched when the FLVPlayback instance enters the buffering state.	FLVPlayback
clear	Dispatched when the user selects 'Clear' (or 'Delete') from the text context menu.	InteractiveObject
click	Dispatched when a user presses and releases the main button of the user's pointing device over the same InteractiveObject.	InteractiveObject
close	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
complete	Dispatched when playing completes because the player reached the end of the FLV file.	FLVPlayback
contextMenu	Dispatched when a user gesture triggers the context menu associated with this interactive object in an AIR application.	InteractiveObject
copy	Dispatched when the user activates the platform-specific accelerator key combination for a copy operation or selects 'Copy' from the text context menu.	InteractiveObject
cuePoint	Dispatched when a cue point is reached.	FLVPlayback
cut	Dispatched when the user activates the platform-specific accelerator key combination for a cut operation or selects 'Cut' from the text context menu.	InteractiveObject
deactivate	[broadcast event] Dispatched when the Flash Player or AIR application operating loses system focus and is becoming inactive.	EventDispatcher
doubleClick	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
enterFrame	[broadcast event] Dispatched when the playhead is entering a new frame.	DisplayObject
exitFrame	[broadcast event] Dispatched when the playhead is exiting the current frame.	DisplayObject
fastForward	Dispatched when the location of the playhead moves forward by a call to the seek() method or by clicking the ForwardButton control.	FLVPlayback
focusIn	Dispatched after a display object gains focus.	InteractiveObject
focusOut	Dispatched after a display object loses focus.	InteractiveObject
frameConstructed	[broadcast event] Dispatched after the constructors of frame display objects have run but before frame scripts have run.	DisplayObject
gestureDirectionalTap	Dispatched 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
gestureLongPress	Dispatched 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
gesturePan	Dispatched 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
gestureRotate	Dispatched 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
gestureSwipe	Dispatched 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
gestureTap	Dispatched 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
gestureZoom	Dispatched 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
imeStartComposition	This event is dispatched to any client app that supports inline input with an IME	InteractiveObject
keyDown	Dispatched when the user presses a key.	InteractiveObject
keyFocusChange	Dispatched when the user attempts to change focus by using keyboard navigation.	InteractiveObject
keyUp	Dispatched when the user releases a key.	InteractiveObject
layout	Dispatched when the video player is resized or laid out.	FLVPlayback
metadataReceived	Dispatched the first time the FLV file's metadata is reached.	FLVPlayback
middleClick	Dispatched when a user presses and releases the middle button of the user's pointing device over the same InteractiveObject.	InteractiveObject
middleMouseDown	Dispatched when a user presses the middle pointing device button over an InteractiveObject instance.	InteractiveObject
middleMouseUp	Dispatched when a user releases the pointing device button over an InteractiveObject instance.	InteractiveObject
mouseDown	Dispatched when a user presses the pointing device button over an InteractiveObject instance.	InteractiveObject
mouseFocusChange	Dispatched when the user attempts to change focus by using a pointer device.	InteractiveObject
mouseMove	Dispatched when a user moves the pointing device while it is over an InteractiveObject.	InteractiveObject
mouseOut	Dispatched when the user moves a pointing device away from an InteractiveObject instance.	InteractiveObject
mouseOver	Dispatched when the user moves a pointing device over an InteractiveObject instance.	InteractiveObject
mouseUp	Dispatched when a user releases the pointing device button over an InteractiveObject instance.	InteractiveObject
mouseWheel	Dispatched when a mouse wheel is spun over an InteractiveObject instance.	InteractiveObject
nativeDragComplete	Dispatched by the drag initiator InteractiveObject when the user releases the drag gesture.	InteractiveObject
nativeDragDrop	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
nativeDragEnter	Dispatched by an InteractiveObject when a drag gesture enters its boundary.	InteractiveObject
nativeDragExit	Dispatched by an InteractiveObject when a drag gesture leaves its boundary.	InteractiveObject
nativeDragOver	Dispatched by an InteractiveObject continually while a drag gesture remains within its boundary.	InteractiveObject
nativeDragStart	Dispatched at the beginning of a drag operation by the InteractiveObject that is specified as the drag initiator in the DragManager.doDrag() call.	InteractiveObject
nativeDragUpdate	Dispatched during a drag operation by the InteractiveObject that is specified as the drag initiator in the DragManager.doDrag() call.	InteractiveObject
paste	Dispatched when the user activates the platform-specific accelerator key combination for a paste operation or selects 'Paste' from the text context menu.	InteractiveObject
pausedStateEntered	Dispatched when the player enters the paused state.	FLVPlayback
playheadUpdate	Dispatched while the FLV file is playing at the frequency specified by the playheadUpdateInterval property or when rewinding starts.	FLVPlayback
playingStateEntered	Dispatched when the playing state is entered.	FLVPlayback
progress	Indicates progress made in number of bytes downloaded.	FLVPlayback
proximityBegin	Dispatched when the user lowers an active stylus past the proximity detection threshold of the screen.	InteractiveObject
proximityEnd	Dispatched when the user lifts an active stylus above the proximity detection threshold of the screen.	InteractiveObject
proximityMove	Dispatched when the user moves an active stylus over the screen while remaining within the proximity detection threshold.	InteractiveObject
proximityOut	Dispatched when the user moves an active stylus away from this InteractiveObject while remaining within the proximity detection threshold of the screen.	InteractiveObject
proximityOver	Dispatched when the user moves an active stylus directly above this InteractiveObject while remaining within the proximity detection threshold of the screen.	InteractiveObject
proximityRollOut	Dispatched 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
proximityRollOver	Dispatched 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
ready	Dispatched when an FLV file is loaded and ready to display.	FLVPlayback
releaseOutside	Dispatched 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
removed	Dispatched when a display object is about to be removed from the display list.	DisplayObject
removedFromStage	Dispatched 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
render	[broadcast event] Dispatched when the display list is about to be updated and rendered.	DisplayObject
rewind	Dispatched when the location of the playhead moves backward by a call to seek() or when an autoRewind call is completed.	FLVPlayback
rightClick	Dispatched when a user presses and releases the right button of the user's pointing device over the same InteractiveObject.	InteractiveObject
rightMouseDown	Dispatched when a user presses the pointing device button over an InteractiveObject instance.	InteractiveObject
rightMouseUp	Dispatched when a user releases the pointing device button over an InteractiveObject instance.	InteractiveObject
rollOut	Dispatched when the user moves a pointing device away from an InteractiveObject instance.	InteractiveObject
rollOver	Dispatched when the user moves a pointing device over an InteractiveObject instance.	InteractiveObject
scrubFinish	Dispatched when the user stops scrubbing the FLV file with the seek bar.	FLVPlayback
scrubStart	Dispatched when the user begins scrubbing the FLV file with the seek bar.	FLVPlayback
seeked	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
selectAll	Dispatched 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
skinError	Dispatched when an error occurs loading a skin SWF file.	FLVPlayback
skinLoaded	Dispatched when a skin SWF file is loaded.	FLVPlayback
softKeyboardActivate	Dispatched immediately after the soft keyboard is raised.	InteractiveObject
softKeyboardActivating	Dispatched immediately before the soft keyboard is raised.	InteractiveObject
softKeyboardDeactivate	Dispatched immediately after the soft keyboard is lowered.	InteractiveObject
soundUpdate	Dispatched when sound changes by the user either moving the handle of the volumeBar control or setting the volume or soundTransform property.	FLVPlayback
stateChange	Dispatched when the playback state changes.	FLVPlayback
stoppedStateEntered	Dispatched when entering the stopped state.	FLVPlayback
tabChildrenChange	Dispatched when the value of the object's tabChildren flag changes.	InteractiveObject
tabEnabledChange	Dispatched when the object's tabEnabled flag changes.	InteractiveObject
tabIndexChange	Dispatched when the value of the object's tabIndex property changes.	InteractiveObject
textInput	Dispatched when a user enters one or more characters of text.	InteractiveObject
touchBegin	Dispatched 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
touchEnd	Dispatched 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
touchMove	Dispatched when the user touches the device, and is continuously dispatched until the point of contact is removed.	InteractiveObject
touchOut	Dispatched 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
touchOver	Dispatched 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
touchRollOut	Dispatched 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
touchRollOver	Dispatched 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
touchTap	Dispatched 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

	Constant		Defined 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

Examples How to use this example

FLVPlaybackExample.as

This example dynamically creates an FLVPlayback instance.

To run the example, follow these steps:

Place the FLVPlayback component on the Stage at 0,0 and provide the instance name player.
Replace videoPath with an absolute or relative path to an FLV file.
Save this code as FLVPlaybackExample.as in the same directory as your FLA file.
Set the Document class in the FLA file to FLVPlaybackExample.

Copy

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

[an error occurred while processing this directive]

Legal Notices | Online Privacy Policy

`backButton`	`playPauseButton`	`skin`	`width`
`bufferingBar`	`scaleX`	`stopButton`	`x`
`bufferingBarHidesAndDisablesOthers`	`transform`	`y`	`setSize()`
`forwardButton`	`scaleY`	`visible`	`setScale()`
`height`	`seekBar`	`volume`	`fullScreenBackgroundColor`
`muteButton`	`seekBarInterval`	`volumeBar`	`fullScreenButton`
`pauseButton`	`seekBarScrubTolerance`	`volumeBarInterval`	`fullScreenSkinDelay`
`playButton`	`seekToPrevOffset`	`volumeBarScrubTolerance`	`fullScreenTakeOver`
`registrationX`	`registrationY`	`registrationWidth`	`registrationHeight`
`skinBackgroundAlpha`	`skinBackgroundColor`	`skinFadeTime`

Parameter	Description
`canSeekToEnd`	A Boolean value that is `true` if the FLV file is encoded with a keyframe on the last frame that allows seeking to the end of a progressive download movie clip. It is `false` if the FLV file is not encoded with a keyframe on the last frame.
`cuePoints`	An array of objects, one for each cue point embedded in the FLV file. Value is undefined if the FLV file does not contain any cue points. Each object has the following properties: `type`—A string that specifies the type of cue point as either "navigation" or "event". `name`—A string that is the name of the cue point. `time`—A number that is the time of the cue point in seconds with a precision of three decimal places (milliseconds). `parameters`—An optional object that has name-value pairs that are designated by the user when creating the cue points.
`audiocodecid`	A number that indicates the audio codec (code/decode technique) that was used.
`audiodelay`	A number that represents time `0` in the source file from which the FLV file was encoded. Video content is delayed for the short period of time that is required to synchronize the audio. For example, if the `audiodelay` value is `.038`, the video that started at time `0` in the source file starts at time `.038` in the FLV file. Note that the FLVPlayback and VideoPlayer classes compensate for this delay in their time settings. This means that you can continue to use the time settings that you used in your the source file.
`audiodatarate`	A number that is the kilobytes per second of audio.
`videocodecid`	A number that is the codec version that was used to encode the video.
`framerate`	A number that is the frame rate of the FLV file.
`videodatarate`	A number that is the video data rate of the FLV file.
`height`	A number that is the height of the FLV file.
`width`	A number that is the width of the FLV file.
`duration`	A number that specifies the duration of the FLV file in seconds.

Property	Value
`bubbles`	`false`
`cancelable`	`false`; there is no default behavior to cancel.
`oldBounds`	The values of the `x`, `y`, `width`, and `height` properties of the target before the `autoLayout` event occurs.
`oldRegistrationBounds`	The values of the `registrationX`, `registrationY`, `registrationWidth`, and `registrationHeight` properties of the target before the `autoLayout` event occurs.
`vp`	The index of the VideoPlayer object.

Property	Value
`bubbles`	`false`
`cancelable`	`false`; there is no default behavior to cancel.
`state`	A string identifying the constant from the VideoState class that describes the playback state of the component.
`playheadTime`	A number that is the current playhead time or position.
`vp`	The index of the VideoPlayer object.

Property	Value
`bubbles`	`false`
`cancelable`	`false`; there is no default behavior to cancel.
`state`	A string identifying the constant from the VideoState class that describes the playback state of the component.
`playheadTime`	A number that is the current playhead time or position.
`vp`	The index of the VideoPlayer object.

	`timeOrCuePoint:*` — An object having `name` and `time` properties, which describe the cue point. It also might have a `parameters` property that holds name/value pairs. It may have the `type` property set to "`actionscript`". If the type is missing or set to something else, it is set automatically. If the object does not conform to these conventions, the method throws a VideoError error. The `time` property sets the time in seconds for a new cue point to be added and the `name` parameter must follow.

	`name:String` (default = `null`) — A string that specifies the name of the cue point if you submit a `time` parameter instead of the cue point.

	`parameters:Object` (default = `null`) — Optional parameters for the cue point if the `timeOrCuePoint` parameter is a number.

	`source:String` — A string that specifies the URL of the FLV file to stream and how to stream it. The URL can be a local path, an HTTP URL to an FLV file, an RTMP URL to an FLV file stream, or an HTTP URL to an XML file.

	`totalTime:Number` (default = `NaN`) — A number that is the total playing time for the video. Optional.

	`isLive:Boolean` (default = `false`) — A Boolean value that is `true` if the video stream is live. This value 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. Optional.

	`source:String` (default = `null`) — A string that specifies the URL of the FLV file to stream and how to stream it. The URL can be a local path, an HTTP URL to an FLV file, an RTMP URL to an FLV file stream, or an HTTP URL to an XML file. It is optional, but the `source` property must be set either through the Component inspector or through ActionScript or this method has no effect.

	`totalTime:Number` (default = `NaN`) — A number that is the total playing time for the video. Optional.

	`isLive:Boolean` (default = `false`) — A Boolean value that is `true` if the video stream is live. This value 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. Optional.

	`enabled:Boolean` — A Boolean value that specifies whether to enable (`true`) or disable (`false`) an FLV file cue point.

	`timeNameOrCuePoint:*` — If this parameter is a string, the method enables or disables the cue point with this name. If this parameter is a number, the method enables or disables the cue point with this time. If this parameter is an object, the method enables or disables the cue point with both the `name` and `time` properties.

	`scaleX:Number` — A number representing the horizontal scale.

	`scaleY:Number` — A number representing the vertical scale.

	`width:Number` — A number that specifies the width of the video player.

	`height:Number` — A number that specifies the height of the video player.

FLVPlayback - AS3 Flash

Packagesx

Language Elements

Appendixes

Package fl.video

activeVideoPlayerIndex

align

autoPlay

autoRewind

backButton

bitrate

buffering

bufferingBar

bufferingBarHidesAndDisablesOthers

bufferTime

bytesLoaded

bytesTotal

cuePoints

endTabIndex

forwardButton

fullScreenBackgroundColor

fullScreenButton

fullScreenSkinDelay

fullScreenTakeOver

height

idleTimeout

isLive

isRTMP

metadata

metadataLoaded

muteButton

ncMgr

pauseButton

paused

playButton

playheadPercentage

playheadTime

playheadUpdateInterval

playing

playPauseButton

preferredHeight

preferredWidth

preview

progressInterval

registrationHeight

registrationWidth

registrationX

registrationY

scaleMode

scaleX

scaleY

scrubbing

seekBar

seekBarInterval

seekBarScrubTolerance

seekToPrevOffset

skin

skinAutoHide

skinBackgroundAlpha

skinBackgroundColor

skinFadeTime

skinScaleMaximum

soundTransform

source

startTabIndex

state

stateResponsive

stopButton

stopped

totalTime

visibleVideoPlayerIndex

volume

volumeBar

volumeBarInterval

volumeBarScrubTolerance

width

x

y

addASCuePoint