Packagemx.effects
Classpublic class SoundEffect
InheritanceSoundEffect Inheritance Effect Inheritance EventDispatcher Inheritance Object

The SoundEffect class plays an MP3 audio file. For example, you could play a sound when a user clicks a Button control. This effect lets you repeat the sound, select the source file, and control the volume and pan.

You specify the MP3 file using the source property. If you have already embedded the MP3 file, using the Embed keyword, you can pass the Class object of the MP3 file to the source property. Otherwise, specify the full URL to the MP3 file.

MXML SyntaxexpandedHide MXML Syntax

The <mx:SoundEffect> tag inherits all of the tag attributes of its superclass, and adds the following tag attributes:

  <mx:SoundEffect
    Properties
    id="ID"
    autoLoad="true|false"
    bufferTime="1000"
    loops="0"
    panEasingFunction=""
    panFrom="0"
    source=""
    startTime="0"
    useDuration="true|false"
    volumeEasingFunction="true|false"
    volumeTo="1"
     
    Events
    complete="No default"
    id3="No default"
    ioError="No default"
    progress="No default"
  />

See also

mx.effects.effectClasses.SoundEffectInstance
flash.media.Sound

Public Properties
 PropertyDefined By
  autoLoad : Boolean
If true, load the MP3 file when the source has been specified.
SoundEffect
  bufferTime : Number = 1000
The SoundEffect class uses an internal Sound object to control the MP3 file.
SoundEffect
 InheritedclassName : String
[read-only] The name of the effect class, such as "Fade".
Effect
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
 InheritedcustomFilter : mx.effects:EffectTargetFilter
Specifies a custom filter object, of type EffectTargetFilter, used by the effect to determine the targets on which to play the effect.
Effect
 Inheritedduration : Number
Duration of the effect in milliseconds.
Effect
 InheritedeffectTargetHost : mx.effects:IEffectTargetHost
A property that lets you access the target list-based control of a data effect.
Effect
 Inheritedfilter : String
Specifies an algorithm for filtering targets for an effect.
Effect
 InheritedhideFocusRing : Boolean
Determines whether the effect should hide the focus ring when starting the effect.
Effect
 InheritedinstanceClass : Class
An object of type Class that specifies the effect instance class class for this effect class.
Effect
  isLoading : Boolean
[read-only] This property is true if the MP3 has been loaded.
SoundEffect
 InheritedisPlaying : Boolean
[read-only] A read-only flag which is true if any instances of the effect are currently playing, and false if none are.
Effect
  loops : int = 0
The number of times to play the sound in a loop, where a value of 0 means play the effect once, a value of 1 means play the effect twice, and so on.
SoundEffect
  panEasingFunction : Function
The easing function for the pan effect.
SoundEffect
  panFrom : Number
Initial pan of the Sound object.
SoundEffect
  panTo : Number
Final pan of the Sound object.
SoundEffect
 InheritedperElementOffset : Number
Additional delay, in milliseconds, for effect targets after the first target of the effect.
Effect
 Inheritedprototype : Object
[static] A reference to the prototype object of a class or function object.
Object
 InheritedrelevantProperties : Array
An Array of property names to use when performing filtering.
Effect
 InheritedrelevantStyles : Array
An Array of style names to use when performing filtering.
Effect
 InheritedrepeatCount : int = 1
Number of times to repeat the effect.
Effect
 InheritedrepeatDelay : int = 0
Amount of time, in milliseconds, to wait before repeating the effect.
Effect
  sound : Sound
[read-only] The Sound object that the MP3 file has been loaded into.
SoundEffect
  source : Object
The URL or class of the MP3 file to play.
SoundEffect
 InheritedstartDelay : int = 0
Amount of time, in milliseconds, to wait before starting the effect.
Effect
  startTime : Number = 0
The initial position in the MP3 file, in milliseconds, at which playback should start.
SoundEffect
 InheritedsuspendBackgroundProcessing : Boolean = false
If true, blocks all background processing while the effect is playing.
Effect
 Inheritedtarget : Object
The UIComponent object to which this effect is applied.
Effect
 Inheritedtargets : Array
An Array of UIComponent objects that are targets for the effect.
Effect
 InheritedtriggerEvent : Event
The Event object passed to this Effect by the EffectManager when an effect is triggered, or null if the effect is not being played by the EffectManager.
Effect
  useDuration : Boolean = true
If true, stop the effect after the time specified by the duration property has elapsed.
SoundEffect
  volumeEasingFunction : Function
The easing function for the volume effect.
SoundEffect
  volumeFrom : Number
Initial volume of the Sound object.
SoundEffect
  volumeTo : Number
Final volume of the Sound object.
SoundEffect
Protected Properties
 PropertyDefined By
 InheritedendValuesCaptured : Boolean = false
