MetadataEvent

Package	mx.events
Class	public class MetadataEvent
Inheritance	MetadataEvent Event Object

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.

More examples

Manually dispatching events

Learn more

About Flex events

Related API Elements

mx.controls.VideoDisplay

Public Properties

	Property		Defined By
		bubbles : Boolean [read-only] Indicates whether an event is a bubbling event.	Event
		cancelable : Boolean [read-only] Indicates whether the behavior associated with the event can be prevented.	Event
		constructor : Object A reference to the class object or constructor function for a given object instance.	Object
		currentTarget : Object [read-only] The object that is actively processing the Event object with an event listener.	Event
		eventPhase : uint [read-only] The current phase in the event flow.	Event
		info : Object For events off type ACTION_SCRIPT and CUE_POINT, the index of the cue point in the VideoDisplay.cuePoint Array.	MetadataEvent
		target : Object [read-only] The event target.	Event
		type : String [read-only] The type of event.	Event

Public Methods

	Method		Defined By
		MetadataEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, info:Object = null) Constructor.	MetadataEvent
		clone():Event Duplicates an instance of an Event subclass.	Event
		formatToString(className:String, ... arguments):String A utility function for implementing the toString() method in custom ActionScript 3.0 Event classes.	Event
		hasOwnProperty(name:String):Boolean Indicates whether an object has a specified property defined.	Object
		isDefaultPrevented():Boolean Checks whether the preventDefault() method has been called on the event.	Event
		isPrototypeOf(theClass:Object):Boolean Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.	Object
		preventDefault():void Cancels an event's default behavior if that behavior can be canceled.	Event
		propertyIsEnumerable(name:String):Boolean Indicates whether the specified property exists and is enumerable.	Object
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Sets the availability of a dynamic property for loop operations.	Object
		stopImmediatePropagation():void Prevents processing of any event listeners in the current node and any subsequent nodes in the event flow.	Event
		stopPropagation():void Prevents processing of any event listeners in nodes subsequent to the current node in the event flow.	Event
		toLocaleString():String Returns the string representation of this object, formatted according to locale-specific conventions.	Object
		toString():String Returns a string containing all the properties of the Event object.	Event
		valueOf():Object Returns the primitive value of the specified object.	Object

Public Constants

	Constant		Defined 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

info

property

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.

Related API Elements

mx.controls.VideoDisplay.metadata

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_SCRIPT

Constant

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:

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`.
`info`	The index of the cue point in the VideoDisplay.cuePoint Array.
`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.

CUE_POINT

Constant

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:

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`.
`info`	The index of the cue point in the VideoDisplay.cuePoint Array.
`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.

METADATA_RECEIVED

Constant

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:

Property	Value
`bubbles`	`false`
`cancelable`	`false`; there is no default behavior to cancel.
`currentTarget`	The Object that defines the event listener that handles the event. For example, if you use `myButton.addEventListener()` to register an event listener, myButton is the value of the `currentTarget`.
`info`	An object describing the FLV file, including any cue points. This property contains the same information as the `VideoDisplay.metadata` property. See the `VideoDisplay.metadata` property for more information.
`target`	The Object that dispatched the event; it is not always the Object listening for the event. Use the `currentTarget` property to always access the Object listening for the event.
`vp`	The index of the VideoPlayer object.

Legal Notices | Online Privacy Policy

MetadataEvent - AS3 Flex

Classes x

info

MetadataEvent

ACTION_SCRIPT

CUE_POINT

METADATA_RECEIVED