Adobe® Flex® 4 Language Reference
Hide Packages and Classes List |  Packages  |  Classes  |  Index  |  Appendixes
mx.controls 
VideoDisplay 
Packagemx.controls
Classpublic class VideoDisplay
InheritanceVideoDisplay Inheritance UIComponent Inheritance FlexSprite Inheritance Sprite Inheritance DisplayObjectContainer Inheritance InteractiveObject Inheritance DisplayObject Inheritance EventDispatcher Inheritance Object

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1


Starting with Flex 4.0, Adobe recommends that you use the spark.components.VideoPlayer class as an alternative to this class.

The VideoDisplay control lets you play an FLV file in a Flex application. It supports progressive download over HTTP, streaming from the Flash Media Server, and streaming from a Camera object.

MXML SyntaxexpandedHide MXML Syntax

The <mx:VideoDisplay> tag inherits all the tag attributes of its superclass, and adds the following tag attributes:

  <mx:VideoDisplay
    Properties
    autoBandWidthDetection="false|true"
    autoPlay="true|false"
    autoRewind="true|false"
    bufferTime="0.1"
    cuePointManagerClass=""
    cuePoints=""
    idleTimeout="300000"
    live="false|true"
    maintainAspectRatio="true|false"
    playheadTime=""
    playheadUpdateInterval="250"
    progressInterval="250"
    source=""
    totalTime=""
    volume="0.75"
  
    Styles
    backgroundAlpha="1.0"
    backgroundColor="0x000000"
    backgroundImage="undefined"
    backgroundSize="undefined"
    borderColor="undefined"
    borderSides="left top right bottom"
    borderSkin="ClassReference('mx.skins.halo.HaloBorder')"
    borderStyle="none"
    borderThickness="1"
    cornerRadius="0"
    dropShadowColor="0x000000"
    dropShadowEnabled="false|true"
    shadowDirection="center"
    shadowDistance="2"
  
    Events
    close="No default"
    complete="No default"
    cuePoint="No default"
    playheadUpdate="No default"
    progress="No default"
    ready="No default"
    rewind="No default"
    stateChange="No default"
 
  />
  

View the examples

See also



Public Properties
 PropertyDefined By
 InheritedaccessibilityDescription : String
A convenience accessor for the description property in this UIComponent's accessibilityProperties object.
UIComponent
 InheritedaccessibilityEnabled : Boolean
A convenience accessor for the silent property in this UIComponent's accessibilityProperties object.
UIComponent
 InheritedaccessibilityImplementation : AccessibilityImplementation
The current accessibility implementation (AccessibilityImplementation) for this InteractiveObject instance.
InteractiveObject
 InheritedaccessibilityName : String
A convenience accessor for the name property in this UIComponent's accessibilityProperties object.
UIComponent
 InheritedaccessibilityProperties : AccessibilityProperties
The current accessibility options for this display object.
DisplayObject
 InheritedaccessibilityShortcut : String
A convenience accessor for the shortcut property in this UIComponent's accessibilityProperties object.
UIComponent
 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
  autoBandWidthDetection : Boolean
Specifies whether the VideoDisplay control should use the built-in automatic bandwidth detection feature.
VideoDisplay
 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.
VideoDisplay
  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.
VideoDisplay
 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
  borderMetrics : EdgeMetrics
[read-only] Returns an EdgeMetrics object that has four properties: left, top, right, and bottom.
VideoDisplay
 Inheritedbottom : Object
The vertical distance in pixels from the bottom edge of the component to the anchor target's bottom edge.
UIComponent
  bufferTime : Number
Number of seconds of video to buffer in memory before starting to play the video file.
VideoDisplay
 InheritedbuttonMode : Boolean
Specifies the button mode of this sprite.
Sprite
  bytesLoaded : int
[read-only] Number of bytes already loaded that are available for playing.
VideoDisplay
  bytesTotal : int
[read-only] Total number of bytes to load.
VideoDisplay
 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
  cuePointManager : Object
[read-only] The instance of the CuePointManager class associated with the VideoPlayer control.
VideoDisplay
  cuePointManagerClass : Class
Cue point manager to use.
VideoDisplay
  cuePoints : Array
The Array of cue points associated with the control.
VideoDisplay
 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
 Inheritedenabled : Boolean
Whether the component can accept user interaction.
UIComponent
 InheritederrorString : String
The text that 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.
UIComponent
 InheritedhasLayoutMatrix3D : Boolean
[read-only] Contians 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
  idleTimeout : int
Specifies the amount of time, in milliseconds, that the connection is idle (playing is paused or stopped) before the connection to the Flash Media Server is stopped.
VideoDisplay
 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] Contains true when the element is in 3D.
UIComponent
 InheritedisDocument : Boolean
[read-only] Contains true if this UIComponent instance is a document object.
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
  live : Boolean
