| Package | mx.controls |
| Class | public class VideoDisplay |
| Inheritance | VideoDisplay  UIComponent FlexSprite Sprite DisplayObjectContainer InteractiveObject DisplayObject EventDispatcher 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 Syntax
Show MXML Syntax
Hide MXML SyntaxThe <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"
/>
More examples
Setting the size of the MX VideoDisplay
control
Using methods of the MX VideoDisplay control
Adding a cue point to the MX VideoDisplay control
Streaming video from a camera to the MX VideoDisplay control
Using the MX VideoDisplay control with Flash Media Server
Using methods of the MX VideoDisplay control
Adding a cue point to the MX VideoDisplay control
Streaming video from a camera to the MX VideoDisplay control
Using the MX VideoDisplay control with Flash Media Server
Learn more
MX VideoDisplay control
Using media in Flex
About the MX VideoDisplay control
Mirroring graphics and video
Using media in Flex
About the MX VideoDisplay control
Mirroring graphics and video
Public Properties
| Property | Defined By | ||
|---|---|---|---|
 | accessibilityDescription : String
A convenience accessor for the description property
in this UIComponent's accessibilityProperties object. | UIComponent | |
| accessibilityEnabled : Boolean
A convenience accessor for the silent property
in this UIComponent's accessibilityProperties object. | UIComponent | |
| accessibilityImplementation : AccessibilityImplementation
The current accessibility implementation (AccessibilityImplementation)
for this InteractiveObject instance. | InteractiveObject | |
| accessibilityName : String
A convenience accessor for the name property
in this UIComponent's accessibilityProperties object. | UIComponent | |
| accessibilityProperties : AccessibilityProperties
The current accessibility options for this display object. | DisplayObject | |
| accessibilityShortcut : String
A convenience accessor for the shortcut property
in this UIComponent's accessibilityProperties object. | UIComponent | |
| activeEffects : Array [read-only]
The list of effects that are currently playing on the component,
as an Array of EffectInstance instances. | UIComponent | |
| alpha : 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 | ||
| automationDelegate : Object
The delegate object that handles the automation-related functionality. | UIComponent | |
| automationEnabled : Boolean [read-only]
True if this component is enabled for automation, false
otherwise. | UIComponent | |
| automationName : String
Name that can be used as an identifier for this object. | UIComponent | |
| automationOwner : DisplayObjectContainer [read-only]
The owner of this component for automation purposes. | UIComponent | |
| automationParent : DisplayObjectContainer [read-only]
The parent of this component for automation purposes. | UIComponent | |
| automationTabularData : Object [read-only]
An implementation of the IAutomationTabularData interface, which
can be used to retrieve the data. | UIComponent | |
| automationValue : 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 | |
| automationVisible : 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 | ||
| baseline : Object
For components, this layout constraint property is a
facade on top of the similarly-named style. | UIComponent | |
| baselinePosition : Number [read-only]
The y-coordinate of the baseline
of the first line of text of the component. | UIComponent | |
| blendMode : String
A value from the BlendMode class that specifies which blend mode to use. | DisplayObject | |
| blendShader : Shader [write-only]
Sets a shader that is used for blending the foreground and background. | DisplayObject | |
| borderMetrics : EdgeMetrics [read-only]
Returns an EdgeMetrics object that has four properties:
left, top, right,
and bottom. | VideoDisplay | ||
| bottom : Object
For components, this layout constraint property is a
facade on top of the similarly-named style. | UIComponent | |
| bufferTime : Number
Number of seconds of video to buffer in memory before starting to play
the video file. | VideoDisplay | ||
| buttonMode : 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 | ||
| cacheAsBitmap : Boolean
If set to true, Flash runtimes cache an internal bitmap representation of the
display object. | DisplayObject | |
| cacheAsBitmapMatrix : Matrix
If non-null, this Matrix object defines how a display object is rendered when
cacheAsBitmap is set to true. | DisplayObject | |
| cacheHeuristic : Boolean [write-only]
Used by Flex to suggest bitmap caching for the object. | UIComponent | |
| cachePolicy : String
Specifies the bitmap caching policy for this object. | UIComponent | |
| className : String [read-only]
The name of this instance's class, such as "Button". | UIComponent | |
| constructor : Object
A reference to the class object or constructor function for a given object instance. | Object | |
| contentMouseX : Number [read-only]
Returns the x position of the mouse, in the content coordinate system. | UIComponent | |
| contentMouseY : Number [read-only]
Returns the y position of the mouse, in the content coordinate system. | UIComponent | |
| contextMenu : 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 | ||
| currentState : String
The current view state of the component. | UIComponent | |
| cursorManager : ICursorManager [read-only]
Gets the CursorManager that controls the cursor for this component
and its peers. | UIComponent | |
| depth : Number
Determines the order in which items inside of containers
are rendered. | UIComponent | |
| descriptor : UIComponentDescriptor
Reference to the UIComponentDescriptor, if any, that was used
by the createComponentFromDescriptor() method to create this
UIComponent instance. | UIComponent | |
| designLayer : DesignLayer
Specifies the optional DesignLayer instance associated with this visual
element. | UIComponent | |
| document : Object
A reference to the document object associated with this UIComponent. | UIComponent | |
| doubleClickEnabled : Boolean [override]
Specifies whether the UIComponent object receives doubleClick events. | UIComponent | |
| dropTarget : DisplayObject [read-only]
Specifies the display object over which the sprite is being dragged, or on
which the sprite was dropped. | Sprite | |
| enabled : Boolean
Whether the component can accept user interaction. | UIComponent | |
| errorString : String
The text that displayed by a component's error tip when a
component is monitored by a Validator and validation fails. | UIComponent | |
| explicitHeight : Number
Number that specifies the explicit height of the component,
in pixels, in the component's coordinates. | UIComponent | |
| explicitMaxHeight : Number
The maximum recommended height of the component to be considered
by the parent during layout. | UIComponent | |
| explicitMaxWidth : Number
The maximum recommended width of the component to be considered
by the parent during layout. | UIComponent | |
| explicitMinHeight : Number
The minimum recommended height of the component to be considered
by the parent during layout. | UIComponent | |
| explicitMinWidth : Number
The minimum recommended width of the component to be considered
by the parent during layout. | UIComponent | |
| explicitWidth : Number
Number that specifies the explicit width of the component,
in pixels, in the component's coordinates. | UIComponent | |
| filters : Array
An indexed array that contains each filter object currently associated with the display object. | DisplayObject | |
| flexContextMenu : IFlexContextMenu
The context menu for this UIComponent. | UIComponent | |
| focusEnabled : Boolean
Indicates whether the component can receive focus when tabbed to. | UIComponent | |
| focusManager : IFocusManager
Gets the FocusManager that controls focus for this component
and its peers. | UIComponent | |
| focusPane : Sprite
The focus pane associated with this object. | UIComponent | |
| focusRect : Object
Specifies whether this object displays a focus rectangle. | InteractiveObject | |
| graphics : Graphics [read-only]
Specifies the Graphics object that belongs to this sprite where vector
drawing commands can occur. | Sprite | |
| hasFocusableChildren : Boolean
A flag that indicates whether child objects can receive focus. | UIComponent | |
| hasLayoutMatrix3D : Boolean [read-only]
Contains true if the element has 3D Matrix. | UIComponent | |
| height : Number [override]
Number that specifies the height of the component, in pixels,
in the parent's coordinates. | UIComponent | |
| hitArea : Sprite
Designates another sprite to serve as the hit area for a sprite. | Sprite | |
| horizontalCenter : Object
For components, this layout constraint property is a
facade on top of the similarly-named style. | UIComponent | |
| id : 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 | ||
| includeInLayout : Boolean
Specifies whether this component is included in the layout of the
parent container. | UIComponent | |
| inheritingStyles : Object
The beginning of this component's chain of inheriting styles. | UIComponent | |
| initialized : 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 | |
| instanceIndex : int [read-only]
The index of a repeated component. | UIComponent | |
| instanceIndices : Array
An Array containing the indices required to reference
this UIComponent object from its parent document. | UIComponent | |
| is3D : Boolean [read-only]
Contains true when the element is in 3D. | UIComponent | |
| isDocument : Boolean [read-only]
Contains true if this UIComponent instance is a document object. | UIComponent | |
| isPopUp : Boolean
Set to true by the PopUpManager to indicate
that component has been popped up. | UIComponent | |
| layoutMatrix3D : Matrix3D [write-only]
The transform matrix that is used to calculate a component's layout
relative to its siblings. | UIComponent | |
| left : Object
For components, this layout constraint property is a
facade on top of the similarly-named style. | UIComponent | |
| live : Boolean
Specifies whether the control is streaming a live feed. | VideoDisplay | ||
| loaderInfo : 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 | ||
| maintainProjectionCenter : Boolean
When true, the component keeps its projection matrix centered on the
middle of its bounding box. | UIComponent | |
| mask : DisplayObject
The calling display object is masked by the specified mask object. | DisplayObject | |
| maxHeight : Number
The maximum recommended height of the component to be considered
by the parent during layout. | UIComponent | |
| maxWidth : Number
The maximum recommended width of the component to be considered
by the parent during layout. | UIComponent | |
| measuredHeight : Number
The default height of the component, in pixels. | UIComponent | |
| measuredMinHeight : Number
The default minimum height of the component, in pixels. | UIComponent | |
| measuredMinWidth : Number
The default minimum width of the component, in pixels. | UIComponent | |
| measuredWidth : 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 | ||
| metaData : Object
Obtains the meta data object of the DisplayObject instance if meta data was stored alongside the
the instance of this DisplayObject in the SWF file through a PlaceObject4 tag. | DisplayObject | |
| minHeight : Number
The minimum recommended height of the component to be considered
by the parent during layout. | UIComponent | |
| minWidth : Number
The minimum recommended width of the component to be considered
by the parent during layout. | UIComponent | |
| moduleFactory : 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 | |
| mouseChildren : Boolean
Determines whether or not the children of the object are mouse, or user input device, enabled. | DisplayObjectContainer | |
| mouseEnabled : Boolean
Specifies whether this object receives mouse, or other user input, messages. | InteractiveObject | |
| mouseFocusEnabled : Boolean
Whether you can receive focus when clicked on. | UIComponent | |
| mouseX : Number [read-only]
Indicates the x coordinate of the mouse or user input device position, in pixels. | DisplayObject | |
| mouseY : Number [read-only]
Indicates the y coordinate of the mouse or user input device position, in pixels. | DisplayObject | |
| name : String
Indicates the instance name of the DisplayObject. | DisplayObject | |
| needsSoftKeyboard : Boolean
Specifies whether a virtual keyboard (an on-screen, software keyboard) should display
when this InteractiveObject instance receives focus. | InteractiveObject | |
| nestLevel : int
Depth of this object in the containment hierarchy. | UIComponent | |
| nonInheritingStyles : Object
The beginning of this component's chain of non-inheriting styles. | UIComponent | |
| numAutomationChildren : int [read-only]
The number of automation children this container has. | UIComponent | |
| numChildren : int [read-only]
Returns the number of children of this object. | DisplayObjectContainer | |
| opaqueBackground : Object
Specifies whether the display object is opaque with a certain background color. | DisplayObject | |
| owner : DisplayObjectContainer
The owner of this IVisualElement object. | UIComponent | |
| parent : DisplayObjectContainer [override] [read-only]
The parent container or component for this component. | UIComponent | |
| parentApplication : Object [read-only]
A reference to the Application object that contains this UIComponent
instance. | UIComponent | |
| parentDocument : Object [read-only]
A reference to the parent document object for this UIComponent. | UIComponent | |
| percentHeight : Number
Specifies the height of a component as a percentage
of its parent's size. | UIComponent | |
| percentWidth : Number
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 | ||
| postLayoutTransformOffsets : 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 | |
| processedDescriptors : 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 | ||
| repeater : IRepeater [read-only]
A reference to the Repeater object
in the parent document that produced this UIComponent. | UIComponent | |
| repeaterIndex : int [read-only]
The index of the item in the data provider
of the Repeater that produced this UIComponent. | UIComponent | |
| repeaterIndices : 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 | |
| repeaters : Array
An Array containing references to the Repeater objects
in the parent document that produced this UIComponent. | UIComponent | |
| right : Object
For components, this layout constraint property is a
facade on top of the similarly-named style. | UIComponent | |
| root : DisplayObject [read-only]
For a display object in a loaded SWF file, the root property is the
top-most display object in the portion of the display list's tree structure represented by that SWF file. | DisplayObject | |
| rotation : Number [override]
Indicates the rotation of the DisplayObject instance, in degrees, from its original orientation. | UIComponent | |
| rotationX : Number [override]
Indicates the x-axis rotation of the DisplayObject instance, in degrees, from its original orientation
relative to the 3D parent container. | UIComponent | |
| rotationY : Number [override]
Indicates the y-axis rotation of the DisplayObject instance, in degrees, from its original orientation
relative to the 3D parent container. | UIComponent | |
| rotationZ : Number [override]
Indicates the z-axis rotation of the DisplayObject instance, in degrees, from its original orientation relative to the 3D parent container. | UIComponent | |
| scale9Grid : Rectangle
The current scaling grid that is in effect. | DisplayObject | |
| scaleX : Number [override]
Number that specifies the horizontal scaling factor. | UIComponent | |
| scaleY : Number [override]
Number that specifies the vertical scaling factor. | UIComponent | |
| scaleZ : Number [override]
Number that specifies the scaling factor along the z axis. | UIComponent | |
| screen : Rectangle [read-only]
Returns an object that contains the size and position of the base
drawing surface for this object. | UIComponent | |
| scrollRect : Rectangle
The scroll rectangle bounds of the display object. | DisplayObject | |
| showInAutomationHierarchy : Boolean
A flag that determines if an automation object
shows in the automation hierarchy. | UIComponent | |
| softKeyboard : String
Controls the appearance of the soft keyboard. | InteractiveObject | |
| softKeyboardInputAreaOfInterest : Rectangle
Defines the area that should remain on-screen when a soft keyboard is displayed (not available on iOS). | InteractiveObject | |
| soundTransform : flash.media:SoundTransform
Controls sound within this sprite. | Sprite | |
| source : String
Relative path and filename of the FLV file to stream. | VideoDisplay | ||
| stage : 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 | ||
| states : Array
The view states that are defined for this component. | UIComponent | |
| styleDeclaration : CSSStyleDeclaration
Storage for the inline inheriting styles on this object. | UIComponent | |
| styleManager : IStyleManager2 [read-only]
Returns the StyleManager instance used by this component. | UIComponent | |
| styleName : Object
The class style used by this component. | UIComponent | |
| styleParent : IAdvancedStyleClient
A component's parent is used to evaluate descendant selectors. | UIComponent | |
| systemManager : ISystemManager
Returns the SystemManager object used by this component. | UIComponent | |
| tabChildren : Boolean
Determines whether the children of the object are tab enabled. | DisplayObjectContainer | |
| tabEnabled : Boolean
Specifies whether this object is in the tab order. | InteractiveObject | |
| tabFocusEnabled : 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 | |
| tabIndex : int
Specifies the tab ordering of objects in a SWF file. | InteractiveObject | |
| textSnapshot : flash.text:TextSnapshot [read-only]
Returns a TextSnapshot object for this DisplayObjectContainer instance. | DisplayObjectContainer | |
| toolTip : String
Text to display in the ToolTip. | UIComponent | |
| top : Object
For components, this layout constraint property is a
facade on top of the similarly-named style. | UIComponent | |
| totalTime : Number
Total length of the media, in seconds. | VideoDisplay | ||
| transform : flash.geom:Transform [override]
An object with properties pertaining to a display object's matrix, color transform,
and pixel bounds. | UIComponent | |
| transformX : Number
Sets the x coordinate for the transform center of the component. | UIComponent | |
| transformY : Number
Sets the y coordinate for the transform center of the component. | UIComponent | |
| transformZ : Number
Sets the z coordinate for the transform center of the component. | UIComponent | |
| transitions : Array
An Array of Transition objects, where each Transition object defines a
set of effects to play when a view state change occurs. | UIComponent | |
| tweeningProperties : Array
Array of properties that are currently being tweened on this object. | UIComponent | |
| uid : String
A unique identifier for the object. | UIComponent | |
| updateCompletePendingFlag : Boolean
A flag that determines if an object has been through all three phases
of layout validation (provided that any were required). | UIComponent | |
| useHandCursor : Boolean
A Boolean value that indicates whether the pointing hand (hand cursor) appears when the pointer rolls
over a sprite in which the buttonMode property is set to true. | Sprite | |
| validationSubField : String
Used by a validator to associate a subfield with this component. | UIComponent | |
| verticalCenter : Object
For components, this layout constraint property is a
facade on top of the similarly-named style. | UIComponent | |
| videoHeight : int [read-only]
Height of the loaded FLV file. | VideoDisplay | ||
| videoWidth : int [read-only]
Width of the loaded FLV file. | VideoDisplay | ||
| visible : 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 | ||
| width : Number [override]
Number that specifies the width of the component, in pixels,
in the parent's coordinates. | UIComponent | |
| x : Number [override]
Number that specifies the component's horizontal position,
in pixels, within its parent container. | UIComponent | |
| y : Number [override]
Number that specifies the component's vertical position,
in pixels, within its parent container. | UIComponent | |
| z : Number [override]
Indicates the z coordinate position along the z-axis of the DisplayObject
instance relative to the 3D parent container. | UIComponent | |
Protected Properties
| Property | Defined By | ||
|---|---|---|---|
| border : IFlexDisplayObject
The border object for the control. | VideoDisplay | ||
| currentCSSState : String [read-only]
The state to be used when matching CSS pseudo-selectors. | UIComponent | |
| hasComplexLayoutMatrix : Boolean [read-only]
Returns true if the UIComponent has any non-translation (x,y) transform properties. | UIComponent | |
| resourceManager : IResourceManager [read-only]
A reference to the object which manages
all of the application's localized resources. | UIComponent | |
| unscaledHeight : Number [read-only]
A convenience method for determining the unscaled height
of the component. | UIComponent | |
| unscaledWidth : 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
| Method | Defined By | ||
|---|---|---|---|
Constructor. | VideoDisplay | ||
|
Adds a child DisplayObject instance to this DisplayObjectContainer instance. | DisplayObjectContainer | |
|
Adds a child DisplayObject instance to this DisplayObjectContainer
instance. | DisplayObjectContainer | |
| addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
Registers an event listener object with an EventDispatcher object so that the listener
receives notification of an event. | EventDispatcher | |
|
Adds a non-visual style client to this component instance. | UIComponent | |
|
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 | ||
|
Queues a function to be called later. | UIComponent | |
|
Deletes a style property from this component instance. | UIComponent | |
Forces the close of an input stream and connection to Flash Media
Server. | VideoDisplay | ||
|
Determines whether the specified display object is a child of the DisplayObjectContainer instance or
the instance itself. | DisplayObjectContainer | |
|
Converts a Point object from content coordinates to global coordinates. | UIComponent | |
|
Converts a Point object from content to local coordinates. | UIComponent | |
|
Returns a set of properties that identify the child within
this container. | UIComponent | |
|
Returns a set of properties that identify the child within
this container. | UIComponent | |
|
Creates an id reference to this IUIComponent object
on its parent document object. | UIComponent | |
|
Deletes the id reference to this IUIComponent object
on its parent document object. | UIComponent | |
|
Returns a UITextFormat object corresponding to the text styles
for this UIComponent. | UIComponent | |
| [override]
Dispatches an event into the event flow. | UIComponent | |
|
Shows or hides the focus indicator around this component. | UIComponent | |
| 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 | |
|
Called by the effect instance when it stops playing on the component. | UIComponent | |
|
Called by the effect instance when it starts playing on the component. | UIComponent | |
|
Ends all currently playing effects on the component. | UIComponent | |
|
Executes all the bindings for which the UIComponent object is the destination. | UIComponent | |
|
Called after printing is complete. | UIComponent | |
|
Provides the automation object at the specified index. | UIComponent | |
|
Provides the automation object list . | UIComponent | |
|
Returns a rectangle that defines the area of the display object relative to the coordinate system
of the targetCoordinateSpace object. | DisplayObject | |
|
Returns the x coordinate of the element's bounds at the specified element size. | UIComponent | |
|
Returns the y coordinate of the element's bounds at the specified element size. | UIComponent | |
|
Returns the child display object instance that exists at the specified index. | DisplayObjectContainer | |
|
Returns the child display object that exists with the specified name. | DisplayObjectContainer | |
|
Returns the index position of a child DisplayObject instance. | DisplayObjectContainer | |
|
Finds the type selectors for this UIComponent instance. | UIComponent | |
|
Returns a layout constraint value, which is the same as
getting the constraint style for this component. | UIComponent | |
|
A convenience method for determining whether to use the
explicit or measured height
| UIComponent | |
|
A convenience method for determining whether to use the
explicit or measured width
| UIComponent | |
|
Gets the object that currently has focus. | UIComponent | |
|
Returns the element's layout height. | UIComponent | |
|
Returns the element's layout width. | UIComponent | |
|
Returns the x coordinate that the element uses to draw on screen. | UIComponent | |
|
Returns the y coordinate that the element uses to draw on screen. | UIComponent | |
|
Returns the transform matrix that is used to calculate the component's
layout relative to its siblings. | UIComponent | |
|
Returns the layout transform Matrix3D for this element. | UIComponent | |
|
Returns the element's maximum height. | UIComponent | |
|
Returns the element's maximum width. | UIComponent | |
|
Returns the element's minimum height. | UIComponent | |
|
Returns the element's minimum width. | UIComponent | |
|
Returns an array of objects that lie under the specified point and are children
(or grandchildren, and so on) of this DisplayObjectContainer instance. | DisplayObjectContainer | |
|
Returns the element's preferred height. | UIComponent | |
|
Returns the element's preferred width. | UIComponent | |
|
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 | |
|
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 | |
|
Gets a style property that has been set anywhere in this
component's style lookup chain. | UIComponent | |
|
Converts a Point object from global to content coordinates. | UIComponent | |
|
Converts the point object from the Stage (global) coordinates
to the display object's (local) coordinates. | DisplayObject | |
|
Converts a two-dimensional point from the Stage (global) coordinates to a
three-dimensional display object's (local) coordinates. | DisplayObject | |
|
Returns true if currentCSSState is not null. | UIComponent | |
|
Checks whether the EventDispatcher object has any listeners registered for a specific type
of event. | EventDispatcher | |
|
Indicates whether an object has a specified property defined. | Object | |
|
Determines whether the specified state has been defined on this
UIComponent. | UIComponent | |
|
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 | |
|
Evaluates the display object to see if it overlaps or intersects with the
point specified by the x and y parameters. | DisplayObject | |
|
Returns a box Matrix which can be passed to the
drawRoundRect() method
as the rot parameter when drawing a horizontal gradient. | UIComponent | |
|
Initializes the internal structure of this component. | UIComponent | |
|
Initializes various properties which keep track of repeated instances
of this component. | UIComponent | |
|
Marks a component so that its updateDisplayList()
method gets called during a later screen update. | UIComponent | |
|
Called by a component's items to indicate that their depth
property has changed. | UIComponent | |
|
An element must call this method when its layoutDirection changes or
when its parent's layoutDirection changes. | UIComponent | |
|
Marks a component so that its commitProperties()
method gets called during a later screen update. | UIComponent | |
|
Marks a component so that its measure()
method gets called during a later screen update. | UIComponent | |
|
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 | ||
|
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 | |
|
Converts a Point object from local to content coordinates. | UIComponent | |
|
Converts the point object from the display object's (local) coordinates to the
Stage (global) coordinates. | DisplayObject | |
|
Returns true if cssState matches currentCSSState. | UIComponent | |
|
Determines whether this instance is the same as, or is a subclass of,
the given type. | UIComponent | |
|
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 | |
|
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 | |
|
Moves the component to a specified position within its parent. | UIComponent | |
|
Propagates style changes to the children. | UIComponent | |
|
Returns true if the chain of owner properties
points from child to this UIComponent. | UIComponent | |
|
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 | ||
|
Prepares an IFlexDisplayObject for printing. | UIComponent | |
|
Indicates whether the specified property exists and is enumerable. | Object | |
|
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 | |
|
For each effect event, registers the EffectManager
as one of the event listeners. | UIComponent | |
|
Removes the specified child DisplayObject instance from the child list of the DisplayObjectContainer instance. | DisplayObjectContainer | |
|
Removes a child DisplayObject from the specified index position in the child list of
the DisplayObjectContainer. | DisplayObjectContainer | |
|
Removes all child DisplayObject instances from the child list of the DisplayObjectContainer instance. | DisplayObjectContainer | |
|
Removes a listener from the EventDispatcher object. | EventDispatcher | |
|
Removes a non-visual style client from this component instance. | UIComponent | |
|
Replays the specified event. | UIComponent | |
|
Raises a virtual keyboard. | InteractiveObject | |
|
Resolves a child by using the id provided. | UIComponent | |
| [static]
Resumes the background processing of methods
queued by callLater(), after a call to
suspendBackgroundProcessing(). | UIComponent | |
|
Sizes the object. | UIComponent | |
|
Changes the position of an existing child in the display object container. | DisplayObjectContainer | |
|
Sets a layout constraint value, which is the same as
setting the constraint style for this component. | UIComponent | |
|
Set the current state. | UIComponent | |
|
Sets the focus to this component. | UIComponent | |
|
Sets the coordinates that the element uses to draw on screen. | UIComponent | |
|
Sets the layout size of the element. | UIComponent | |
|
Sets the transform Matrix that is used to calculate the component's layout
size and position relative to its siblings. | UIComponent | |
|
Sets the transform Matrix3D that is used to calculate the component's layout
size and position relative to its siblings. | UIComponent | |
|
Sets the availability of a dynamic property for loop operations. | Object | |
|
Sets a style property on this component instance. | UIComponent | |
|
Called when the visible property changes. | UIComponent | |
|
Lets the user drag the specified sprite. | Sprite | |
|
Lets the user drag the specified sprite on a touch-enabled device. | Sprite | |
Stops playback. | VideoDisplay | ||
|
Recursively stops the timeline execution of all MovieClips rooted at this object. | DisplayObjectContainer | |
|
Ends the startDrag() method. | Sprite | |
|
Ends the startTouchDrag() method, for use with touch-enabled devices. | Sprite | |
|
Detects changes to style properties. | UIComponent | |
|
Flex calls the stylesInitialized() method when
the styles for a component are first initialized. | UIComponent | |
| [static]
Blocks the background processing of methods
queued by callLater(),
until resumeBackgroundProcessing() is called. | UIComponent | |
|
Swaps the z-order (front-to-back order) of the two specified child objects. | DisplayObjectContainer | |
|
Swaps the z-order (front-to-back order) of the child objects at the two specified index positions in the
child list. | DisplayObjectContainer | |
|
Returns the string representation of this object, formatted according to locale-specific conventions. | Object | |
| [override]
Returns a string indicating the location of this object
within the hierarchy of DisplayObjects in the Application. | FlexSprite | |
| 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 | |
|
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 | |
|
Validates the position and size of children and draws other
visuals. | UIComponent | |
|
Validate and update the properties and layout of this object
and redraw it, if necessary. | UIComponent | |
|
Used by layout logic to validate the properties of a component
by calling the commitProperties() method. | UIComponent | |
|
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 | |
|
Handles both the valid and invalid events from a
validator assigned to this component. | UIComponent | |
|
Returns the primitive value of the specified object. | Object | |
|
Returns a box Matrix which can be passed to drawRoundRect()
as the rot parameter when drawing a vertical gradient. | UIComponent | |
|
Checks whether an event listener is registered with this EventDispatcher object or any of
its ancestors for the specified event type. | EventDispatcher | |
Protected Methods
| Method | Defined By | ||
|---|---|---|---|
|
Adjust the focus rectangle. | UIComponent | |
|
Commits the computed matrix built from the combination of the layout
matrix and the transform offsets to the flash displayObject's transform. | UIComponent | |
|
This is an internal method used by the Flex framework
to support the Dissolve effect. | UIComponent | |
|
Determines if the call to the measure() method can be skipped. | UIComponent | |
|
Performs any final processing after child objects are created. | UIComponent | |
|
Processes the properties set on the component. | UIComponent | |
Creates the border for this component. | VideoDisplay | ||
|
Create child objects of the component. | UIComponent | |
|
Creates a new object using a context
based on the embedded font being used. | UIComponent | |
|
Creates the object using a given moduleFactory. | UIComponent | |
|
Helper method for dispatching a PropertyChangeEvent
when a property is updated. | UIComponent | |
|
The event handler called when a UIComponent object gets focus. | UIComponent | |
|
The event handler called when a UIComponent object loses focus. | UIComponent | |
|
Initializes the implementation and storage of some of the less frequently
used advanced layout features of a component. | UIComponent | |
|
Finalizes the initialization of this component. | UIComponent | |
|
Initializes this component's accessibility code. | UIComponent | |
|
Helper method to invalidate parent size and display list if
this object affects its layout (includeInLayout is true). | UIComponent | |
|
Typically overridden by components containing UITextField objects,
where the UITextField object gets focus. | UIComponent | |
|
The event handler called for a keyDown event. | UIComponent | |
|
The event handler called for a keyUp event. | UIComponent | |
Responds to size changes by setting the positions and sizes of
the borders. | VideoDisplay | ||
|
Calculates the default size, and optionally the default minimum size,
of the component. | UIComponent | |
|
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 | |
|
Specifies a transform stretch factor in the horizontal and vertical direction. | UIComponent | |
|
This method is called when a state changes to check whether
state-specific styles apply to this component. | UIComponent | |
|
Draws the object and/or sizes and positions its children. | UIComponent | |
Events
| Event | Summary | Defined By | ||
|---|---|---|---|---|
| [broadcast event] Dispatched when the Flash Player or AIR application gains operating system focus and becomes active. | EventDispatcher | ||
| Dispatched when the component is added to a container as a content child by using the addChild(), addChildAt(), addElement(), or addElementAt() method. | UIComponent | ||
| Dispatched when a display object is added to the display list. | DisplayObject | ||
| Dispatched when a display object is added to the on stage display list, either directly or through the addition of a sub tree in which the display object is contained. | DisplayObject | ||
| Dispatched when the user selects 'Clear' (or 'Delete') from the text context menu. | InteractiveObject | ||
| Dispatched 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 | |||
| Dispatched when a user gesture triggers the context menu associated with this interactive object in an AIR application. | InteractiveObject | ||
| Dispatched when the user activates the platform-specific accelerator key combination for a copy operation or selects 'Copy' from the text context menu. | InteractiveObject | ||
| Dispatched when 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 | |||
| Dispatched after the view state has changed. | UIComponent | ||
| Dispatched after the currentState property changes, but before the view state changes. | UIComponent | ||
| Dispatched when the user activates the platform-specific accelerator key combination for a cut operation or selects 'Cut' from the text context menu. | InteractiveObject | ||
| [broadcast event] Dispatched when the Flash Player or AIR application operating loses system focus and is becoming inactive. | EventDispatcher | ||
| Dispatched when a user presses and releases the main button of a pointing device twice in rapid succession over the same InteractiveObject when that object's doubleClickEnabled flag is set to true. | InteractiveObject | ||
| Dispatched 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 | ||
| Dispatched by the drop target when the user releases the mouse over it. | UIComponent | ||
| Dispatched by a component when the user moves the mouse over the component during a drag operation. | UIComponent | ||
| Dispatched by the component when the user drags outside the component, but does not drop the data onto the target. | UIComponent | ||
| Dispatched by a component when the user moves the mouse while over the component during a drag operation. | UIComponent | ||
| Dispatched by the drag initiator when starting a drag operation. | UIComponent | ||
| Dispatched after an effect ends. | UIComponent | ||
| Dispatched just before an effect starts. | UIComponent | ||
| Dispatched after an effect is stopped, which happens only by a call to stop() on the effect. | UIComponent | ||
| [broadcast event] Dispatched when the playhead is entering a new frame. | DisplayObject | ||
| Dispatched after the component has entered a view state. | UIComponent | ||
| [broadcast event] Dispatched when the playhead is exiting the current frame. | DisplayObject | ||
| Dispatched just before the component exits a view state. | UIComponent | ||
| Dispatched after a display object gains focus. | InteractiveObject | ||
| Dispatched after a display object loses focus. | InteractiveObject | ||
| [broadcast event] Dispatched after the constructors of frame display objects have run but before frame scripts have run. | DisplayObject | ||
| Dispatched when the user creates a point of contact along the edge of the touch surface with an InteractiveObject instance, (such as tapping along the edge of the touch surface on Siri Remote for Apple TV) Some devices might also interpret this contact as a combination of several touch events, as well. | InteractiveObject | ||
| Dispatched when the user presses two points of contact over the same InteractiveObject instance on a touch-enabled device (such as presses and releases two fingers over a display object on a mobile phone or tablet with a touch screen). | InteractiveObject | ||
| Dispatched when the user moves a point of contact over the InteractiveObject instance on a touch-enabled device (such as moving a finger from left to right over a display object on a mobile phone or tablet with a touch screen). | InteractiveObject | ||
| Dispatched when the user performs a rotation gesture at a point of contact with an InteractiveObject instance (such as touching two fingers and rotating them over a display object on a mobile phone or tablet with a touch screen). | InteractiveObject | ||
| Dispatched when the user performs a swipe gesture at a point of contact with an InteractiveObject instance (such as touching three fingers to a screen and then moving them in parallel over a display object on a mobile phone or tablet with a touch screen). | InteractiveObject | ||
| Dispatched when the user creates a point of contact with an InteractiveObject instance, then taps on a touch-enabled device (such as placing several fingers over a display object to open a menu and then taps one finger to select a menu item on a mobile phone or tablet with a touch screen). | InteractiveObject | ||
| Dispatched when the user performs a zoom gesture at a point of contact with an InteractiveObject instance (such as touching two fingers to a screen and then quickly spreading the fingers apart over a display object on a mobile phone or tablet with a touch screen). | InteractiveObject | ||
| Dispatched when an object's state changes from visible to invisible. | UIComponent | ||
| This event is dispatched to any client app that supports inline input with an IME | InteractiveObject | ||
| Dispatched when the component has finished its construction and has all initialization properties set. | UIComponent | ||
| Dispatched when a component is monitored by a Validator and the validation failed. | UIComponent | ||
| Dispatched when the user presses a key. | InteractiveObject | ||
| Dispatched when the user attempts to change focus by using keyboard navigation. | InteractiveObject | ||
| Dispatched when the user releases a key. | InteractiveObject | ||
| Dispatched the first time metadata in the FLV file is reached. | VideoDisplay | |||
| Dispatched when a user presses and releases the middle button of the user's pointing device over the same InteractiveObject. | InteractiveObject | ||
| Dispatched when a user presses the middle pointing device button over an InteractiveObject instance. | InteractiveObject | ||
| Dispatched when a user releases the pointing device button over an InteractiveObject instance. | InteractiveObject | ||
| Dispatched when a user presses the pointing device button over an InteractiveObject instance. | InteractiveObject | ||
| Dispatched from a component opened using the PopUpManager when the user clicks outside it. | UIComponent | ||
| Dispatched when the user attempts to change focus by using a pointer device. | InteractiveObject | ||
| Dispatched when a user moves the pointing device while it is over an InteractiveObject. | InteractiveObject | ||
| Dispatched when the user moves a pointing device away from an InteractiveObject instance. | InteractiveObject | ||
| Dispatched when the user moves a pointing device over an InteractiveObject instance. | InteractiveObject | ||
| Dispatched when a user releases the pointing device button over an InteractiveObject instance. | InteractiveObject | ||
| Dispatched when a mouse wheel is spun over an InteractiveObject instance. | InteractiveObject | ||
| Dispatched from a component opened using the PopUpManager when the user scrolls the mouse wheel outside it. | UIComponent | ||
| Dispatched when the object has moved. | UIComponent | ||
| Dispatched by the drag initiator InteractiveObject when the user releases the drag gesture. | InteractiveObject | ||
| Dispatched by the target InteractiveObject when a dragged object is dropped on it and the drop has been accepted with a call to DragManager.acceptDragDrop(). | InteractiveObject | ||
| Dispatched by an InteractiveObject when a drag gesture enters its boundary. | InteractiveObject | ||
| Dispatched by an InteractiveObject when a drag gesture leaves its boundary. | InteractiveObject | ||
| Dispatched by an InteractiveObject continually while a drag gesture remains within its boundary. | InteractiveObject | ||
| Dispatched at the beginning of a drag operation by the InteractiveObject that is specified as the drag initiator in the DragManager.doDrag() call. | InteractiveObject | ||
| Dispatched during a drag operation by the InteractiveObject that is specified as the drag initiator in the DragManager.doDrag() call. | InteractiveObject | ||
| Dispatched 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 | |||
| Dispatched at the beginning of the component initialization sequence. | UIComponent | ||
| Dispatched continuously until the FLV file has downloaded completely. | VideoDisplay | |||
| Dispatched when the user lowers an active stylus past the proximity detection threshold of the screen. | InteractiveObject | ||
| Dispatched when the user lifts an active stylus above the proximity detection threshold of the screen. | InteractiveObject | ||
| Dispatched when the user moves an active stylus over the screen while remaining within the proximity detection threshold. | InteractiveObject | ||
| Dispatched when the user moves an active stylus away from this InteractiveObject while remaining within the proximity detection threshold of the screen. | InteractiveObject | ||
| Dispatched when the user moves an active stylus directly above this InteractiveObject while remaining within the proximity detection threshold of the screen. | InteractiveObject | ||
| Dispatched when the user moves an active stylus away from this InteractiveObject and any of its children while remaining within the proximity detection threshold of the screen. | InteractiveObject | ||
| Dispatched when the user moves an active stylus over this InteractiveObject from outside the object's tree of descendents in the display list (while remaining within the proximity detection threshold of the screen). | InteractiveObject | ||
| Dispatched when the FLV file is loaded and ready to play. | VideoDisplay | |||
| Dispatched when a user releases the button on the pointing device after the user first pressed the button over an InteractiveObject instance and then moved the pointing device off of the InteractiveObject instance. | InteractiveObject | ||
| Dispatched when the component is removed from a container as a content child by using the removeChild(), removeChildAt(), removeElement(), or removeElementAt() method. | UIComponent | ||
| Dispatched when a display object is about to be removed from the display list. | DisplayObject | ||
| Dispatched when a display object is about to be removed from the display list, either directly or through the removal of a sub tree in which the display object is contained. | DisplayObject | ||
| [broadcast event] Dispatched when the display list is about to be updated and rendered. | DisplayObject | ||
| Dispatched when the component is resized. | UIComponent | ||
| Dispatched when the control autorewinds. | VideoDisplay | |||
| Dispatched when a user presses and releases the right button of the user's pointing device over the same InteractiveObject. | InteractiveObject | ||
| Dispatched when a user presses the pointing device button over an InteractiveObject instance. | InteractiveObject | ||
| Dispatched when a user releases the pointing device button over an InteractiveObject instance. | InteractiveObject | ||
| Dispatched when the user moves a pointing device away from an InteractiveObject instance. | InteractiveObject | ||
| Dispatched when the user moves a pointing device over an InteractiveObject instance. | InteractiveObject | ||
| Dispatched when the user activates the platform-specific accelerator key combination for a select all operation or selects 'Select All' from the text context menu. | InteractiveObject | ||
| Dispatched when an object's state changes from invisible to visible. | UIComponent | ||
| Dispatched immediately after the soft keyboard is raised. | InteractiveObject | ||
| Dispatched immediately before the soft keyboard is raised. | InteractiveObject | ||
| Dispatched immediately after the soft keyboard is lowered. | InteractiveObject | ||
| Dispatched when the state of the control changes. | VideoDisplay | |||
| Dispatched after the component has entered a new state and any state transition animation to that state has finished playing. | UIComponent | ||
| Dispatched when a component interrupts a transition to its current state in order to switch to a new state. | UIComponent | ||
| Dispatched when the value of the object's tabChildren flag changes. | InteractiveObject | ||
| Dispatched when the object's tabEnabled flag changes. | InteractiveObject | ||
| Dispatched when the value of the object's tabIndex property changes. | InteractiveObject | ||
| Dispatched when a user enters one or more characters of text. | InteractiveObject | ||
| Dispatched by the component when it is time to create a ToolTip. | UIComponent | ||
| Dispatched by the component when its ToolTip has been hidden and is to be discarded soon. | UIComponent | ||
| Dispatched by the component when its ToolTip is about to be hidden. | UIComponent | ||
| Dispatched by the component when its ToolTip is about to be shown. | UIComponent | ||
| Dispatched by the component when its ToolTip has been shown. | UIComponent | ||
| Dispatched by a component whose toolTip property is set, as soon as the user moves the mouse over it. | UIComponent | ||
| Dispatched when the user first contacts a touch-enabled device (such as touches a finger to a mobile phone or tablet with a touch screen). | InteractiveObject | ||
| Dispatched when the user removes contact with a touch-enabled device (such as lifts a finger off a mobile phone or tablet with a touch screen). | InteractiveObject | ||
| A non-cancellable event, dispatched by a component when it is done responding to a touch interaction user gesture. | UIComponent | ||
| A non-cancellable event, dispatched by a component when it starts responding to a touch interaction user gesture. | UIComponent | ||
| A cancellable event, dispatched by a component in an attempt to respond to a touch interaction user gesture. | UIComponent | ||
| Dispatched when the user touches the device, and is continuously dispatched until the point of contact is removed. | InteractiveObject | ||
| Dispatched when the user moves the point of contact away from InteractiveObject instance on a touch-enabled device (such as drags a finger from one display object to another on a mobile phone or tablet with a touch screen). | InteractiveObject | ||
| Dispatched when the user moves the point of contact over an InteractiveObject instance on a touch-enabled device (such as drags a finger from a point outside a display object to a point over a display object on a mobile phone or tablet with a touch screen). | InteractiveObject | ||
| Dispatched when the user moves the point of contact away from an InteractiveObject instance on a touch-enabled device (such as drags a finger from over a display object to a point outside the display object on a mobile phone or tablet with a touch screen). | InteractiveObject | ||
| Dispatched when the user moves the point of contact over an InteractiveObject instance on a touch-enabled device (such as drags a finger from a point outside a display object to a point over a display object on a mobile phone or tablet with a touch screen). | InteractiveObject | ||
| Dispatched when the user lifts the point of contact over the same InteractiveObject instance on which the contact was initiated on a touch-enabled device (such as presses and releases a finger from a single point over a display object on a mobile phone or tablet with a touch screen). | InteractiveObject | ||
| Dispatched when an object has had its commitProperties(), measure(), and updateDisplayList() methods called (if needed). | UIComponent | ||
| Dispatched when a component is monitored by a Validator and the validation succeeded. | UIComponent | ||
| Dispatched 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 | ||
|---|---|---|---|---|
| Type: String CSS Inheritance: No Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 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 Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 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 Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 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 | ||
| Type: String CSS Inheritance: No Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 The vertical distance, in pixels, from the bottom edge of the component to the bottom edge of its parent container's content area. | UIComponent | ||
| Type: uint Format: Color CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 Color of the component highlight when validation fails. | UIComponent | ||
| Type: String CSS Inheritance: No Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 Blend mode used by the focus rectangle. | UIComponent | ||
| Type: Class CSS Inheritance: No Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 Skin used to draw the focus rectangle. | UIComponent | ||
| Type: Number Format: Length CSS Inheritance: No Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 Thickness, in pixels, of the focus rectangle outline. | UIComponent | ||
| Type: String CSS Inheritance: No Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 The horizontal distance in pixels from the center of the component's content area to the center of the component. | UIComponent | ||
| Type: String CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 4.5 Runtime Versions: Flash10, AIR 2.5 The primary interaction mode for this component. | UIComponent | ||
| Type: String CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 4.1 Runtime Versions: Flash10, AIR 1.5 Specifies the desired layout direction of a component. | UIComponent | ||
| Type: String CSS Inheritance: No Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 The horizontal distance, in pixels, from the left edge of the component to the left edge of its parent container's content area. | UIComponent | ||
| Type: String CSS Inheritance: No Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 The horizontal distance, in pixels, from the right edge of the component to the right edge of its parent container's content area. | UIComponent | ||
| Type: Boolean CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 4.5 Runtime Versions: Flash10, AIR 1.5 Show the error border or skin when this component is invalid | UIComponent | ||
| Type: Boolean CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 4.5 Runtime Versions: Flash10, AIR 1.5 Show the error tip when this component is invalid and the user rolls over it | UIComponent | ||
| Type: String CSS Inheritance: No Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 The vertical distance, in pixels, from the top edge of the component to the top edge of its parent container's content area. | UIComponent | ||
| Type: String CSS Inheritance: No Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 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 Language Version: ActionScript 3.0 Product Version: Flex 4 Runtime Versions: Flash10, AIR 1.5 Alpha of the border. The default value is 1. | VideoDisplay | ||
borderColor | Type: uint Format: Color CSS Inheritance: No Theme: halo, spark Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 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 Language Version: ActionScript 3.0 Product Version: Flex 4 Runtime Versions: Flash10, AIR 1.5 Visibility of the border. The default value is true. | VideoDisplay | ||
| Type: uint Format: Color CSS Inheritance: Yes Theme: spark Language Version: ActionScript 3.0 Product Version: Flex 4 Runtime Versions: Flash10, AIR 1.5 The main color for a component. | UIComponent | ||
contentBackgroundAlpha | Type: Number CSS Inheritance: Yes Theme: spark Language Version: ActionScript 3.0 Product Version: Flex 4 Runtime Versions: Flash10, AIR 1.5 The alpha of the content background for this component. | VideoDisplay | ||
contentBackgroundColor | Type: uint Format: Color CSS Inheritance: Yes Theme: spark Language Version: ActionScript 3.0 Product Version: Flex 4 Runtime Versions: Flash10, AIR 1.5 Color of the content area of the component. The default value is 0xFFFFFF. | VideoDisplay | ||
dropShadowVisible | Type: Boolean CSS Inheritance: No Theme: spark Language Version: ActionScript 3.0 Product Version: Flex 4 Runtime Versions: Flash10, AIR 1.5 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
| VideoDisplay | ||
Halo Theme Styles
| Style | Description | Defined By | ||
|---|---|---|---|---|
backgroundAlpha | Type: Number CSS Inheritance: No Theme: halo Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 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 Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 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
<mx:Container backgroundColor="0x66CC66"/>
<mx:ControlName ... fillAlphas="[1,1]"/>
</mx:Container>
| VideoDisplay | ||
backgroundDisabledColor | Type: uint Format: Color CSS Inheritance: Yes Theme: halo Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 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 Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 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
<mx:Container backgroundColor="0x66CC66"/>
<mx:ControlName ... fillAlphas="[1,1]"/>
</mx:Container>
| VideoDisplay | ||
backgroundSize | Type: String CSS Inheritance: No Theme: halo Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 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 Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 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 Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 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 Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 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 Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 Radius of component corners. The default value is 0. | VideoDisplay | ||
dropShadowColor | Type: uint Format: Color CSS Inheritance: Yes Theme: halo Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 Color of the drop shadow. The default value is 0x000000. | VideoDisplay | ||
dropShadowEnabled | Type: Boolean CSS Inheritance: No Theme: halo Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 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
| VideoDisplay | ||
shadowDirection | Type: String CSS Inheritance: No Theme: halo Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 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 Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 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 | ||
| Type: uint Format: Color CSS Inheritance: Yes Theme: halo Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 Theme color of a component. | UIComponent | ||
Public Constants
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); }
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):voidautoPlay | 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):voidautoRewind | 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):voidborder | 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():EdgeMetricsbufferTime | 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):voidbytesLoaded | 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():intbytesTotal | 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():intcuePointManager | 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():ObjectRelated API Elements
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):voidRelated API Elements
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
namefield contains an arbitrary name of the cue point. - The
timefield 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):voididleTimeout | 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):voidlive | 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):voidmaintainAspectRatio | 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):voidmetadata | 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.
| Parameter | Description |
|---|---|
canSeekToEnd | A Boolean value that is true if the FLV file is encoded with a keyframe on the last frame that allows seeking to the end of a progressive download movie clip. It is false if the FLV file is not encoded with a keyframe on the last frame. |
cuePoints | An Array of objects, one for each cue point embedded in the FLV file. Value is undefined if the FLV file does not contain any cue points. Each object has the following properties:
|
audiocodecid | A Number that indicates the audio codec (code/decode technique) that was used. |
audiodelay | A Number that represents time 0 in the source file from which the FLV file was encoded.
Video content is delayed for the short period of time that is required to synchronize the audio. For example, if the 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. |
audiodatarate | A Number that is the kilobytes per second of audio. |
videocodecid | A Number that is the codec version that was used to encode the video. |
framerate | A Number that is the frame rate of the FLV file. |
videodatarate | A Number that is the video data rate of the FLV file. |
height | A Number that is the height of the FLV file. |
width | A Number that is the width of the FLV file. |
duration | A Number that specifies the duration of the FLV file in seconds. |
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():ObjectplayheadTime | 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):voidplayheadUpdateInterval | 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):voidplaying | 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():BooleanprogressInterval | 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):voidsource | 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):voidstate | 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():StringRelated API Elements
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():BooleantotalTime | 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):voidvideoHeight | 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():intvideoWidth | 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():intvolume | 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):voidConstructor 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:
property VideoEvent.type =
mx.events.VideoEventproperty 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.
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:
| Property | Value |
|---|---|
bubbles | false |
cancelable | false |
currentTarget | The 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. |
playheadTime | The location of the playhead when the event occurs. |
state | The value of the
VideoDisplay.state property when the event occurs. |
stateResponsive | The value of the
VideoDisplay.stateResponsive property
when the event occurs. |
target | The 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:
property VideoEvent.type =
mx.events.VideoEventproperty 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.
TheVideoEvent.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:
| Property | Value |
|---|---|
bubbles | false |
cancelable | false |
currentTarget | The 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. |
playheadTime | The location of the playhead when the event occurs. |
state | The value of the
VideoDisplay.state property when the event occurs. |
stateResponsive | The value of the
VideoDisplay.stateResponsive property
when the event occurs. |
target | The 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:
property CuePointEvent.type =
mx.events.CuePointEventproperty 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.
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:
| Property | Value |
|---|---|
bubbles | false |
cancelable | false |
cuePointName | The name of the cue point. |
cuePointTime | The time of the cue point, in seconds. |
cuePointType | The string
"actionscript". |
currentTarget | The 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. |
target | The 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:
property MetadataEvent.type =
mx.events.MetadataEventproperty 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 thetype property for a metadataReceived event.
This event has the following properties:
| Property | Value |
|---|---|
bubbles | false |
cancelable | false;
there is no default behavior to cancel. |
currentTarget | The 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. |
info | An 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. |
target | The 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. |
vp | The index of the VideoPlayer object. |
playheadUpdate | Event |
Event Object Type:
property VideoEvent.type =
mx.events.VideoEventproperty 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.
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:
| Property | Value |
|---|---|
bubbles | false |
cancelable | false |
currentTarget | The 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. |
playheadTime | The location of the playhead when the event occurs. |
state | The value of the
VideoDisplay.state property when the event occurs. |
stateResponsive | The value of the
VideoDisplay.stateResponsive property
when the event occurs. |
target | The 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:
property ProgressEvent.type =
flash.events.ProgressEventproperty 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.
type property of a progress event object.
This event has the following properties:
| Property | Value |
|---|---|
bubbles | false |
bytesLoaded | The number of items or bytes loaded at the time the listener processes the event. |
bytesTotal | The total number of items or bytes that ultimately will be loaded if the loading process succeeds. |
cancelable | false; there is no default behavior to cancel. |
currentTarget | The object that is actively processing the Event object with an event listener. |
target | The object reporting progress. |
ready | Event |
Event Object Type:
property VideoEvent.type =
mx.events.VideoEventproperty 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.
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:
| Property | Value |
|---|---|
bubbles | false |
cancelable | false |
currentTarget | The 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. |
playheadTime | The location of the playhead when the event occurs. |
state | The value of the
VideoDisplay.state property when the event occurs. |
stateResponsive | The value of the
VideoDisplay.stateResponsive property
when the event occurs. |
target | The 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:
property VideoEvent.type =
mx.events.VideoEventproperty 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.
TheVideoEvent.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:
| Property | Value |
|---|---|
bubbles | false |
cancelable | false |
currentTarget | The 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. |
playheadTime | The location of the playhead when the event occurs. |
state | The value of the
VideoDisplay.state property when the event occurs. |
stateResponsive | The value of the
VideoDisplay.stateResponsive property
when the event occurs. |
target | The 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. |
Related API Elements
stateChange | Event |
Event Object Type:
property VideoEvent.type =
mx.events.VideoEventproperty 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.
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:
| Property | Value |
|---|---|
bubbles | false |
cancelable | false |
currentTarget | The 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. |
playheadTime | The location of the playhead when the event occurs. |
state | The value of the
VideoDisplay.state property when the event occurs. |
stateResponsive | The value of the
VideoDisplay.stateResponsive property
when the event occurs. |
target | The 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. |
Examples How to use this example
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>
Thu Dec 6 2018, 01:12 PM -08:00