Packagespark.components
Classpublic class VideoPlayer
InheritanceVideoPlayer Inheritance SkinnableComponent Inheritance UIComponent Inheritance FlexSprite Inheritance Sprite Inheritance DisplayObjectContainer Inheritance InteractiveObject Inheritance DisplayObject Inheritance EventDispatcher Inheritance Object

Language Version: ActionScript 3.0
Product Version: Flex 4
Runtime Versions: Flash Player 10, AIR 1.5

The VideoPlayer control is a skinnable video player that supports progressive download, multi-bitrate streaming, and streaming video. It supports playback of FLV and F4v files. The VideoPlayer control contains a full-featured UI for controlling video playback.

VideoElement is the chromeless version.

The VideoPlayer control has the following default characteristics:

CharacteristicDescription
Default size263 pixels wide by 184 pixels high
Minimum size0
Maximum size10000 pixels wide and 10000 pixels high
Default skin classspark.skins.spark.VideoPlayerSkin

MXML SyntaxexpandedHide MXML Syntax

The <s:VideoPlayer> tag inherits all of the tag attributes of its superclass and adds the following tag attributes:

  <s:VideoPlayer
  
    Properties
    autoPlay="true"
    autoRewind="false"
    enabled=""
    loop="false"
    maintainAspectRatio="true"
    muted="false"
    source=""
    volume=".75"
  
    Events
    close="No default"
    complete="No default"
    metadataReceived="No default"
    playheadUpdate="No default"
    progress="No default"
    ready="No default"
  />
  

Default MXML Propertysource

See also

spark.primitives.VideoElement
spark.skins.spark.VideoPlayerSkin
spark.skins.spark.mediaClasses.fullScreen.FullScreenButtonSkin
spark.skins.spark.mediaClasses.fullScreen.MuteButtonSkin
spark.skins.spark.mediaClasses.fullScreen.PlayPauseButtonSkin
spark.skins.spark.mediaClasses.fullScreen.ScrubBarSkin
spark.skins.spark.mediaClasses.fullScreen.ScrubBarThumbSkin
spark.skins.spark.mediaClasses.fullScreen.ScrubBarTrackSkin
spark.skins.spark.mediaClasses.fullScreen.VolumeBarSkin
spark.skins.spark.mediaClasses.fullScreen.VolumeBarThumbSkin
spark.skins.spark.mediaClasses.fullScreen.VolumeBarTrackSkin
spark.skins.spark.mediaClasses.normal.FullScreenButtonSkin
spark.skins.spark.mediaClasses.normal.MuteButtonSkin
spark.skins.spark.mediaClasses.normal.PlayPauseButtonSkin
spark.skins.spark.mediaClasses.normal.ScrubBarSkin
spark.skins.spark.mediaClasses.normal.ScrubBarThumbSkin
spark.skins.spark.mediaClasses.normal.ScrubBarTrackSkin
spark.skins.spark.mediaClasses.normal.VolumeBarSkin
spark.skins.spark.mediaClasses.normal.VolumeBarThumbSkin
spark.skins.spark.mediaClasses.normal.VolumeBarTrackSkin
VideoPlayer control


Public Properties
 PropertyDefined By
 InheritedaccessibilityProperties : AccessibilityProperties
The current accessibility options for this display object.
DisplayObject
 InheritedactiveEffects : Array
[read-only] The list of effects that are currently playing on the component, as an Array of EffectInstance instances.
UIComponent
 Inheritedalpha : Number
Indicates the alpha transparency value of the object specified.
DisplayObject
 InheritedautomationDelegate : Object
The delegate object that handles the automation-related functionality.
UIComponent
 InheritedautomationEnabled : Boolean
[read-only] True if this component is enabled for automation, false otherwise.
UIComponent
 InheritedautomationName : String
Name that can be used as an identifier for this object.
UIComponent
 InheritedautomationOwner : DisplayObjectContainer
[read-only] The owner of this component for automation purposes.
UIComponent
 InheritedautomationParent : DisplayObjectContainer
[read-only] The parent of this component for automation purposes.
UIComponent
 InheritedautomationTabularData : Object
[read-only] An implementation of the IAutomationTabularData interface, which can be used to retrieve the data.
UIComponent
 InheritedautomationValue : Array
[read-only] This value generally corresponds to the rendered appearance of the object and should be usable for correlating the identifier with the object as it appears visually within the application.
UIComponent
 InheritedautomationVisible : Boolean
[read-only] True if this component is visible for automation, false otherwise.
UIComponent
  autoPlay : Boolean
Specifies whether the video should start playing immediately when the source property is set.
VideoPlayer
  autoRewind : Boolean
Specifies whether the FLV file should be rewound to the first frame when play stops, either by calling the stop() method or by reaching the end of the stream.
VideoPlayer
 Inheritedbaseline : Object
The vertical distance in pixels from the anchor target to the control's baseline position.
UIComponent
 InheritedbaselinePosition : Number
[read-only] The y-coordinate of the baseline of the first line of text of the component.
UIComponent
 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
 Inheritedbottom : Object
The vertical distance in pixels from the bottom edge of the component to the anchor target's bottom edge.
UIComponent
 InheritedbuttonMode : Boolean
Specifies the button mode of this sprite.
Sprite
 InheritedcacheAsBitmap : Boolean
If set to true, Flash Player or Adobe AIR caches an internal bitmap representation of the display object.
DisplayObject
 InheritedcacheHeuristic : Boolean
[write-only] Used by Flex to suggest bitmap caching for the object.
UIComponent
 InheritedcachePolicy : String
Specifies the bitmap caching policy for this object.
UIComponent
 InheritedclassName : String
[read-only] The name of this instance's class, such as "Button".
UIComponent
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
 InheritedcontentMouseX : Number
[read-only] Returns the x position of the mouse, in the content coordinate system.
UIComponent
 InheritedcontentMouseY : Number
[read-only] Returns the y position of the mouse, in the content coordinate system.
UIComponent
 InheritedcontextMenu : NativeMenu
Specifies the context menu associated with this object.
InteractiveObject
 InheritedcurrentState : String
The current view state of the component.
UIComponent
 InheritedcursorManager : ICursorManager
[read-only] Gets the CursorManager that controls the cursor for this component and its peers.
UIComponent
 Inheriteddepth : Number
Determines the order in which items inside of containers are rendered.
UIComponent
 Inheriteddescriptor : UIComponentDescriptor
Reference to the UIComponentDescriptor, if any, that was used by the createComponentFromDescriptor() method to create this UIComponent instance.
UIComponent
 InheriteddesignLayer : DesignLayer
Specifies the optional DesignLayer instance associated with this visual element.
UIComponent
 Inheriteddocument : Object
A reference to the document object associated with this UIComponent.
UIComponent
 InheriteddoubleClickEnabled : Boolean
[override] Specifies whether the UIComponent object receives doubleClick events.
UIComponent
 InheriteddropTarget : DisplayObject
[read-only] Specifies the display object over which the sprite is being dragged, or on which the sprite was dropped.
Sprite
  enabled : Boolean
[override] Setting enabled to false disables the UI and pauses the video if it was currently playing.
VideoPlayer
 InheritederrorString : String
The text that will be displayed by a component's error tip when a component is monitored by a Validator and validation fails.
UIComponent
 InheritedexplicitHeight : Number
Number that specifies the explicit height of the component, in pixels, in the component's coordinates.
UIComponent
 InheritedexplicitMaxHeight : Number
The maximum recommended height of the component to be considered by the parent during layout.
UIComponent
 InheritedexplicitMaxWidth : Number
The maximum recommended width of the component to be considered by the parent during layout.
UIComponent
 InheritedexplicitMinHeight : Number
The minimum recommended height of the component to be considered by the parent during layout.
UIComponent
 InheritedexplicitMinWidth : Number
The minimum recommended width of the component to be considered by the parent during layout.
UIComponent
 InheritedexplicitWidth : Number
Number that specifies the explicit width of the component, in pixels, in the component's coordinates.
UIComponent
 Inheritedfilters : Array
An indexed array that contains each filter object currently associated with the display object.
DisplayObject
 InheritedflexContextMenu : IFlexContextMenu
The context menu for this UIComponent.
UIComponent
 InheritedfocusEnabled : Boolean
Indicates whether the component can receive focus when tabbed to.
UIComponent
 InheritedfocusManager : IFocusManager
Gets the FocusManager that controls focus for this component and its peers.
UIComponent
 InheritedfocusPane : Sprite
The focus pane associated with this object.
UIComponent
 InheritedfocusRect : Object
Specifies whether this object displays a focus rectangle.
InteractiveObject
 Inheritedgraphics : Graphics
[read-only] Specifies the Graphics object that belongs to this sprite where vector drawing commands can occur.
Sprite
 InheritedhasFocusableChildren : Boolean
A flag that indicates whether child objects can receive focus This is similar to the tabChildren property used by Flash Player. This is usually false because most components either receive focus themselves or delegate focus to a single internal sub-component and appear as if the component has received focus.
UIComponent
 InheritedhasLayoutMatrix3D : Boolean
[read-only] True if the element has 3D Matrix.
UIComponent
 Inheritedheight : Number
[override] Number that specifies the height of the component, in pixels, in the parent's coordinates.
UIComponent
 InheritedhitArea : Sprite
Designates another sprite to serve as the hit area for a sprite.
Sprite
 InheritedhorizontalCenter : Object
The horizontal distance in pixels from the center of the component to the center of the anchor target's content area.
UIComponent
 Inheritedid : String
ID of the component.
UIComponent
 InheritedincludeInLayout : Boolean
Specifies whether this component is included in the layout of the parent container.
UIComponent
 InheritedinheritingStyles : Object
The beginning of this component's chain of inheriting styles.
UIComponent
 Inheritedinitialized : Boolean
A flag that determines if an object has been through all three phases of layout: commitment, measurement, and layout (provided that any were required).
UIComponent
 InheritedinstanceIndex : int
[read-only] The index of a repeated component.
UIComponent
 InheritedinstanceIndices : Array
An Array containing the indices required to reference this UIComponent object from its parent document.
UIComponent
 Inheritedis3D : Boolean
