ActionScript® 3.0 Reference for the Adobe® Flash® Platform
Home  |  Show Packages and Classes List |  Packages  |  Classes  |  What's New  |  Index  |  Appendixes
org.osmf.events 

MediaElementEvent  - AS3 OSMF
Packageorg.osmf.events
Classpublic class MediaElementEvent
InheritanceMediaElementEvent Inheritance Event Inheritance Object

Language Version: ActionScript 3.0
Product Version: OSMF 1.0
Runtime Versions: Flash Player 10, AIR 1.5

A MediaElementEvent is dispatched when the properties of a MediaElement change.


Public Properties
 PropertyDefined By
 Inheritedbubbles : Boolean
[read-only] Indicates whether an event is a bubbling event.
Event
 Inheritedcancelable : Boolean
[read-only] Indicates whether the behavior associated with the event can be prevented.
Event
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
 InheritedcurrentTarget : Object
[read-only] The object that is actively processing the Event object with an event listener.
Event
 InheritedeventPhase : uint
[read-only] The current phase in the event flow.
Event
  metadata : Metadata
[read-only] The Metadata that was added or removed.
MediaElementEvent
  namespaceURL : String
[read-only] The namespace URL for the Metadata that was added or removed.
MediaElementEvent
 Inheritedtarget : Object
[read-only] The event target.
Event
  traitType : String
[read-only] The MediaTraitType for the trait that was added or removed.
MediaElementEvent
 Inheritedtype : String
[read-only] The type of event.
Event
Public Methods
 MethodDefined By
  
MediaElementEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, traitType:String = null, namespaceURL:String = null, metadata:Metadata = null)
Constructor.
MediaElementEvent
 Inherited
clone():Event
Duplicates an instance of an Event subclass.
Event
 Inherited
formatToString(className:String, ... arguments):String
A utility function for implementing the toString() method in custom ActionScript 3.0 Event classes.
Event
 Inherited
hasOwnProperty(name:String):Boolean
Indicates whether an object has a specified property defined.
Object
 Inherited
isDefaultPrevented():Boolean
Checks whether the preventDefault() method has been called on the event.
Event
 Inherited
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
 Inherited
preventDefault():void
Cancels an event's default behavior if that behavior can be canceled.
Event
 Inherited
propertyIsEnumerable(name:String):Boolean
Indicates whether the specified property exists and is enumerable.
Object
 Inherited
setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void
Sets the availability of a dynamic property for loop operations.
Object
 Inherited
stopImmediatePropagation():void
Prevents processing of any event listeners in the current node and any subsequent nodes in the event flow.
Event
 Inherited
stopPropagation():void
Prevents processing of any event listeners in nodes subsequent to the current node in the event flow.
Event
 Inherited
toLocaleString():String
Returns the string representation of this object, formatted according to locale-specific conventions.
Object
 Inherited
toString():String
Returns a string containing all the properties of the Event object.
Event
 Inherited
valueOf():Object
Returns the primitive value of the specified object.
Object
Public Constants
 ConstantDefined By
  METADATA_ADD : String = "metadataAdd"
[static] The MediaElementEvent.METADATA_ADD constant defines the value of the type property of the event object for a metadataAdd event.
MediaElementEvent
  METADATA_REMOVE : String = "metadataRemove"
[static] The MediaElementEvent.METADATA_REMOVE constant defines the value of the type property of the event object for a metadataRemove event.
MediaElementEvent
  TRAIT_ADD : String = "traitAdd"
[static] The MediaElementEvent.TRAIT_ADD constant defines the value of the type property of the event object for a traitAdd event.
MediaElementEvent
  TRAIT_REMOVE : String = "traitRemove"
[static] The MediaElementEvent.TRAIT_REMOVE constant defines the value of the type property of the event object for a traitRemove event.
MediaElementEvent
Property Detail

metadata

property
metadata:Metadata  [read-only]

The Metadata that was added or removed. Null if type is not METADATA_ADD or METADATA_REMOVE.



Implementation
    public function get metadata():Metadata

namespaceURL

property 
namespaceURL:String  [read-only]

The namespace URL for the Metadata that was added or removed. Null if type is not METADATA_ADD or METADATA_REMOVE.



Implementation
    public function get namespaceURL():String

traitType

property 
traitType:String  [read-only]

Language Version: ActionScript 3.0
Product Version: OSMF 1.0
Runtime Versions: Flash Player 10, AIR 1.5

The MediaTraitType for the trait that was added or removed. Null if type is not TRAIT_ADD or TRAIT_REMOVE.



Implementation
    public function get traitType():String
Constructor Detail

MediaElementEvent

()Constructor
public function MediaElementEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, traitType:String = null, namespaceURL:String = null, metadata:Metadata = 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.
 
traitType:String (default = null) — The MediaTraitType for the trait that was added or removed. Null if type is not TRAIT_ADD or TRAIT_REMOVE.
 
namespaceURL:String (default = null) — The namespace URL of the Metadata that was added or removed. Null if type is not METADATA_ADD or METADATA_REMOVE.
 
metadata:Metadata (default = null) — The Metadata that was added or removed. Null if type is not METADATA_ADD or METADATA_REMOVE.
Constant Detail

METADATA_ADD

Constant
public static const METADATA_ADD:String = "metadataAdd"

Language Version: ActionScript 3.0
Product Version: OSMF 1.0
Runtime Versions: Flash Player 10, AIR 1.5

The MediaElementEvent.METADATA_ADD constant defines the value of the type property of the event object for a metadataAdd event.

METADATA_REMOVE

Constant 
public static const METADATA_REMOVE:String = "metadataRemove"

Language Version: ActionScript 3.0
Product Version: OSMF 1.0
Runtime Versions: Flash Player 10, AIR 1.5

The MediaElementEvent.METADATA_REMOVE constant defines the value of the type property of the event object for a metadataRemove event.

TRAIT_ADD

Constant 
public static const TRAIT_ADD:String = "traitAdd"

Language Version: ActionScript 3.0
Product Version: OSMF 1.0
Runtime Versions: Flash Player 10, AIR 1.5

The MediaElementEvent.TRAIT_ADD constant defines the value of the type property of the event object for a traitAdd event.

TRAIT_REMOVE

Constant 
public static const TRAIT_REMOVE:String = "traitRemove"

Language Version: ActionScript 3.0
Product Version: OSMF 1.0
Runtime Versions: Flash Player 10, AIR 1.5

The MediaElementEvent.TRAIT_REMOVE constant defines the value of the type property of the event object for a traitRemove event.




© 2014 Adobe Systems Incorporated. All rights reserved.
Thu Dec 4 2014, 05:50 PM -08:00
 

 

Legal Notices | Online Privacy Policy