LoadableElementBase

Package	org.osmf.media
Class	public class LoadableElementBase
Inheritance	LoadableElementBase MediaElement EventDispatcher 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

Hide Inherited Public Properties

Show Inherited Public Properties

	Property		Defined By
		constructor : Object A reference to the class object or constructor function for a given object instance.	Object
		container : IMediaContainer [read-only] The media container that this element uses.	MediaElement
		metadataNamespaceURLs : Vector.<String> [read-only] A Vector containing the namespace URLs for all Metadata objects stored within this MediaElement.	MediaElement
		resource : MediaResourceBase The media resource that this media element operates on.	MediaElement
		traitTypes : Vector.<String> [read-only] A Vector of MediaTraitType values representing the trait types on this media element.	MediaElement

Protected Properties

	Property		Defined By
		loader : LoaderBase The LoaderBase used by this element to load resources.	LoadableElementBase

Public Methods

Hide Inherited Public Methods

Show Inherited Public Methods

	Method		Defined By
		LoadableElementBase(resource:MediaResourceBase = null, loader:LoaderBase = null) Constructor.	LoadableElementBase
		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
		addMetadata(namespaceURL:String, metadata:Metadata):void Adds a Metadata object to this MediaElement under the specified namespace URL.	MediaElement
		dispatchEvent(event:Event):Boolean Dispatches an event into the event flow.	EventDispatcher
		getMetadata(namespaceURL:String):Metadata Returns the Metadata object that is stored under this MediaElement with the specified namespace URL.	MediaElement
		getTrait(type:String):org.osmf.traits:MediaTraitBase Returns the media trait of the specified type.	MediaElement
		hasEventListener(type:String):Boolean Checks whether the EventDispatcher object has any listeners registered for a specific type of event.	EventDispatcher
		hasOwnProperty(name:String):Boolean Indicates whether an object has a specified property defined.	Object
		hasTrait(type:String):Boolean Determines whether this media element has a media trait of the specified type.	MediaElement
		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
		propertyIsEnumerable(name:String):Boolean Indicates whether the specified property exists and is enumerable.	Object
		removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void Removes a listener from the EventDispatcher object.	EventDispatcher
		removeMetadata(namespaceURL:String):Metadata Removes the Metadata object that was stored under this MediaElement with the specified namespace URL.	MediaElement
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Sets the availability of a dynamic property for loop operations.	Object
		toLocaleString():String Returns the string representation of this object, formatted according to locale-specific conventions.	Object
		toString():String Returns the string representation of the specified object.	Object
		valueOf():Object Returns the primitive value of the specified object.	Object
		willTrigger(type:String):Boolean Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type.	EventDispatcher

Protected Methods

Hide Inherited Protected Methods

Show Inherited Protected Methods

	Method		Defined By
		addTrait(type:String, instance:org.osmf.traits:MediaTraitBase):void Adds a new media trait to this media element.	MediaElement
		createLoadTrait(resource:MediaResourceBase, loader:LoaderBase):org.osmf.traits:LoadTrait Subclasses can override this method to return a custom LoadTrait subclass.	LoadableElementBase
		processLoadingState():void Subclasses can override this method to do processing when the media element enters the LOADING state.	LoadableElementBase
		processReadyState():void Subclasses can override this method to do processing when the media element enters the READY state.	LoadableElementBase
		processUnloadingState():void Subclasses can override this method to do processing when the media element enters the UNLOADING state.	LoadableElementBase
		removeTrait(type:String):org.osmf.traits:MediaTraitBase Removes a media trait from this media element.	MediaElement
		setupTraits():void Sets up the traits for this media element.	MediaElement

Events

Click for more information on events

Hide Inherited Events

Show Inherited Events

	Summary	Defined By
activate	[broadcast event] Dispatched when the Flash Player or AIR application gains operating system focus and becomes active.	EventDispatcher
containerChange	Dispatched when the element's container property changed.	MediaElement
deactivate	[broadcast event] Dispatched when the Flash Player or AIR application operating loses system focus and is becoming inactive.	EventDispatcher
mediaError	Dispatched when an error which impacts the operation of the media element occurs.	MediaElement
mediaInfo	Dispatched when a info which impacts the operation of the media element is available.	MediaElement
metadataAdd	Dispatched when a Metadata object has been added to this media element.	MediaElement
metadataRemove	Dispatched when a Metadata object has been removed from this media element.	MediaElement
traitAdd	Dispatched when a trait is added to the media element.	MediaElement
traitRemove	Dispatched 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

()

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.

LoadableElementBase - AS3 OSMF

Classes x

loader