[read-only] True, when the element is in 3D.
UIComponent
 InheritedisDocument : Boolean
[read-only] Determines whether this UIComponent instance is a document object, that is, whether it is at the top of the hierarchy of a Flex application, MXML component, or ActionScript component.
UIComponent
 InheritedisPopUp : Boolean
Set to true by the PopUpManager to indicate that component has been popped up.
UIComponent
 InheritedlayoutMatrix3D : Matrix3D
[write-only] The transform matrix that is used to calculate a component's layout relative to its siblings.
UIComponent
 Inheritedleft : Object
The horizontal distance in pixels from the left edge of the component to the anchor target's left edge.
UIComponent
 InheritedloaderInfo : LoaderInfo
[read-only] Returns a LoaderInfo object containing information about loading the file to which this display object belongs.
DisplayObject
  loop : Boolean
Indicates whether the media should play again after playback has completed.
VideoPlayer
  maintainAspectRatio : Boolean
Specifies whether the control should maintain the original aspect ratio while resizing the video.
VideoPlayer
 InheritedmaintainProjectionCenter : Boolean
When true, the component will keep its projection matrix centered on the middle of its bounding box.
UIComponent
 Inheritedmask : DisplayObject
The calling display object is masked by the specified mask object.
DisplayObject
 InheritedmaxHeight : Number
The maximum recommended height of the component to be considered by the parent during layout.
UIComponent
 InheritedmaxWidth : Number
The maximum recommended width of the component to be considered by the parent during layout.
UIComponent
 InheritedmeasuredHeight : Number
The default height of the component, in pixels.
UIComponent
 InheritedmeasuredMinHeight : Number
The default minimum height of the component, in pixels.
UIComponent
 InheritedmeasuredMinWidth : Number
The default minimum width of the component, in pixels.
UIComponent
 InheritedmeasuredWidth : Number
The default width of the component, in pixels.
UIComponent
 InheritedminHeight : Number
The minimum recommended height of the component to be considered by the parent during layout.
UIComponent
 InheritedminWidth : Number
The minimum recommended width of the component to be considered by the parent during layout.
UIComponent
 InheritedmoduleFactory : IFlexModuleFactory
A module factory is used as context for using embeded fonts and for finding the style manager that controls the styles for this component.
UIComponent
 InheritedmouseChildren : Boolean
Determines whether or not the children of the object are mouse enabled.
DisplayObjectContainer
 InheritedmouseEnabled : Boolean
Specifies whether this object receives mouse messages.
InteractiveObject
 InheritedmouseFocusEnabled : Boolean
Whether you can receive focus when clicked on.
UIComponent
 InheritedmouseX : Number
[read-only] Indicates the x coordinate of the mouse position, in pixels.
DisplayObject
 InheritedmouseY : Number
[read-only] Indicates the y coordinate of the mouse position, in pixels.
DisplayObject
  muted : Boolean
Set to true to mute the video, false to unmute the video.
VideoPlayer
 Inheritedname : String
Indicates the instance name of the DisplayObject.
DisplayObject
 InheritednestLevel : int
Depth of this object in the containment hierarchy.
UIComponent
 InheritednonInheritingStyles : Object
The beginning of this component's chain of non-inheriting styles.
UIComponent
 InheritednumAutomationChildren : int
[read-only] The number of automation children this container has.
UIComponent
 InheritedopaqueBackground : Object
Specifies whether the display object is opaque with a certain background color.
DisplayObject
 Inheritedowner : DisplayObjectContainer
The owner of this IVisualElement object.
UIComponent
 Inheritedparent : DisplayObjectContainer
[override] [read-only]
UIComponent
 InheritedparentApplication : Object
[read-only] A reference to the Application object that contains this UIComponent instance.
UIComponent
 InheritedparentDocument : Object
[read-only] A reference to the parent document object for this UIComponent.
UIComponent
 InheritedpercentHeight : Number
Number that specifies the height of a component as a percentage of its parent's size.
UIComponent
 InheritedpercentWidth : Number
Number that specifies the width of a component as a percentage of its parent's size.
UIComponent
  playheadTime : Number
[read-only] Playhead position, measured in seconds, since the video starting playing.
VideoPlayer
  playing : Boolean
[read-only] Returns true if the video is playing or is attempting to play.
VideoPlayer
  playWhenHidden : Boolean
Controls whether the video continues to play when it is hidden.
VideoPlayer
 InheritedpostLayoutTransformOffsets : mx.geom:TransformOffsets
UIComponent
 InheritedprocessedDescriptors : Boolean
Set to true after immediate or deferred child creation, depending on which one happens.
UIComponent
 Inheritedprototype : Object
[static] A reference to the prototype object of a class or function object.
Object
 Inheritedrepeater : IRepeater
[read-only] A reference to the Repeater object in the parent document that produced this UIComponent.
UIComponent
 InheritedrepeaterIndex : int
[read-only] The index of the item in the data provider of the Repeater that produced this UIComponent.
UIComponent
 InheritedrepeaterIndices : Array
An Array containing the indices of the items in the data provider of the Repeaters in the parent document that produced this UIComponent.
UIComponent
 Inheritedrepeaters : Array
An Array containing references to the Repeater objects in the parent document that produced this UIComponent.
UIComponent
 Inheritedright : Object
The horizontal distance in pixels from the right edge of the component to the anchor target's right edge.
UIComponent
 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
[override]
UIComponent
 InheritedrotationX : Number
[override] Indicates the x-axis rotation of the DisplayObject instance, in degrees, from its original orientation relative to the 3D parent container.
UIComponent
 InheritedrotationY : Number
[override] Indicates the y-axis rotation of the DisplayObject instance, in degrees, from its original orientation relative to the 3D parent container.
UIComponent
 InheritedrotationZ : Number
[override] Indicates the z-axis rotation of the DisplayObject instance, in degrees, from its original orientation relative to the 3D parent container.
UIComponent
 Inheritedscale9Grid : Rectangle
The current scaling grid that is in effect.
DisplayObject
 InheritedscaleX : Number
[override] Number that specifies the horizontal scaling factor.
UIComponent
 InheritedscaleY : Number
[override] Number that specifies the vertical scaling factor.
UIComponent
 InheritedscaleZ : Number
[override] Number that specifies the scaling factor along the z axis.
UIComponent
 Inheritedscreen : Rectangle
[read-only] Returns an object that contains the size and position of the base drawing surface for this object.
UIComponent
 InheritedscrollRect : Rectangle
The scroll rectangle bounds of the display object.
DisplayObject
 InheritedshowInAutomationHierarchy : Boolean
A flag that determines if an automation object shows in the automation hierarchy.
UIComponent
 Inheritedskin : UIComponent
[read-only] The instance of the skin class for this component instance.
SkinnableComponent
 InheritedsoundTransform : flash.media:SoundTransform
Controls sound within this sprite.
Sprite
  source : Object
For progressive download, the source is just a path or URL pointing to the video file to play.
VideoPlayer
 Inheritedstage : Stage
[read-only] The Stage of the display object.
DisplayObject
 Inheritedstates : Array
The view states that are defined for this component.
UIComponent
 InheritedstyleDeclaration : CSSStyleDeclaration
Storage for the inline inheriting styles on this object.
UIComponent
 InheritedstyleName : Object
The class style used by this component.
UIComponent
 InheritedstyleParent : IAdvancedStyleClient
[read-only] A component's parent is used to evalate descendant selectors.
UIComponent
 InheritedsystemManager : ISystemManager
Returns the SystemManager object used by this component.
UIComponent
 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
 InheritedtabFocusEnabled : Boolean
A flag that indicates whether this object can receive focus via the TAB key This is similar to the tabEnabled property used by the Flash Player. This is usually true for components that handle keyboard input, but some components in controlbars have them set to false because they should not steal focus from another component like an editor.
UIComponent
 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
 InheritedtoolTip : String
Text to display in the ToolTip.
UIComponent
 Inheritedtop : Object
The vertical distance in pixels from the top edge of the component to the anchor target's top edge.
UIComponent
  totalTime : Number
[read-only] Total time for the video feed.
VideoPlayer
 Inheritedtransform : flash.geom:Transform
An object with properties pertaining to a display object's matrix, color transform, and pixel bounds.
DisplayObject
 InheritedtransformX : Number
Sets the x coordinate for the transform center of the component.
UIComponent
 InheritedtransformY : Number
Sets the y coordinate for the transform center of the component.
UIComponent
 InheritedtransformZ : Number
Sets the z coordinate for the transform center of the component.
UIComponent
 Inheritedtransitions : Array
An Array of Transition objects, where each Transition object defines a set of effects to play when a view state change occurs.
UIComponent
 InheritedtweeningProperties : Array
Array of properties that are currently being tweened on this object.
UIComponent
 Inheriteduid : String
A unique identifier for the object.
UIComponent
 InheritedupdateCompletePendingFlag : Boolean
A flag that determines if an object has been through all three phases of layout validation (provided that any were required).
UIComponent
 InheriteduseHandCursor : Boolean
A Boolean value that indicates whether the pointing hand (hand cursor) appears when the mouse rolls over a sprite in which the buttonMode property is set to true.
Sprite
 InheritedvalidationSubField : String
Used by a validator to associate a subfield with this component.
UIComponent
 InheritedverticalCenter : Object
The vertical distance in pixels from the center of the component to the center of the anchor target's content area.
UIComponent
 Inheritedvisible : Boolean
[override]
UIComponent
  volume : Number
The volume level, specified as an value between 0 and 1.
VideoPlayer
 Inheritedwidth : Number
[override] Number that specifies the width of the component, in pixels, in the parent's coordinates.
UIComponent
 Inheritedx : Number
[override] Number that specifies the component's horizontal position, in pixels, within its parent container.
UIComponent
 Inheritedy : Number
[override] Number that specifies the component's vertical position, in pixels, within its parent container.
UIComponent
 Inheritedz : Number
[override] Indicates the z coordinate position along the z-axis of the DisplayObject instance relative to the 3D parent container.
UIComponent
Protected Properties
 PropertyDefined By
 InheritedcurrentCSSState : String
[override] [read-only] The state to be used when matching CSS pseudo-selectors.
SkinnableComponent
 InheritedhasComplexLayoutMatrix : Boolean
