mx.effects.effectClasses.SoundEffectInstance - Adobe® Flex® 4 Language Reference (Flex 4)

Package	mx.effects.effectClasses
Class	public class SoundEffectInstance
Inheritance	SoundEffectInstance EffectInstance EventDispatcher Object

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

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

Hide Inherited Public Properties

Show Inherited Public Properties

	Property		Defined By
		bufferTime : Number = 1000 The SoundEffect class uses an internal Sound object to control the MP3 file.	SoundEffectInstance
		className : String [read-only] 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 The duration of the effect, in milliseconds.	EffectInstance
		effect : IEffect The IEffect object that created this IEffectInstance object.	EffectInstance
		effectTargetHost : mx.effects:IEffectTargetHost A property that lets you access the target list-based control of a data effect.	EffectInstance
		hideFocusRing : 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
		playheadTime : Number Current time position of the effect.	EffectInstance
		propertyChanges : PropertyChanges Specifies the PropertyChanges object containing the start and end values for the set of properties relevant to the effect's targets.	EffectInstance
		prototype : Object [static] A reference to the prototype object of a class or function object.	Object
		repeatCount : int Number of times to repeat the effect.	EffectInstance
		repeatDelay : 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
		startDelay : 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
		suspendBackgroundProcessing : Boolean If true, blocks all background processing while the effect is playing.	EffectInstance
		target : Object The UIComponent object to which this effect is applied.	EffectInstance
		triggerEvent : 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

Protected Properties

Hide Inherited Protected Properties

Show Inherited Protected Properties

	Property		Defined By
		playCount : int = 0 Number of times that the instance has been played.	EffectInstance

Public Methods

Hide Inherited Public Methods

Show Inherited Public Methods

	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
		dispatchEvent(event:Event):Boolean 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
		hasEventListener(type:String):Boolean Checks whether the EventDispatcher object has any listeners registered for a specific type of event.	EventDispatcher
		hasOwnProperty(name:String):Boolean Indicates whether an object has a specified property defined.	Object
		initEffect(event:Event):void This method is called if the effect was triggered by the EffectManager.	EffectInstance
		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
		pause():void Pauses the effect until you call the resume() method.	EffectInstance
		play():void Plays the effect instance on the target.	EffectInstance
		propertyIsEnumerable(name:String):Boolean Indicates whether the specified property exists and is enumerable.	Object
		removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void 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
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void 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
		stop():void Stops the effect, leaving the target in its current state.	EffectInstance
		toLocaleString():String Returns the string representation of this object, formatted according to locale-specific conventions.	Object
		toString():String Returns the string representation of the specified object.	Object
		valueOf():Object Returns the primitive value of the specified object.	Object
		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

Hide Inherited Events

Show Inherited Events

	Event		Summary	Defined By
		activate	[broadcast event] Dispatched when the Flash Player or AIR application gains operating system focus and becomes active.	EventDispatcher
		deactivate	[broadcast event] Dispatched when the Flash Player or AIR application operating loses system focus and is becoming inactive.	EventDispatcher

Property Detail

bufferTime

property

public var bufferTime:Number = 1000

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

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.

isLoading

property

isLoading:Boolean [read-only]

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

This property is true if the MP3 has been loaded.

Implementation
public function get isLoading():Boolean

loops

property

public var loops:int = 0

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

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

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

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:Number

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

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.

panTo

property

public var panTo:Number

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

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.

sound

property

public var sound:Sound

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

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

soundChannel

property

soundChannel:SoundChannel [read-only]

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

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

Implementation
public function get soundChannel():SoundChannel

source

property

source:Object

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

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

startTime

property

public var startTime:Number = 0

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

The 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

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

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

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

The easing function for the volume effect. Use this function to interpolate between the values of volumeFrom and volumeTo.

volumeFrom

property

public var volumeFrom:Number

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

Initial 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:Number

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

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)

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

Constructor.

Parameters

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