CompositeElement

Package	org.osmf.elements
Class	public class CompositeElement
Inheritance	CompositeElement MediaElement EventDispatcher Object
Subclasses	ParallelElement, SerialElement

Language Version:

ActionScript 3.0

Product Version:

OSMF 1.0

Runtime Versions:

Flash Player 10, AIR 1.5

CompositeElement is a media element which encapsulates a collection of other more granular media elements. It is generally referred to as a media composition.

The media elements that make up a media composition are treated as a single, unified media element. For example, if a media composition encapsulates a sequence of videos, the CompositeElement will behave as if it's a single VideoElement, but one which plays several videos in sequence.

Because a CompositeElement maintains a list of MediaElement children, any of which may be CompositeElements themselves, a media composition can be expressed as a tree structure.

Typically a CompositeElement is not instantiated directly but instead is used as the base class for creating specific types of media compositions.

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
		numChildren : int [read-only] The number of child MediaElements in this media composition.	CompositeElement
		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

Public Methods

	Method		Defined By
		CompositeElement() Constructor.	CompositeElement
		addChild(child:MediaElement):MediaElement Adds the specified child to the end of the list.	CompositeElement
		addChildAt(child:MediaElement, index:Number):MediaElement Adds the child to the list at the specified index.	CompositeElement
		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
		getChildAt(index:int):MediaElement Gets the child at the specified index.	CompositeElement
		getChildIndex(child:MediaElement):int Returns the index of the child if it is in the list such that getChildAt(index) == child.	CompositeElement
		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
		removeChild(child:MediaElement):MediaElement Removes the specified child and returns it.	CompositeElement
		removeChildAt(index:int):MediaElement Removes the child at the specified index and returns it.	CompositeElement
		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

Property Detail

numChildren

property

numChildren:int [read-only]

Language Version:

ActionScript 3.0

Product Version:

OSMF 1.0

Runtime Versions:

Flash Player 10, AIR 1.5

The number of child MediaElements in this media composition.

Implementation
public function get numChildren():int

Constructor Detail

CompositeElement

()

Constructor

public function CompositeElement()

Language Version:

ActionScript 3.0

Product Version:

OSMF 1.0

Runtime Versions:

Flash Player 10, AIR 1.5

Constructor.

Method Detail

addChild

()

method

public function addChild(child:MediaElement):MediaElement

Language Version:

ActionScript 3.0

Product Version:

OSMF 1.0

Runtime Versions:

Flash Player 10, AIR 1.5

Adds the specified child to the end of the list. Equivalent to addChildAt(child,numChildren).

Parameters

child:MediaElement — The child to add.

Returns

MediaElement — The MediaElement that you pass in the child parameter.

Throws

	`ArgumentError` — If child is `null`.

	`RangeError` — If the specified index is less than zero or greater than the length of the list.

	`Error` — If the child is already a child.

addChildAt

()

method

public function addChildAt(child:MediaElement, index:Number):MediaElement

Language Version:

ActionScript 3.0

Product Version:

OSMF 1.0

Runtime Versions:

Flash Player 10, AIR 1.5

Adds the child to the list at the specified index. If a child already exists at this index, it and all subsequent children will have their index positions increased by one.

Parameters

	`child:MediaElement` — The child to add.

	`index:Number` — The index position at which to add the child.

Returns

MediaElement — The MediaElement that you pass in the child parameter.

Throws

	`ArgumentError` — If child is `null`.

	`RangeError` — If the specified index is less than zero or greater than the length of the list.

	`Error` — If the child is already a child.

getChildAt

()

method

public function getChildAt(index:int):MediaElement

Language Version:

ActionScript 3.0

Product Version:

OSMF 1.0

Runtime Versions:

Flash Player 10, AIR 1.5

Gets the child at the specified index.

Parameters

index:int — The index in the list from which to retrieve the child.

Returns

MediaElement — The child at that index or null if there is none.

getChildIndex

()

method

public function getChildIndex(child:MediaElement):int

Language Version:

ActionScript 3.0

Product Version:

OSMF 1.0

Runtime Versions:

Flash Player 10, AIR 1.5

Returns the index of the child if it is in the list such that getChildAt(index) == child.

Parameters

child:MediaElement — The child to find.

Returns

int — The index of the child or -1 if the child is not in the list.

removeChild

()

method

public function removeChild(child:MediaElement):MediaElement

Language Version:

ActionScript 3.0

Product Version:

OSMF 1.0

Runtime Versions:

Flash Player 10, AIR 1.5

Removes the specified child and returns it. Equivalent to removeChildAt(child,getChildIndex(child)).

Parameters

child:MediaElement — The child MediaElement to remove.

Returns

MediaElement — The MediaElement that you pass in the child parameter.

Throws

ArgumentError — If the child is not a child of this composition.

removeChildAt

()

method

public function removeChildAt(index:int):MediaElement

Language Version:

ActionScript 3.0

Product Version:

OSMF 1.0

Runtime Versions:

Flash Player 10, AIR 1.5

Removes the child at the specified index and returns it. Any children with index positions greater than this index have their index positions decreased by one.

Parameters

index:int — The index from which to remove the child.

Returns

MediaElement — The child at that index.

Throws

RangeError — If the specified index is less than zero or greater than the length of the list.

Legal Notices | Online Privacy Policy

CompositeElement - AS3 OSMF

Classes x

numChildren

CompositeElement

addChild

addChildAt

getChildAt

getChildIndex

removeChild

removeChildAt