Specifies whether the control is streaming a live feed.
VideoDisplay
 InheritedloaderInfo : LoaderInfo
[read-only] Returns a LoaderInfo object containing information about loading the file to which this display object belongs.
DisplayObject
  maintainAspectRatio : Boolean
Specifies whether the control should maintain the original aspect ratio while resizing the video.
VideoDisplay
 InheritedmaintainProjectionCenter : Boolean
When true, the component keeps 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
  metadata : Object
[read-only] An object that contains a metadata information packet that is received from a call to the NetStream.onMetaData() callback method, if available.
VideoDisplay
 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 embedded 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
 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
 InheritednumChildren : int
[read-only] Returns the number of children of this object.
DisplayObjectContainer
 InheritedopaqueBackground : Object
Specifies whether the display object is opaque with a certain background color.
DisplayObject
 Inheritedowner : DisplayObjectContainer
The owner of this IVisualElement object.
UIComponent
 Inheritedparent : DisplayObjectContainer
[override] [read-only] The parent container or component for this component.
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
Playhead position, measured in seconds, since the video starting playing.
VideoDisplay
  playheadUpdateInterval : int
Specifies the amount of time, in milliseconds, between each playheadUpdate event.
VideoDisplay
  playing : Boolean
[read-only] If true, the media is currently playing.
VideoDisplay
 InheritedpostLayoutTransformOffsets : mx.geom:TransformOffsets
Defines a set of adjustments that can be applied to the object's transform in a way that is invisible to its parent's layout.
UIComponent
 InheritedprocessedDescriptors : Boolean
Set to true after immediate or deferred child creation, depending on which one happens.
UIComponent
  progressInterval : int
Specifies the amount of time, in milliseconds, between each progress event.
VideoDisplay
 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] Indicates the rotation of the DisplayObject instance, in degrees, from its original orientation.
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
 InheritedsoundTransform : flash.media:SoundTransform
Controls sound within this sprite.
Sprite
  source : String
Relative path and filename of the FLV file to stream.
VideoDisplay
 Inheritedstage : Stage
[read-only] The Stage of the display object.
DisplayObject
  state : String
[read-only] The current state of the VideoDisplay control.
VideoDisplay
  stateResponsive : Boolean
[read-only] Specifies whether the VideoDisplay control is in a responsive state, true, or in the unresponsive state, false.
VideoDisplay
 Inheritedstates : Array
The view states that are defined for this component.
UIComponent
 InheritedstyleDeclaration : CSSStyleDeclaration
Storage for the inline inheriting styles on this object.
UIComponent
 InheritedstyleManager : IStyleManager2
[read-only] Returns the StyleManager instance used by this component.
UIComponent
 InheritedstyleName : Object
The class style used by this component.
UIComponent
 InheritedstyleParent : IAdvancedStyleClient
[read-only] A component's parent is used to evaluate 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
Total length of the media, in seconds.
VideoDisplay
 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
  videoHeight : int
[read-only] Height of the loaded FLV file.
VideoDisplay
  videoWidth : int
[read-only] Width of the loaded FLV file.
VideoDisplay
 Inheritedvisible : Boolean
[override] Whether or not the display object is visible.
UIComponent
  volume : Number
The volume level, specified as an value between 0 and 1.
VideoDisplay
 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
  border : IFlexDisplayObject
The border object for the control.
VideoDisplay
 InheritedcurrentCSSState : String
[read-only] The state to be used when matching CSS pseudo-selectors.
UIComponent
 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.
VideoDisplay
 Inherited
Adds a child DisplayObject instance to this DisplayObjectContainer instance.
DisplayObjectContainer
 Inherited
Adds a child DisplayObject instance to this DisplayObjectContainer instance.
DisplayObjectContainer
 Inherited
addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
Registers an event listener object with an EventDispatcher object so that the listener receives notification of an event.
EventDispatcher
 Inherited
Indicates whether the security restrictions would cause any display objects to be omitted from the list returned by calling the DisplayObjectContainer.getObjectsUnderPoint() method with the specified point point.
DisplayObjectContainer
  
Specifies to play a video stream from a camera.
VideoDisplay
 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
  
Forces the close of an input stream and connection to Flash Media Server.
VideoDisplay
 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 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
Programmatically 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 instance that exists at the specified index.
DisplayObjectContainer
 Inherited
Returns the child display object that exists with the specified name.
DisplayObjectContainer
 Inherited
Returns the index position of a child DisplayObject instance.
DisplayObjectContainer
 Inherited
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
Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.
Object
  
Loads the media file without playing it.
VideoDisplay
 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
Returns true if cssState matches currentCSSState.
UIComponent
 Inherited
Determines whether this instance is the same as, or is a subclass of, the given type.
UIComponent
 Inherited
Measures the specified HTML text, which can 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 (or UIFTETextField) 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.
VideoDisplay
  
Plays the media file.
VideoDisplay
 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
