| Package | org.osmf.events |
| Class | public class AlternativeAudioEvent |
| Inheritance | AlternativeAudioEvent  Event Object |
| Language Version: | ActionScript 3.0 |
| Product Version: | OSMF 1.6 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
Related API Elements
Public Properties
Hide Inherited Public Properties
Show Inherited Public Properties| Property | Defined By | ||
|---|---|---|---|
 | bubbles : Boolean [read-only]
Indicates whether an event is a bubbling event. | Event | |
| cancelable : Boolean [read-only]
Indicates whether the behavior associated with the event can be prevented. | Event | |
| constructor : Object
A reference to the class object or constructor function for a given object instance. | Object | |
| currentTarget : Object [read-only]
The object that is actively processing the Event object with an event listener. | Event | |
| eventPhase : uint [read-only]
The current phase in the event flow. | Event | |
| switching : Boolean [read-only]
Returns a Boolean value indicating whether an alternative audio stream switch is in progress (TRUE) or not (FALSE). | AlternativeAudioEvent | ||
| target : Object [read-only]
The event target. | Event | |
| type : String [read-only]
The type of event. | Event | |
Public Methods
| Method | Defined By | ||
|---|---|---|---|
AlternativeAudioEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, switching:Boolean = false)
Default Constructor. | AlternativeAudioEvent | ||
|
Duplicates an instance of an Event subclass. | Event | |
|
A utility function for implementing the toString() method in custom
ActionScript 3.0 Event classes. | Event | |
|
Indicates whether an object has a specified property defined. | Object | |
|
Checks whether the preventDefault() method has been called on the event. | Event | |
|
Indicates whether an instance of the Object class is in the prototype chain of the object specified
as the parameter. | Object | |
|
Cancels an event's default behavior if that behavior can be canceled. | Event | |
|
Indicates whether the specified property exists and is enumerable. | Object | |
|
Sets the availability of a dynamic property for loop operations. | Object | |
|
Prevents processing of any event listeners in the current node and any subsequent nodes in
the event flow. | Event | |
|
Prevents processing of any event listeners in nodes subsequent to the current node in the
event flow. | Event | |
|
Returns the string representation of this object, formatted according to locale-specific conventions. | Object | |
|
Returns a string containing all the properties of the Event object. | Event | |
|
Returns the primitive value of the specified object. | Object | |
Public Constants
| Constant | Defined By | ||
|---|---|---|---|
| AUDIO_SWITCHING_CHANGE : String = "audioSwitchingChange" [static]
Dispatched when the switching state of the alternative audio stream has changed. | AlternativeAudioEvent | ||
| NUM_ALTERNATIVE_AUDIO_STREAMS_CHANGE : String = "numAlternativeAudioStreamsChange" [static]
Dispatched when the number of available alternative audio streams has changed.. | AlternativeAudioEvent | ||
Property Detail
switching | property |
switching:Boolean [read-only] | Language Version: | ActionScript 3.0 |
| Product Version: | OSMF 1.6 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
Returns a Boolean value indicating whether an alternative audio stream switch is in progress (TRUE) or not (FALSE).
Implementation
public function get switching():BooleanConstructor Detail
AlternativeAudioEvent | () | Constructor |
public function AlternativeAudioEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, switching:Boolean = false)| Language Version: | ActionScript 3.0 |
| Product Version: | OSMF 1.6 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
Default Constructor.
Parameterstype:String — Event type.
| |
bubbles:Boolean (default = false) | |
cancelable:Boolean (default = false) | |
switching:Boolean (default = false)Boolean value indicating whether an alternative audio stream switch is in progress (TRUE) or not (FALSE).
|
Constant Detail
AUDIO_SWITCHING_CHANGE | Constant |
public static const AUDIO_SWITCHING_CHANGE:String = "audioSwitchingChange"| Language Version: | ActionScript 3.0 |
| Product Version: | OSMF 1.6 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
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 ).
NUM_ALTERNATIVE_AUDIO_STREAMS_CHANGE | Constant |
public static const NUM_ALTERNATIVE_AUDIO_STREAMS_CHANGE:String = "numAlternativeAudioStreamsChange"| Language Version: | ActionScript 3.0 |
| Product Version: | OSMF 1.6 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
Dispatched when the number of available alternative audio streams has changed..
Thu Dec 6 2018, 01:12 PM -08:00