MetadataEvent

Package	fl.video
Class	public class MetadataEvent
Inheritance	MetadataEvent Event Object
Implements	IVPEvent

Language Version:

ActionScript 3.0

Product Version:

Flash CS3

Runtime Versions:

Flash Player 9.0.28.0, AIR 1.0

Flash^® Player dispatches a MetadataEvent object when the user requests the FLV file's metadata information packet (NetStream.onMetaData) and when cue points (NetStream.onCuePoint) are encountered in the FLV file.

Related API Elements

NetStream.onCuePoint event
NetStream.onMetaData event

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 An object with dynamic properties added depending on the event type.	MetadataEvent
		target : Object [read-only] The event target.	Event
		type : String [read-only] The type of event.	Event
		vp : uint The index of the VideoPlayer object involved in this event.	MetadataEvent

Public Methods

	Method		Defined By
		MetadataEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, info:Object = null, vp:uint = 0) Creates an Event object that contains information about metadata events.	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
		CUE_POINT : String = "cuePoint" [static] Defines the value of the type property of a cuePoint event object.	MetadataEvent
		METADATA_RECEIVED : String = "metadataReceived" [static] Defines the value of the type property of a metadataReceived event object.	MetadataEvent

Property Detail

info

property

info:Object

Language Version:

ActionScript 3.0

Product Version:

Flash CS3

Runtime Versions:

Flash Player 9.0.28.0, AIR 1.0

An object with dynamic properties added depending on the event type.

Implementation
public function get info():Object
public function set info(value:Object):void

Related API Elements

NetStream.onCuePoint event
NetStream.onMetaData event

vp

property

vp:uint

Language Version:

ActionScript 3.0

Product Version:

Flash CS3

Runtime Versions:

Flash Player 9.0.28.0, AIR 1.0

The index of the VideoPlayer object involved in this event.

Implementation
public function get vp():uint
public function set vp(value:uint):void

Related API Elements

FLVPlayback.activeVideoPlayerIndex
FLVPlayback.visibleVideoPlayerIndex
FLVPlayback.getVideoPlayer()

Constructor Detail

MetadataEvent

()

Constructor

public function MetadataEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, info:Object = null, vp:uint = 0)

Language Version:

ActionScript 3.0

Product Version:

Flash CS3

Runtime Versions:

Flash Player 9.0.28.0, AIR 1.0

Creates an Event object that contains information about metadata events. Event objects are passed as parameters to event listeners.

Parameters

	`type:String` — The type of the event. Event listeners can access this information through the inherited `type` property. Possible values are `MetadataEvent.CUE_POINT` and `MetadataEvent.METADATA_RECEIVED`.

	`bubbles:Boolean` (default = `false`) — Determines whether the Event object participates in the bubbling stage of the event flow. Event listeners can access this information through the inherited `bubbles` property.

	`cancelable:Boolean` (default = `false`) — Determines whether the Event object can be canceled. Event listeners can access this information through the inherited `cancelable` property.

	`info:Object` (default = `null`) — Determines the dynamic properties to add.

	`vp:uint` (default = `0`) — Determines the index of the VideoPlayer object.

Constant Detail

CUE_POINT

Constant

public static const CUE_POINT:String = "cuePoint"

Language Version:

ActionScript 3.0

Product Version:

Flash CS3

Runtime Versions:

Flash Player 9.0.28.0, AIR 1.0

Defines the value of the type property of a cuePoint event object.

This event has the following properties:

Property	Value
`bubbles`	`false`
`cancelable`	`false`; there is no default behavior to cancel.
`info`	The object with properties describing the cue point.
`vp`	The index of the VideoPlayer object.

Related API Elements

cuePoint event

METADATA_RECEIVED

Constant

public static const METADATA_RECEIVED:String = "metadataReceived"

Language Version:

ActionScript 3.0

Product Version:

Flash CS3

Runtime Versions:

Flash Player 9.0.28.0, AIR 1.0

Defines the value of the type property of a metadataReceived event object.

This event has the following properties:

Property	Value
`bubbles`	`false`
`cancelable`	`false`; there is no default behavior to cancel.
`info`	The object with properties describing the FLV file.
`vp`	The index of the VideoPlayer object.

Related API Elements

metadataReceived event

Legal Notices | Online Privacy Policy

MetadataEvent - AS3 Flash

Classes x

info

vp

MetadataEvent

CUE_POINT

METADATA_RECEIVED