[read-only] Returns true if the UIComponent has any non-translation (x,y) transform properties
UIComponent
 InheritedresourceManager : IResourceManager
[read-only] A reference to the object which manages all of the application's localized resources.
UIComponent
 InheritedunscaledHeight : Number
[read-only] A convenience method for determining the unscaled height of the component.
UIComponent
 InheritedunscaledWidth : Number
[read-only] A convenience method for determining the unscaled width of the component All of a component's drawing and child layout should be done within a bounding rectangle of this width, which is also passed as an argument to updateDisplayList().
UIComponent
Public Methods
 MethodDefined By
  
Constructor.
VideoPlayer
 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
 Inherited
callLater(method:Function, args:Array = null):void
Queues a function to be called later.
UIComponent
 Inherited
Deletes a style property from this component instance.
UIComponent
 Inherited
Determines whether the specified display object is a child of the DisplayObjectContainer instance or the instance itself.
DisplayObjectContainer
 Inherited
Converts a Point object from content coordinates to global coordinates.
UIComponent
 Inherited
Converts a Point object from content to local coordinates.
UIComponent
 Inherited
Returns a set of properties that identify the child within this container.
UIComponent
 Inherited
Returns a set of properties as automation ID that identify the child within this container.
UIComponent
 Inherited
Creates an id reference to this IUIComponent object on its parent document object.
UIComponent
 Inherited
Deletes the id reference to this IUIComponent object on its parent document object.
UIComponent
 Inherited
Returns a UITextFormat object corresponding to the text styles for this UIComponent.
UIComponent
 Inherited
[override] Dispatches an event into the event flow.
UIComponent
 Inherited
Shows or hides the focus indicator around this component.
UIComponent
 Inherited
drawRoundRect(x:Number, y:Number, w:Number, h:Number, r:Object = null, c:Object = null, alpha:Object = null, rot:Object = null, gradient:String = null, ratios:Array = null, hole:Object = null):void
Programatically draws a rectangle into this skin's Graphics object.
UIComponent
 Inherited
Called by the effect instance when it stops playing on the component.
UIComponent
 Inherited
Called by the effect instance when it starts playing on the component.
UIComponent
 Inherited
Ends all currently playing effects on the component.
UIComponent
 Inherited
executeBindings(recurse:Boolean = false):void
Executes all the bindings for which the UIComponent object is the destination.
UIComponent
 Inherited
Called after printing is complete.
UIComponent
 Inherited
Provides the automation object at the specified index.
UIComponent
 Inherited
Provides the automation object list .
UIComponent
 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
getBoundsXAtSize(width:Number, height:Number, postLayoutTransform:Boolean = true):Number
Returns the x coordinate of the element's bounds at the specified element size.
UIComponent
 Inherited
getBoundsYAtSize(width:Number, height:Number, postLayoutTransform:Boolean = true):Number
Returns the y coordinate of the element's bounds at the specified element size.
UIComponent
 Inherited
Returns the child display object that exists with the specified name.
DisplayObjectContainer
 Inherited
Finds the type selectors for this UIComponent instance.
UIComponent
 Inherited
getConstraintValue(constraintName:String):*
Returns a layout constraint value, which is the same as getting the constraint style for this component.
UIComponent
 Inherited
A convenience method for determining whether to use the explicit or measured height
UIComponent
 Inherited
A convenience method for determining whether to use the explicit or measured width
UIComponent
 Inherited
Gets the object that currently has focus.
UIComponent
 Inherited
getLayoutBoundsHeight(postLayoutTransform:Boolean = true):Number
Returns the element's layout height.
UIComponent
 Inherited
getLayoutBoundsWidth(postLayoutTransform:Boolean = true):Number
Returns the element's layout width.
UIComponent
 Inherited
getLayoutBoundsX(postLayoutTransform:Boolean = true):Number
Returns the x coordinate that the element uses to draw on screen.
UIComponent
 Inherited
getLayoutBoundsY(postLayoutTransform:Boolean = true):Number
Returns the y coordinate that the element uses to draw on screen.
UIComponent
 Inherited
Returns the transform matrix that is used to calculate the component's layout relative to its siblings.
UIComponent
 Inherited
Returns the layout transform Matrix3D for this element.
UIComponent
 Inherited
getMaxBoundsHeight(postLayoutTransform:Boolean = true):Number
Returns the element's maximum height.
UIComponent
 Inherited
getMaxBoundsWidth(postLayoutTransform:Boolean = true):Number
Returns the element's maximum width.
UIComponent
 Inherited
getMinBoundsHeight(postLayoutTransform:Boolean = true):Number
Returns the element's minimum height.
UIComponent
 Inherited
getMinBoundsWidth(postLayoutTransform:Boolean = true):Number
Returns the element's minimum width.
UIComponent
 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
getPreferredBoundsHeight(postLayoutTransform:Boolean = true):Number
Returns the element's preferred height.
UIComponent
 Inherited
getPreferredBoundsWidth(postLayoutTransform:Boolean = true):Number
Returns the element's preferred width.
UIComponent
 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
 Inherited
getRepeaterItem(whichRepeater:int = -1):Object
Returns the item in the dataProvider that was used by the specified Repeater to produce this Repeater, or null if this Repeater isn't repeated.
UIComponent
 Inherited
getStyle(styleProp:String):*
Gets a style property that has been set anywhere in this component's style lookup chain.
UIComponent
 Inherited
Converts a Point object from global to content coordinates.
UIComponent
 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
Determines whether the specified state has been defined on this UIComponent.
UIComponent
 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
 Inherited
Returns a box Matrix which can be passed to the drawRoundRect() method as the rot parameter when drawing a horizontal gradient.
UIComponent
 Inherited
Initializes the internal structure of this component.
UIComponent
 Inherited
Initializes various properties which keep track of repeated instances of this component.
UIComponent
 Inherited
Marks a component so that its updateDisplayList() method gets called during a later screen update.
UIComponent
 Inherited
Called by a component's items to indicate that their depth property has changed.
UIComponent
 Inherited
Marks a component so that its commitProperties() method gets called during a later screen update.
UIComponent
 Inherited
Marks a component so that its measure() method gets called during a later screen update.
UIComponent
 Inherited
Marks the component so that the new state of the skin will get set during a later screen update.
SkinnableComponent
 Inherited
Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.
Object
 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 a Point object from local to content coordinates.
UIComponent
 Inherited
Converts the point object from the display object's (local) coordinates to the Stage (global) coordinates.
DisplayObject
 Inherited
Determins whether the current state of this component matches a CSS pseudo-selector.
UIComponent
 Inherited
Determines whether this component is assignable to the given CSS type.
UIComponent
 Inherited
Measures the specified HTML text, which may contain HTML tags such as <font> and <b>, assuming that it is displayed in a single-line UITextField using a UITextFormat determined by the styles of this UIComponent.
UIComponent
 Inherited
Measures the specified text, assuming that it is displayed in a single-line UITextField using a UITextFormat determined by the styles of this UIComponent.
UIComponent
 Inherited
Moves the component to a specified position within its parent.
UIComponent
 Inherited
Propagates style changes to the children.
UIComponent
 Inherited
Returns true if the chain of owner properties points from child to this UIComponent.
UIComponent
 Inherited
Called by Flex when a UIComponent object is added to or removed from a parent.
UIComponent
  
Pauses playback without moving the playhead.
VideoPlayer
  
Causes the video to play.
VideoPlayer
 Inherited
Prepares an IFlexDisplayObject for printing.
UIComponent
 Inherited
Indicates whether the specified property exists and is enumerable.
Object
 Inherited
Builds or rebuilds the CSS style cache for this component and, if the recursive parameter is true, for all descendants of this component as well.
UIComponent
 Inherited
For each effect event, registers the EffectManager as one of the event listeners.
UIComponent
 Inherited
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
Removes a listener from the EventDispatcher object.
EventDispatcher
 Inherited
Replays the specified event.
UIComponent
 Inherited
Resolves a child by using the id provided.
UIComponent
 Inherited
[static] Resumes the background processing of methods queued by callLater(), after a call to suspendBackgroundProcessing().
UIComponent
  
Seeks to given second in video.
VideoPlayer
 Inherited
Sizes the object.
UIComponent
 Inherited
setConstraintValue(constraintName:String, value:*):void
Sets a layout constraint value, which is the same as setting the constraint style for this component.
UIComponent
 Inherited
setCurrentState(stateName:String, playTransition:Boolean = true):void
Set the current state.
UIComponent
 Inherited
Sets the focus to this component.
UIComponent
 Inherited
setLayoutBoundsPosition(x:Number, y:Number, postLayoutTransform:Boolean = true):void
Sets the coordinates that the element uses to draw on screen.
UIComponent
 Inherited
setLayoutBoundsSize(width:Number, height:Number, postLayoutTransform:Boolean = true):void
Sets the layout size to the specified dimensions.
UIComponent
 Inherited
setLayoutMatrix(value:Matrix, invalidateLayout:Boolean):void
Sets the transform Matrix that is used to calculate the component's layout size and position relative to its siblings.
UIComponent
 Inherited
setLayoutMatrix3D(value:Matrix3D, invalidateLayout:Boolean):void
Similarly to the layoutMatrix3D property, sets the layout Matrix3D, but doesn't trigger a layout pass.
UIComponent
 Inherited
Sets the availability of a dynamic property for loop operations.
Object
 Inherited
setStyle(styleProp:String, newValue:*):void
Sets a style property on this component instance.
UIComponent
 Inherited
setVisible(value:Boolean, noEvent:Boolean = false):void
Called when the visible property changes.
UIComponent
 Inherited
startDrag(lockCenter:Boolean = false, bounds:Rectangle = null):void
Lets the user drag the specified sprite.
Sprite
  
Stops video playback.
VideoPlayer
 Inherited
Ends the startDrag() method.
Sprite
 Inherited
Detects changes to style properties.
UIComponent
 Inherited
Flex calls the stylesInitialized() method when the styles for a component are first initialized.
UIComponent
 Inherited
[static] Blocks the background processing of methods queued by callLater(), until resumeBackgroundProcessing() is called.
UIComponent
 Inherited
