F4MLoader

Package	org.osmf.elements
Class	public class F4MLoader
Inheritance	F4MLoader LoaderBase EventDispatcher Object

Language Version:

ActionScript 3.0

Product Version:

OSMF 1.0

Runtime Versions:

Flash Player 10, AIR 1.5

F4MLoader is a loader that is capable of loading F4M files. F4M files are XML documents that adhere to the Flash Media Manifest format, and which represent all of the information needed to load and play a media file.

Learn more

Flash Media Manifest File Format Specification

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

Public Methods

Hide Inherited Public Methods

Show Inherited Public Methods

	Method		Defined By
		F4MLoader(factory:MediaFactory = null) Constructor.	F4MLoader
		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
		canHandleResource(resource:MediaResourceBase):Boolean Indicates whether this loader is capable of handling (loading) the given MediaResourceBase.	LoaderBase
		dispatchEvent(event:Event):Boolean Dispatches an event into the event flow.	EventDispatcher
		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
		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
		load(loadTrait:org.osmf.traits:LoadTrait):void Loads the specified LoadTrait.	LoaderBase
		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
		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
		unload(loadTrait:org.osmf.traits:LoadTrait):void Unloads the specified LoadTrait.	LoaderBase
		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
		executeLoad(loadTrait:org.osmf.traits:LoadTrait):void Executes the load of the given LoadTrait.	LoaderBase
		executeUnload(loadTrait:org.osmf.traits:LoadTrait):void Executes the unload of the given LoadTrait.	LoaderBase
		getBuilders():Vector.<BaseManifestBuilder> Defines the BaseManifestBuilder objects used to create the ManifestParser.	F4MLoader
		updateLoadTrait(loadTrait:org.osmf.traits:LoadTrait, newState:String):void Updates the given LoadTrait with the given info, and dispatches the state change event if necessary.	LoaderBase

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
deactivate	[broadcast event] Dispatched when the Flash Player or AIR application operating loses system focus and is becoming inactive.	EventDispatcher
loadStateChange	Dispatched when the state of a LoadTrait being loaded or unloaded by the LoaderBase has changed.	LoaderBase

Public Constants

	Constant		Defined By
		F4M_MIME_TYPE : String = "application/f4m+xml" [static] The MIME type for F4M files.	F4MLoader

Constructor Detail

()

Constructor

public function F4MLoader(factory:MediaFactory = null)

Language Version:

ActionScript 3.0

Product Version:

OSMF 1.0

Runtime Versions:

Flash Player 10, AIR 1.5

Constructor.

Parameters

factory:MediaFactory (default = null) — The factory that is used to create MediaElements based on the media specified in the manifest file. If no factory is provided, the F4MLoader will use a DefaultMediaFactory.

Method Detail

getBuilders

()

method

protected function getBuilders():Vector.<BaseManifestBuilder>

Defines the BaseManifestBuilder objects used to create the ManifestParser.

Returns

Vector.<BaseManifestBuilder> — A Vector of BaseManifestBuilder objects.

Constant Detail

F4M_MIME_TYPE

Constant

public static const F4M_MIME_TYPE:String = "application/f4m+xml"

Language Version:

ActionScript 3.0

Product Version:

OSMF 1.0

Runtime Versions:

Flash Player 10, AIR 1.5

The MIME type for F4M files.

F4MLoader - AS3 OSMF

Classes x

F4MLoader

getBuilders

F4M_MIME_TYPE

org.osmf.elements F4MLoader - AS3 OSMF		Properties \| Properties \| Constructor \| Methods \| Global Constants \| Events \| Styles \| Skin Parts \| Skin States \| Effects \| Constants \| Global Functions \| Functions \| Interfaces \| Classes \| Examples