| Package | mx.effects.effectClasses |
| Class | public class SoundEffectInstance |
| Inheritance | SoundEffectInstance  EffectInstance EventDispatcher Object |
See also
| Property | Defined by | ||
|---|---|---|---|
| bufferTime : Number = 1000
The SoundEffect class uses an internal Sound object to control
the MP3 file.
| SoundEffectInstance | ||
 | className : String
The name of the effect class, such as
"FadeInstance". | EffectInstance | |
| constructor : Object
A reference to the class object or constructor function for a given object instance.
| Object | |
| duration : Number
Duration of the effect in milliseconds.
| EffectInstance | |
| effect : 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 | ||
| playheadTime : Number
Current position in time of the effect.
| EffectInstance | |
| propertyChanges : PropertyChanges | EffectInstance | |
| prototype : Object
[static]
A reference to the prototype object of a class or function object.
| Object | |
| repeatCount : int | EffectInstance | |
| repeatDelay : int | 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 | ||
| startDelay : int | EffectInstance | |
| startTime : Number = 0
The initial position in the MP3 file, in milliseconds,
at which playback should start.
| SoundEffectInstance | ||
| suspendBackgroundProcessing : Boolean | EffectInstance | |
| target : Object | EffectInstance | |
| triggerEvent : Event | 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 | ||
| Method | Defined by | ||
|---|---|---|---|
|
SoundEffectInstance(target:Object)
Constructor.
| SoundEffectInstance | ||
|
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 | |
|
Dispatches an event into the event flow.
| EventDispatcher | |
|
end():void
Interrupts an effect instance that is currently playing,
and jumps immediately to the end of the effect.
| EffectInstance | |
|
finishEffect():void
Called by the
end() method when the effect
finishes playing. | EffectInstance | |
|
finishRepeat():void
Called after each iteration of a repeated effect finishes playing.
| EffectInstance | |
|
Checks whether the EventDispatcher object has any listeners registered for a specific type
of event.
| EventDispatcher | |
|
initEffect(event:Event):void
This method is called if the effect was triggered by the EffectManager.
| EffectInstance | |
|
pause():void
Pauses the effect until you call the
resume() method. | EffectInstance | |
|
play():void
Plays the effect instance on the target.
| EffectInstance | |
|
Removes a listener from the EventDispatcher object.
| EventDispatcher | |
|
resume():void
Resumes the effect after it has been paused
by a call to the
pause() method. | EffectInstance | |
|
reverse():void
Plays the effect in reverse, starting from the current position of the effect.
| EffectInstance | |
|
Sets the availability of a dynamic property for loop operations.
| Object | |
|
startEffect():void
Plays the effect instance on the target after the
startDelay period
has elapsed. | EffectInstance | |
|
Returns the string representation of the specified object.
| Object | |
|
Returns the primitive value of the specified object.
| Object | |
|
Checks whether an event listener is registered with this EventDispatcher object or any of
its ancestors for the specified event type.
| EventDispatcher | |
| bufferTime | property |
Hide Inherited Public Properties
Show Inherited Public Propertiespublic var bufferTime:Number = 1000The 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.
| isLoading | property |
isLoading:Boolean [read-only]
This property is true if the MP3 has been loaded.
public function get isLoading():Boolean
| loops | property |
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.
| panEasingFunction | property |
public var panEasingFunction:Function
The easing function for the pan effect.
This function is used to interpolate between the values
of panFrom and panTo.
| panFrom | property |
public var panFrom:NumberInitial 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.
| panTo | property |
public var panTo:NumberFinal 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.
| sound | property |
public var sound:SoundReference to the internal Sound object. The SoundEffect uses this instance to play the MP3 file.
| soundChannel | property |
soundChannel:SoundChannel [read-only]The SoundChannel object that the MP3 file has been loaded into.
Implementation public function get soundChannel():SoundChannel
| source | property |
source:Object [read-write]
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.
public function get source():Object
public function set source(value:Object):void
| startTime | property |
public var startTime:Number = 0The initial position in the MP3 file, in milliseconds, at which playback should start.
The default value is 0.
| useDuration | property |
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.
| volumeEasingFunction | property |
public var volumeEasingFunction:Function
The easing function for the volume effect.
Use this function to interpolate between the values
of volumeFrom and volumeTo.
| volumeFrom | property |
public var volumeFrom:NumberInitial volume of the Sound object. Value can range from 0.0 to 1.0.
The default value is 1.0.
| volumeTo | property |
public var volumeTo:NumberFinal volume of the Sound object. Value can range from 0.0 to 1.0.
The default value is 1.0.
| SoundEffectInstance | () | constructor |
public function SoundEffectInstance(target:Object)Constructor.
Parameterstarget:Object — The Object to animate with this effect.
|