Returns the string representation of this object, formatted according to locale-specific conventions.
Object
 Inherited
[override] Returns a string indicating the location of this object within the hierarchy of DisplayObjects in the Application.
FlexSprite
 Inherited
transformAround(transformCenter:Vector3D, scale:Vector3D = null, rotation:Vector3D = null, translation:Vector3D = null, postLayoutScale:Vector3D = null, postLayoutRotation:Vector3D = null, postLayoutTranslation:Vector3D = null):void
UIComponent
 Inherited
transformPointToParent(transformCenter:Vector3D, position:Vector3D, postLayoutPosition:Vector3D):void
FIXME (chaase) : FLEXDOCS-1031
UIComponent
 Inherited
Validates the position and size of children and draws other visuals.
UIComponent
 Inherited
Validate and update the properties and layout of this object and redraw it, if necessary.
UIComponent
 Inherited
Used by layout logic to validate the properties of a component by calling the commitProperties() method.
UIComponent
 Inherited
validateSize(recursive:Boolean = false):void
Validates the measured size of the component If the LayoutManager.invalidateSize() method is called with this ILayoutManagerClient, then the validateSize() method is called when it's time to do measurements.
UIComponent
 Inherited
Handles both the valid and invalid events from a validator assigned to this component.
UIComponent
 Inherited
Returns the primitive value of the specified object.
Object
 Inherited
Returns a box Matrix which can be passed to drawRoundRect() as the rot parameter when drawing a vertical gradient.
UIComponent
 Inherited
Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type.
EventDispatcher
Protected Methods
 MethodDefined By
 Inherited
Adjust the focus rectangle.
UIComponent
 Inherited
Commits the computed matrix built from the combination of the layout matrix and the transform offsets to the flash displayObject's transform.
UIComponent
 Inherited
This is an internal method used by the Flex framework to support the Dissolve effect.
UIComponent
 Inherited
Create the skin for the component.
SkinnableComponent
 Inherited
Determines if the call to the measure() method can be skipped.
UIComponent
 Inherited
Performs any final processing after child objects are created.
UIComponent
 Inherited
Clear out references to skin parts.
SkinnableComponent
 Inherited
Processes the properties set on the component.
UIComponent
 Inherited
Create child objects of the component.
UIComponent
 Inherited
Create an instance of a dynamic skin part.
SkinnableComponent
 Inherited
Creates a new object using a context based on the embedded font being used.
UIComponent
 Inherited
Creates the object using a given moduleFactory.
UIComponent
 Inherited
Destroys and removes the skin for this component.
SkinnableComponent
 Inherited
dispatchPropertyChangeEvent(prop:String, oldValue:*, value:*):void
Helper method for dispatching a PropertyChangeEvent when a property is updated.
UIComponent
 Inherited
Find the skin parts in the skin class and assign them to the properties of the component.
SkinnableComponent
 Inherited
The event handler called when a UIComponent object gets focus.
UIComponent
 Inherited
The event handler called when a UIComponent object loses focus.
UIComponent
  
Formats a time value, given in seconds, into a string that gets used for the playheadTimeDisplay and the totalTimeDisplay.
VideoPlayer
 Inherited
Returns the name of the state to be applied to the skin.
SkinnableComponent
 Inherited
Returns a specific instance of a dynamic part.
SkinnableComponent
 Inherited
Initializes the implementation and storage of some of the less frequently used advanced layout features of a component.
UIComponent
 Inherited
Finalizes the initialization of this component.
UIComponent
 Inherited
Initializes this component's accessibility code.
UIComponent
 Inherited
Helper method to invalidate parent size and display list if this object affects its layout (includeInLayout is true).
UIComponent
 Inherited
Typically overridden by components containing UITextField objects, where the UITextField object gets focus.
UIComponent
 Inherited
The event handler called for a keyDown event.
UIComponent
 Inherited
The event handler called for a keyUp event.
UIComponent
 Inherited
Calculates the default size, and optionally the default minimum size, of the component.
UIComponent
 Inherited
UIComponent
 Inherited
Returns the number of instances of a dynamic part.
SkinnableComponent
 Inherited
partAdded(partName:String, instance:Object):void
Called when a skin part is added.
SkinnableComponent
 Inherited
partRemoved(partName:String, instance:Object):void
Called when an instance of a skin part is being removed.
SkinnableComponent
 Inherited
Remove an instance of a dynamic part.
SkinnableComponent
 Inherited
This method is called when a UIComponent is constructed, and again whenever the ResourceManager dispatches a "change" Event to indicate that the localized resources have changed in some way.
UIComponent
 Inherited
setStretchXY(stretchX:Number, stretchY:Number):void
Specifies a transform stretch factor in the horizontal and vertical direction.
UIComponent
 Inherited
stateChanged(oldState:String, newState:String, recursive:Boolean):void
This method is called when a state changes to check whether state-specific styles apply to this component.
UIComponent
 Inherited
updateDisplayList(unscaledWidth:Number, unscaledHeight:Number):void
Draws the object and/or sizes and positions its children.
UIComponent
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 the component is added to a container as a content child by using the addChild(), addChildAt(), addElement(), or addElementAt() method.UIComponent
 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
 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 NetConnection is closed, whether by being timed out, by calling the close() method, or by loading a new video stream.VideoPlayer
  Dispatched when playing completes because the player reached the end of the FLV file.VideoPlayer
 InheritedDispatched 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
 InheritedDispatched when the component has finished its construction, property processing, measuring, layout, and drawing.UIComponent
 InheritedDispatched after the view state has changed.UIComponent
 InheritedDispatched after the currentState property changes, but before the view state changes.UIComponent
 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
 InheritedDispatched by the drag initiator (the component that is the source of the data being dragged) when the drag operation completes, either when you drop the dragged data onto a drop target or when you end the drag-and-drop operation without performing a drop.UIComponent
 InheritedDispatched by the drop target when the user releases the mouse over it.UIComponent
 InheritedDispatched by a component when the user moves the mouse over the component during a drag operation.UIComponent
 InheritedDispatched by the component when the user drags outside the component, but does not drop the data onto the target.UIComponent
 InheritedDispatched by a component when the user moves the mouse while over the component during a drag operation.UIComponent
 InheritedDispatched by the drag initiator when starting a drag operation.UIComponent
 InheritedDispatched after an effect ends.UIComponent
 InheritedDispatched just before an effect starts.UIComponent
 InheritedDispatched after an effect is stopped, which happens only by a call to stop() on the effect.UIComponent
 Inherited[broadcast event] Dispatched when the playhead is entering a new frame.DisplayObject
 InheritedDispatched after the component has entered a view state.UIComponent
 Inherited[broadcast event] Dispatched when the playhead is exiting the current frame.DisplayObject
 InheritedDispatched just before the component exits a view state.UIComponent
 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 an object's state changes from visible to invisible.UIComponent
 InheritedDispatched when the component has finished its construction and has all initialization properties set.UIComponent
 InheritedDispatched when a component is monitored by a Validator and the validation failed.UIComponent
 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 the first time the FLV file's metadata is reached.VideoPlayer
 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 from a component opened using the PopUpManager when the user clicks outside it.UIComponent
 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 from a component opened using the PopUpManager when the user scrolls the mouse wheel outside it.UIComponent
 InheritedDispatched when the object has moved.UIComponent
 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 every 0.25 seconds while the video is playing.VideoPlayer
 InheritedDispatched at the beginning of the component initialization sequence.UIComponent
  Indicates progress made in number of bytes downloaded.VideoPlayer
  Dispatched when the video is loaded and ready to display.VideoPlayer
 InheritedDispatched when the component is removed from a container as a content child by using the removeChild(), removeChildAt(), removeElement(), or removeElementAt() method.UIComponent
 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
 InheritedDispatched when the component is resized.UIComponent
 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
 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
 InheritedDispatched when an object's state changes from invisible to visible.UIComponent
 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 by the component when it is time to create a ToolTip.UIComponent
 InheritedDispatched by the component when its ToolTip has been hidden and will be discarded soon.UIComponent
 InheritedDispatched by the component when its ToolTip is about to be hidden.UIComponent
 InheritedDispatched by the component when its ToolTip is about to be shown.UIComponent
 InheritedDispatched by the component when its ToolTip has been shown.UIComponent
 InheritedDispatched by a component whose toolTip property is set, as soon as the user moves the mouse over it.UIComponent
 InheritedDispatched when an object has had its commitProperties(), measure(), and updateDisplayList() methods called (if needed).UIComponent
 InheritedDispatched when a component is monitored by a Validator and the validation succeeded.UIComponent
 InheritedDispatched when values are changed programmatically or by user interaction.UIComponent
Styles
 Style Description Defined By
  
alignmentBaseline
Type: String CSS Inheritance: yes
Specifies the baseline to which the dominant baseline aligns. For example, if you set dominantBaseline to ASCENT, setting alignmentBaseline to DESCENT aligns the top of the text with the DESCENT baseline, or below the line. The largest element in the line generally determines the baselines.

baselines

Legal values are flash.text.engine.TextBaseline.ROMAN, flash.text.engine.TextBaseline.ASCENT, flash.text.engine.TextBaseline.DESCENT, flash.text.engine.TextBaseline.IDEOGRAPHIC_TOP, flash.text.engine.TextBaseline.IDEOGRAPHIC_CENTER, flash.text.engine.TextBaseline.IDEOGRAPHIC_BOTTOM, flash.text.engine.TextBaseline.USE_DOMINANT_BASELINE, flashx.textLayout.formats.FormatValue.INHERIT.

Default value is undefined indicating not set.

If undefined during the cascade this property will inherit its value from an ancestor. If no ancestor has set this property, it will have a value of USE_DOMINANT_BASELINE.

VideoPlayer
 InheritedType: uint Format: Color CSS Inheritance: yes Theme: spark
SkinnableComponent
 InheritedType: String CSS Inheritance: no
The vertical distance in pixels from the top edge of the content area to the control's baseline position.
UIComponent
  
baselineShift
Type: Object CSS Inheritance: yes
Amount to shift the baseline from the dominantBaseline value. Units are in pixels, or a percentage of fontSize (in which case, enter a string value, like 140%). Positive values shift the line up for horizontal text (right for vertical) and negative values shift it down for horizontal (left for vertical).

