Packagevegas.events
Classpublic class SoundEvent
InheritanceSoundEvent Inheritance BasicEvent Inheritance flash.events.Event

Flash® Player dispatches a SoundEvent object when the user changes the sound by either moving the handle of the volumeBar control or setting the volume or soundTransform property.


Public Properties
 PropertyDefined By
 Inheritedcontext : *
Determinates the optional context of this event.
BasicEvent
  soundTransform : SoundTransform
[read-only] Defines the value of the type property of a soundUpdate event object.
SoundEvent
  SOUND_UPDATE : String = soundUpdate
[static] The name of the event when the localization is changed.
SoundEvent
 Inheritedtarget : Object
[override] Indicates the custom event target.
BasicEvent
 InheritedtimeStamp : uint
[read-only] Indicates the timestamp of the event.
BasicEvent
 Inheritedtype : String
[override] Returns the type of event.
BasicEvent
Public Methods
 MethodDefined By
  
SoundEvent(type:String, target:* = null, soundTransform:SoundTransform = null, context:* = null, bubbles:Boolean = false, cancelable:Boolean = false, time:Number = 0)
Creates a new SoundEvent instance.
SoundEvent
  
clone():Event
[override] Returns a shallow copy of this object.
SoundEvent
 Inherited
dispatch(channel:String = null):void
Dispatch the event with the global event flow.
BasicEvent
 Inherited
toString():String
[override] Returns the string representation of this event.
BasicEvent
Protected Methods
 MethodDefined By
 Inherited
setTimeStamp(time:uint = 0):void
Sets the timestamp of the event (used this method only in internal in the Event class).
BasicEvent
Property Detail
SOUND_UPDATEproperty
public static var SOUND_UPDATE:String = soundUpdate

The name of the event when the localization is changed.

soundTransformproperty 
soundTransform:SoundTransform  [read-only]

Defines the value of the type property of a soundUpdate event object.


Implementation
    public function get soundTransform():SoundTransform
Constructor Detail
SoundEvent()Constructor
public function SoundEvent(type:String, target:* = null, soundTransform:SoundTransform = null, context:* = null, bubbles:Boolean = false, cancelable:Boolean = false, time:Number = 0)

Creates a new SoundEvent instance.

Parameters
type:String — the string type of the instance.
 
target:* (default = null) — the target of the event.
 
soundTransform:SoundTransform (default = null) — Indicates new values for volume and panning.
 
context:* (default = null) — the optional context object of the event.
 
bubbles:Boolean (default = false) — indicates if the event is a bubbling event.
 
cancelable:Boolean (default = false) — indicates if the event is a cancelable event.
 
time:Number (default = 0) — this optional parameter is used in the eden deserialization to copy the timestamp value of this event.
Method Detail
clone()method
override public function clone():Event

Returns a shallow copy of this object.

Returns
Event — a shallow copy of this object.




Mardi Août 16 2011, 02:33 PM +02:00