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 

TimelineMetadataEvent  - AS3 OSMF

Packageorg.osmf.events
Classpublic class TimelineMetadataEvent
InheritanceTimelineMetadataEvent Inheritance MetadataEvent Inheritance Event Inheritance Object

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

A TimelineMetadataEvent is dispatched when properties of a TimelineMetadata object 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
 Inheritedkey : String
[read-only] The key associated with this event.
MetadataEvent
  marker : org.osmf.metadata:TimelineMarker
[read-only] The TimelineMarker associated with the event.
TimelineMetadataEvent
 InheritedoldValue : *
[read-only] The old value associated with this event.
MetadataEvent
 Inheritedtarget : Object
[read-only] The event target.
Event
 Inheritedtype : String
[read-only] The type of event.
Event
 Inheritedvalue : *
[read-only] The value associated with this event.
MetadataEvent
Public Methods
 MethodDefined By
  
TimelineMetadataEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, marker:org.osmf.metadata:TimelineMarker = null)
Constructor.
TimelineMetadataEvent
 Inherited
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
Indicates whether an object has a specified property defined.
Object
 Inherited
Checks whether the preventDefault() method has been called on the event.
Event
 Inherited
Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.
Object
 Inherited
Cancels an event's default behavior if that behavior can be canceled.
Event
 Inherited
Indicates whether the specified property exists and is enumerable.
Object
 Inherited
Sets the availability of a dynamic property for loop operations.
Object
 Inherited
Prevents processing of any event listeners in the current node and any subsequent nodes in the event flow.
Event
 Inherited
Prevents processing of any event listeners in nodes subsequent to the current node in the event flow.
Event
 Inherited
Returns the string representation of this object, formatted according to locale-specific conventions.
Object
 Inherited
Returns a string containing all the properties of the Event object.
Event
 Inherited
Returns the primitive value of the specified object.
Object
Public Constants
 ConstantDefined By
  MARKER_ADD : String = "markerAdd"
[static] The TimelineMetadataEvent.MARKER_ADD constant defines the value of the type property of the event object for a markerAdd event.
TimelineMetadataEvent
  MARKER_DURATION_REACHED : String = "markerDurationReached"
[static] The TimelineMetadataEvent.MARKER_DURATION_REACHED constant defines the value of the type property of the event object for a markerDurationReached event.
TimelineMetadataEvent
  MARKER_REMOVE : String = "markerRemove"
[static] The TimelineMetadataEvent.MARKER_REMOVE constant defines the value of the type property of the event object for a markerRemove event.
TimelineMetadataEvent
  MARKER_TIME_REACHED : String = "markerTimeReached"
[static] The TimelineMetadataEvent.MARKER_TIME_REACHED constant defines the value of the type property of the event object for a markerTimeReached event.
TimelineMetadataEvent
Property Detail

marker

property
marker:org.osmf.metadata:TimelineMarker  [read-only]

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

The TimelineMarker associated with the event.



Implementation
    public function get marker():org.osmf.metadata:TimelineMarker
Constructor Detail

TimelineMetadataEvent

()Constructor
public function TimelineMetadataEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, marker:org.osmf.metadata:TimelineMarker = null)

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

Constructor.

Parameters
type:String
 
bubbles:Boolean (default = false)
 
cancelable:Boolean (default = false)
 
marker:org.osmf.metadata:TimelineMarker (default = null)
Constant Detail

MARKER_ADD

Constant
public static const MARKER_ADD:String = "markerAdd"

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

The TimelineMetadataEvent.MARKER_ADD constant defines the value of the type property of the event object for a markerAdd event.

MARKER_DURATION_REACHED

Constant 
public static const MARKER_DURATION_REACHED:String = "markerDurationReached"

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

The TimelineMetadataEvent.MARKER_DURATION_REACHED constant defines the value of the type property of the event object for a markerDurationReached event.

MARKER_REMOVE

Constant 
public static const MARKER_REMOVE:String = "markerRemove"

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

The TimelineMetadataEvent.MARKER_REMOVE constant defines the value of the type property of the event object for a markerRemove event.

MARKER_TIME_REACHED

Constant 
public static const MARKER_TIME_REACHED:String = "markerTimeReached"

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

The TimelineMetadataEvent.MARKER_TIME_REACHED constant defines the value of the type property of the event object for a markerTimeReached event.