Legal values are flashx.textLayout.formats.BaselineShift.SUPERSCRIPT, flashx.textLayout.formats.BaselineShift.SUBSCRIPT, flashx.textLayout.formats.FormatValue.INHERIT.

Legal values as a number are from -1000 to 1000.

Legal values as a percent are numbers from -1000 to 1000.

Default value is undefined indicating not set.

If undefined during the cascade this property will inherit its value from an ancestor. If no ancestor has set this property, it will have a value of 0.0.

VideoPlayer
 InheritedType: String CSS Inheritance: no
The vertical distance in pixels from the lower edge of the component to the lower edge of its content area.
UIComponent
  
cffHinting
Type: String CSS Inheritance: yes
The type of CFF hinting used for this text. CFF hinting determines whether the Flash runtime forces strong horizontal stems to fit to a sub pixel grid or not. This property applies only if the renderingMode property is set to RenderingMode.CFF, and the font is embedded (fontLookup property is set to FontLookup.EMBEDDED_CFF). At small screen sizes, hinting produces a clear, legible text for human readers.

Legal values are flash.text.engine.CFFHinting.NONE, flash.text.engine.CFFHinting.HORIZONTAL_STEM, flashx.textLayout.formats.FormatValue.INHERIT.

Default value is undefined indicating not set.

If undefined during the cascade this property will inherit its value from an ancestor. If no ancestor has set this property, it will have a value of HORIZONTAL_STEM.

VideoPlayer
  
color
Type: uint Format: Color CSS Inheritance: yes
Color of the text. A hexadecimal number that specifies three 8-bit RGB (red, green, blue) values; for example, 0xFF0000 is red and 0x00FF00 is green.

Default value is undefined indicating not set.

If undefined during the cascade this property will inherit its value from an ancestor. If no ancestor has set this property, it will have a value of 0.

VideoPlayer
  
digitCase
Type: String CSS Inheritance: yes
The type of digit case used for this text. Setting the value to DigitCase.OLD_STYLE approximates lowercase letterforms with varying ascenders and descenders. The figures are proportionally spaced. This style is only available in selected typefaces, most commonly in a supplemental or expert font. The DigitCase.LINING setting has all-cap height and is typically monospaced to line up in charts.

digitCase

Legal values are flash.text.engine.DigitCase.DEFAULT, flash.text.engine.DigitCase.LINING, flash.text.engine.DigitCase.OLD_STYLE, flashx.textLayout.formats.FormatValue.INHERIT.

Default value is undefined indicating not set.

If undefined during the cascade this property will inherit its value from an ancestor. If no ancestor has set this property, it will have a value of DEFAULT.

VideoPlayer
  
digitWidth
Type: String CSS Inheritance: yes
Type of digit width used for this text. This can be DigitWidth.PROPORTIONAL, which looks best for individual numbers, or DigitWidth.TABULAR, which works best for numbers in tables, charts, and vertical rows.

digitWidth

Legal values are flash.text.engine.DigitWidth.DEFAULT, flash.text.engine.DigitWidth.PROPORTIONAL, flash.text.engine.DigitWidth.TABULAR, flashx.textLayout.formats.FormatValue.INHERIT.

Default value is undefined indicating not set.

If undefined during the cascade this property will inherit its value from an ancestor. If no ancestor has set this property, it will have a value of DEFAULT.

VideoPlayer
  
direction
Type: String CSS Inheritance: yes
Specifies the default bidirectional embedding level of the text in the text block. Left-to-right reading order, as in Latin-style scripts, or right-to-left reading order, as in Arabic or Hebrew. This property also affects column direction when it is applied at the container level. Columns can be either left-to-right or right-to-left, just like text. Below are some examples:

direction

Legal values are flashx.textLayout.formats.Direction.LTR, flashx.textLayout.formats.Direction.RTL, flashx.textLayout.formats.FormatValue.INHERIT.

Default value is undefined indicating not set.

If undefined during the cascade this property will inherit its value from an ancestor. If no ancestor has set this property, it will have a value of LTR.

VideoPlayer
  
dominantBaseline
Type: String CSS Inheritance: yes
Specifies which element baseline snaps to the alignmentBaseline to determine the vertical position of the element on the line. A value of TextBaseline.AUTO selects the dominant baseline based on the locale property of the parent paragraph. For Japanese and Chinese, the selected baseline value is TextBaseline.IDEOGRAPHIC_CENTER; for all others it is TextBaseline.ROMAN. These baseline choices are determined by the choice of font and the font size.

baselines

Legal values are flashx.textLayout.formats.FormatValue.AUTO, flash.text.engine.TextBaseline.ROMAN, flash.text.engine.TextBaseline.ASCENT, flash.text.engine.TextBaseline.DESCENT, flash.text.engine.TextBaseline.IDEOGRAPHIC_TOP, flash.text.engine.TextBaseline.IDEOGRAPHIC_CENTER, flash.text.engine.TextBaseline.IDEOGRAPHIC_BOTTOM, flashx.textLayout.formats.FormatValue.INHERIT.

Default value is undefined indicating not set.

If undefined during the cascade this property will inherit its value from an ancestor. If no ancestor has set this property, it will have a value of flashx.textLayout.formats.FormatValue.AUTO.

VideoPlayer
 InheritedType: Class
Name of the skin class to use for this component when a validation error occurs.
SkinnableComponent
 InheritedType: Class CSS Inheritance: no
Skin used to draw the focus rectangle.
UIComponent
  
fontFamily
Type: String CSS Inheritance: yes
The name of the font to use, or a comma-separated list of font names. The Flash runtime renders the element with the first available font in the list. For example Arial, Helvetica, _sans causes the player to search for Arial, then Helvetica if Arial is not found, then _sans if neither is found.

Default value is undefined indicating not set.

If undefined during the cascade this property will inherit its value from an ancestor. If no ancestor has set this property, it will have a value of Times New Roman.

VideoPlayer
  
fontLookup
Type: String CSS Inheritance: yes
Font lookup to use. Specifying FontLookup.DEVICE uses the fonts installed on the system that is running the SWF file. Device fonts result in a smaller movie size, but text is not always rendered the same across different systems and platforms. Specifying FontLookup.EMBEDDED_CFF uses font outlines embedded in the published SWF file. Embedded fonts increase the size of the SWF file (sometimes dramatically), but text is consistently displayed in the chosen font.

Legal values are flash.text.engine.FontLookup.DEVICE, flash.text.engine.FontLookup.EMBEDDED_CFF, flashx.textLayout.formats.FormatValue.INHERIT.

Default value is undefined indicating not set.

If undefined during the cascade this property will inherit its value from an ancestor. If no ancestor has set this property, it will have a value of DEVICE.

VideoPlayer
  
fontSize
Type: Number Format: Length CSS Inheritance: yes
The size of the text in pixels.

Legal values are numbers from 1 to 720 and flashx.textLayout.formats.FormatValue.INHERIT.

Default value is undefined indicating not set.

If undefined during the cascade this property will inherit its value from an ancestor. If no ancestor has set this property, it will have a value of 12.

VideoPlayer
  
fontStyle
Type: String CSS Inheritance: yes
Style of text. May be FontPosture.NORMAL, for use in plain text, or FontPosture.ITALIC for italic. This property applies only to device fonts (fontLookup property is set to flash.text.engine.FontLookup.DEVICE).

Legal values are flash.text.engine.FontPosture.NORMAL, flash.text.engine.FontPosture.ITALIC, flashx.textLayout.formats.FormatValue.INHERIT.

Default value is undefined indicating not set.

If undefined during the cascade this property will inherit its value from an ancestor. If no ancestor has set this property, it will have a value of NORMAL.

VideoPlayer
  
fontWeight
Type: String CSS Inheritance: yes
Weight of text. May be FontWeight.NORMAL for use in plain text, or FontWeight.BOLD. Applies only to device fonts (fontLookup property is set to flash.text.engine.FontLookup.DEVICE).

Legal values are flash.text.engine.FontWeight.NORMAL, flash.text.engine.FontWeight.BOLD, flashx.textLayout.formats.FormatValue.INHERIT.

Default value is undefined indicating not set.

If undefined during the cascade this property will inherit its value from an ancestor. If no ancestor has set this property, it will have a value of NORMAL.

VideoPlayer
  
fullScreenHideControlsDelay
Type: Number CSS Inheritance: no
The time, in milli-seconds, to wait in fullscreen mode with no user-interaction before hiding the video playback controls. The default value is 3000.
VideoPlayer
 InheritedType: String CSS Inheritance: no
The horizontal distance in pixels from the center of the component's content area to the center of the component.
UIComponent
  
justificationRule
Type: String CSS Inheritance: yes
Rule used to justify text in a paragraph. Default value is FormatValue.AUTO, which justifies text based on the paragraph's locale property. For all languages except Japanese and Chinese, FormatValue.AUTO becomes JustificationRule.SPACE, which adds extra space to the space characters. For Japanese and Chinese, FormatValue.AUTO becomes JustficationRule.EAST_ASIAN. In part, justification changes the spacing of punctuation. In Roman text the comma and Japanese periods take a full character's width but in East Asian text only half of a character's width. Also, in the East Asian text the spacing between sequential punctuation marks becomes tighter, obeying traditional East Asian typographic conventions. Note, too, in the example below the leading that is applied to the second line of the paragraphs. In the East Asian version, the last two lines push left. In the Roman version, the second and following lines push left.

justificationRule

Legal values are flashx.textLayout.formats.JustificationRule.EAST_ASIAN, flashx.textLayout.formats.JustificationRule.SPACE, flashx.textLayout.formats.FormatValue.AUTO, flashx.textLayout.formats.FormatValue.INHERIT.

Default value is undefined indicating not set.

If undefined during the cascade this property will inherit its value from an ancestor. If no ancestor has set this property, it will have a value of flashx.textLayout.formats.FormatValue.AUTO.

VideoPlayer
  
