Package | spark.components |
Class | public class VideoPlayer |
Inheritance | VideoPlayer SkinnableComponent UIComponent FlexSprite Sprite DisplayObjectContainer InteractiveObject DisplayObject EventDispatcher Object |
Language Version: | ActionScript 3.0 |
Product Version: | Flex 4 |
Runtime Versions: | Flash Player 10, AIR 1.5 |
VideoElement
is the chromeless version.
The VideoPlayer control has the following default characteristics:
Characteristic | Description |
---|---|
Default size | 263 pixels wide by 184 pixels high |
Minimum size | 0 |
Maximum size | 10000 pixels wide and 10000 pixels high |
Default skin class | spark.skins.spark.VideoPlayerSkin |
The <s:VideoPlayer>
tag inherits all of the tag
attributes of its superclass and adds the following tag attributes:
<s:VideoPlayer Properties autoPlay="true" autoRewind="false" enabled="" loop="false" maintainAspectRatio="true" muted="false" source="" volume=".75" Events close="No default" complete="No default" metadataReceived="No default" playheadUpdate="No default" progress="No default" ready="No default" />
Default MXML Propertysource
See also
Property | Defined By | ||
---|---|---|---|
accessibilityProperties : AccessibilityProperties
The current accessibility options for this display object. | DisplayObject | ||
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 | ||
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. | VideoPlayer | ||
autoRewind : Boolean
Specifies whether the FLV file should be rewound to the first frame
when play stops, either by calling the stop() method or by
reaching the end of the stream. | VideoPlayer | ||
baseline : Object
The vertical distance in pixels from the anchor target to
the control's baseline position. | 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 | ||
bottom : Object
The vertical distance in pixels from the bottom edge of the component to the
anchor target's bottom edge. | UIComponent | ||
buttonMode : Boolean
Specifies the button mode of this sprite. | Sprite | ||
cacheAsBitmap : Boolean
If set to true, Flash Player or Adobe AIR caches an internal bitmap representation of the
display object. | 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 | ||
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 [override]
Setting enabled to false disables the UI and
pauses the video if it was currently playing. | VideoPlayer | ||
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
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
This is similar to the tabChildren property
used by Flash Player.
This is usually false because most components
either receive focus themselves or delegate focus to a single
internal sub-component and appear as if the component has
received focus. | UIComponent | ||
hasLayoutMatrix3D : Boolean [read-only]
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
The horizontal distance in pixels from the center of the component to the
center of the anchor target's content area. | UIComponent | ||
id : String
ID of the component. | UIComponent | ||
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]
True, when the element is in 3D. | UIComponent | ||
isDocument : Boolean [read-only]
Determines whether this UIComponent instance is a document object,
that is, whether it is at the top of the hierarchy of a Flex
application, MXML component, or ActionScript component. | UIComponent | ||
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
The horizontal distance in pixels from the left edge of the component to the
anchor target's left edge. | UIComponent | ||
loaderInfo : LoaderInfo [read-only]
Returns a LoaderInfo object containing information about loading the file
to which this display object belongs. | DisplayObject | ||
loop : Boolean
Indicates whether the media should play again after playback has completed. | VideoPlayer | ||
maintainAspectRatio : Boolean
Specifies whether the control should maintain the original aspect ratio
while resizing the video. | VideoPlayer | ||
maintainProjectionCenter : Boolean
When true, the component will keep 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 | ||
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 embeded 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 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 [read-only]
Indicates the x coordinate of the mouse position, in pixels. | DisplayObject | ||
mouseY : Number [read-only]
Indicates the y coordinate of the mouse position, in pixels. | DisplayObject | ||
muted : Boolean
Set to true to mute the video, false
to unmute the video. | VideoPlayer | ||
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 | ||
numAutomationChildren : int [read-only]
The number of automation children this container has. | UIComponent | ||
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]
| 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
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 [read-only]
Playhead position, measured in seconds, since the video starting
playing. | VideoPlayer | ||
playing : Boolean [read-only]
Returns true if the video is playing or is attempting to play. | VideoPlayer | ||
playWhenHidden : Boolean
Controls whether the video continues to play when it is
hidden. | VideoPlayer | ||
postLayoutTransformOffsets : mx.geom:TransformOffsets | UIComponent | ||
processedDescriptors : Boolean
Set to true after immediate or deferred child creation,
depending on which one happens. | UIComponent | ||
prototype : Object [static]
A reference to the prototype object of a class or function object. | Object | ||
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
The horizontal distance in pixels from the right edge of the component to the
anchor target's right edge. | 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]
| 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 | ||
skin : UIComponent [read-only]
The instance of the skin class for this component instance. | SkinnableComponent | ||
soundTransform : flash.media:SoundTransform
Controls sound within this sprite. | Sprite | ||
source : Object
For progressive download, the source is just a path or URL pointing
to the video file to play. | VideoPlayer | ||
stage : Stage [read-only]
The Stage of the display object. | DisplayObject | ||
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 | ||
styleParent : IAdvancedStyleClient [read-only]
A component's parent is used to evalate 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
The vertical distance in pixels from the top edge of the component to the
anchor target's top edge. | UIComponent | ||
totalTime : Number [read-only]
Total time for the video feed. | VideoPlayer | ||
transform : flash.geom:Transform
An object with properties pertaining to a display object's matrix, color transform, and pixel bounds. | DisplayObject | ||
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 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 | ||
verticalCenter : Object
The vertical distance in pixels from the center of the component to the
center of the anchor target's content area. | UIComponent | ||
visible : Boolean [override]
| UIComponent | ||
volume : Number
The volume level, specified as an value between 0 and 1. | VideoPlayer | ||
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 |
Method | Defined By | ||
---|---|---|---|
Constructor. | VideoPlayer | ||
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 | ||
Queues a function to be called later. | UIComponent | ||
Deletes a style property from this component instance. | UIComponent | ||
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 as automation ID 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
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 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 that exists with the specified name. | 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 | ||
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 | ||
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 | ||
Marks the component so that the new state of the skin will get set
during a later screen update. | SkinnableComponent | ||
Indicates whether an instance of the Object class is in the prototype chain of the object specified
as the parameter. | Object | ||
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 | ||
Determins whether the current state of this component matches a
CSS pseudo-selector. | UIComponent | ||
Determines whether this component is assignable to the given CSS type. | UIComponent | ||
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. | 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. | VideoPlayer | ||
Causes the video to play. | VideoPlayer | ||
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 a listener from the EventDispatcher object. | EventDispatcher | ||
Replays the specified event. | UIComponent | ||
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 | ||
Seeks to given second in video. | VideoPlayer | ||
Sizes the object. | UIComponent | ||
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 to the specified dimensions. | UIComponent | ||
Sets the transform Matrix that is used to calculate the component's layout
size and position relative to its siblings. | UIComponent | ||
Similarly to the layoutMatrix3D property, sets the layout Matrix3D, but
doesn't trigger a layout pass. | 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 | ||
Stops video playback. | VideoPlayer | ||
Ends the startDrag() method. | 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 | ||
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 | ||
UIComponent | |||
transformPointToParent(transformCenter:Vector3D, position:Vector3D, postLayoutPosition:Vector3D):void
FIXME (chaase) : FLEXDOCS-1031
| 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 |
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 | ||
Create the skin for the component. | SkinnableComponent | ||
Determines if the call to the measure() method can be skipped. | UIComponent | ||
Performs any final processing after child objects are created. | UIComponent | ||
Clear out references to skin parts. | SkinnableComponent | ||
Processes the properties set on the component. | UIComponent | ||
Create child objects of the component. | UIComponent | ||
Create an instance of a dynamic skin part. | SkinnableComponent | ||
Creates a new object using a context
based on the embedded font being used. | UIComponent | ||
Creates the object using a given moduleFactory. | UIComponent | ||
Destroys and removes the skin for this component. | SkinnableComponent | ||
Helper method for dispatching a PropertyChangeEvent
when a property is updated. | UIComponent | ||
Find the skin parts in the skin class and assign them to the properties of the component. | SkinnableComponent | ||
The event handler called when a UIComponent object gets focus. | UIComponent | ||
The event handler called when a UIComponent object loses focus. | UIComponent | ||
Formats a time value, given in seconds, into a string that
gets used for the playheadTimeDisplay and the totalTimeDisplay. | VideoPlayer | ||
Returns the name of the state to be applied to the skin. | SkinnableComponent | ||
Returns a specific instance of a dynamic part. | SkinnableComponent | ||
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 | ||
Calculates the default size, and optionally the default minimum size,
of the component. | UIComponent | ||
UIComponent | |||
Returns the number of instances of a dynamic part. | SkinnableComponent | ||
Called when a skin part is added. | SkinnableComponent | ||
Called when an instance of a skin part is being removed. | SkinnableComponent | ||
Remove an instance of a dynamic part. | SkinnableComponent | ||
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 |
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 is closed, whether by being timed out, by calling the close() method, or by loading a new video stream. | VideoPlayer | |||
Dispatched when playing completes because the player reached the end of the FLV file. | VideoPlayer | |||
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 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 an object's state changes from visible to invisible. | UIComponent | |||
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 the FLV file's metadata is reached. | VideoPlayer | |||
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 every 0.25 seconds while the video is playing. | VideoPlayer | |||
Dispatched at the beginning of the component initialization sequence. | UIComponent | |||
Indicates progress made in number of bytes downloaded. | VideoPlayer | |||
Dispatched when the video is loaded and ready to display. | VideoPlayer | |||
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 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 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 will 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 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 |
Style | Description | Defined By | ||
---|---|---|---|---|
alignmentBaseline | Type: String CSS Inheritance: yes Specifies the baseline to which the dominant baseline aligns. For example, if you set dominantBaseline to ASCENT, setting alignmentBaseline to DESCENT aligns the top of the text with the DESCENT baseline, or below the line. The largest element in the line generally determines the baselines.
Legal values are flash.text.engine.TextBaseline.ROMAN, flash.text.engine.TextBaseline.ASCENT, flash.text.engine.TextBaseline.DESCENT, flash.text.engine.TextBaseline.IDEOGRAPHIC_TOP, flash.text.engine.TextBaseline.IDEOGRAPHIC_CENTER, flash.text.engine.TextBaseline.IDEOGRAPHIC_BOTTOM, flash.text.engine.TextBaseline.USE_DOMINANT_BASELINE, flashx.textLayout.formats.FormatValue.INHERIT. Default value is undefined indicating not set. If undefined during the cascade this property will inherit its value from an ancestor. If no ancestor has set this property, it will have a value of USE_DOMINANT_BASELINE. | VideoPlayer | ||
Type: uint Format: Color CSS Inheritance: yes Theme: spark | SkinnableComponent | |||
Type: String CSS Inheritance: no The vertical distance in pixels from the top edge of the content area to the control's baseline position. | UIComponent | |||
baselineShift | Type: Object CSS Inheritance: yes Amount to shift the baseline from the dominantBaseline value. Units are in pixels, or a percentage of fontSize (in which case, enter a string value, like 140%). Positive values shift the line up for horizontal text (right for vertical) and negative values shift it down for horizontal (left for vertical).
Legal values are flashx.textLayout.formats.BaselineShift.SUPERSCRIPT, flashx.textLayout.formats.BaselineShift.SUBSCRIPT, flashx.textLayout.formats.FormatValue.INHERIT. Legal values as a number are from -1000 to 1000. Legal values as a percent are numbers from -1000 to 1000. Default value is undefined indicating not set. If undefined during the cascade this property will inherit its value from an ancestor. If no ancestor has set this property, it will have a value of 0.0. | VideoPlayer | ||
Type: String CSS Inheritance: no The vertical distance in pixels from the lower edge of the component to the lower edge of its content area. | UIComponent | |||
cffHinting | Type: String CSS Inheritance: yes The type of CFF hinting used for this text. CFF hinting determines whether the Flash runtime forces strong horizontal stems to fit to a sub pixel grid or not. This property applies only if the renderingMode property is set to RenderingMode.CFF , and the font is embedded (fontLookup property is set to FontLookup.EMBEDDED_CFF ). At small screen sizes, hinting produces a clear, legible text for human readers.
Legal values are flash.text.engine.CFFHinting.NONE, flash.text.engine.CFFHinting.HORIZONTAL_STEM, flashx.textLayout.formats.FormatValue.INHERIT. Default value is undefined indicating not set. If undefined during the cascade this property will inherit its value from an ancestor. If no ancestor has set this property, it will have a value of HORIZONTAL_STEM. | VideoPlayer | ||
color | Type: uint Format: Color CSS Inheritance: yes Color of the text. A hexadecimal number that specifies three 8-bit RGB (red, green, blue) values; for example, 0xFF0000 is red and 0x00FF00 is green. Default value is undefined indicating not set. If undefined during the cascade this property will inherit its value from an ancestor. If no ancestor has set this property, it will have a value of 0. | VideoPlayer | ||
digitCase | Type: String CSS Inheritance: yes The type of digit case used for this text. Setting the value to DigitCase.OLD_STYLE approximates lowercase letterforms with varying ascenders and descenders. The figures are proportionally spaced. This style is only available in selected typefaces, most commonly in a supplemental or expert font. The DigitCase.LINING setting has all-cap height and is typically monospaced to line up in charts.
Legal values are flash.text.engine.DigitCase.DEFAULT, flash.text.engine.DigitCase.LINING, flash.text.engine.DigitCase.OLD_STYLE, flashx.textLayout.formats.FormatValue.INHERIT. Default value is undefined indicating not set. If undefined during the cascade this property will inherit its value from an ancestor. If no ancestor has set this property, it will have a value of DEFAULT. | VideoPlayer | ||
digitWidth | Type: String CSS Inheritance: yes Type of digit width used for this text. This can be DigitWidth.PROPORTIONAL , which looks best for individual numbers, or DigitWidth.TABULAR , which works best for numbers in tables, charts, and vertical rows.
Legal values are flash.text.engine.DigitWidth.DEFAULT, flash.text.engine.DigitWidth.PROPORTIONAL, flash.text.engine.DigitWidth.TABULAR, flashx.textLayout.formats.FormatValue.INHERIT. Default value is undefined indicating not set. If undefined during the cascade this property will inherit its value from an ancestor. If no ancestor has set this property, it will have a value of DEFAULT. | VideoPlayer | ||
direction | Type: String CSS Inheritance: yes Specifies the default bidirectional embedding level of the text in the text block. Left-to-right reading order, as in Latin-style scripts, or right-to-left reading order, as in Arabic or Hebrew. This property also affects column direction when it is applied at the container level. Columns can be either left-to-right or right-to-left, just like text. Below are some examples: Legal values are flashx.textLayout.formats.Direction.LTR, flashx.textLayout.formats.Direction.RTL, flashx.textLayout.formats.FormatValue.INHERIT. Default value is undefined indicating not set. If undefined during the cascade this property will inherit its value from an ancestor. If no ancestor has set this property, it will have a value of LTR. | VideoPlayer | ||
dominantBaseline | Type: String CSS Inheritance: yes Specifies which element baseline snaps to the alignmentBaseline to determine the vertical position of the element on the line. A value of TextBaseline.AUTO selects the dominant baseline based on the locale property of the parent paragraph. For Japanese and Chinese, the selected baseline value is TextBaseline.IDEOGRAPHIC_CENTER ; for all others it is TextBaseline.ROMAN . These baseline choices are determined by the choice of font and the font size.
Legal values are flashx.textLayout.formats.FormatValue.AUTO, flash.text.engine.TextBaseline.ROMAN, flash.text.engine.TextBaseline.ASCENT, flash.text.engine.TextBaseline.DESCENT, flash.text.engine.TextBaseline.IDEOGRAPHIC_TOP, flash.text.engine.TextBaseline.IDEOGRAPHIC_CENTER, flash.text.engine.TextBaseline.IDEOGRAPHIC_BOTTOM, flashx.textLayout.formats.FormatValue.INHERIT. Default value is undefined indicating not set. If undefined during the cascade this property will inherit its value from an ancestor. If no ancestor has set this property, it will have a value of flashx.textLayout.formats.FormatValue.AUTO. | VideoPlayer | ||
Type: Class Name of the skin class to use for this component when a validation error occurs. | SkinnableComponent | |||
Type: Class CSS Inheritance: no Skin used to draw the focus rectangle. | UIComponent | |||
fontFamily | Type: String CSS Inheritance: yes The name of the font to use, or a comma-separated list of font names. The Flash runtime renders the element with the first available font in the list. For example Arial, Helvetica, _sans causes the player to search for Arial, then Helvetica if Arial is not found, then _sans if neither is found. Default value is undefined indicating not set. If undefined during the cascade this property will inherit its value from an ancestor. If no ancestor has set this property, it will have a value of Times New Roman. | VideoPlayer | ||
fontLookup | Type: String CSS Inheritance: yes Font lookup to use. Specifying FontLookup.DEVICE uses the fonts installed on the system that is running the SWF file. Device fonts result in a smaller movie size, but text is not always rendered the same across different systems and platforms. Specifying FontLookup.EMBEDDED_CFF uses font outlines embedded in the published SWF file. Embedded fonts increase the size of the SWF file (sometimes dramatically), but text is consistently displayed in the chosen font.
Legal values are flash.text.engine.FontLookup.DEVICE, flash.text.engine.FontLookup.EMBEDDED_CFF, flashx.textLayout.formats.FormatValue.INHERIT. Default value is undefined indicating not set. If undefined during the cascade this property will inherit its value from an ancestor. If no ancestor has set this property, it will have a value of DEVICE. | VideoPlayer | ||
fontSize | Type: Number Format: Length CSS Inheritance: yes The size of the text in pixels. Legal values are numbers from 1 to 720 and flashx.textLayout.formats.FormatValue.INHERIT. Default value is undefined indicating not set. If undefined during the cascade this property will inherit its value from an ancestor. If no ancestor has set this property, it will have a value of 12. | VideoPlayer | ||
fontStyle | Type: String CSS Inheritance: yes Style of text. May be FontPosture.NORMAL , for use in plain text, or FontPosture.ITALIC for italic. This property applies only to device fonts (fontLookup property is set to flash.text.engine.FontLookup.DEVICE).
Legal values are flash.text.engine.FontPosture.NORMAL, flash.text.engine.FontPosture.ITALIC, flashx.textLayout.formats.FormatValue.INHERIT. Default value is undefined indicating not set. If undefined during the cascade this property will inherit its value from an ancestor. If no ancestor has set this property, it will have a value of NORMAL. | VideoPlayer | ||
fontWeight | Type: String CSS Inheritance: yes Weight of text. May be FontWeight.NORMAL for use in plain text, or FontWeight.BOLD . Applies only to device fonts (fontLookup property is set to flash.text.engine.FontLookup.DEVICE).
Legal values are flash.text.engine.FontWeight.NORMAL, flash.text.engine.FontWeight.BOLD, flashx.textLayout.formats.FormatValue.INHERIT. Default value is undefined indicating not set. If undefined during the cascade this property will inherit its value from an ancestor. If no ancestor has set this property, it will have a value of NORMAL. | VideoPlayer | ||
fullScreenHideControlsDelay | Type: Number CSS Inheritance: no The time, in milli-seconds, to wait in fullscreen mode with no user-interaction before hiding the video playback controls. The default value is 3000 . | VideoPlayer | ||
Type: String CSS Inheritance: no The horizontal distance in pixels from the center of the component's content area to the center of the component. | UIComponent | |||
justificationRule | Type: String CSS Inheritance: yes Rule used to justify text in a paragraph. Default value is FormatValue.AUTO , which justifies text based on the paragraph's locale property. For all languages except Japanese and Chinese, FormatValue.AUTO becomes JustificationRule.SPACE , which adds extra space to the space characters. For Japanese and Chinese, FormatValue.AUTO becomes JustficationRule.EAST_ASIAN . In part, justification changes the spacing of punctuation. In Roman text the comma and Japanese periods take a full character's width but in East Asian text only half of a character's width. Also, in the East Asian text the spacing between sequential punctuation marks becomes tighter, obeying traditional East Asian typographic conventions. Note, too, in the example below the leading that is applied to the second line of the paragraphs. In the East Asian version, the last two lines push left. In the Roman version, the second and following lines push left.
Legal values are flashx.textLayout.formats.JustificationRule.EAST_ASIAN, flashx.textLayout.formats.JustificationRule.SPACE, flashx.textLayout.formats.FormatValue.AUTO, flashx.textLayout.formats.FormatValue.INHERIT. Default value is undefined indicating not set. If undefined during the cascade this property will inherit its value from an ancestor. If no ancestor has set this property, it will have a value of flashx.textLayout.formats.FormatValue.AUTO. | VideoPlayer | ||
justificationStyle | Type: String CSS Inheritance: yes The style used for justification of the paragraph. Used only in conjunction with a justificationRule setting of JustificationRule.EAST_ASIAN .
Default value of FormatValue.AUTO is resolved to JustificationStyle.PUSH_IN_KINSOKU for all locales. The constants defined by the JustificationStyle class specify options for handling kinsoku characters, which are Japanese characters that cannot appear at either the beginning or end of a line. If you want looser text, specify JustificationStyle.PUSH-OUT-ONLY . If you want behavior that is like what you get with the justificationRule of JustificationRule.SPACE , use JustificationStyle.PRIORITIZE-LEAST-ADJUSTMENT .
Legal values are flash.text.engine.JustificationStyle.PRIORITIZE_LEAST_ADJUSTMENT, flash.text.engine.JustificationStyle.PUSH_IN_KINSOKU, flash.text.engine.JustificationStyle.PUSH_OUT_ONLY, flashx.textLayout.formats.FormatValue.AUTO, flashx.textLayout.formats.FormatValue.INHERIT. Default value is undefined indicating not set. If undefined during the cascade this property will inherit its value from an ancestor. If no ancestor has set this property, it will have a value of flashx.textLayout.formats.FormatValue.AUTO. | VideoPlayer | ||
kerning | Type: String CSS Inheritance: yes Kerning adjusts the pixels between certain character pairs to improve readability. Kerning is supported for all fonts with kerning tables. Legal values are flash.text.engine.Kerning.ON, flash.text.engine.Kerning.OFF, flash.text.engine.Kerning.AUTO, flashx.textLayout.formats.FormatValue.INHERIT. Default value is undefined indicating not set. If undefined during the cascade this property will inherit its value from an ancestor. If no ancestor has set this property, it will have a value of AUTO. | VideoPlayer | ||
Type: String CSS Inheritance: no The horizontal distance in pixels from the left edge of the component's content area to the left edge of the component. | UIComponent | |||
ligatureLevel | Type: String CSS Inheritance: yes Controls which of the ligatures that are defined in the font may be used in the text. The ligatures that appear for each of these settings is dependent on the font. A ligature occurs where two or more letter-forms are joined as a single glyph. Ligatures usually replace consecutive characters sharing common components, such as the letter pairs 'fi', 'fl', or 'ae'. They are used with both Latin and Non-Latin character sets. The ligatures enabled by the values of the LigatureLevel class - MINIMUM , COMMON , UNCOMMON , and EXOTIC - are additive. Each value enables a new set of ligatures, but also includes those of the previous types.Note: When working with Arabic or Syriac fonts, Legal values are flash.text.engine.LigatureLevel.MINIMUM, flash.text.engine.LigatureLevel.COMMON, flash.text.engine.LigatureLevel.UNCOMMON, flash.text.engine.LigatureLevel.EXOTIC, flashx.textLayout.formats.FormatValue.INHERIT. Default value is undefined indicating not set. If undefined during the cascade this property will inherit its value from an ancestor. If no ancestor has set this property, it will have a value of COMMON. | VideoPlayer | ||
lineHeight | Type: Object CSS Inheritance: yes Leading controls for the text. The distance from the baseline of the previous or the next line (based on LeadingModel ) to the baseline of the current line is equal to the maximum amount of the leading applied to any character in the line. This is either a number or a percent. If specifying a percent, enter a string value, like 140%.
Legal values as a number are from -720 to 720. Legal values as a percent are numbers from -1000% to 1000%. Legal values include flashx.textLayout.formats.FormatValue.INHERIT. Default value is undefined indicating not set. If undefined during the cascade this property will inherit its value from an ancestor. If no ancestor has set this property, it will have a value of 120%. | VideoPlayer | ||
lineThrough | Type: Boolean CSS Inheritance: yes If true , applies strikethrough, a line drawn through the middle of the text.
Legal values are true, false and flashx.textLayout.formats.FormatValue.INHERIT. Default value is undefined indicating not set. If undefined during the cascade this property will inherit its value from an ancestor. If no ancestor has set this property, it will have a value of false. | VideoPlayer | ||
locale | Type: String CSS Inheritance: yes The locale of the text. Controls case transformations and shaping. Standard locale identifiers as described in Unicode Technical Standard #35 are used. For example en, en_US and en-US are all English, ja is Japanese. Default value is undefined indicating not set. If undefined during the cascade this property will inherit its value from an ancestor. If no ancestor has set this property, it will have a value of en. | VideoPlayer | ||
renderingMode | Type: String CSS Inheritance: yes The rendering mode used for this text. Applies only to embedded fonts ( fontLookup property is set to FontLookup.EMBEDDED_CFF ).
Legal values are flash.text.engine.RenderingMode.NORMAL, flash.text.engine.RenderingMode.CFF, flashx.textLayout.formats.FormatValue.INHERIT. Default value is undefined indicating not set. If undefined during the cascade this property will inherit its value from an ancestor. If no ancestor has set this property, it will have a value of CFF. | VideoPlayer | ||
Type: String CSS Inheritance: no The horizontal distance in pixels from the right edge of the component to the right edge of its content area. | UIComponent | |||
Type: Class Name of the skin class to use for this component. | SkinnableComponent | |||
symbolColor | Type: uint Format: Color CSS Inheritance: yes Theme: spark Color of any symbol of a component. Examples include the check mark of a CheckBox or the arrow of a scroll button | VideoPlayer | ||
textAlign | Type: String CSS Inheritance: yes Alignment of lines in the paragraph relative to the container. TextAlign.LEFT aligns lines along the left edge of the container. TextAlign.RIGHT aligns on the right edge. TextAlign.CENTER positions the line equidistant from the left and right edges. TextAlign.JUSTIFY spreads the lines out so they fill the space. TextAlign.START is equivalent to setting left in left-to-right text, or right in right-to-left text. TextAlign.END is equivalent to setting right in left-to-right text, or left in right-to-left text.
Legal values are flashx.textLayout.formats.TextAlign.LEFT, flashx.textLayout.formats.TextAlign.RIGHT, flashx.textLayout.formats.TextAlign.CENTER, flashx.textLayout.formats.TextAlign.JUSTIFY, flashx.textLayout.formats.TextAlign.START, flashx.textLayout.formats.TextAlign.END, flashx.textLayout.formats.FormatValue.INHERIT. Default value is undefined indicating not set. If undefined during the cascade this property will inherit its value from an ancestor. If no ancestor has set this property, it will have a value of START. | VideoPlayer | ||
textAlignLast | Type: String CSS Inheritance: yes Alignment of the last (or only) line in the paragraph relative to the container in justified text. If textAlign is set to TextAlign.JUSTIFY , textAlignLast specifies how the last line (or only line, if this is a one line block) is aligned. Values are similar to textAlign .
Legal values are flashx.textLayout.formats.TextAlign.LEFT, flashx.textLayout.formats.TextAlign.RIGHT, flashx.textLayout.formats.TextAlign.CENTER, flashx.textLayout.formats.TextAlign.JUSTIFY, flashx.textLayout.formats.TextAlign.START, flashx.textLayout.formats.TextAlign.END, flashx.textLayout.formats.FormatValue.INHERIT. Default value is undefined indicating not set. If undefined during the cascade this property will inherit its value from an ancestor. If no ancestor has set this property, it will have a value of START. | VideoPlayer | ||
textAlpha | Type: Number CSS Inheritance: yes Alpha (transparency) value for the text. A value of 0 is fully transparent, and a value of 1 is fully opaque. Display objects with textAlpha set to 0 are active, even though they are invisible.
Legal values are numbers from 0 to 1 and flashx.textLayout.formats.FormatValue.INHERIT. Default value is undefined indicating not set. If undefined during the cascade this property will inherit its value from an ancestor. If no ancestor has set this property, it will have a value of 1. | VideoPlayer | ||
textDecoration | Type: String CSS Inheritance: yes Decoration on text. Use to apply underlining; default is none. Legal values are flashx.textLayout.formats.TextDecoration.NONE, flashx.textLayout.formats.TextDecoration.UNDERLINE, flashx.textLayout.formats.FormatValue.INHERIT. Default value is undefined indicating not set. If undefined during the cascade this property will inherit its value from an ancestor. If no ancestor has set this property, it will have a value of NONE. | VideoPlayer | ||
textJustify | Type: String CSS Inheritance: yes Specifies options for justifying text. Default value is TextJustify.INTER_WORD , meaning that extra space is added to the space characters. TextJustify.DISTRIBUTE adds extra space to space characters and between individual letters. Used only in conjunction with a justificationRule value of JustificationRule.SPACE .
Legal values are flashx.textLayout.formats.TextJustify.INTER_WORD, flashx.textLayout.formats.TextJustify.DISTRIBUTE, flashx.textLayout.formats.FormatValue.INHERIT. Default value is undefined indicating not set. If undefined during the cascade this property will inherit its value from an ancestor. If no ancestor has set this property, it will have a value of INTER_WORD. | VideoPlayer | ||
Type: String CSS Inheritance: no The vertical distance in pixels from the top edge of the control's content area to the top edge of the component. | UIComponent | |||
trackingLeft | Type: Object CSS Inheritance: yes Number in pixels (or percent of fontSize , like 120%) indicating the amount of tracking (manual kerning) to be applied to the left of each character. If kerning is enabled, the trackingLeft value is added to the values in the kerning table for the font. If kerning is disabled, the trackingLeft value is used as a manual kerning value. Supports both positive and negative values.
Legal values as a number are from -100 to 100. Legal values as a percent are numbers from -100% to 100%. Legal values include flashx.textLayout.formats.FormatValue.INHERIT. Default value is undefined indicating not set. If undefined during the cascade this property will inherit its value from an ancestor. If no ancestor has set this property, it will have a value of 0. | VideoPlayer | ||
trackingRight | Type: Object CSS Inheritance: yes Number in pixels (or percent of fontSize , like 120%) indicating the amount of tracking (manual kerning) to be applied to the right of each character. If kerning is enabled, the trackingRight value is added to the values in the kerning table for the font. If kerning is disabled, the trackingRight value is used as a manual kerning value. Supports both positive and negative values.
Legal values as a number are from -100 to 100. Legal values as a percent are numbers from -100% to 100%. Legal values include flashx.textLayout.formats.FormatValue.INHERIT. Default value is undefined indicating not set. If undefined during the cascade this property will inherit its value from an ancestor. If no ancestor has set this property, it will have a value of 0. | VideoPlayer | ||
typographicCase | Type: String CSS Inheritance: yes The type of typographic case used for this text. Here are some examples: Legal values are flashx.textLayout.formats.TLFTypographicCase.DEFAULT, flashx.textLayout.formats.TLFTypographicCase.CAPS_TO_SMALL_CAPS, flashx.textLayout.formats.TLFTypographicCase.UPPERCASE, flashx.textLayout.formats.TLFTypographicCase.LOWERCASE, flashx.textLayout.formats.TLFTypographicCase.LOWERCASE_TO_SMALL_CAPS, flashx.textLayout.formats.FormatValue.INHERIT. Default value is undefined indicating not set. If undefined during the cascade this property will inherit its value from an ancestor. If no ancestor has set this property, it will have a value of DEFAULT. | VideoPlayer | ||
Type: String CSS Inheritance: no The vertical distance in pixels from the center of the component's content area to the center of the component. | UIComponent |
This component uses skins made up of skin parts. Do not set the skin parts directly. The component's skin sets the skin parts.
Skin Part | Description | Defined By | ||
---|---|---|---|---|
fullScreenButton:ButtonBase | Required: false Part Type: Static An optional skin part for a button to toggle fullscreen mode. | VideoPlayer | ||
muteButton:MuteButton | Required: false Part Type: Static An optional skin part for the mute button. The mute button has both a muted property and a volume property. | VideoPlayer | ||
pauseButton:ButtonBase | Required: false Part Type: Static An optional skin part for the pause button | VideoPlayer | ||
playButton:ButtonBase | Required: false Part Type: Static An optional skin part for the play button | VideoPlayer | ||
playerControls:DisplayObject | Required: false Part Type: Static An optional skin part for all of the player controls. This skin is used to determine what to hide when the player is in full screen mode and there has been no user interaction. | VideoPlayer | ||
playheadTimeDisplay:TextBase | Required: false Part Type: Static An optional skin part to display the current playheadTime. | VideoPlayer | ||
playPauseButton:ToggleButtonBase | Required: false Part Type: Static An optional skin part for a play/pause button. When the video is playing, the selected property will be set to true. When the video is paused or stopped, the selected property will be set to false. | VideoPlayer | ||
scrubBar:ScrubBar | Required: false Part Type: Static An optional skin part for the scrub bar (the timeline). | VideoPlayer | ||
stopButton:ButtonBase | Required: false Part Type: Static An optional skin part for the stop button | VideoPlayer | ||
totalTimeDisplay:TextBase | Required: false Part Type: Static An optional skin part to display the totalTime. | VideoPlayer | ||
videoElement:VideoElement | Required: true Part Type: Static A required skin part that defines the VideoElement. | VideoPlayer | ||
volumeBar:VolumeBar | Required: false Part Type: Static An optional skin part for the volume control. | VideoPlayer |
To skin the component, implement a skin that defines the following states. Although you must implement all skin states, a skin state can be empty. An empty skin state specifies no changes to the default skin state.
autoPlay | property |
autoPlay:Boolean
Language Version: | ActionScript 3.0 |
Product Version: | Flex 4 |
Runtime Versions: | Flash Player 10, AIR 1.5 |
Specifies whether the video should start playing immediately when the
source
property is set.
If true
, the video file immediately begins to buffer and
play.
Even if autoPlay
is set to false
, Flex
starts loading the video after the initialize()
method is
called.
For Flash Media Server, this means creating the stream and loading
the first frame to display.
In the case of an HTTP download, Flex starts downloading the stream
and shows the first frame.
public function get autoPlay():Boolean
public function set autoPlay(value:Boolean):void
autoRewind | property |
autoRewind:Boolean
Language Version: | ActionScript 3.0 |
Product Version: | Flex 4 |
Runtime Versions: | Flash Player 10, AIR 1.5 |
Specifies whether the FLV file should be rewound to the first frame
when play stops, either by calling the stop()
method or by
reaching the end of the stream.
This property has no effect for live streaming video.
public function get autoRewind():Boolean
public function set autoRewind(value:Boolean):void
enabled | property |
enabled:Boolean
[override] Language Version: | ActionScript 3.0 |
Product Version: | Flex 4 |
Runtime Versions: | Flash Player 10, AIR 1.5 |
Setting enabled to false
disables the UI and
pauses the video if it was currently playing. Re-enabling the component
does not cause the video to continue playing again; you must
explicitly call play()
.
Even though the component is initially paused while disabled,
if you want to play the video or perform some other action
while disabled, you may still do so through method calls, like
play()
.
override public function get enabled():Boolean
override public function set enabled(value:Boolean):void
loop | property |
loop:Boolean
Language Version: | ActionScript 3.0 |
Product Version: | Flex 4 |
Runtime Versions: | Flash Player 10, AIR 1.5 |
Indicates whether the media should play again after playback has completed.
The loop
property takes precedence over the the autoRewind
property, so if loop is set to true
, the autoRewind
property is ignored.
public function get loop():Boolean
public function set loop(value:Boolean):void
maintainAspectRatio | property |
maintainAspectRatio:Boolean
Language Version: | ActionScript 3.0 |
Product Version: | Flex 4 |
Runtime Versions: | Flash Player 10, AIR 1.5 |
Specifies whether the control should maintain the original aspect ratio while resizing the video.
If no width, height, or constraints are specified on the VideoElement, this property has no effect.
public function get maintainAspectRatio():Boolean
public function set maintainAspectRatio(value:Boolean):void
muted | property |
muted:Boolean
Language Version: | ActionScript 3.0 |
Product Version: | Flex 4 |
Runtime Versions: | Flash Player 10, AIR 1.5 |
Set to true
to mute the video, false
to unmute the video.
This property can be used as the source for data binding. When this property is modified, it dispatches the propertyChange
event.
public function get muted():Boolean
public function set muted(value:Boolean):void
playheadTime | property |
playheadTime:Number
[read-only] Language Version: | ActionScript 3.0 |
Product Version: | Flex 4 |
Runtime Versions: | Flash Player 10, AIR 1.5 |
Playhead position, measured in seconds, since the video starting playing. The event object for many of the VideoPlay events include the playhead position so that you can determine the location in the video file where the event occurred.
Setting this property to a value in seconds performs a seek operation. If the video is currently playing, it continues playing from the new playhead position. If the video is paused, it seeks to the new playhead position and remains paused. If the video is stopped, it seeks to the new playhead position and enters the paused state. Setting this property has no effect with live video streams.
If the new playhead position is less than 0 or NaN, the control throws an exception. If the new playhead position is past the end of the video, or past the amount of the video file downloaded so far, then the control still attempts the seek.
For an FLV file, setting the playheadTime
property seeks
to the keyframe closest to the specified position, where
keyframes are specified in the FLV file at the time of encoding.
Therefore, you might not seek to the exact time if there
is no keyframe specified at that position.
This property throws an exception if set when no stream is
connected. Use the stateChange
event and the
connected
property to determine when it is
safe to set this property.
This property can be used as the source for data binding. When this property is modified, it dispatches the propertyChange
event.
public function get playheadTime():Number
playing | property |
playing:Boolean
[read-only] Language Version: | ActionScript 3.0 |
Product Version: | Flex 4 |
Runtime Versions: | Flash Player 10, AIR 1.5 |
Returns true if the video is playing or is attempting to play.
The video may not be currently playing, as it may be seeking or buferring, but the video is attempting to play.
public function get playing():Boolean
playWhenHidden | property |
playWhenHidden:Boolean
Language Version: | ActionScript 3.0 |
Product Version: | Flex 4 |
Runtime Versions: | Flash Player 10, AIR 1.5 |
Controls whether the video continues to play when it is
hidden. The video is hidden when either visible
is set to false
or when the video is taken off
of the display list. If set to false
, the video
will pause playback until the video is visible again. If set to
true
the video will continue to play when it is hidden.
The default is false
.
public function get playWhenHidden():Boolean
public function set playWhenHidden(value:Boolean):void
source | property |
source:Object
Language Version: | ActionScript 3.0 |
Product Version: | Flex 4 |
Runtime Versions: | Flash Player 10, AIR 1.5 |
For progressive download, the source is just a path or URL pointing to the video file to play. For streaming (streaming, live streaming, or multi-bitrate streaming), the source property is a StreamingVideoSource object.
This property can be used as the source for data binding. When this property is modified, it dispatches the propertyChange
event.
public function get source():Object
public function set source(value:Object):void
totalTime | property |
totalTime:Number
[read-only] Language Version: | ActionScript 3.0 |
Product Version: | Flex 4 |
Runtime Versions: | Flash Player 10, AIR 1.5 |
Total time for the video feed. -1 means that property
was not pass into play()
or
we were unable to detect the total time automatically,
or have not yet.
This property can be used as the source for data binding. When this property is modified, it dispatches the propertyChange
event.
public function get totalTime():Number
volume | property |
volume:Number
Language Version: | ActionScript 3.0 |
Product Version: | Flex 4 |
Runtime Versions: | Flash Player 10, AIR 1.5 |
The volume level, specified as an value between 0 and 1.
This property can be used as the source for data binding. When this property is modified, it dispatches the propertyChange
event.
public function get volume():Number
public function set volume(value:Number):void
VideoPlayer | () | Constructor |
public function VideoPlayer()
Language Version: | ActionScript 3.0 |
Product Version: | Flex 4 |
Runtime Versions: | Flash Player 10, AIR 1.5 |
Constructor.
formatTimeValue | () | method |
protected function formatTimeValue(value:Number):String
Formats a time value, given in seconds, into a string that gets used for the playheadTimeDisplay and the totalTimeDisplay.
Parameters
value:Number — Value in seconds of the time to format
|
String — Formatted time value
|
pause | () | method |
public function pause():void
Language Version: | ActionScript 3.0 |
Product Version: | Flex 4 |
Runtime Versions: | Flash Player 10, AIR 1.5 |
Pauses playback without moving the playhead. If playback is already is paused or is stopped, this method has no effect.
To start playback again, call the play()
method.
TypeError — If the skin hasn't been loaded and there is no videoElement.
|
play | () | method |
public function play():void
Language Version: | ActionScript 3.0 |
Product Version: | Flex 4 |
Runtime Versions: | Flash Player 10, AIR 1.5 |
Causes the video to play. Can be called while the video is paused, stopped, or while the video is already playing.
TypeError — if the skin hasn't been loaded up yet
and there's no videoElement.
|
seek | () | method |
public function seek(time:Number):void
Language Version: | ActionScript 3.0 |
Product Version: | Flex 4 |
Runtime Versions: | Flash Player 10, AIR 1.5 |
Seeks to given second in video. If video is playing, continues playing from that point. If video is paused, seek to that point and remain paused. If video is stopped, seek to that point and enters paused state. Has no effect with live streams.
If time is less than 0 or NaN, throws exeption. If time is past the end of the stream, or past the amount of file downloaded so far, then will attempt seek and when fails will recover.
The playheadTime
property might not have the expected value
immediately after you call one of the seek methods or set
playheadTime
to cause seeking. For a progressive download,
you can seek only to a keyframe; therefore, a seek takes you to the
time of the first keyframe after the specified time.
Note: When streaming, a seek always goes to the precise specified time even if the source FLV file doesn't have a keyframe there.
Seeking is asynchronous, so if you call a seek method or set the
playheadTime
property, playheadTime
does not update immediately.
To obtain the time after the seek is complete, listen for the seek
event,
which does not start until the playheadTime
property is updated.
Parameters
time:Number — seconds
|
TypeError — if the skin hasn't been loaded up yet
and there's no videoElement.
|
stop | () | method |
public function stop():void
Language Version: | ActionScript 3.0 |
Product Version: | Flex 4 |
Runtime Versions: | Flash Player 10, AIR 1.5 |
Stops video playback. If autoRewind
is set to
true
, rewinds to first frame. If video is already
stopped, has no effect. To start playback again, call
play()
.
TypeError — if the skin hasn't been loaded up yet
and there's no videoElement.
|
close | Event |
spark.events.VideoEvent
spark.events.VideoEvent.CLOSE
Language Version: | ActionScript 3.0 |
Product Version: | Flex 4 |
Runtime Versions: | Flash Player 10, AIR 1.5 |
Dispatched when the NetConnection
is closed,
whether by being timed out, by calling the close()
method,
or by loading a new video stream. This event is only dispatched
with RTMP streams, never HTTP.
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 . |
metadataInfo | If the event was triggerred from new metadata, an object describing the FLV file. |
playheadTime | The location of the playhead 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 |
spark.events.VideoEvent
spark.events.VideoEvent.COMPLETE
Language Version: | ActionScript 3.0 |
Product Version: | Flex 4 |
Runtime Versions: | Flash Player 10, AIR 1.5 |
Dispatched when playing completes because the player reached the end of the FLV file.
The component does not dispatch the event if you call the stop()
or
pause()
methods
or click the corresponding controls.
VideoEvent.COMPLETE
constant defines the value of the
type
property of the event object for a complete
event.
The properties of the event object have the following values:
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 . |
metadataInfo | If the event was triggerred from new metadata, an object describing the FLV file. |
playheadTime | The location of the playhead 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. |
metadataReceived | Event |
spark.events.VideoEvent
spark.events.VideoEvent.METADATA_RECEIVED
Language Version: | ActionScript 3.0 |
Product Version: | Flex 4 |
Runtime Versions: | Flash Player 10, AIR 1.5 |
Dispatched the first time the FLV file's metadata is reached.
The event object has an info
property that contains the
info object received by the NetStream.onMetaData
event callback.
type
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 . |
metadataInfo | If the event was triggerred from new metadata, an object describing the FLV file. |
playheadTime | The location of the playhead 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. |
playheadUpdate | Event |
spark.events.VideoEvent
spark.events.VideoEvent.PLAYHEAD_UPDATE
Language Version: | ActionScript 3.0 |
Product Version: | Flex 4 |
Runtime Versions: | Flash Player 10, AIR 1.5 |
Dispatched every 0.25 seconds while the video is playing. This event is not dispatched when it is paused or stopped, unless a seek occurs.
TheVideoEvent.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 . |
metadataInfo | If the event was triggerred from new metadata, an object describing the FLV file. |
playheadTime | The location of the playhead 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 |
flash.events.ProgressEvent
flash.events.ProgressEvent.PROGRESS
Language Version: | ActionScript 3.0 |
Product Version: | Flex 4 |
Runtime Versions: | Flash Player 10, AIR 1.5 |
Indicates progress made in number of bytes downloaded. Dispatched starting when the load begins and ending when all bytes are loaded or there is a network error. Dispatched every 0.25 seconds starting when load is called and ending when all bytes are loaded or if there is a network error. Use this event to check bytes loaded or number of bytes in the buffer.
Dispatched only for a progressive HTTP download. Indicates progress in number of
downloaded bytes. The event object has the bytesLoaded
and bytesTotal
properties
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 |
spark.events.VideoEvent
spark.events.VideoEvent.READY
Language Version: | ActionScript 3.0 |
Product Version: | Flex 4 |
Runtime Versions: | Flash Player 10, AIR 1.5 |
Dispatched when the video is loaded and ready to display.
This event is dispatched the first time the VideoPlayer
enters a responsive state after a new FLV is loaded
with the play()
or load()
method.
It is dispatched once for each FLV loaded.
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 . |
metadataInfo | If the event was triggerred from new metadata, an object describing the FLV file. |
playheadTime | The location of the playhead 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. |