F4MElement

Package	org.osmf.elements
Class	public class F4MElement
Inheritance	F4MElement LoadFromDocumentElement ProxyElement MediaElement EventDispatcher Object

Language Version:

ActionScript 3.0

Product Version:

OSMF 1.0

Runtime Versions:

Flash Player 10, AIR 1.5

F4MElement is a media element used to load media from 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.

The basic steps for creating and using an F4MElement are:

Create a new URLResource pointing to the URL of the F4M file.
Create the new F4MElement, passing the URLResource as a parameter.
Create a new MediaPlayer.
Assign the F4MElement to the MediaPlayer's media property.
Control the media using the MediaPlayer's methods, properties, and events.
When done with the F4MElement, set the MediaPlayer's media property to null. This will unload the F4MElement.

Note: It is simplest to use the MediaPlayer class in conjunction with the F4MElement. If you work directly with an F4MElement, then it's important to listen for events related to traits being added and removed. If you use the MediaPlayer class with an F4MElement, then the MediaPlayer will automatically listen for these events for you.

View the examples

Learn more

Flash Media Manifest File Format Specification

Related API Elements

org.osmf.media.MediaPlayer
org.osmf.media.URLResource

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
		proxiedElement : MediaElement The MediaElement for which this ProxyElement serves as a proxy, or wrapper.	ProxyElement
		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
		blockedTraits : Vector.<String> The set of MediaTraitTypes that this ProxyElement will block.	ProxyElement

Public Methods

	Method		Defined By
		F4MElement(resource:MediaResourceBase = null, loader:F4MLoader = null) Constructor.	F4MElement
		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

	Method		Defined By
		addTrait(type:String, instance:org.osmf.traits:MediaTraitBase):void Adds a new media trait to this media element.	MediaElement
		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

	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

Constructor Detail

F4MElement

()

Constructor

public function F4MElement(resource:MediaResourceBase = null, loader:F4MLoader = 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`) — MediaResourceBase that points to the F4M file that this F4MElement will use.

	`loader:F4MLoader` (default = `null`) — F4MLoader used to load the F4M file. If null, an F4MLoader will be created by the F4MElement.

Examples How to use this example

F4MElementExample.as

package
{
    import flash.display.Sprite;
    import flash.display.StageAlign;
    import flash.display.StageScaleMode;
    
    import org.osmf.elements.F4MElement;
    import org.osmf.elements.VideoElement;
    import org.osmf.media.MediaPlayer;
    import org.osmf.media.MediaPlayerSprite;
    import org.osmf.media.URLResource;
    
    public class F4MElementExample extends Sprite
    {
        public function F4MElementExample()
        {
            super();
            
            stage.scaleMode = StageScaleMode.NO_SCALE;
            stage.align = StageAlign.TOP_LEFT;
            
            var mediaPlayerSprite:MediaPlayerSprite = new MediaPlayerSprite();
            var manifestElement:F4MElement = new F4MElement();
            manifestElement.resource = new URLResource("http://mediapm.edgesuite.net/osmf/content/test/manifest-files/progressive.f4m");
            
            addChild(mediaPlayerSprite);
            mediaPlayerSprite.media = manifestElement;    
            
        }
    }
}

Legal Notices | Online Privacy Policy

F4MElement - AS3 OSMF

Classes x

F4MElement