Packagecom.acleveraddress.net.multi_loader.extras
Classpublic class SoundManager

Used for controlling multiple Sound objects

See also

com.research_now.net.multi_loader.extras.SoundItem

Public Methods
 MethodDefined by
  
add(key:String, sound:Sound):void
[static] Adds a sound to this manager
SoundManager
  
disposeAll():void
[static] Disposes of every Sound object that this manager controls and renders this controller available for Garbage Collection
SoundManager
  
disposeSound(key:String):void
[static] Disposes of a sound
SoundManager
  
getVolume(key:String):Number
[static] Returns the volume of a Sound object
SoundManager
  
muteAll(flag:Boolean):void
[static] Mutes every Sound object that this manager controls
SoundManager
  
muteSound(key:String, flag:Boolean):void
[static] Mutes a Sound object
SoundManager
  
pause(key:String):void
[static] Pause a Sound object
SoundManager
  
pauseAll():void
[static] Pause every Sound object that this manager controls
SoundManager
  
play(key:String, startTime:Number = 0, loops:int = 0, volume:Number = 1, panning:Number = 0):void
[static] Play the sound object
SoundManager
  
resume(key:String):void
[static] Resume a Sound object
SoundManager
  
resumeAll():void
[static] Resumes every Sound object that this manager controls
SoundManager
  
setAllVolumes(volume:Number):void
[static] Sets the volume of every Sound object that this manager controls
SoundManager
  
setVolume(key:String, volume:Number):void
[static] Sets the volume of a Sound object
SoundManager
  
stop(key:String):void
[static] Stop a Sound object
SoundManager
  
stopAll():void
[static] Stops every Sound object that this manager controls
SoundManager
Method detail
add()method
public static function add(key:String, sound:Sound):void

Adds a sound to this manager

Parameters
key:String — Indentifier for the sound
 
sound:Sound — The Sound object to add
disposeAll()method 
public static function disposeAll():void

Disposes of every Sound object that this manager controls and renders this controller available for Garbage Collection

disposeSound()method 
public static function disposeSound(key:String):void

Disposes of a sound

Parameters
key:String — Identifier of the Sound object to remove
getVolume()method 
public static function getVolume(key:String):Number

Returns the volume of a Sound object

Parameters
key:String — Identifier of the Sound object to stop

Returns
Number — The volume, ranging from 0 (silent) to 1 (full volume)
muteAll()method 
public static function muteAll(flag:Boolean):void

Mutes every Sound object that this manager controls

Parameters
flag:Boolean — Set to true to mute the sound, or false to unmute
muteSound()method 
public static function muteSound(key:String, flag:Boolean):void

Mutes a Sound object

Parameters
key:String — Identifier of the Sound object to stop
 
flag:Boolean
pause()method 
public static function pause(key:String):void

Pause a Sound object

Parameters
key:String — Identifier of the Sound object to pause
pauseAll()method 
public static function pauseAll():void

Pause every Sound object that this manager controls

play()method 
public static function play(key:String, startTime:Number = 0, loops:int = 0, volume:Number = 1, panning:Number = 0):void

Play the sound object

Parameters
key:String — Identifier of the sound to play
 
startTime:Number (default = 0) — The initial position in milliseconds at which playback should start
 
loops:int (default = 0) — Defines the number of times a sound loops back to the startTime value before the sound channel stops playback.
 
volume:Number (default = 1) — The volume, ranging from 0 (silent) to 1 (full volume).
 
panning:Number (default = 0) — The left-to-right panning of the sound, ranging from -1 (full pan left) to 1 (full pan right). A value of 0 represents no panning (center).
resume()method 
public static function resume(key:String):void

Resume a Sound object

Parameters
key:String — Identifier of the Sound object to resume
resumeAll()method 
public static function resumeAll():void

Resumes every Sound object that this manager controls

setAllVolumes()method 
public static function setAllVolumes(volume:Number):void

Sets the volume of every Sound object that this manager controls

Parameters
volume:Number — The volume, ranging from 0 (silent) to 1 (full volume)
setVolume()method 
public static function setVolume(key:String, volume:Number):void

Sets the volume of a Sound object

Parameters
key:String — Identifier of the Sound object to update
 
volume:Number — The volume, ranging from 0 (silent) to 1 (full volume)
stop()method 
public static function stop(key:String):void

Stop a Sound object

Parameters
key:String — Identifier of the Sound object to stop
stopAll()method 
public static function stopAll():void

Stops every Sound object that this manager controls




chris@acleveraddress.com - 2010