org.osmf.events

# MetadataEvent - AS3 OSMF

Package | org.osmf.events
Class | public class MetadataEvent
Inheritance | MetadataEvent Event Object
Subclasses | TimelineMetadataEvent

Language Version: | ActionScript 3.0

Product Version: | OSMF 1.0

Runtime Versions: | Flash Player 10, AIR 1.5

A MetadataEvent is dispatched by a Metadata object when metadata values are added, removed, or changed.

Public Properties
Hide Inherited Public Properties
Show Inherited 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
|  | key : String [read-only] The key associated with this event. | MetadataEvent
|  | oldValue : * [read-only] The old value associated with this event. | MetadataEvent
|  | target : Object [read-only] The event target. | Event
|  | type : String [read-only] The type of event. | Event
|  | value : * [read-only] The value associated with this event. | MetadataEvent

Public Methods
Hide Inherited Public Methods
Show Inherited Public Methods

| Method | Defined By
--- | --- | ---
|  | MetadataEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, key:String = null, value:* = null, oldValue:* = 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
Hide Inherited Public Constants
Show Inherited Public Constants

| Constant | Defined By
--- | --- | ---
|  | VALUE_ADD : String = "valueAdd" [static] The MetadataEvent.VALUE_ADD constant defines the value of the type property of the event object for a valueAdd event. | MetadataEvent
|  | VALUE_CHANGE : String = "valueChange" [static] The MetadataEvent.VALUE_CHANGE constant defines the value of the type property of the event object for a valueChange event. | MetadataEvent
|  | VALUE_REMOVE : String = "valueRemove" [static] The MetadataEvent.VALUE_REMOVE constant defines the value of the type property of the event object for a valueRemove event. | MetadataEvent

Property Detail

### key

property

`key:String` [read-only]

Language Version: | ActionScript 3.0

Product Version: | OSMF 1.0

Runtime Versions: | Flash Player 10, AIR 1.5

The key associated with this event.

Implementation
`public function get key():String`

### oldValue

property

`oldValue:*` [read-only]

Language Version: | ActionScript 3.0

Product Version: | OSMF 1.0

Runtime Versions: | Flash Player 10, AIR 1.5

The old value associated with this event. Only valid for VALUE_CHANGE events.

Implementation
`public function get oldValue():*`

### value

property

`value:*` [read-only]

Language Version: | ActionScript 3.0

Product Version: | OSMF 1.0

Runtime Versions: | Flash Player 10, AIR 1.5

The value associated with this event.

Implementation
`public function get value():*`
Constructor Detail

### MetadataEvent

()
Constructor

`public function MetadataEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, key:String = null, value:* = null, oldValue:* = null)`

Language Version: | ActionScript 3.0

Product Version: | OSMF 1.0

Runtime Versions: | Flash Player 10, AIR 1.5

Constructor.

Parameters

| `type:String` — Event type.
| `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.
| `key:String` (default = `null`)`` — The key associated with the event.
| `value:*` (default = `null`)`` — The value associated with the event.
| `oldValue:*` (default = `null`)`` — The old value associated with the event. Only valid for VALUE_CHANGE events.

Constant Detail

### VALUE_ADD

Constant

`public static const VALUE_ADD:String = "valueAdd"`

Language Version: | ActionScript 3.0

Product Version: | OSMF 1.0

Runtime Versions: | Flash Player 10, AIR 1.5

The MetadataEvent.VALUE_ADD constant defines the value of the type property of the event object for a valueAdd event.

### VALUE_CHANGE

Constant

`public static const VALUE_CHANGE:String = "valueChange"`

Language Version: | ActionScript 3.0

Product Version: | OSMF 1.0

Runtime Versions: | Flash Player 10, AIR 1.5

The MetadataEvent.VALUE_CHANGE constant defines the value of the type property of the event object for a valueChange event.

### VALUE_REMOVE

Constant

`public static const VALUE_REMOVE:String = "valueRemove"`

Language Version: | ActionScript 3.0

Product Version: | OSMF 1.0

Runtime Versions: | Flash Player 10, AIR 1.5

The MetadataEvent.VALUE_REMOVE constant defines the value of the type property of the event object for a valueRemove event.

© 2015 Adobe Systems Incorporated. All rights reserved.
Mon Apr 10 2017, 12:28 PM -07:00