A flag containing true if the end values of an effect have already been determined, or false if they should be acquired from the current properties of the effect targets when the effect runs.
Effect
Public Methods
 MethodDefined By
  
SoundEffect(target:Object = null)
Constructor.
SoundEffect
 Inherited
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
 Inherited
captureEndValues():void
Captures the current values of the relevant properties on the effect's targets and saves them as end values.
Effect
 Inherited
captureMoreStartValues(targets:Array):void
Captures the current values of the relevant properties of an additional set of targets This function is used by Flex when a data change effect is run.
Effect
 Inherited
captureStartValues():void
Captures the current values of the relevant properties on the effect's targets.
Effect
 Inherited
createInstance(target:Object = null):IEffectInstance
Creates a single effect instance and initializes it.
Effect
 Inherited
createInstances(targets:Array = null):Array
Takes an Array of target objects and invokes the createInstance() method on each target.
Effect
 Inherited
deleteInstance(instance:IEffectInstance):void
Removes event listeners from an instance and removes it from the list of instances.
Effect
 Inherited
dispatchEvent(event:Event):Boolean
Dispatches an event into the event flow.
EventDispatcher
 Inherited
end(effectInstance:IEffectInstance = null):void
Interrupts an effect that is currently playing, and jumps immediately to the end of the effect.
Effect
 Inherited
getAffectedProperties():Array
Returns an Array of Strings, where each String is the name of a property that is changed by this effect.
Effect
 Inherited
hasEventListener(type:String):Boolean
Checks whether the EventDispatcher object has any listeners registered for a specific type of event.
EventDispatcher
 Inherited
hasOwnProperty(name:String):Boolean
Indicates whether an object has a specified property defined.
Object
 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
  
load():void
Loads the MP3 if the source property points to a URL.
SoundEffect
 Inherited
pause():void
Pauses the effect until you call the resume() method.
Effect
 Inherited
play(targets:Array = null, playReversedFromEnd:Boolean = false):Array
Begins playing the effect.
Effect
 Inherited
propertyIsEnumerable(name:String):Boolean
Indicates whether the specified property exists and is enumerable.
Object
 Inherited
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
Removes a listener from the EventDispatcher object.
EventDispatcher
 Inherited
resume():void
Resumes the effect after it has been paused by a call to the pause() method.
Effect
 Inherited
reverse():void
Plays the effect in reverse, if the effect is currently playing, starting from the current position of the effect.
Effect
 Inherited
setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void
Sets the availability of a dynamic property for loop operations.
Object
 Inherited
stop():void
Stops the effect, leaving the effect targets in their current state.
Effect
 Inherited
toLocaleString():String
Returns the string representation of this object, formatted according to locale-specific conventions.
Object
 Inherited
toString():String
Returns the string representation of the specified object.
Object
 Inherited
valueOf():Object
Returns the primitive value of the specified object.
Object
 Inherited
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
Protected Methods
 MethodDefined By
 Inherited
applyValueToTarget(target:Object, property:String, value:Object, props:*):void
Used internally by the Effect infrastructure.
Effect
 Inherited
effectEndHandler(event:EffectEvent):void
Called when an effect instance has finished playing.
Effect
 Inherited
effectStartHandler(event:EffectEvent):void
This method is called when the effect instance starts playing.
Effect
 Inherited
filterInstance(propChanges:Array, target:Object):Boolean
Determines the logic for filtering out an effect instance.
Effect
 Inherited
getValueFromTarget(target:Object, property:String):*
Called by the captureStartValues() method to get the value of a property from the target.
Effect
 Inherited
initInstance(instance:IEffectInstance):void
Copies properties of the effect to the effect instance.
Effect
Events
Click for more information on events
 Event Summary Defined By
 Inherited
activate
[broadcast event] Dispatched when the Flash Player or AIR application gains operating system focus and becomes active.EventDispatcher
  
complete
Dispatched when the sound file finishes loading.SoundEffect
 Inherited
deactivate
[broadcast event] Dispatched when the Flash Player or AIR application operating loses system focus and is becoming inactive.EventDispatcher
 Inherited
effectEnd
Dispatched when the effect finishes playing, either when the effect finishes playing or when the effect has been interrupted by a call to the end() method.Effect
 Inherited
effectStart
Dispatched when the effect starts playing.Effect
  
id3
Dispatched when ID3 data is available for an MP3 sound file.SoundEffect
  
ioError
Dispatched when an error occurs during the loading of the sound file.SoundEffect
  
progress
Dispatched periodically as the sound file loads.SoundEffect
Property Detail
autoLoadproperty
autoLoad:Boolean

If true, load the MP3 file when the source has been specified.

The default value is true.



Implementation
    public function get autoLoad():Boolean
    public function set autoLoad(value:Boolean):void
bufferTimeproperty 
public var bufferTime:Number = 1000