justificationStyle
Type: String CSS Inheritance: yes
The style used for justification of the paragraph. Used only in conjunction with a justificationRule setting of JustificationRule.EAST_ASIAN. Default value of FormatValue.AUTO is resolved to JustificationStyle.PUSH_IN_KINSOKU for all locales. The constants defined by the JustificationStyle class specify options for handling kinsoku characters, which are Japanese characters that cannot appear at either the beginning or end of a line. If you want looser text, specify JustificationStyle.PUSH-OUT-ONLY. If you want behavior that is like what you get with the justificationRule of JustificationRule.SPACE, use JustificationStyle.PRIORITIZE-LEAST-ADJUSTMENT.

Legal values are flash.text.engine.JustificationStyle.PRIORITIZE_LEAST_ADJUSTMENT, flash.text.engine.JustificationStyle.PUSH_IN_KINSOKU, flash.text.engine.JustificationStyle.PUSH_OUT_ONLY, flashx.textLayout.formats.FormatValue.AUTO, flashx.textLayout.formats.FormatValue.INHERIT.

Default value is undefined indicating not set.

If undefined during the cascade this property will inherit its value from an ancestor. If no ancestor has set this property, it will have a value of flashx.textLayout.formats.FormatValue.AUTO.

VideoPlayer
  
kerning
Type: String CSS Inheritance: yes
Kerning adjusts the pixels between certain character pairs to improve readability. Kerning is supported for all fonts with kerning tables.

Legal values are flash.text.engine.Kerning.ON, flash.text.engine.Kerning.OFF, flash.text.engine.Kerning.AUTO, flashx.textLayout.formats.FormatValue.INHERIT.

Default value is undefined indicating not set.

If undefined during the cascade this property will inherit its value from an ancestor. If no ancestor has set this property, it will have a value of AUTO.

VideoPlayer
 InheritedType: String CSS Inheritance: no
The horizontal distance in pixels from the left edge of the component's content area to the left edge of the component.
UIComponent
  
ligatureLevel
Type: String CSS Inheritance: yes
Controls which of the ligatures that are defined in the font may be used in the text. The ligatures that appear for each of these settings is dependent on the font. A ligature occurs where two or more letter-forms are joined as a single glyph. Ligatures usually replace consecutive characters sharing common components, such as the letter pairs 'fi', 'fl', or 'ae'. They are used with both Latin and Non-Latin character sets. The ligatures enabled by the values of the LigatureLevel class - MINIMUM, COMMON, UNCOMMON, and EXOTIC - are additive. Each value enables a new set of ligatures, but also includes those of the previous types.

Note: When working with Arabic or Syriac fonts, ligatureLevel must be set to MINIMUM or above.

ligatureLevel

Legal values are flash.text.engine.LigatureLevel.MINIMUM, flash.text.engine.LigatureLevel.COMMON, flash.text.engine.LigatureLevel.UNCOMMON, flash.text.engine.LigatureLevel.EXOTIC, flashx.textLayout.formats.FormatValue.INHERIT.

Default value is undefined indicating not set.

If undefined during the cascade this property will inherit its value from an ancestor. If no ancestor has set this property, it will have a value of COMMON.

VideoPlayer
  
lineHeight
Type: Object CSS Inheritance: yes
Leading controls for the text. The distance from the baseline of the previous or the next line (based on LeadingModel) to the baseline of the current line is equal to the maximum amount of the leading applied to any character in the line. This is either a number or a percent. If specifying a percent, enter a string value, like 140%.

lineHeight1lineHeight2

Legal values as a number are from -720 to 720.

Legal values as a percent are numbers from -1000% to 1000%.

Legal values include flashx.textLayout.formats.FormatValue.INHERIT.

Default value is undefined indicating not set.

If undefined during the cascade this property will inherit its value from an ancestor. If no ancestor has set this property, it will have a value of 120%.

VideoPlayer
  
lineThrough
Type: Boolean CSS Inheritance: yes
If true, applies strikethrough, a line drawn through the middle of the text.

Legal values are true, false and flashx.textLayout.formats.FormatValue.INHERIT.

Default value is undefined indicating not set.

If undefined during the cascade this property will inherit its value from an ancestor. If no ancestor has set this property, it will have a value of false.

VideoPlayer
  
locale
Type: String CSS Inheritance: yes
The locale of the text. Controls case transformations and shaping. Standard locale identifiers as described in Unicode Technical Standard #35 are used. For example en, en_US and en-US are all English, ja is Japanese.

Default value is undefined indicating not set.

If undefined during the cascade this property will inherit its value from an ancestor. If no ancestor has set this property, it will have a value of en.

VideoPlayer
  
renderingMode
Type: String CSS Inheritance: yes
The rendering mode used for this text. Applies only to embedded fonts (fontLookup property is set to FontLookup.EMBEDDED_CFF).

Legal values are flash.text.engine.RenderingMode.NORMAL, flash.text.engine.RenderingMode.CFF, flashx.textLayout.formats.FormatValue.INHERIT.

Default value is undefined indicating not set.

If undefined during the cascade this property will inherit its value from an ancestor. If no ancestor has set this property, it will have a value of CFF.

VideoPlayer
 InheritedType: String CSS Inheritance: no
The horizontal distance in pixels from the right edge of the component to the right edge of its content area.
UIComponent
 InheritedType: Class
Name of the skin class to use for this component.
SkinnableComponent
  
symbolColor
Type: uint Format: Color CSS Inheritance: yes Theme: spark
Color of any symbol of a component. Examples include the check mark of a CheckBox or the arrow of a scroll button
VideoPlayer
  
textAlign
Type: String CSS Inheritance: yes
Alignment of lines in the paragraph relative to the container. TextAlign.LEFT aligns lines along the left edge of the container. TextAlign.RIGHT aligns on the right edge. TextAlign.CENTER positions the line equidistant from the left and right edges. TextAlign.JUSTIFY spreads the lines out so they fill the space. TextAlign.START is equivalent to setting left in left-to-right text, or right in right-to-left text. TextAlign.END is equivalent to setting right in left-to-right text, or left in right-to-left text.

Legal values are flashx.textLayout.formats.TextAlign.LEFT, flashx.textLayout.formats.TextAlign.RIGHT, flashx.textLayout.formats.TextAlign.CENTER, flashx.textLayout.formats.TextAlign.JUSTIFY, flashx.textLayout.formats.TextAlign.START, flashx.textLayout.formats.TextAlign.END, flashx.textLayout.formats.FormatValue.INHERIT.

Default value is undefined indicating not set.

If undefined during the cascade this property will inherit its value from an ancestor. If no ancestor has set this property, it will have a value of START.

VideoPlayer
  
textAlignLast
Type: String CSS Inheritance: yes
Alignment of the last (or only) line in the paragraph relative to the container in justified text. If textAlign is set to TextAlign.JUSTIFY, textAlignLast specifies how the last line (or only line, if this is a one line block) is aligned. Values are similar to textAlign.

Legal values are flashx.textLayout.formats.TextAlign.LEFT, flashx.textLayout.formats.TextAlign.RIGHT, flashx.textLayout.formats.TextAlign.CENTER, flashx.textLayout.formats.TextAlign.JUSTIFY, flashx.textLayout.formats.TextAlign.START, flashx.textLayout.formats.TextAlign.END, flashx.textLayout.formats.FormatValue.INHERIT.

Default value is undefined indicating not set.

If undefined during the cascade this property will inherit its value from an ancestor. If no ancestor has set this property, it will have a value of START.

VideoPlayer
  
textAlpha
Type: Number CSS Inheritance: yes
Alpha (transparency) value for the text. A value of 0 is fully transparent, and a value of 1 is fully opaque. Display objects with textAlpha set to 0 are active, even though they are invisible.

Legal values are numbers from 0 to 1 and flashx.textLayout.formats.FormatValue.INHERIT.

Default value is undefined indicating not set.

If undefined during the cascade this property will inherit its value from an ancestor. If no ancestor has set this property, it will have a value of 1.

VideoPlayer
  
textDecoration
Type: String CSS Inheritance: yes
Decoration on text. Use to apply underlining; default is none.

Legal values are flashx.textLayout.formats.TextDecoration.NONE, flashx.textLayout.formats.TextDecoration.UNDERLINE, flashx.textLayout.formats.FormatValue.INHERIT.

Default value is undefined indicating not set.

If undefined during the cascade this property will inherit its value from an ancestor. If no ancestor has set this property, it will have a value of NONE.

VideoPlayer
  
textJustify
Type: String CSS Inheritance: yes
Specifies options for justifying text. Default value is TextJustify.INTER_WORD, meaning that extra space is added to the space characters. TextJustify.DISTRIBUTE adds extra space to space characters and between individual letters. Used only in conjunction with a justificationRule value of JustificationRule.SPACE.

Legal values are flashx.textLayout.formats.TextJustify.INTER_WORD, flashx.textLayout.formats.TextJustify.DISTRIBUTE, flashx.textLayout.formats.FormatValue.INHERIT.

Default value is undefined indicating not set.

If undefined during the cascade this property will inherit its value from an ancestor. If no ancestor has set this property, it will have a value of INTER_WORD.

VideoPlayer
 InheritedType: String CSS Inheritance: no
The vertical distance in pixels from the top edge of the control's content area to the top edge of the component.
UIComponent
  
trackingLeft
Type: Object CSS Inheritance: yes
Number in pixels (or percent of fontSize, like 120%) indicating the amount of tracking (manual kerning) to be applied to the left of each character. If kerning is enabled, the trackingLeft value is added to the values in the kerning table for the font. If kerning is disabled, the trackingLeft value is used as a manual kerning value. Supports both positive and negative values.

Legal values as a number are from -100 to 100.

Legal values as a percent are numbers from -100% to 100%.

Legal values include flashx.textLayout.formats.FormatValue.INHERIT.

Default value is undefined indicating not set.

If undefined during the cascade this property will inherit its value from an ancestor. If no ancestor has set this property, it will have a value of 0.

VideoPlayer
  
trackingRight
Type: Object CSS Inheritance: yes
Number in pixels (or percent of fontSize, like 120%) indicating the amount of tracking (manual kerning) to be applied to the right of each character. If kerning is enabled, the trackingRight value is added to the values in the kerning table for the font. If kerning is disabled, the trackingRight value is used as a manual kerning value. Supports both positive and negative values.