Removes the specified child DisplayObject instance from the child list of the DisplayObjectContainer instance.
DisplayObjectContainer
 Inherited
Removes a child DisplayObject from the specified index position in the child list of the DisplayObjectContainer.
DisplayObjectContainer
 Inherited
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
 Inherited
Sizes the object.
UIComponent
 Inherited
Changes the position of an existing child in the display object container.
DisplayObjectContainer
 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 of the element.
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
Sets the transform Matrix3D that is used to calculate the component's layout size and position relative to its siblings.
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 playback.
VideoDisplay
 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
Swaps the z-order (front-to-back order) of the two specified child objects.
DisplayObjectContainer
 Inherited
swapChildrenAt(index1:int, index2:int):void
Swaps the z-order (front-to-back order) of the child objects at the two specified index positions in the child list.
DisplayObjectContainer
 Inherited
Returns the string representation of this object, formatted according to locale-specific conventions.
Object
 Inherited
[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, invalidateLayout:Boolean = true):void
A utility method to update the rotation, scale, and translation of the transform while keeping a particular point, specified in the component's own coordinate space, fixed in the parent's coordinate space.
UIComponent
 Inherited
transformPointToParent(localPosition:Vector3D, position:Vector3D, postLayoutPosition:Vector3D):void
A utility method to transform a point specified in the local coordinates of this object to its location in the object's parent's coordinates.
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
Determines if the call to the measure() method can be skipped.
UIComponent
 Inherited
Performs any final processing after child objects are created.
UIComponent
 Inherited
Processes the properties set on the component.
UIComponent
  
Creates the border for this component.
VideoDisplay
 Inherited
Create child objects of the component.
UIComponent
 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
dispatchPropertyChangeEvent(prop:String, oldValue:*, value:*):void
Helper method for dispatching a PropertyChangeEvent when a property is updated.
UIComponent
 Inherited
The event handler called when a UIComponent object gets focus.
UIComponent
 Inherited
The event handler called when a UIComponent object loses focus.
UIComponent
 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
  
layoutChrome(unscaledWidth:Number, unscaledHeight:Number):void
Responds to size changes by setting the positions and sizes of the borders.
VideoDisplay
 Inherited
Calculates the default size, and optionally the default minimum size, of the component.
UIComponent
 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 object is closed, whether by timing out or by calling the close() method.VideoDisplay
  Dispatched when the playhead reaches the end of the FLV file.VideoDisplay
 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
  Dispatched when the value of a cue point's time property is equal to the current playhead location.VideoDisplay
 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 metadata in the FLV file is reached.VideoDisplay
 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 continuosly while the video is playing.VideoDisplay
 InheritedDispatched at the beginning of the component initialization sequence.UIComponent
  Dispatched continuously until the FLV file has downloaded completely.VideoDisplay
  Dispatched when the FLV file is loaded and ready to play.VideoDisplay
 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
  Dispatched when the control autorewinds.VideoDisplay
 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
  Dispatched when the state of the control changes.VideoDisplay
 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 is to 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

Styles are either common or associated with a specific theme. If the style is common, it can be used with any theme. If a style is associated with a specific theme, it can only be used if your application uses that theme.

Common Styles
 Style Description Defined By
 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
  
borderSkin
Type: Class CSS Inheritance: no
The border skin class of the component. The default value in all components that do not explicitly set their own default for the Halo theme is mx.skins.halo.HaloBorder and for the Spark theme is mx.skins.spark.BorderSkin. The Panel container has a default value of mx.skins.halo.PanelSkin for the Halo theme and mx.skins.spark.BorderSkin for the Spark theme. To determine the default value for a component, see the default.css file.
VideoDisplay
  
borderStyle
Type: String CSS Inheritance: no
Bounding box style. The possible values are "none", "solid", "inset", and "outset". The default value depends on the component class; if not overridden for the class, the default value is "inset". The default value for most Containers is "none". The "inset" and "outset" values are only valid with the halo theme.
VideoDisplay
 InheritedType: String CSS Inheritance: no
The vertical distance, in pixels, from the bottom edge of the component to the bottom edge of its parent container's content area.
UIComponent
 InheritedType: uint Format: Color CSS Inheritance: yes
Color of the component highlight when validation fails.
UIComponent
 InheritedType: String CSS Inheritance: no
Blend mode used by the focus rectangle.
UIComponent
 InheritedType: Class CSS Inheritance: no
Skin used to draw the focus rectangle.
UIComponent
 InheritedType: Number Format: Length CSS Inheritance: no
Thickness, in pixels, of the focus rectangle outline.
UIComponent
 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
 InheritedType: String CSS Inheritance: no
The horizontal distance, in pixels, from the left edge of the component to the left edge of its parent container's content area.
UIComponent
 InheritedType: String CSS Inheritance: no
The horizontal distance, in pixels, from the right edge of the component to the right edge of its parent container's content area.
UIComponent
 InheritedType: String CSS Inheritance: no
