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

LoadableElementBase  - AS3 OSMF

Packageorg.osmf.media
Classpublic class LoadableElementBase
InheritanceLoadableElementBase Inheritance MediaElement Inheritance EventDispatcher Inheritance Object
Subclasses AudioElement, ImageElement, LightweightVideoElement, SWFElement

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

LoadableElementBase is the base class for media elements that have a LoadTrait. It manages the registration of event listeners, and provides protected hook methods to simplify the load workflow for subclasses.



Public Properties
 PropertyDefined By
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
 Inheritedcontainer : IMediaContainer
[read-only] The media container that this element uses.
MediaElement
 InheritedmetadataNamespaceURLs : Vector.<String>
[read-only] A Vector containing the namespace URLs for all Metadata objects stored within this MediaElement.
MediaElement
 Inheritedresource : MediaResourceBase
The media resource that this media element operates on.
MediaElement
 InheritedtraitTypes : Vector.<String>
[read-only] A Vector of MediaTraitType values representing the trait types on this media element.
MediaElement
Protected Properties
 PropertyDefined By
  loader : LoaderBase
The LoaderBase used by this element to load resources.
LoadableElementBase
Public Methods
 MethodDefined By
  
LoadableElementBase(resource:MediaResourceBase = null, loader:LoaderBase = null)
Constructor.
LoadableElementBase
 Inherited
addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
Registers an event listener object with an EventDispatcher object so that the listener receives notification of an event.
EventDispatcher
 Inherited
addMetadata(namespaceURL:String, metadata:Metadata):void
Adds a Metadata object to this MediaElement under the specified namespace URL.
MediaElement
 Inherited
Dispatches an event into the event flow.
EventDispatcher
 Inherited
Returns the Metadata object that is stored under this MediaElement with the specified namespace URL.
MediaElement
 Inherited
Returns the media trait of the specified type.
MediaElement
 Inherited
Checks whether the EventDispatcher object has any listeners registered for a specific type of event.
EventDispatcher
 Inherited
Indicates whether an object has a specified property defined.
Object
 Inherited
Determines whether this media element has a media trait of the specified type.
MediaElement
 Inherited
Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.
Object
 Inherited
Indicates whether the specified property exists and is enumerable.
Object
 Inherited
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
Removes a listener from the EventDispatcher object.
EventDispatcher
 Inherited
Removes the Metadata object that was stored under this MediaElement with the specified namespace URL.
MediaElement
 Inherited
Sets the availability of a dynamic property for loop operations.
Object
 Inherited
Returns the string representation of this object, formatted according to locale-specific conventions.
Object
 Inherited
Returns the string representation of the specified object.
Object
 Inherited
Returns the primitive value of the specified object.
Object
 Inherited
Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type.
EventDispatcher
Protected Methods
 MethodDefined By
 Inherited
Adds a new media trait to this media element.
MediaElement
  
Subclasses can override this method to return a custom LoadTrait subclass.
LoadableElementBase
  
Subclasses can override this method to do processing when the media element enters the LOADING state.
LoadableElementBase
  
Subclasses can override this method to do processing when the media element enters the READY state.
LoadableElementBase
  
Subclasses can override this method to do processing when the media element enters the UNLOADING state.
LoadableElementBase
 Inherited
Removes a media trait from this media element.
MediaElement
 Inherited
Sets up the traits for this media element.
MediaElement
Events
 Event Summary Defined By
 Inherited[broadcast event] Dispatched when the Flash Player or AIR application gains operating system focus and becomes active.EventDispatcher
 InheritedDispatched when the element's container property changed.MediaElement
 Inherited[broadcast event] Dispatched when the Flash Player or AIR application operating loses system focus and is becoming inactive.EventDispatcher
 InheritedDispatched when an error which impacts the operation of the media element occurs.MediaElement
 InheritedDispatched when a info which impacts the operation of the media element is available.MediaElement
 InheritedDispatched when a Metadata object has been added to this media element.MediaElement
 InheritedDispatched when a Metadata object has been removed from this media element.MediaElement
 InheritedDispatched when a trait is added to the media element.MediaElement
 InheritedDispatched when a trait is removed from the media element.MediaElement
Property Detail

loader

property
loader:LoaderBase

The LoaderBase used by this element to load resources.



Implementation
    protected function get loader():LoaderBase
    protected function set loader(value:LoaderBase):void
Constructor Detail

LoadableElementBase

()Constructor
public function LoadableElementBase(resource:MediaResourceBase = null, loader:LoaderBase = null)

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

Constructor.

Parameters
resource:MediaResourceBase (default = null) — The MediaResourceBase that represents the piece of media to load into this media element.
 
loader:LoaderBase (default = null) — Loader used to load the media. If null, then this class is responsible for selecting/generating the appropriate loader.
Method Detail

createLoadTrait

()method
protected function createLoadTrait(resource:MediaResourceBase, loader:LoaderBase):org.osmf.traits:LoadTrait

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

Subclasses can override this method to return a custom LoadTrait subclass.

Parameters

resource:MediaResourceBase
 
loader:LoaderBase

Returns
org.osmf.traits:LoadTrait

processLoadingState

()method 
protected function processLoadingState():void

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

Subclasses can override this method to do processing when the media element enters the LOADING state.

processReadyState

()method 
protected function processReadyState():void

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

Subclasses can override this method to do processing when the media element enters the READY state.

processUnloadingState

()method 
protected function processUnloadingState():void

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

Subclasses can override this method to do processing when the media element enters the UNLOADING state.