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 

AudioEvent  - AS3 OSMF
Packageorg.osmf.events
Classpublic class AudioEvent
InheritanceAudioEvent Inheritance Event Inheritance Object

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

An AudioEvent is dispatched when the properties of an AudioTrait change.


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
  muted : Boolean
[read-only] New muted value resulting from this change.
AudioEvent
  pan : Number
[read-only] New pan value resulting from this change.
AudioEvent
 Inheritedtarget : Object
[read-only] The event target.
Event
 Inheritedtype : String
[read-only] The type of event.
Event
  volume : Number
[read-only] New volume value resulting from this change.
AudioEvent
Public Methods
 MethodDefined By
  
AudioEvent(type:String, bubbles:Boolean, cancelable:Boolean, muted:Boolean = false, volume:Number = NaN, pan:Number = NaN)
Constructor.
AudioEvent
 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
  MUTED_CHANGE : String = "mutedChange"
[static] The AudioEvent.MUTED_CHANGE constant defines the value of the type property of the event object for a mutedChange event.
AudioEvent
  PAN_CHANGE : String = "panChange"
[static] The AudioEvent.PAN_CHANGE constant defines the value of the type property of the event object for a panChange event.
AudioEvent
  VOLUME_CHANGE : String = "volumeChange"
[static] The AudioEvent.VOLUME_CHANGE constant defines the value of the type property of the event object for a volumeChange event.
AudioEvent
Property Detail

muted

property
muted:Boolean  [read-only]

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

New muted value resulting from this change.



Implementation
    public function get muted():Boolean

pan

property 
pan:Number  [read-only]

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

New pan value resulting from this change.



Implementation
    public function get pan():Number

volume

property 
volume:Number  [read-only]

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

New volume value resulting from this change.



Implementation
    public function get volume():Number
Constructor Detail

AudioEvent

()Constructor
public function AudioEvent(type:String, bubbles:Boolean, cancelable:Boolean, muted:Boolean = false, volume:Number = NaN, pan:Number = NaN)

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

Constructor.

Parameters
type:String — The type of the event.
 
bubbles:Boolean — Specifies whether the event can bubble up the display list hierarchy.
 
cancelable:Boolean — Specifies whether the behavior associated with the event can be prevented.
 
muted:Boolean (default = false) — Specifies whether or not the trait is currently buffering.
 
volume:Number (default = NaN) — The new bufferTime for the trait.
 
pan:Number (default = NaN) — Previous volume.
Constant Detail

MUTED_CHANGE

Constant
public static const MUTED_CHANGE:String = "mutedChange"

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

The AudioEvent.MUTED_CHANGE constant defines the value of the type property of the event object for a mutedChange event.

PAN_CHANGE

Constant 
public static const PAN_CHANGE:String = "panChange"

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

The AudioEvent.PAN_CHANGE constant defines the value of the type property of the event object for a panChange event.

VOLUME_CHANGE

Constant 
public static const VOLUME_CHANGE:String = "volumeChange"

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

The AudioEvent.VOLUME_CHANGE constant defines the value of the type property of the event object for a volumeChange event.




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

 

Legal Notices | Online Privacy Policy