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 

MediaFactoryEvent  - AS3 OSMF

Packageorg.osmf.events
Classpublic class MediaFactoryEvent
InheritanceMediaFactoryEvent Inheritance Event Inheritance Object

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

A MediaFactoryEvent is dispatched when the MediaFactory creates a MediaElement or succeeds or fails at loading a plugin.



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
  mediaElement : MediaElement
[read-only] The created MediaElement.
MediaFactoryEvent
  resource : MediaResourceBase
[read-only] The resource representing the plugin.
MediaFactoryEvent
 Inheritedtarget : Object
[read-only] The event target.
Event
 Inheritedtype : String
[read-only] The type of event.
Event
Public Methods
 MethodDefined By
  
MediaFactoryEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, resource:MediaResourceBase = null, mediaElement:MediaElement = null)
Constructor.
MediaFactoryEvent
 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
  MEDIA_ELEMENT_CREATE : String = "mediaElementCreate"
[static] The MediaFactoryEvent.MEDIA_ELEMENT_CREATE constant defines the value of the type property of the event object for a mediaElementCreate event.
MediaFactoryEvent
  PLUGIN_LOAD : String = "pluginLoad"
[static] The MediaFactoryEvent.PLUGIN_LOAD constant defines the value of the type property of the event object for a pluginLoad event.
MediaFactoryEvent
  PLUGIN_LOAD_ERROR : String = "pluginLoadError"
[static] The MediaFactoryEvent.PLUGIN_LOAD_ERROR constant defines the value of the type property of the event object for a pluginLoadError event.
MediaFactoryEvent
Property Detail

mediaElement

property
mediaElement:MediaElement  [read-only]

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

The created MediaElement. Null if type is not MEDIA_ELEMENT_CREATE.



Implementation
    public function get mediaElement():MediaElement

resource

property 
resource:MediaResourceBase  [read-only]

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

The resource representing the plugin. Null if type is neither PLUGIN_LOAD nor PLUGIN_LOAD_ERROR.



Implementation
    public function get resource():MediaResourceBase
Constructor Detail

MediaFactoryEvent

()Constructor
public function MediaFactoryEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, resource:MediaResourceBase = null, mediaElement:MediaElement = null)

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

Constructor.

Parameters
type:String — The type of 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.
 
resource:MediaResourceBase (default = null) — The resource representing the plugin. Null if type is neither PLUGIN_LOAD nor PLUGIN_LOAD_ERROR.
 
mediaElement:MediaElement (default = null) — The created MediaElement. Null if type is not MEDIA_ELEMENT_CREATE.
Constant Detail

MEDIA_ELEMENT_CREATE

Constant
public static const MEDIA_ELEMENT_CREATE:String = "mediaElementCreate"

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

The MediaFactoryEvent.MEDIA_ELEMENT_CREATE constant defines the value of the type property of the event object for a mediaElementCreate event.

PLUGIN_LOAD

Constant 
public static const PLUGIN_LOAD:String = "pluginLoad"

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

The MediaFactoryEvent.PLUGIN_LOAD constant defines the value of the type property of the event object for a pluginLoad event.

PLUGIN_LOAD_ERROR

Constant 
public static const PLUGIN_LOAD_ERROR:String = "pluginLoadError"

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

The MediaFactoryEvent.PLUGIN_LOAD_ERROR constant defines the value of the type property of the event object for a pluginLoadError event.