ActionScript® 3.0 Reference for the Adobe® Flash® Platform
Home  |  Show Packages and Classes List |  Packages  |  Classes  |  What's New  |  Index  |  Appendixes
org.osmf.events 

AlternativeAudioEvent  - AS3 OSMF
Packageorg.osmf.events
Classpublic class AlternativeAudioEvent
InheritanceAlternativeAudioEvent Inheritance Event Inheritance Object

Language Version: ActionScript 3.0
Product Version: OSMF 1.6
Runtime Versions: Flash Player 10, AIR 1.5

An AlternativeAudioEvent is dispatched when the properties of an AlternativeAudioTrait change.

Related API Elements

org.osmf.traits.AlternativeAudioTrait

Public Properties
 PropertyDefined By
 Inheritedbubbles : Boolean
[read-only] Indicates whether an event is a bubbling event.
Event
 Inheritedcancelable : Boolean
[read-only] Indicates whether the behavior associated with the event can be prevented.
Event
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
 InheritedcurrentTarget : Object
[read-only] The object that is actively processing the Event object with an event listener.
Event
 InheritedeventPhase : 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
 Inheritedtarget : Object
[read-only] The event target.
Event
 Inheritedtype : String
[read-only] The type of event.
Event
Public Methods
 MethodDefined By
  
AlternativeAudioEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, switching:Boolean = false)
Default Constructor.
AlternativeAudioEvent
 Inherited
clone():Event
Duplicates an instance of an Event subclass.
Event
 Inherited
formatToString(className:String, ... arguments):String
A utility function for implementing the toString() method in custom ActionScript 3.0 Event classes.
Event
 Inherited
hasOwnProperty(name:String):Boolean
Indicates whether an object has a specified property defined.
Object
 Inherited
isDefaultPrevented():Boolean
Checks whether the preventDefault() method has been called on the event.
Event
 Inherited
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
 Inherited
preventDefault():void
Cancels an event's default behavior if that behavior can be canceled.
Event
 Inherited
propertyIsEnumerable(name:String):Boolean
Indicates whether the specified property exists and is enumerable.
Object
 Inherited
setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void
Sets the availability of a dynamic property for loop operations.
Object
 Inherited
stopImmediatePropagation():void
Prevents processing of any event listeners in the current node and any subsequent nodes in the event flow.
Event
 Inherited
stopPropagation():void
Prevents processing of any event listeners in nodes subsequent to the current node in the event flow.
Event
 Inherited
toLocaleString():String
Returns the string representation of this object, formatted according to locale-specific conventions.
Object
 Inherited
toString():String
Returns a string containing all the properties of the Event object.
Event
 Inherited
valueOf():Object
Returns the primitive value of the specified object.
Object
Public Constants
 ConstantDefined 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():Boolean
Constructor 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.

Parameters
type:String — Event type.
 
bubbles:Boolean (default = false) — Specifies whether the event can bubble up the display list hierarchy.
 
cancelable:Boolean (default = false) — Specifies whether the behavior associated with the event can be prevented.
 
switching:Boolean (default = false) — A 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..




© 2014 Adobe Systems Incorporated. All rights reserved.
Thu Dec 4 2014, 05:50 PM -08:00
 

 

Legal Notices | Online Privacy Policy