Packagemx.effects.effectClasses
Classpublic class SoundEffectInstance
InheritanceSoundEffectInstance Inheritance EffectInstance Inheritance EventDispatcher Inheritance Object

The SoundEffectInstance class implements the instance class for the SoundEffect effect. Flex creates an instance of this class when it plays a SoundEffect effect; you do not create one yourself.

See also

mx.effects.Fade

Public Properties
 PropertyDefined By
  bufferTime : Number = 1000
The SoundEffect class uses an internal Sound object to control the MP3 file.
SoundEffectInstance
 InheritedclassName : String
[read-only] The name of the effect class, such as "FadeInstance".
EffectInstance
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
 Inheritedduration : Number
The duration of the effect, in milliseconds.
EffectInstance
 Inheritedeffect : IEffect
The IEffect object that created this IEffectInstance object.
EffectInstance
 InheritedeffectTargetHost : mx.effects:IEffectTargetHost
A property that lets you access the target list-based control of a data effect.
EffectInstance
 InheritedhideFocusRing : Boolean
Determines whether the effect should hide the focus ring when starting the effect.
EffectInstance
  isLoading : Boolean
[read-only] This property is true if the MP3 has been loaded.
SoundEffectInstance
  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.
SoundEffectInstance
  panEasingFunction : Function
The easing function for the pan effect.
SoundEffectInstance
  panFrom : Number
Initial pan of the Sound object.
SoundEffectInstance
  panTo : Number
Final pan of the Sound object.
SoundEffectInstance
 InheritedplayheadTime : Number
[read-only] Current position in time of the effect.
EffectInstance
 InheritedpropertyChanges : PropertyChanges
Specifies the PropertyChanges object containing the start and end values for the set of properties relevant to the effect's targets.
EffectInstance
 Inheritedprototype : Object
[static] A reference to the prototype object of a class or function object.
Object
 InheritedrepeatCount : int
Number of times to repeat the effect.
EffectInstance
 InheritedrepeatDelay : int
Amount of time, in milliseconds, to wait before repeating the effect.
EffectInstance
  sound : Sound
Reference to the internal Sound object.
SoundEffectInstance
  soundChannel : SoundChannel
[read-only] The SoundChannel object that the MP3 file has been loaded into.
SoundEffectInstance
  source : Object
The URL or class of the MP3 file to play.
SoundEffectInstance
 InheritedstartDelay : int
Amount of time, in milliseconds, to wait before starting the effect.
EffectInstance
  startTime : Number = 0
The initial position in the MP3 file, in milliseconds, at which playback should start.
SoundEffectInstance
 InheritedsuspendBackgroundProcessing : Boolean
If true, blocks all background processing while the effect is playing.
EffectInstance
 Inheritedtarget : Object
The UIComponent object to which this effect is applied.
EffectInstance
 InheritedtriggerEvent : Event
The event, if any, which triggered the playing of the effect.
EffectInstance
  useDuration : Boolean = true
If true, stop the effect after the time specified by the duration property has elapsed.
SoundEffectInstance
  volumeEasingFunction : Function
The easing function for the volume effect.
SoundEffectInstance
  volumeFrom : Number
Initial volume of the Sound object.
SoundEffectInstance
  volumeTo : Number
Final volume of the Sound object.
SoundEffectInstance
Public Methods
 MethodDefined By
  
SoundEffectInstance(target:Object)
Constructor.
SoundEffectInstance
 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
dispatchEvent(event:Event):Boolean
Dispatches an event into the event flow.
EventDispatcher
 Inherited
end():void
Interrupts an effect instance that is currently playing, and jumps immediately to the end of the effect.
EffectInstance
 Inherited
finishEffect():void
Called by the end() method when the effect finishes playing.
EffectInstance
 Inherited
finishRepeat():void
Called after each iteration of a repeated effect finishes playing.
EffectInstance
 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
initEffect(event:Event):void
This method is called if the effect was triggered by the EffectManager.
EffectInstance
 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
pause():void
Pauses the effect until you call the resume() method.
EffectInstance
 Inherited
play():void
Plays the effect instance on the target.
EffectInstance
 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.
EffectInstance
 Inherited
reverse():void
Plays the effect in reverse, starting from the current position of the effect.
EffectInstance
 Inherited
setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void
Sets the availability of a dynamic property for loop operations.
Object
 Inherited
startEffect():void
Plays the effect instance on the target after the startDelay period has elapsed.
EffectInstance
 Inherited
stop():void
Stops the effect, leaving the target in its current state.
EffectInstance
 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
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
 Inherited
deactivate
[broadcast event] Dispatched when the Flash Player or AIR application operating loses system focus and is becoming inactive.EventDispatcher
Property Detail
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. This function is used 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.

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.

soundproperty 
public var sound:Sound

Reference to the internal Sound object. The SoundEffect uses this instance to play the MP3 file.

soundChannelproperty 
soundChannel:SoundChannel  [read-only]

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



Implementation
    public function get soundChannel():SoundChannel
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. Use this function 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.0.

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.0.

Constructor Detail
SoundEffectInstance()Constructor
public function SoundEffectInstance(target:Object)

Constructor.

Parameters
target:Object — The Object to animate with this effect.



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