Legal values as a number are from -100 to 100.

Legal values as a percent are numbers from -100% to 100%.

Legal values include flashx.textLayout.formats.FormatValue.INHERIT.

Default value is undefined indicating not set.

If undefined during the cascade this property will inherit its value from an ancestor. If no ancestor has set this property, it will have a value of 0.

VideoPlayer
  
typographicCase
Type: String CSS Inheritance: yes
The type of typographic case used for this text. Here are some examples:

typographicCase

Legal values are flashx.textLayout.formats.TLFTypographicCase.DEFAULT, flashx.textLayout.formats.TLFTypographicCase.CAPS_TO_SMALL_CAPS, flashx.textLayout.formats.TLFTypographicCase.UPPERCASE, flashx.textLayout.formats.TLFTypographicCase.LOWERCASE, flashx.textLayout.formats.TLFTypographicCase.LOWERCASE_TO_SMALL_CAPS, flashx.textLayout.formats.FormatValue.INHERIT.

Default value is undefined indicating not set.

If undefined during the cascade this property will inherit its value from an ancestor. If no ancestor has set this property, it will have a value of DEFAULT.

VideoPlayer
 InheritedType: String CSS Inheritance: no
The vertical distance in pixels from the center of the component's content area to the center of the component.
UIComponent
Skin Parts

This component uses skins made up of skin parts. Do not set the skin parts directly. The component's skin sets the skin parts.


 Skin Part Description Defined By
  
fullScreenButton:ButtonBase
Required: false Part Type: Static
An optional skin part for a button to toggle fullscreen mode.
VideoPlayer
  
muteButton:MuteButton
Required: false Part Type: Static
An optional skin part for the mute button. The mute button has both a muted property and a volume property.
VideoPlayer
  
pauseButton:ButtonBase
Required: false Part Type: Static
An optional skin part for the pause button
VideoPlayer
  
playButton:ButtonBase
Required: false Part Type: Static
An optional skin part for the play button
VideoPlayer
  
playerControls:DisplayObject
Required: false Part Type: Static
An optional skin part for all of the player controls. This skin is used to determine what to hide when the player is in full screen mode and there has been no user interaction.
VideoPlayer
  
playheadTimeDisplay:TextBase
Required: false Part Type: Static
An optional skin part to display the current playheadTime.
VideoPlayer
  
playPauseButton:ToggleButtonBase
Required: false Part Type: Static
An optional skin part for a play/pause button. When the video is playing, the selected property will be set to true. When the video is paused or stopped, the selected property will be set to false.
VideoPlayer
  
scrubBar:ScrubBar
Required: false Part Type: Static
An optional skin part for the scrub bar (the timeline).
VideoPlayer
  
stopButton:ButtonBase
Required: false Part Type: Static
An optional skin part for the stop button
VideoPlayer
  
totalTimeDisplay:TextBase
Required: false Part Type: Static
An optional skin part to display the totalTime.
VideoPlayer
  
videoElement:VideoElement
Required: true Part Type: Static
A required skin part that defines the VideoElement.
VideoPlayer
  
volumeBar:VolumeBar
Required: false Part Type: Static
An optional skin part for the volume control.
VideoPlayer
Skin States

To skin the component, implement a skin that defines the following states. Although you must implement all skin states, a skin state can be empty. An empty skin state specifies no changes to the default skin state.


 Skin State Description Defined By
  
connectionError
Connection Error State of the VideoPlayer VideoPlayer
  
connectionErrorAndFullScreen
Connection Error State of the VideoPlayer when in full screen mode. VideoPlayer
  
disabled
Disabled State of the VideoPlayer VideoPlayer
  
disabledAndFullScreen
Disabled State of the VideoPlayer when in full screen mode. VideoPlayer
  
disconnected
Disconnected State of the VideoPlayer VideoPlayer
  
disconnectedAndFullScreen
Disconnected State of the VideoPlayer when in full screen mode. VideoPlayer
  
loading
Loading State of the VideoPlayer VideoPlayer
  
loadingAndFullScreen
Loading State of the VideoPlayer when in full screen mode. VideoPlayer
  
playing
Playing State of the VideoPlayer VideoPlayer
  
playingAndFullScreen
Playing State of the VideoPlayer when in full screen mode. VideoPlayer
  
stopped
Stopped State of the VideoPlayer VideoPlayer
  
stoppedAndFullScreen
Stopped State of the VideoPlayer when in full screen mode. VideoPlayer
Effects
 Effect Description Defined By
 Inherited Triggering Event: added
Played when the component is added as a child to a Container.
UIComponent
 Inherited Triggering Event: creationComplete
Played when the component is created.
UIComponent
 Inherited Triggering Event: focusIn
Played when the component gains keyboard focus.
UIComponent
 Inherited Triggering Event: focusOut
Played when the component loses keyboard focus.
UIComponent
 Inherited Triggering Event: hide
Played when the component becomes invisible.
UIComponent
 Inherited Triggering Event: mouseDown
Played when the user presses the mouse button while over the component.
UIComponent
 Inherited Triggering Event: mouseUp
Played when the user releases the mouse button while over the component.
UIComponent
 Inherited Triggering Event: move
Played when the component is moved.
UIComponent
 Inherited Triggering Event: removed
Played when the component is removed from a Container.
UIComponent
 Inherited Triggering Event: resize
Played when the component is resized.
UIComponent
 Inherited Triggering Event: rollOut
Played when the user rolls the mouse so it is no longer over the component.
UIComponent
 Inherited Triggering Event: rollOver
Played when the user rolls the mouse over the component.
UIComponent
 Inherited Triggering Event: show
Played when the component becomes visible.
UIComponent
Public Constants
 ConstantDefined By
 InheritedDEFAULT_MAX_HEIGHT : Number = 10000
[static] The default value for the maxHeight property.
UIComponent
 InheritedDEFAULT_MAX_WIDTH : Number = 10000
[static] The default value for the maxWidth property.
UIComponent
 InheritedDEFAULT_MEASURED_HEIGHT : Number = 22
[static] The default value for the measuredHeight property.
UIComponent
 InheritedDEFAULT_MEASURED_MIN_HEIGHT : Number = 22
[static] The default value for the measuredMinHeight property.
UIComponent
 InheritedDEFAULT_MEASURED_MIN_WIDTH : Number = 40
[static] The default value for the measuredMinWidth property.
UIComponent
 InheritedDEFAULT_MEASURED_WIDTH : Number = 160
[static] The default value for the measuredWidth property.
UIComponent
Property Detail
autoPlayproperty
autoPlay:Boolean

Language Version: ActionScript 3.0
Product Version: Flex 4
Runtime Versions: Flash Player 10, AIR 1.5

Specifies whether the video should start playing immediately when the source property is set. If true, the video file immediately begins to buffer and play.

Even if autoPlay is set to false, Flex starts loading the video after the initialize() method is called. For Flash Media Server, this means creating the stream and loading the first frame to display. In the case of an HTTP download, Flex starts downloading the stream and shows the first frame.



Implementation
    public function get autoPlay():Boolean
    public function set autoPlay(value:Boolean):void
autoRewindproperty 
autoRewind:Boolean

Language Version: ActionScript 3.0
Product Version: Flex 4
Runtime Versions: Flash Player 10, AIR 1.5

Specifies whether the FLV file should be rewound to the first frame when play stops, either by calling the stop() method or by reaching the end of the stream.

This property has no effect for live streaming video.



Implementation
    public function get autoRewind():Boolean
    public function set autoRewind(value:Boolean):void
enabledproperty 
enabled:Boolean[override]

Language Version: ActionScript 3.0
Product Version: Flex 4
Runtime Versions: Flash Player 10, AIR 1.5

Setting enabled to false disables the UI and pauses the video if it was currently playing. Re-enabling the component does not cause the video to continue playing again; you must explicitly call play().

Even though the component is initially paused while disabled, if you want to play the video or perform some other action while disabled, you may still do so through method calls, like play().



Implementation
    override public function get enabled():Boolean
    override public function set enabled(value:Boolean):void
loopproperty 
loop:Boolean

Language Version: ActionScript 3.0
Product Version: Flex 4
Runtime Versions: Flash Player 10, AIR 1.5

Indicates whether the media should play again after playback has completed. The loop property takes precedence over the the autoRewind property, so if loop is set to true, the autoRewind property is ignored.



Implementation
    public function get loop():Boolean
    public function set loop(value:Boolean):void
maintainAspectRatioproperty 
maintainAspectRatio:Boolean

Language Version: ActionScript 3.0
Product Version: Flex 4
Runtime Versions: Flash Player 10, AIR 1.5

Specifies whether the control should maintain the original aspect ratio while resizing the video.

If no width, height, or constraints are specified on the VideoElement, this property has no effect.



Implementation
    public function get maintainAspectRatio():Boolean
    public function set maintainAspectRatio(value:Boolean):void
mutedproperty 
muted:Boolean

Language Version: ActionScript 3.0
Product Version: Flex 4
Runtime Versions: Flash Player 10, AIR 1.5

Set to true to mute the video, false to unmute the video.

This property can be used as the source for data binding. When this property is modified, it dispatches the propertyChange event.



Implementation
    public function get muted():Boolean
    public function set muted(value:Boolean):void
playheadTimeproperty 
playheadTime:Number  [read-only]

Language Version: ActionScript 3.0
Product Version: Flex 4
Runtime Versions: Flash Player 10, AIR 1.5

Playhead position, measured in seconds, since the video starting playing. The event object for many of the VideoPlay events include the playhead position so that you can determine the location in the video file where the event occurred.

Setting this property to a value in seconds performs a seek operation. If the video is currently playing, it continues playing from the new playhead position. If the video is paused, it seeks to the new playhead position and remains paused. If the video is stopped, it seeks to the new playhead position and enters the paused state. Setting this property has no effect with live video streams.

If the new playhead position is less than 0 or NaN, the control throws an exception. If the new playhead position is past the end of the video, or past the amount of the video file downloaded so far, then the control still attempts the seek.

For an FLV file, setting the playheadTime property seeks to the keyframe closest to the specified position, where keyframes are specified in the FLV file at the time of encoding. Therefore, you might not seek to the exact time if there is no keyframe specified at that position.

