| Package | org.osmf.elements |
| Class | public class AudioElement |
| Inheritance | AudioElement LoadableElementBase MediaElement EventDispatcher Object |
| Language Version: | ActionScript 3.0 |
| Product Version: | OSMF 1.0 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
AudioElement can load and present any MP3 or AAC file. It supports MP3 files over HTTP, as well as audio-only streams from Flash Media Server.
The basic steps for creating and using an AudioElement are:
- Create a new URLResource pointing to the URL of the audio stream or file containing the sound to be loaded.
- Create the new AudioElement, passing the URLResource as a parameter.
- Create a new MediaPlayer.
- Assign the AudioElement to the MediaPlayer's
mediaproperty. - Control the media using the MediaPlayer's methods, properties, and events.
- When done with the AudioElement, set the MediaPlayer's
mediaproperty to null. This will unload the AudioElement.
Related API Elements
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 | |
| defaultDuration : Number
Defines the duration that the element's TimeTrait will expose until the
element's content is loaded. | AudioElement | ||
![]() | metadataNamespaceURLs : Vector.<String> [read-only]
A Vector containing the namespace URLs for all Metadata
objects stored within this MediaElement. | MediaElement | |
![]() | prototype : Object [static]
A reference to the prototype object of a class or function object. | Object | |
![]() | 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
Public Methods
| Method | Defined By | ||
|---|---|---|---|
Constructor. | AudioElement | ||
![]() | 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 | |
![]() |
Adds a Metadata object to this MediaElement under the specified namespace URL. | MediaElement | |
![]() |
Dispatches an event into the event flow. | EventDispatcher | |
![]() |
Returns the Metadata object that is stored under this MediaElement with
the specified namespace URL. | MediaElement | |
![]() |
Returns the media trait of the specified type. | MediaElement | |
![]() |
Checks whether the EventDispatcher object has any listeners registered for a specific type
of event. | EventDispatcher | |
![]() |
Indicates whether an object has a specified property defined. | Object | |
![]() |
Determines whether this media element has a media trait of the
specified type. | MediaElement | |
![]() |
Indicates whether an instance of the Object class is in the prototype chain of the object specified
as the parameter. | Object | |
![]() |
Indicates whether the specified property exists and is enumerable. | Object | |
![]() |
Removes a listener from the EventDispatcher object. | EventDispatcher | |
![]() |
Removes the Metadata object that was stored under this MediaElement with
the specified namespace URL. | MediaElement | |
![]() |
Sets the availability of a dynamic property for loop operations. | Object | |
![]() |
Returns the string representation of this object, formatted according to locale-specific conventions. | Object | |
![]() |
Returns the string representation of the specified object. | Object | |
![]() |
Returns the primitive value of the specified object. | Object | |
![]() |
Checks whether an event listener is registered with this EventDispatcher object or any of
its ancestors for the specified event type. | EventDispatcher | |
Protected Methods
Property Detail
defaultDuration | property |
defaultDuration:Number| Language Version: | ActionScript 3.0 |
| Product Version: | OSMF 1.0 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
Defines the duration that the element's TimeTrait will expose until the element's content is loaded. Setting this property to a positive value results in the element becoming temporal. Any other value will remove the element's TimeTrait, unless the loaded content is exposing a duration.
Implementation
public function get defaultDuration():Number public function set defaultDuration(value:Number):voidConstructor Detail
AudioElement | () | Constructor |
public function AudioElement(resource:URLResource = null, loader:LoaderBase = null)| Language Version: | ActionScript 3.0 |
| Product Version: | OSMF 1.0 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
Constructor.
Parametersresource:URLResource (default = null) — URLResource that points to the audio source that the AudioElement
will use.
| |
loader:LoaderBase (default = null) — Loader used to load the sound. This must be either a
NetLoader (for streaming audio) or a SoundLoader (for progressive audio).
If null, the appropriate Loader will be created based on the type of the
resource.
|
Throws
ArgumentError — If loader is neither a NetLoader nor a SoundLoader.
|
Related API Elements
Examples How to use this example
AudioElementExample.as
package
{
import flash.display.Sprite;
import org.osmf.elements.AudioElement;
import org.osmf.media.MediaPlayer;
import org.osmf.media.URLResource;
public class AudioElementExample extends Sprite
{
public function AudioElementExample()
{
super();
var mediaPlayer:MediaPlayer = new MediaPlayer();
var audioElement:AudioElement = new AudioElement();
audioElement.resource = new URLResource("http://mediapm.edgesuite.net/osmf/content/test/train_1500.mp3");
mediaPlayer.media = audioElement;
}
}
}
Mon Nov 28 2011, 06:48 AM -08:00
Hide Inherited Public Properties
Show Inherited Public Properties