| Package | org.osmf.traits |
| Class | public class AlternativeAudioTrait |
| Inheritance | AlternativeAudioTrait  MediaTraitBase EventDispatcher Object |
| Language Version: | ActionScript 3.0 |
| Product Version: | OSMF 1.6 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
Use the MediaElement.hasTrait(MediaTraitType.ALTERNATIVE_AUDIO)
method to query whether a media element has a trait of this type.
If hasTrait(MediaTraitType.ALTERNATIVE_AUDIO) returns true,
use the MediaElement.getTrait(MediaTraitType.ALTERNATIVE_AUDIO) method
to get an object of this type.
Related API Elements
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 | |
| currentIndex : int [read-only]
Obtains a 0-based index identifying the current audio stream, or
-1 if no stream is selected. | AlternativeAudioTrait | ||
| numAlternativeAudioStreams : int [read-only]
Obtains the total number of alternative audio streams. | AlternativeAudioTrait | ||
| switching : Boolean [read-only]
Indicates whether an alternative audio stream switch is currently in progress. | AlternativeAudioTrait | ||
| traitType : String [read-only]
The MediaTraitType for this trait. | MediaTraitBase | |
| Property | Defined By | ||
|---|---|---|---|
| _indexToSwitchTo : int = -2 | AlternativeAudioTrait | ||
| Method | Defined By | ||
|---|---|---|---|
AlternativeAudioTrait(numAlternativeAudioStreams:int)
Default Constructor. | AlternativeAudioTrait | ||
| 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 | |
|
Dispatches an event into the event flow. | EventDispatcher | |
|
Disposes of any resources used by this trait. | MediaTraitBase | |
Returns the associated streaming item for the specified index. | AlternativeAudioTrait | ||
|
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 | |
|
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 | |
|
Sets the availability of a dynamic property for loop operations. | Object | |
Switches the current audio stream to the alternate stream specified by the
index value. | AlternativeAudioTrait | ||
|
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 | |
| Event | Summary | Defined By | ||
|---|---|---|---|---|
| [broadcast event] Dispatched when the Flash Player or AIR application gains operating system focus and becomes active. | EventDispatcher | ||
| Dispatched when an alternative audio stream switch is requested, completed, or has failed. | AlternativeAudioTrait | |||
| [broadcast event] Dispatched when the Flash Player or AIR application operating loses system focus and is becoming inactive. | EventDispatcher | ||
| Dispatched when the total number of alternative audio streams has changed. | AlternativeAudioTrait | |||
| Constant | Defined By | ||
|---|---|---|---|
| DEFAULT_TRANSITION_INDEX : int = -1 [static] | AlternativeAudioTrait | ||
| INVALID_TRANSITION_INDEX : int = -2 [static] | AlternativeAudioTrait | ||
_indexToSwitchTo | property |
protected var _indexToSwitchTo:int = -2currentIndex | property |
currentIndex:int [read-only] | Language Version: | ActionScript 3.0 |
| Product Version: | OSMF 1.6 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
Obtains a 0-based index identifying the current audio stream, or
-1 if no stream is selected. The returned value is
always been -1 and numAlternativeAudioStreams-1.
Implementation
public function get currentIndex():intnumAlternativeAudioStreams | property |
switching | property |
switching:Boolean [read-only] | Language Version: | ActionScript 3.0 |
| Product Version: | OSMF 1.6 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
Indicates whether an alternative audio stream switch is currently in progress.
Returns true while an audio stream switch has been requested but
not yet acknowledged and no switching failure has occurred. Returns
false once the switch request is acknowledged or a switching
failure occurs.
Implementation
public function get switching():BooleanAlternativeAudioTrait | () | Constructor |
getItemForIndex | () | method |
public function getItemForIndex(index:int):StreamingItem| Language Version: | ActionScript 3.0 |
| Product Version: | OSMF 1.6 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
Returns the associated streaming item for the specified index. Returns
null if the index is -1.
Parameters
index:int |
StreamingItem |
Throws
RangeError — If the specified index is less than -1 or
greater than (numAlternativeAudioStreams - 1).
|
switchTo | () | method |
public function switchTo(index:int):void| Language Version: | ActionScript 3.0 |
| Product Version: | OSMF 1.6 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
Switches the current audio stream to the alternate stream specified by the
index value. Passing -1 for the index
value resets the current audio stream to the default one.
Note: If media playback is currently paused, the audio stream
switch does not occur until after play resumes.
Parameters
index:int |
Throws
RangeError — If the specified index is less than -1 or
greater than numAlternativeAudioStreams-1.
|
audioSwitchingChange | Event |
org.osmf.events.AlternativeAudioEventproperty AlternativeAudioEvent.type =
org.osmf.events.AlternativeAudioEvent.AUDIO_SWITCHING_CHANGE| Language Version: | ActionScript 3.0 |
| Product Version: | OSMF 1.6 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
Dispatched when an alternative audio stream switch is requested, completed, or has failed.
Dispatched when the switching state of the alternative audio stream has changed. Usually for any successful switching operation, two AUDIO_SWITCHING_CHANGE events will be triggered. One when the switch operation starts ( theswitching
property will be set to true ) and one when the operation ends ( the
switching property will be set to false ).
numAlternativeAudioStreamsChange | Event |
org.osmf.events.AlternativeAudioEventproperty AlternativeAudioEvent.type =
org.osmf.events.AlternativeAudioEvent.NUM_ALTERNATIVE_AUDIO_STREAMS_CHANGE| Language Version: | ActionScript 3.0 |
| Product Version: | OSMF 1.6 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
Dispatched when the total number of alternative audio streams has changed.
Dispatched when the number of available alternative audio streams has changed..DEFAULT_TRANSITION_INDEX | Constant |
protected static const DEFAULT_TRANSITION_INDEX:int = -1INVALID_TRANSITION_INDEX | Constant |
protected static const INVALID_TRANSITION_INDEX:int = -2Wed Nov 21 2018, 06:34 AM -08:00