The vertical distance, in pixels, from the top edge of the component to the top edge of its parent container's content area.
UIComponent
 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
Spark Theme Styles
 Style Description Defined By
  
borderAlpha
Type: Number CSS Inheritance: no Theme: spark
Alpha of the border. The default value is 1.
VideoDisplay
  
borderColor
Type: uint Format: Color CSS Inheritance: no Theme: halo, spark
Color of the border. The default value depends on the component class; if not overridden for the class, the default value is 0xB7BABC for the Halo theme and 0x696969 for the Spark theme.
VideoDisplay
  
borderVisible
Type: Boolean CSS Inheritance: no Theme: spark
Visibility of the border. The default value is true.
VideoDisplay
 InheritedType: uint Format: Color CSS Inheritance: yes Theme: spark
The main color for a component.
UIComponent
  
contentBackgroundAlpha
Type: Number CSS Inheritance: yes Theme: spark
The alpha of the content background for this component.
VideoDisplay
  
contentBackgroundColor
Type: uint Format: Color CSS Inheritance: yes Theme: spark
Color of the content area of the component. The default value is 0xFFFFFF.
VideoDisplay
  
dropShadowVisible
Type: Boolean CSS Inheritance: no Theme: spark
Boolean property that specifies whether the component has a visible drop shadow. The default value is false.

Note: For drop shadows to appear on containers, set contentBackgroundColor property. Otherwise, the shadow appears behind the container because the default background of a container is transparent.

VideoDisplay
Halo Theme Styles
 Style Description Defined By
  
backgroundAlpha
Type: Number CSS Inheritance: no Theme: halo
Alpha level of the color defined by the backgroundColor property, of the image or SWF file defined by the backgroundImage style. Valid values range from 0.0 to 1.0. For most controls, the default value is 1.0, but for ToolTip controls, the default value is 0.95 and for Alert controls, the default value is 0.9. The default value is 1.0.
VideoDisplay
  
backgroundColor
Type: uint Format: Color CSS Inheritance: no Theme: halo
Background color of a component. You can have both a backgroundColor and a backgroundImage set. Some components do not have a background. The DataGrid control ignores this style. The default value is undefined, which means it is not set. If both this style and the backgroundImage style are undefined, the component has a transparent background.

For the Application container, this style specifies the background color while the application loads, and a background gradient while it is running. Flex calculates the gradient pattern between a color slightly darker than the specified color, and a color slightly lighter than the specified color.

The default skins of most Flex controls are partially transparent. As a result, the background color of a container partially "bleeds through" to controls that are in that container. You can avoid this by setting the alpha values of the control's fillAlphas property to 1, as the following example shows:

  <mx:Container backgroundColor="0x66CC66"/>
      <mx:ControlName ... fillAlphas="[1,1]"/>
  </mx:Container>

VideoDisplay
  
backgroundDisabledColor
Type: uint Format: Color CSS Inheritance: yes Theme: halo
Background color of the component when it is disabled. The global default value is undefined. The default value for List controls is 0xDDDDDD (light gray). If a container is disabled, the background is dimmed, and the degree of dimming is controlled by the disabledOverlayAlpha style.
VideoDisplay
  
backgroundImage
Type: Object Format: File CSS Inheritance: no Theme: halo
Background image of a component. This can be an absolute or relative URL or class. You can set either the backgroundColor or the backgroundImage. The background image is displayed on top of the background color. The default value is undefined, meaning "not set". If this style and the backgroundColor style are undefined, the component has a transparent background.

The default skins of most Flex controls are partially transparent. As a result, the background image of a container partially "bleeds through" to controls that are in that container. You can avoid this by setting the alpha values of the control's fillAlphas property to 1, as the following example shows:

  <mx:Container backgroundColor="0x66CC66"/>
      <mx:ControlName ... fillAlphas="[1,1]"/>
  </mx:Container>

VideoDisplay
  
backgroundSize
Type: String CSS Inheritance: no Theme: halo
Scales the image specified by backgroundImage to different percentage sizes. A value of "100%" stretches the image to fit the entire component. To specify a percentage value, you must include the percent sign (%). The default for the Application container is 100%. The default value for all other containers is auto, which maintains the original size of the image.
VideoDisplay
  
borderColor
Type: uint Format: Color CSS Inheritance: no Theme: halo, spark
Color of the border. The default value depends on the component class; if not overridden for the class, the default value is 0xB7BABC for the Halo theme and 0x696969 for the Spark theme.
VideoDisplay
  
borderSides
Type: String CSS Inheritance: no Theme: halo
Bounding box sides. A space-delimited String that specifies the sides of the border to show. The String can contain "left", "top", "right", and "bottom" in any order. The default value is "left top right bottom", which shows all four sides. This style is only used when borderStyle is "solid".
VideoDisplay
  