The SoundEffect class uses an internal Sound object to control the MP3 file. This property specifies the minimum number of milliseconds worth of sound data to hold in the Sound object's buffer. The Sound object waits until it has at least this much data before beginning playback, and before resuming playback after a network stall.

The default value is 1000.

isLoadingproperty 
isLoading:Boolean  [read-only]

This property is true if the MP3 has been loaded.



Implementation
    public function get isLoading():Boolean
loopsproperty 
public var loops:int = 0

The number of times to play the sound in a loop, where a value of 0 means play the effect once, a value of 1 means play the effect twice, and so on. If you repeat the MP3 file, it still uses the setting of the useDuration property to determine the playback time.

The duration property takes precedence over this property. If the effect duration is not long enough to play the sound at least once, the sound does not loop.

The default value is 0.

panEasingFunctionproperty 
public var panEasingFunction:Function

The easing function for the pan effect. Use this function to interpolate between the values of panFrom and panTo.

panFromproperty 
public var panFrom:Number

Initial pan of the Sound object. The value can range from -1.0 to 1.0, where -1.0 uses only the left channel, 1.0 uses only the right channel, and 0.0 balances the sound evenly between the two channels.

The default value is 0.0.

panToproperty 
public var panTo:Number

Final pan of the Sound object. The value can range from -1.0 to 1.0, where -1.0 uses only the left channel, 1.0 uses only the right channel, and 0.0 balances the sound evenly between the two channels.

The default value is 0.0.

soundproperty 
sound:Sound  [read-only]

The Sound object that the MP3 file has been loaded into.



Implementation
    public function get sound():Sound
sourceproperty 
source:Object

The URL or class of the MP3 file to play. If you have already embedded the MP3 file, using the Embed keyword, you can pass the Class object of the MP3 file to the source property. Otherwise, specify the full URL to the MP3 file.



Implementation
    public function get source():Object
    public function set source(value:Object):void
startTimeproperty 
public var startTime:Number = 0

The initial position in the MP3 file, in milliseconds, at which playback should start.

The default value is 0.

useDurationproperty 
public var useDuration:Boolean = true

If true, stop the effect after the time specified by the duration property has elapsed. If false, stop the effect after the MP3 finishes playing or looping.

The default value is true.

volumeEasingFunctionproperty 
public var volumeEasingFunction:Function

The easing function for the volume effect. This function is used to interpolate between the values of volumeFrom and volumeTo.

volumeFromproperty 
public var volumeFrom:Number

Initial volume of the Sound object. Value can range from 0.0 to 1.0.

The default value is 1.

volumeToproperty 
public var volumeTo:Number

Final volume of the Sound object. Value can range from 0.0 to 1.0.

The default value is 1.

Constructor Detail
SoundEffect()Constructor
public function SoundEffect(target:Object = null)

Constructor.

Parameters
target:Object (default = null) — The Object to animate with this effect.
Method Detail
load()method
public function load():void

Loads the MP3 if the source property points to a URL.

Event Detail
complete Event
Event Object Type: flash.events.Event
property Event.type = flash.events.Event.COMPLETE

Dispatched when the sound file finishes loading.

The Event.COMPLETE constant defines the value of the type property of a complete event object.

This event has the following properties:

PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event object with an event listener.
targetThe network object that has completed loading.
id3 Event  
Event Object Type: flash.events.Event
property Event.type = flash.events.Event.ID3

Dispatched when ID3 data is available for an MP3 sound file.

The Event.ID3 constant defines the value of the type property of an id3 event object.

This event has the following properties:

PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event object with an event listener.
targetThe Sound object loading the MP3 for which ID3 data is now available. The target is not always the object in the display list that registered the event listener. Use the currentTarget property to access the object in the display list that is currently processing the event.
ioError Event  
Event Object Type: flash.events.IOErrorEvent
property IOErrorEvent.type = flash.events.IOErrorEvent.IO_ERROR

Dispatched when an error occurs during the loading of the sound file.

Defines the value of the type property of an ioError event object.

This event has the following properties:

PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event object with an event listener.
errorIDA reference number associated with the specific error (AIR only).
targetThe network object experiencing the input/output error.
textText to be displayed as an error message.
progress Event  
Event Object Type: flash.events.ProgressEvent
property ProgressEvent.type = flash.events.ProgressEvent.PROGRESS

Dispatched periodically as the sound file loads.

Within the event object, you can access the number of bytes currently loaded and the total number of bytes to load. The event is not guaranteed to be dispatched, which means that the complete event might be dispatched without any progress events being dispatched.

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

This event has the following properties:

PropertyValue
bubblesfalse
bytesLoadedThe number of items or bytes loaded at the time the listener processes the event.
bytesTotalThe total number of items or bytes that ultimately will be loaded if the loading process succeeds.
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event object with an event listener.
targetThe object reporting progress.



© 2009 Adobe Systems Incorporated. All rights reserved.
Fri Aug 14 2009, 04:09 PM +05:30