This property throws an exception if set when no stream is connected. Use the stateChange event and the connected property to determine when it is safe to set this property.

This property can be used as the source for data binding. When this property is modified, it dispatches the propertyChange event.



Implementation
    public function get playheadTime():Number
playingproperty 
playing:Boolean  [read-only]

Language Version: ActionScript 3.0
Product Version: Flex 4
Runtime Versions: Flash Player 10, AIR 1.5

Returns true if the video is playing or is attempting to play.

The video may not be currently playing, as it may be seeking or buferring, but the video is attempting to play.



Implementation
    public function get playing():Boolean
playWhenHiddenproperty 
playWhenHidden:Boolean

Language Version: ActionScript 3.0
Product Version: Flex 4
Runtime Versions: Flash Player 10, AIR 1.5

Controls whether the video continues to play when it is hidden. The video is hidden when either visible is set to false or when the video is taken off of the display list. If set to false, the video will pause playback until the video is visible again. If set to true the video will continue to play when it is hidden. The default is false.



Implementation
    public function get playWhenHidden():Boolean
    public function set playWhenHidden(value:Boolean):void
sourceproperty 
source:Object

Language Version: ActionScript 3.0
Product Version: Flex 4
Runtime Versions: Flash Player 10, AIR 1.5

For progressive download, the source is just a path or URL pointing to the video file to play. For streaming (streaming, live streaming, or multi-bitrate streaming), the source property is a StreamingVideoSource object.

This property can be used as the source for data binding. When this property is modified, it dispatches the propertyChange event.



Implementation
    public function get source():Object
    public function set source(value:Object):void
totalTimeproperty 
totalTime:Number  [read-only]

Language Version: ActionScript 3.0
Product Version: Flex 4
Runtime Versions: Flash Player 10, AIR 1.5

Total time for the video feed. -1 means that property was not pass into play() or we were unable to detect the total time automatically, or have not yet.

This property can be used as the source for data binding. When this property is modified, it dispatches the propertyChange event.



Implementation
    public function get totalTime():Number
volumeproperty 
volume:Number

Language Version: ActionScript 3.0
Product Version: Flex 4
Runtime Versions: Flash Player 10, AIR 1.5

The volume level, specified as an value between 0 and 1.

This property can be used as the source for data binding. When this property is modified, it dispatches the propertyChange event.



Implementation
    public function get volume():Number
    public function set volume(value:Number):void
Constructor Detail
VideoPlayer()Constructor
public function VideoPlayer()

Language Version: ActionScript 3.0
Product Version: Flex 4
Runtime Versions: Flash Player 10, AIR 1.5

Constructor.

Method Detail
formatTimeValue()method
protected function formatTimeValue(value:Number):String

Formats a time value, given in seconds, into a string that gets used for the playheadTimeDisplay and the totalTimeDisplay.

Parameters

value:Number — Value in seconds of the time to format

Returns
String — Formatted time value
pause()method 
public function pause():void

Language Version: ActionScript 3.0
Product Version: Flex 4
Runtime Versions: Flash Player 10, AIR 1.5

Pauses playback without moving the playhead. If playback is already is paused or is stopped, this method has no effect.

To start playback again, call the play() method.


Throws
TypeError — If the skin hasn't been loaded and there is no videoElement.
play()method 
public function play():void

Language Version: ActionScript 3.0
Product Version: Flex 4
Runtime Versions: Flash Player 10, AIR 1.5

Causes the video to play. Can be called while the video is paused, stopped, or while the video is already playing.


Throws
TypeError — if the skin hasn't been loaded up yet and there's no videoElement.
seek()method 
public function seek(time:Number):void

Language Version: ActionScript 3.0
Product Version: Flex 4
Runtime Versions: Flash Player 10, AIR 1.5

Seeks to given second in video. If video is playing, continues playing from that point. If video is paused, seek to that point and remain paused. If video is stopped, seek to that point and enters paused state. Has no effect with live streams.

If time is less than 0 or NaN, throws exeption. If time is past the end of the stream, or past the amount of file downloaded so far, then will attempt seek and when fails will recover.

The playheadTime property might not have the expected value immediately after you call one of the seek methods or set playheadTime to cause seeking. For a progressive download, you can seek only to a keyframe; therefore, a seek takes you to the time of the first keyframe after the specified time.

Note: When streaming, a seek always goes to the precise specified time even if the source FLV file doesn't have a keyframe there.

Seeking is asynchronous, so if you call a seek method or set the playheadTime property, playheadTime does not update immediately. To obtain the time after the seek is complete, listen for the seek event, which does not start until the playheadTime property is updated.

Parameters

time:Number — seconds


Throws
TypeError — if the skin hasn't been loaded up yet and there's no videoElement.
stop()method 
public function stop():void

Language Version: ActionScript 3.0
Product Version: Flex 4
Runtime Versions: Flash Player 10, AIR 1.5

Stops video playback. If autoRewind is set to true, rewinds to first frame. If video is already stopped, has no effect. To start playback again, call play().


Throws
TypeError — if the skin hasn't been loaded up yet and there's no videoElement.
Event Detail
close Event
Event Object Type: spark.events.VideoEvent
property VideoEvent.type = spark.events.VideoEvent.CLOSE

Language Version: ActionScript 3.0
Product Version: Flex 4
Runtime Versions: Flash Player 10, AIR 1.5

Dispatched when the NetConnection is closed, whether by being timed out, by calling the close() method, or by loading a new video stream. This event is only dispatched with RTMP streams, never HTTP.

The VideoEvent.CLOSE constant defines the value of the type property of the event object for a close event.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelablefalse
currentTargetThe Object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget.
metadataInfoIf the event was triggerred from new metadata, an object describing the FLV file.
playheadTimeThe location of the playhead when the event occurs.
targetThe Object that dispatched the event; it is not always the Object listening for the event. Use the currentTarget property to always access the Object listening for the event.
complete Event  
Event Object Type: spark.events.VideoEvent
property VideoEvent.type = spark.events.VideoEvent.COMPLETE

Language Version: ActionScript 3.0
Product Version: Flex 4
Runtime Versions: Flash Player 10, AIR 1.5

Dispatched when playing completes because the player reached the end of the FLV file. The component does not dispatch the event if you call the stop() or pause() methods or click the corresponding controls.

The VideoEvent.COMPLETE constant defines the value of the type property of the event object for a complete event.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelablefalse
currentTargetThe Object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget.
metadataInfoIf the event was triggerred from new metadata, an object describing the FLV file.
playheadTimeThe location of the playhead when the event occurs.
targetThe Object that dispatched the event; it is not always the Object listening for the event. Use the currentTarget property to always access the Object listening for the event.
metadataReceived Event  
Event Object Type: spark.events.VideoEvent
property VideoEvent.type = spark.events.VideoEvent.METADATA_RECEIVED

Language Version: ActionScript 3.0
Product Version: Flex 4
Runtime Versions: Flash Player 10, AIR 1.5

Dispatched the first time the FLV file's metadata is reached. The event object has an info property that contains the info object received by the NetStream.onMetaData event callback.

The VideoEvent.METADATA_RECEIVED constant defines the value of the type property for a metadataReceived event.

This event has the following properties:

PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe Object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget.
metadataInfoIf the event was triggerred from new metadata, an object describing the FLV file.
playheadTimeThe location of the playhead when the event occurs.
targetThe Object that dispatched the event; it is not always the Object listening for the event. Use the currentTarget property to always access the Object listening for the event.
playheadUpdate Event  
Event Object Type: spark.events.VideoEvent
property VideoEvent.type = spark.events.VideoEvent.PLAYHEAD_UPDATE

Language Version: ActionScript 3.0
Product Version: Flex 4
Runtime Versions: Flash Player 10, AIR 1.5

Dispatched every 0.25 seconds while the video is playing. This event is not dispatched when it is paused or stopped, unless a seek occurs.

The VideoEvent.PLAYHEAD_UPDATE constant defines the value of the type property of the event object for a playheadUpdate event.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelablefalse
currentTargetThe Object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget.
metadataInfoIf the event was triggerred from new metadata, an object describing the FLV file.
playheadTimeThe location of the playhead when the event occurs.
targetThe Object that dispatched the event; it is not always the Object listening for the event. Use the currentTarget property to always access the Object listening for the event.
progress Event  
Event Object Type: flash.events.ProgressEvent
property ProgressEvent.type = flash.events.ProgressEvent.PROGRESS

Language Version: ActionScript 3.0
Product Version: Flex 4
Runtime Versions: Flash Player 10, AIR 1.5

Indicates progress made in number of bytes downloaded. Dispatched starting when the load begins and ending when all bytes are loaded or there is a network error. Dispatched every 0.25 seconds starting when load is called and ending when all bytes are loaded or if there is a network error. Use this event to check bytes loaded or number of bytes in the buffer.

Dispatched only for a progressive HTTP download. Indicates progress in number of downloaded bytes. The event object has the bytesLoaded and bytesTotal properties

Defines the value of the type property of a progress event object.

This event has the following properties:

PropertyValue
bubblesfalse
bytesLoadedThe number of items or bytes loaded at the time the listener processes the event.
bytesTotalThe total number of items or bytes that ultimately will be loaded if the loading process succeeds.
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event object with an event listener.
targetThe object reporting progress.
ready Event  
Event Object Type: spark.events.VideoEvent
property VideoEvent.type = spark.events.VideoEvent.READY

Language Version: ActionScript 3.0
Product Version: Flex 4
Runtime Versions: Flash Player 10, AIR 1.5

Dispatched when the video is loaded and ready to display.

This event is dispatched the first time the VideoPlayer enters a responsive state after a new FLV is loaded with the play() or load() method. It is dispatched once for each FLV loaded.

The VideoEvent.READY constant defines the value of the type property of the event object for a ready event.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelablefalse
currentTargetThe Object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget.
metadataInfoIf the event was triggerred from new metadata, an object describing the FLV file.
playheadTimeThe location of the playhead when the event occurs.
targetThe Object that dispatched the event; it is not always the Object listening for the event. Use the currentTarget property to always access the Object listening for the event.