borderThickness
Type: Number Format: Length CSS Inheritance: no Theme: halo
Bounding box thickness. Only used when borderStyle is set to "solid". The default value is 1.
VideoDisplay
  
cornerRadius
Type: Number Format: Length CSS Inheritance: no Theme: halo
Radius of component corners. The default value is 0.
VideoDisplay
  
dropShadowColor
Type: uint Format: Color CSS Inheritance: yes Theme: halo
Color of the drop shadow. The default value is 0x000000.
VideoDisplay
  
dropShadowEnabled
Type: Boolean CSS Inheritance: no Theme: halo
Boolean property that specifies whether the component has a visible drop shadow. This style is used with borderStyle="solid". The default value is false.

Note: For drop shadows to appear on containers, set backgroundColor or backgroundImage properties. Otherwise, the shadow appears behind the container because the default background of a container is transparent.

VideoDisplay
  
shadowDirection
Type: String CSS Inheritance: no Theme: halo
Direction of the drop shadow. Possible values are "left", "center", and "right". The default value is "center".
VideoDisplay
  
shadowDistance
Type: Number Format: Length CSS Inheritance: no Theme: halo
Distance of the drop shadow. If the property is set to a negative value, the shadow appears above the component. The default value is 2.
VideoDisplay
 InheritedType: uint Format: Color CSS Inheritance: yes Theme: halo
Theme color of a component.
UIComponent
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

autoBandWidthDetection

property
autoBandWidthDetection:Boolean

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

Specifies whether the VideoDisplay control should use the built-in automatic bandwidth detection feature. When false, you do not require a main.asc file on Flash Media Server (FMS) 2 to connect to FMS. When true, you need to implement a main.asc and store it in the directory structure of FMS. The main.asc file must define the following functions:

  •       application.onConnect = function(p_client, p_autoSenseBW)
          {
            //Add security code here.     
            this.acceptConnection(p_client);      
            if (p_autoSenseBW)
              this.calculateClientBw(p_client);
            else
              p_client.call("onBWDone");
          }
  •       application.calculateClientBw = function(p_client)
          {
            // Add code to set the clients BandWidth.
            // Use p_client.getStats() which returns bytes_in 
            // and bytes_Out and check your bandWidth using 
            // p_client.call("onBWCheck", result, p_client.payload).
            p_client.call("onBWDone");
          }
          
  •       Client.prototype.getStreamLength = function(p_streamName)
          {
            return Stream.length(p_streamName);
          }
For more information on writing main.asc, see the FMS documentation.

The default value is false.

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



Implementation
    public function get autoBandWidthDetection():Boolean
    public function set autoBandWidthDetection(value:Boolean):void

autoPlay

property 
autoPlay:Boolean

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

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 (and loading more if autoSize or aspectRatio is set to true). In the case of an HTTP download, Flex starts downloading the stream and shows the first frame.

The default value is true.



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

autoRewind

property 
autoRewind:Boolean

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

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.

The default value is true.

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



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

border

property 
protected var border:IFlexDisplayObject

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

The border object for the control.

borderMetrics

property 
borderMetrics:EdgeMetrics  [read-only]

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

Returns an EdgeMetrics object that has four properties: left, top, right, and bottom. The value of each property is equal to the thickness of one side of the border around the control, in pixels.



Implementation
    public function get borderMetrics():EdgeMetrics

bufferTime

property 
bufferTime:Number

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

Number of seconds of video to buffer in memory before starting to play the video file. For slow connections streaming over RTMP, it is important to increase this property from the default.

The default value is 0.1.

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



Implementation
    public function get bufferTime():Number
    public function set bufferTime(value:Number):void

bytesLoaded

property 
bytesLoaded:int  [read-only]

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

Number of bytes already loaded that are available for playing. The value is only useful for media loaded using HTTP.

Contains -1 when there is no input stream, when the stream is from Flash Media Server, or if the information is not yet available.

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



Implementation
    public function get bytesLoaded():int

bytesTotal

property 
bytesTotal:int  [read-only]

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

Total number of bytes to load. The value is only useful for media loaded using HTTP.

Contains -1 when there is no input stream, when the stream is from Flash Media Server, or if the information is not yet available.

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



Implementation
    public function get bytesTotal():int

cuePointManager

property 
cuePointManager:Object  [read-only]

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

The instance of the CuePointManager class associated with the VideoPlayer control. You can use this object to control cue points, or use the cuePoints property.

You use cue points to trigger cuePoint events when the playback of your video reaches a specified location. To set cue points, you use methods of the CuePointManager class.

Cue points embedded in the FLV are not available via cuePoints or cuePointManager. In order to retrieve them, you can access the metadata property or the metadataReceived event.



Implementation
    public function get cuePointManager():Object

See also

cuePointManagerClass

property 
cuePointManagerClass:Class

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

Cue point manager to use. Set this to mx.controls.videoClasses.CuePointManager to enable cue point management.



