org.osmf.traits

# AlternativeAudioTrait - AS3 OSMF

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

AlternativeAudioTrait defines the trait interface for media supporting alternative audio streams. It can also be used as the base class for a more specific AlternativeAudioTrait subclass.

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

org.osmf.media.MediaElement

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
|  | 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

Protected Properties

| Property | Defined By
--- | --- | ---
|  | _indexToSwitchTo : int = -2 | AlternativeAudioTrait

Public Methods
Hide Inherited Public Methods
Show Inherited Public Methods

| 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
|  | dispatchEvent(event:Event):Boolean Dispatches an event into the event flow. | EventDispatcher
|  | dispose():void Disposes of any resources used by this trait. | MediaTraitBase
|  | getItemForIndex(index:int):StreamingItem Returns the associated streaming item for the specified index. | AlternativeAudioTrait
|  | 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
|  | 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
|  | switchTo(index:int):void Switches the current audio stream to the alternate stream specified by the index value. | AlternativeAudioTrait
|  | 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

Events
Click for more information on events
Hide Inherited Events
Show Inherited Events

| Event | Summary | Defined By
--- | --- | --- | ---
|  | activate | [broadcast event] Dispatched when the Flash Player or AIR application gains operating system focus and becomes active. | EventDispatcher
|  | audioSwitchingChange | Dispatched when an alternative audio stream switch is requested, completed, or has failed. | AlternativeAudioTrait
|  | deactivate | [broadcast event] Dispatched when the Flash Player or AIR application operating loses system focus and is becoming inactive. | EventDispatcher
|  | numAlternativeAudioStreamsChange | Dispatched when the total number of alternative audio streams has changed. | AlternativeAudioTrait

Protected Constants

| Constant | Defined By
--- | --- | ---
|  | DEFAULT_TRANSITION_INDEX : int = -1 [static] | AlternativeAudioTrait
|  | INVALID_TRANSITION_INDEX : int = -2 [static] | AlternativeAudioTrait

Property Detail

### _indexToSwitchTo

property

`protected var _indexToSwitchTo:int = -2`

### currentIndex

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():int`

### numAlternativeAudioStreams

property

`numAlternativeAudioStreams:int` [read-only]

Language Version: | ActionScript 3.0

Product Version: | OSMF 1.6

Runtime Versions: | Flash Player 10, AIR 1.5

Obtains the total number of alternative audio streams.

Implementation
`public function get numAlternativeAudioStreams():int`

### 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():Boolean`
Constructor Detail

### AlternativeAudioTrait

()
Constructor

`public function AlternativeAudioTrait(numAlternativeAudioStreams:int)`

Language Version: | ActionScript 3.0

Product Version: | OSMF 1.6

Runtime Versions: | Flash Player 10, AIR 1.5

Default Constructor.

Parameters

| `numAlternativeAudioStreams:int` — The total number of alternative audio streams.

Method Detail

### 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`

Returns

| `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`.

Event Detail

### audioSwitchingChange

Event

Event Object Type: `org.osmf.events.AlternativeAudioEvent`
property 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 ( the `switching` property will be set to `true` ) and one when the operation ends ( the `switching` property will be set to `false` ).

### numAlternativeAudioStreamsChange

Event

Event Object Type: `org.osmf.events.AlternativeAudioEvent`
property 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..
Constant Detail

### DEFAULT_TRANSITION_INDEX

Constant

`protected static const DEFAULT_TRANSITION_INDEX:int = -1`

### INVALID_TRANSITION_INDEX

Constant

`protected static const INVALID_TRANSITION_INDEX:int = -2`

© 2015 Adobe Systems Incorporated. All rights reserved.
Mon Apr 10 2017, 12:28 PM -07:00