Packagemx.events
Classpublic class MetadataEvent
InheritanceMetadataEvent Inheritance flash.events.Event

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

The MetadataEvent class defines the event type for metadata and cue point events. These events are used primarily by the VideoDisplay control.

See also

mx.controls.VideoDisplay


Public Properties
 PropertyDefined By
  info : Object
For events off type ACTION_SCRIPT and CUE_POINT, the index of the cue point in the VideoDisplay.cuePoint Array.
MetadataEvent
Public Methods
 MethodDefined By
  
MetadataEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, info:Object = null)
Constructor.
MetadataEvent
Public Constants
 ConstantDefined By
  ACTION_SCRIPT : String = actionscript
[static] The MetadataEvent.ACTION_SCRIPT constant defines the value of the type property of the event object for a actionscript event.
MetadataEvent
  CUE_POINT : String = cuePoint
[static] The MetadataEvent.CUE_POINT constant defines the value of the type property of the event object for a cuePoint event.
MetadataEvent
  METADATA_RECEIVED : String = metadataReceived
[static] The MetadataEvent.METADATA_RECEIVED constant defines the value of the type property for a metadataReceived event.
MetadataEvent
Property Detail
infoproperty
public var info:Object

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

For events off type ACTION_SCRIPT and CUE_POINT, the index of the cue point in the VideoDisplay.cuePoint Array.

For events off type METADATA_RECEIVED, an object describing the FLV file, including any cue points, which is the same information as the VideoDisplay.metadata property.

See also

Constructor Detail
MetadataEvent()Constructor
public function MetadataEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, info:Object = null)

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

Constructor.

Parameters
type:String — The event type; indicates the action that caused the event.
 
bubbles:Boolean (default = false) — Specifies whether the event can bubble up the display list hierarchy.
 
cancelable:Boolean (default = false) — Specifies whether the behavior associated with the event can be prevented.
 
info:Object (default = null) — For events off type ACTION_SCRIPT and CUE_POINT, the index of the cue point in the VideoDisplay.cuePoint Array. For events off type METADATA_RECEIVED, an object describing the FLV file, including any cue points, which is the same information as the VideoDisplay.metadata property.
Constant Detail
ACTION_SCRIPTConstant
public static const ACTION_SCRIPT:String = actionscript

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

The MetadataEvent.ACTION_SCRIPT constant defines the value of the type property of the event object for a actionscript event. These cue points are not embedded in the FLV file but defined using ActionScript at run time.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelablefalse
currentTargetThe Object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget.
infoThe index of the cue point in the VideoDisplay.cuePoint Array.
targetThe Object that dispatched the event; it is not always the Object listening for the event. Use the currentTarget property to always access the Object listening for the event.

CUE_POINTConstant 
public static const CUE_POINT:String = cuePoint

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

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

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelablefalse
currentTargetThe Object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget.
infoThe index of the cue point in the VideoDisplay.cuePoint Array.
targetThe Object that dispatched the event; it is not always the Object listening for the event. Use the currentTarget property to always access the Object listening for the event.

METADATA_RECEIVEDConstant 
public static const METADATA_RECEIVED:String = metadataReceived

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

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

This event has the following properties:

PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe Object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget.
infoAn object describing the FLV file, including any cue points. This property contains the same information as the VideoDisplay.metadata property. See the VideoDisplay.metadata property for more information.
targetThe Object that dispatched the event; it is not always the Object listening for the event. Use the currentTarget property to always access the Object listening for the event.
vpThe index of the VideoPlayer object.