Implementation
    public function get cuePointManagerClass():Class
    public function set cuePointManagerClass(value:Class):void

See also

cuePoints

property 
cuePoints:Array

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

The Array of cue points associated with the control. You can use this property to control cue points, or use the cuePointManager property.

You use cue points to trigger cuePoint events when the playback of your video reaches a specified location. To set cue points, you pass an Array to the cuePoints property.

Cue points embedded in the FLV are not available via cuePoints or cuePointManager. In order to retrieve them, you can access the metadata property or the metadataReceived event.

Each element of the Array contains two fields:

  • The name field contains an arbitrary name of the cue point.
  • The time field contains the playhead location, in seconds, of the VideoDisplay control with which the cue point is associated.

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



Implementation
    public function get cuePoints():Array
    public function set cuePoints(value:Array):void

idleTimeout

property 
idleTimeout:int

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

Specifies the amount of time, in milliseconds, that the connection is idle (playing is paused or stopped) before the connection to the Flash Media Server is stopped. This property has no effect on the HTTP download of FLV files. If this property is set when the stream is already idle, it restarts the idle timeout with a new value.

The default value is 300000 (five minutes).



Implementation
    public function get idleTimeout():int
    public function set idleTimeout(value:int):void

live

property 
live:Boolean

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

Specifies whether the control is streaming a live feed. Set this property to true when streaming a live feed from Flash Media Server.

The default value is false.



Implementation
    public function get live():Boolean
    public function set live(value:Boolean):void

maintainAspectRatio

property 
maintainAspectRatio:Boolean

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

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

The default value is true.

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



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

metadata

property 
metadata:Object  [read-only]

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

An object that contains a metadata information packet that is received from a call to the NetStream.onMetaData() callback method, if available. Ready when the metadataReceived event is dispatched.

If the FLV file is encoded with the Flash 8 encoder, the metadata property contains the following information. Older FLV files contain only the height, width, and duration values.

ParameterDescription
canSeekToEndA Boolean value that is true if the FLV file is encoded with a keyframe on the last frame that allows seeking to the end of a progressive download movie clip. It is false if the FLV file is not encoded with a keyframe on the last frame.
cuePointsAn Array of objects, one for each cue point embedded in the FLV file. Value is undefined if the FLV file does not contain any cue points. Each object has the following properties:
  • type—A String that specifies the type of cue point as either "navigation" or "event".
  • name—A String that is the name of the cue point.
  • time—A Number that is the time of the cue point in seconds with a precision of three decimal places (milliseconds).
  • parameters—An optional Object that has name-value pairs that are designated by the user when creating the cue points.
audiocodecidA Number that indicates the audio codec (code/decode technique) that was used.
audiodelay A Number that represents time 0 in the source file from which the FLV file was encoded.

Video content is delayed for the short period of time that is required to synchronize the audio. For example, if the audiodelay value is .038, the video that started at time 0 in the source file starts at time .038 in the FLV file.

Note that the VideoDisplay class compensates for this delay in its time settings. This means that you can continue to use the time settings that you used in your the source file.

audiodatarateA Number that is the kilobytes per second of audio.
videocodecidA Number that is the codec version that was used to encode the video.
framerateA Number that is the frame rate of the FLV file.
videodatarateA Number that is the video data rate of the FLV file.
heightA Number that is the height of the FLV file.
widthA Number that is the width of the FLV file.
durationA Number that specifies the duration of the FLV file in seconds.

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



Implementation
    public function get metadata():Object

playheadTime

property 
playheadTime:Number

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

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.

If player is in an unresponsive state, it queues the request.

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.

The default value is NaN.

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



Implementation
    public function get playheadTime():Number
    public function set playheadTime(value:Number):void

playheadUpdateInterval

property 
playheadUpdateInterval:int

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

Specifies the amount of time, in milliseconds, between each playheadUpdate event.

If you set this property when the video is playing, the timer restarts at 0, and the next playheadUpdate event occurs after the new time interval.

The default value is 250.



Implementation
    public function get playheadUpdateInterval():int
    public function set playheadUpdateInterval(value:int):void

playing

property 
playing:Boolean  [read-only]

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

If true, the media is currently playing.

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



Implementation
    public function get playing():Boolean

progressInterval

property 
progressInterval:int

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

Specifies the amount of time, in milliseconds, between each progress event. The progress event occurs continuously until the video file downloads completely.

If you set this property when the video is downloading, the timer restarts at 0, and the next progress event occurs after the new time interval.

The default value is 250.



Implementation
    public function get progressInterval():int
    public function set progressInterval(value:int):void

source

property 
source:String

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

Relative path and filename of the FLV file to stream.

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



Implementation
    public function get source():String
    public function set source(value:String):void

state

property 
state:String  [read-only]

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

The current state of the VideoDisplay control. You set this property by calls to the load(), play(), stop(), and pause() methods, and setting the playHeadTime property.

