| Package | mx.controls |
| Class | public class VideoDisplay |
| Inheritance | VideoDisplay UIComponent FlexSprite Sprite DisplayObjectContainer InteractiveObject DisplayObject EventDispatcher Object |
Hide MXML Syntax
The <mx:VideoDisplay> tag inherits all the tag
attributes of its superclass, and adds the following tag attributes:
<mx:VideoDisplay
Properties
autoBandWidthDetection="false|true"
autoPlay="true|false"
autoRewind="true|false"
bufferTime="0.1"
cuePointManagerClass=""
cuePoints=""
idleTimeout="300000"
live="false|true"
maintainAspectRatio="true|false"
playheadTime=""
playheadUpdateInterval="250"
progressInterval="250"
source=""
totalTime=""
volume="0.75"
Styles
backgroundAlpha="1.0"
backgroundColor="0x000000"
backgroundImage="undefined"
backgroundSize="undefined"
borderColor="undefined"
borderSides="left top right bottom"
borderSkin="ClassReference('mx.skins.halo.HaloBorder')"
borderStyle="none"
borderThickness="1"
cornerRadius="0"
dropShadowColor="0x000000"
dropShadowEnabled="false|true"
shadowDirection="center"
shadowDistance="2"
Events
close="No default"
complete="No default"
cuePoint="No default"
playheadUpdate="No default"
progress="No default"
ready="No default"
rewind="No default"
stateChange="No default"
/>
See also
| Property | Defined by | ||
|---|---|---|---|
![]() | accessibilityProperties : AccessibilityProperties
The current accessibility options for this display object.
| DisplayObject | |
![]() | 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 | ||
| 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 | ||
![]() | baselinePosition : Number
Determines the baseline y-coordinate
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 | |
| borderMetrics : EdgeMetrics
[read-only]
Returns an EdgeMetrics object that has four properties:
left, top, right,
and bottom. | VideoDisplay | ||
| 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 Player caches an internal bitmap representation of the
display object. | DisplayObject | |
![]() | cacheHeuristic : Boolean
Used by Flex to suggest bitmap caching for the object.
| UIComponent | |
![]() | cachePolicy : String
Specifies the bitmap caching policy for this object.
| UIComponent | |
![]() | className : String
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
Returns the x position of the mouse, in the content coordinate system.
| UIComponent | |
![]() | contentMouseY : Number
Returns the y position of the mouse, in the content coordinate system.
| UIComponent | |
![]() | contextMenu : ContextMenu
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 | |
![]() | descriptor : UIComponentDescriptor
Reference to the UIComponentDescriptor, if any, that was used
by the
createComponentFromDescriptor() method to create this
UIComponent instance. | UIComponent | |
![]() | document : Object
A reference to the document object associated with this UIComponent.
| UIComponent | |
![]() | doubleClickEnabled : Boolean
Specifies whether the UIComponent object receives
doubleClick events. | UIComponent | |
![]() | dropTarget : DisplayObject
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 will be 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
Number that specifies the maximum height of the component,
in pixels, in the component's coordinates.
| UIComponent | |
![]() | explicitMaxWidth : Number
Number that specifies the maximum width of the component,
in pixels, in the component's coordinates.
| UIComponent | |
![]() | explicitMinHeight : Number
Number that specifies the minimum height of the component,
in pixels, in the component's coordinates.
| UIComponent | |
![]() | explicitMinWidth : Number
Number that specifies the minimum width of the component,
in pixels, in the component's coordinates.
| 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 | |
![]() | focusEnabled : Boolean
Indicates whether the component can receive focus when clicked on.
| 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
Specifies the Graphics object that belongs to this sprite where vector
drawing commands can occur.
| Sprite | |
![]() | height : Number
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 | |
![]() | 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
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 | |
![]() | isDocument : Boolean
Determines whether this UIComponent instance is a document object,
that is, whether it is at the top of the hierarchy of a Flex
application, MXML component, or ActionScript component.
| UIComponent | |
![]() | isPopUp : Boolean
Set to
true by the PopUpManager to indicate
that component has been popped up. | UIComponent | |
| live : Boolean
Specifies whether the control is streaming a live feed.
| VideoDisplay | ||
![]() | loaderInfo : LoaderInfo
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 | ||
![]() | mask : DisplayObject
The calling display object is masked by the specified
mask object. | DisplayObject | |
![]() | maxHeight : Number
Number that specifies the maximum height of the component,
in pixels, in the component's coordinates.
| UIComponent | |
![]() | maxWidth : Number
Number that specifies the maximum width of the component,
in pixels, in the component's coordinates.
| 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 | |
![]() | minHeight : Number
Number that specifies the minimum height of the component,
in pixels, in the component's coordinates.
| UIComponent | |
![]() | minWidth : Number
Number that specifies the minimum width of the component,
in pixels, in the component's coordinates.
| UIComponent | |
![]() | mouseChildren : Boolean
Determines whether or not the children of the object are mouse enabled.
| DisplayObjectContainer | |
![]() | mouseEnabled : Boolean
Specifies whether this object receives mouse messages.
| InteractiveObject | |
![]() | mouseFocusEnabled : Boolean
Whether you can receive focus when clicked on.
| UIComponent | |
![]() | mouseX : Number
Indicates the x coordinate of the mouse position, in pixels.
| DisplayObject | |
![]() | mouseY : Number
Indicates the y coordinate of the mouse position, in pixels.
| DisplayObject | |
![]() | name : String
Indicates the instance name of the DisplayObject.
| DisplayObject | |
![]() | 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 | |
![]() | numChildren : int
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 UIComponent.
| UIComponent | |
![]() | parent : DisplayObjectContainer
The parent container or component for this component.
| UIComponent | |
![]() | parentApplication : Object
A reference to the Application object that contains this UIComponent
instance.
| UIComponent | |
![]() | parentDocument : Object
A reference to the parent document object for this UIComponent.
| UIComponent | |
![]() | percentHeight : Number
Number that specifies the height of a component as a percentage
of its parent's size.
| UIComponent | |
![]() | percentWidth : Number
Number that specifies the width of a component as a percentage
of its parent's size.
| UIComponent | |
| playheadTime : Number
Playhead position, measured in seconds, since the video starting
playing.
| VideoDisplay | ||
| playheadUpdateInterval : int
Specifies the amount of time, in milliseconds,
between each
playheadUpdate event. | VideoDisplay | ||
| playing : Boolean
[read-only]
If
true, the media is currently playing. | VideoDisplay | ||
![]() | 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 | ||
![]() | prototype : Object
[static]
A reference to the prototype object of a class or function object.
| Object | |
![]() | repeater : IRepeater
A reference to the Repeater object
in the parent document that produced this UIComponent.
| UIComponent | |
![]() | repeaterIndex : int
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 | |
![]() | root : DisplayObject
For a display object in a loaded SWF file, the
root property is the
top-most display object in the portion of the display list's tree structure represented by that SWF file. | DisplayObject | |
![]() | rotation : Number
Indicates the rotation of the DisplayObject instance, in degrees, from its original orientation.
| DisplayObject | |
![]() | scale9Grid : Rectangle
The current scaling grid that is in effect.
| DisplayObject | |
![]() | scaleX : Number
Number that specifies the horizontal scaling factor.
| UIComponent | |
![]() | scaleY : Number
Number that specifies the vertical scaling percentage.
| UIComponent | |
![]() | screen : Rectangle
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 | |
![]() | soundTransform : SoundTransform
Controls sound within this sprite.
| Sprite | |
| source : String
Relative path and filename of the FLV file to stream.
| VideoDisplay | ||
![]() | stage : Stage
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 | |
![]() | styleName : Object
The class style used by this component.
| 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 | |
![]() | tabIndex : int
Specifies the tab ordering of objects in a SWF file.
| InteractiveObject | |
![]() | textSnapshot : TextSnapshot
Returns a TextSnapshot object for this DisplayObjectContainer instance.
| DisplayObjectContainer | |
![]() | toolTip : String
Text to display in the ToolTip.
| UIComponent | |
| totalTime : Number
Total length of the media, in seconds.
| VideoDisplay | ||
![]() | transform : Transform
An object with properties pertaining to a display object's matrix, color transform, and pixel bounds.
| DisplayObject | |
![]() | 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 mouse 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 | |
| videoHeight : int
[read-only]
Height of the loaded FLV file.
| VideoDisplay | ||
| videoWidth : int
[read-only]
Width of the loaded FLV file.
| VideoDisplay | ||
![]() | visible : Boolean
Controls the visibility of this UIComponent.
| UIComponent | |
| volume : Number
The volume level, specified as an value between 0 and 1.
| VideoDisplay | ||
![]() | width : Number
Number that specifies the width of the component, in pixels,
in the parent's coordinates.
| UIComponent | |
![]() | x : Number
Number that specifies the component's horizontal position,
in pixels, within its parent container.
| UIComponent | |
![]() | y : Number
Number that specifies the component's vertical position,
in pixels, within its parent container.
| UIComponent | |
| Property | Defined by | ||
|---|---|---|---|
| border : IFlexDisplayObject
The border object for the control.
| VideoDisplay | ||
![]() | unscaledHeight : Number
A convenience method for determining the unscaled height
of the component
All of a component's drawing and child layout should be done
within a bounding rectangle of this height, which is also passed
as an argument to
updateDisplayList(). | UIComponent | |
![]() | unscaledWidth : Number
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 | |
| 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 | |
![]() |
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 whether 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 | |
![]() |
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 | |
![]() |
Dispatches an event into the event flow.
| EventDispatcher | |
![]() |
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
Programatically 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 the data bindings into this UIComponent object.
| UIComponent | |
![]() |
Called after printing is complete.
| UIComponent | |
![]() |
Returns a rectangle that defines the area of the display object relative to the coordinate system
of the
targetCoordinateSpace object. | DisplayObject | |
![]() |
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 | |
![]() |
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 an array of objects that lie under the specified point and are children
(or grandchildren, and so on) of this DisplayObjectContainer instance.
| DisplayObjectContainer | |
![]() |
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 | |
![]() |
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 | |
![]() |
Evaluates the display object to see if it overlaps or intersects with 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 | |
![]() |
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
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 | |
![]() |
Measures the specified HTML text, which may contain HTML tags such
as
<font> and <b>,
assuming that it is displayed
in a single-line UITextField using a UITextFormat
determined by the styles of this UIComponent. | UIComponent | |
![]() |
Measures the specified text, assuming that it is displayed
in a single-line UITextField using a UITextFormat
determined by the styles of this UIComponent.
| UIComponent | |
![]() |
Moves the component to a specified position within its parent.
| ||