This property can have the following values defined in the VideoEvent class: VideoEvent.BUFFERING, VideoEvent.CONNECTION_ERROR, VideoEvent.DISCONNECTED, VideoEvent.EXEC_QUEUED_CMD, VideoEvent.LOADING, VideoEvent.PAUSED, VideoEvent.PLAYING, VideoEvent.RESIZING, VideoEvent.REWINDING, VideoEvent.SEEKING, and VideoEvent.STOPPED.

The default value is VideoEvent.DISCONNECTED.

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



Implementation
    public function get state():String

See also

stateResponsive

property 
stateResponsive:Boolean  [read-only]

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

Specifies whether the VideoDisplay control is in a responsive state, true, or in the unresponsive state, false. The control enters the unresponsive state when video is being loaded or is rewinding.

The control is also in a responsive state when the state property is: VideoEvent.CONNECTION_ERROR, VideoEvent.EXEC_QUEUED_CMD, or VideoEvent.RESIZING.

If the control is unresponsive, calls to the play(), load(), stop(), and pause() methods are queued, and then executed when the control changes to the responsive state.

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



Implementation
    public function get stateResponsive():Boolean

totalTime

property 
totalTime:Number

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

Total length of the media, in seconds. For FLV 1.0 video files, you manually set this property. For FLV 1.1 and later, the control calculates this value automatically.

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



Implementation
    public function get totalTime():Number
    public function set totalTime(value:Number):void

videoHeight

property 
videoHeight:int  [read-only]

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

Height of the loaded FLV file. -1 if no FLV file loaded yet.

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



Implementation
    public function get videoHeight():int

videoWidth

property 
videoWidth:int  [read-only]

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

Width of the loaded FLV file. -1 if no FLV file loaded yet.

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



Implementation
    public function get videoWidth():int

volume

property 
volume:Number

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

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

The default value is 0.75.

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



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

VideoDisplay

()Constructor
public function VideoDisplay()

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

Constructor.

Method Detail

attachCamera

()method
public function attachCamera(camera:Camera):void

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

Specifies to play a video stream from a camera. The video is displayed within the boundaries of the control in the application window. Do not call the play() method when displaying a stream from a camera.

Parameters

camera:Camera — A Camera object that is capturing video data.

close

()method 
public function close():void

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

Forces the close of an input stream and connection to Flash Media Server. Calling this method dispatches the close event. Typically calling this method directly is not necessary because the connection is automatically closed when the idle period times out, as defined by the idleTimeout property.

createBorder

()method 
protected function createBorder():void

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

Creates the border for this component. Normally the border is determined by the borderStyle and borderSkin styles. It must set the border property to the instance of the border.

layoutChrome

()method 
protected function layoutChrome(unscaledWidth:Number, unscaledHeight:Number):void

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

Responds to size changes by setting the positions and sizes of the borders.

The VideoDisplay.layoutChrome() method sets the position and size of the VideoDisplay's border. In every subclass of VideoDisplay, the subclass's layoutChrome() method should call the super.layoutChrome() method, so that the border is positioned properly.

Parameters

unscaledWidth:Number — Specifies the width of the component, in pixels, in the component's coordinates, regardless of the value of the scaleX property of the component.
 
unscaledHeight:Number — Specifies the height of the component, in pixels, in the component's coordinates, regardless of the value of the scaleY property of the component.

load

()method 
public function load():void

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

Loads the media file without playing it.

This method is similar to the play() method, but it causes the file to be loaded without playing. Autoresizing will occur if appropriate. After the load and autoresize, the state of the control is set to VideoEvent.PAUSED.

pause

()method 
public function pause():void

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

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.

If the control is in an unresponsive state, the request is queued.

play

()method 
public function play():void

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

Plays the media file. If the file has not been loaded, it loads it. You can call this method while playback is paused, stopped, or while the control is playing.

If the control is in an unresponsive state, the request is queued.

To stream video from a camera, call the attachCamera() method, instead of the play() method.

stop

()method 
public function stop():void

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

Stops playback. If the autoRewind property is set to true, rewind to the first frame.

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

If playback is already stopped, this method has no effect. If the control is in an unresponsive state, the request is queued.

Event Detail

close

Event
Event Object Type: mx.events.VideoEvent
property VideoEvent.type = mx.events.VideoEvent.CLOSE

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

Dispatched when the NetConnection object is closed, whether by timing out or by calling the close() method. You use this event when working with Flash Media Server.

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.
playheadTimeThe location of the playhead when the event occurs.
stateThe value of the VideoDisplay.state property when the event occurs.
stateResponsiveThe value of the VideoDisplay.stateResponsive property 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: mx.events.VideoEvent
property VideoEvent.type = mx.events.VideoEvent.COMPLETE

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

Dispatched when the playhead reaches the end of the FLV file.

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.
playheadTimeThe location of the playhead when the event occurs.
stateThe value of the VideoDisplay.state property when the event occurs.
stateResponsiveThe value of the VideoDisplay.stateResponsive property 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.

cuePoint

Event  
Event Object Type: mx.events.CuePointEvent
property CuePointEvent.type = mx.events.CuePointEvent.CUE_POINT

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

Dispatched when the value of a cue point's time property is equal to the current playhead location.

The CuePointEvent.CUE_POINT constant defines the value of the type property of the event object for a cuePoint event.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelablefalse
cuePointNameThe name of the cue point.
cuePointTimeThe time of the cue point, in seconds.
cuePointTypeThe string "actionscript".
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.
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: mx.events.MetadataEvent
property MetadataEvent.type = mx.events.MetadataEvent.METADATA_RECEIVED

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

Dispatched the first time metadata in the FLV file is reached.

The MetadataEvent.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.
infoAn object describing the FLV file, including any cue points. This property contains the same information as the VideoDisplay.metadata property. See the VideoDisplay.metadata property for more information.
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.
vpThe index of the VideoPlayer object.

playheadUpdate

Event  
Event Object Type: mx.events.VideoEvent
property VideoEvent.type = mx.events.VideoEvent.PLAYHEAD_UPDATE

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

Dispatched continuosly while the video is playing. The interval between events, in milliseconds, is specified by the playheadUpdateInterval property, which defaults to 250 ms. This event is not dispatched when the video is in a paused or stopped state.

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.
playheadTimeThe location of the playhead when the event occurs.
stateThe value of the VideoDisplay.state property when the event occurs.
stateResponsiveThe value of the VideoDisplay.stateResponsive property 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 3
Runtime Versions: Flash Player 9, AIR 1.1

Dispatched continuously until the FLV file has downloaded completely.

You can use this event to check the number of bytes loaded or the number of bytes in the buffer. This event starts getting dispatched when the load() or play() method is called first and ends when all bytes are loaded or if there is a network error.

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: mx.events.VideoEvent
property VideoEvent.type = mx.events.VideoEvent.READY

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

Dispatched when the FLV file is loaded and ready to play.

This event is dispatched the first time the VideoDisplay control enters a responsive state after a new FLV file is loaded by the load() or play() method. It is dispatched only once for each FLV file 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.
playheadTimeThe location of the playhead when the event occurs.
stateThe value of the VideoDisplay.state property when the event occurs.
stateResponsiveThe value of the VideoDisplay.stateResponsive property 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.

rewind

Event  
Event Object Type: mx.events.VideoEvent
property VideoEvent.type = mx.events.VideoEvent.REWIND

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

Dispatched when the control autorewinds.

The VideoEvent.REWIND constant defines the value of the type property of the event object for a rewind 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.
playheadTimeThe location of the playhead when the event occurs.
stateThe value of the VideoDisplay.state property when the event occurs.
stateResponsiveThe value of the VideoDisplay.stateResponsive property 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.

See also

stateChange

Event  
Event Object Type: mx.events.VideoEvent
property VideoEvent.type = mx.events.VideoEvent.STATE_CHANGE

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

Dispatched when the state of the control changes.

You can use this event to track when playback enters and leaves the unresponsive state (for example, in the middle of connecting, resizing, or rewinding), during which time calls to the play(), pause(), and stop() methods and writes to the playHeadTime property are queued, and then executed when the player enters the responsive state.

The VideoEvent.STATE_CHANGE constant defines the value of the type property of the event object for a stateChange 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.
playheadTimeThe location of the playhead when the event occurs.
stateThe value of the VideoDisplay.state property when the event occurs.
stateResponsiveThe value of the VideoDisplay.stateResponsive property 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.
VideoDisplayExample.mxml
<?xml version="1.0" encoding="utf-8"?>
<!-- Simple example to demonstrate the Halo VideoDisplay control. -->
<s:Application xmlns:fx="http://ns.adobe.com/mxml/2009"
        xmlns:s="library://ns.adobe.com/flex/spark"
        xmlns:mx="library://ns.adobe.com/flex/mx">

    <s:Panel title="Halo VideoDisplay Control Example"
            width="75%" height="75%"
            horizontalCenter="0" verticalCenter="0">
        <s:VGroup left="10" right="10" top="10" bottom="10" horizontalAlign="center">
            <s:Label width="100%" color="blue"
                    text="Use the buttons to control the video. The Stop button resets the video to the beginning."/>
    
            <mx:VideoDisplay id="myVid" height="158" width="211" source="assets/phone.flv" autoPlay="false"/>
    
            <s:HGroup>
                <s:Button label="Play" click="myVid.play();"/>
                <s:Button label="Pause" click="myVid.pause();"/>
                <s:Button label="Stop" click="myVid.stop();"/>
            </s:HGroup>
        </s:VGroup>
    </s:Panel>

</s:Application>