SoundManager

Kind of class: public class
Package:
Inherits from:
  • EventDispatcher
Classpath: org.asaplibrary.util.sound.SoundManager
File last modified: Friday, 13 May 2011, 22:20:36
Class for managing sounds in an application.
Example
  • Add a sound in the library as follows:
    var name:String = "linkageIDOfSoundInLibrary";
SoundManager.getInstance().addSound(new (getDefinitionByName(name)) as Sound, name);
    Then play the sound as follows: SoundManager.getInstance().playSound(name); Sounds can be added only once for a particular name, so make sure they are removed with removeSound(name) when a swf containing sounds is removed. External sounds (mp3's on the file system or server) can be added to the list of available sounds with addExternalSound(), after which they can be played and controlled by name. They can also be played directly with playExternalSound(), which is meant for external sounds that need less control. Sounds that are currently being played, or present in the list, can be muted and unmuted with muteAllSounds() and unmuteAllSounds(). Muting is also applied to sounds that are started after mute is set. These sounds will start normally, but will not be audible if muting is applied. The overall sound volume can be set with setOverallVolume(). This multiplies the volume of individual sounds with the overall volume value.

Summary

Constructor
Class properties
  • doShowErrors : Boolean
    • If true, an error is logged when a sound is not found for playing, stopping, setting volume etc.
Class methods
Instance methods
  • addSound (inSound:Sound, inName:String) : void
    • Add a sound for specified name.
  • addExternalSound (inURL:String, inName:String, inStartLoad:Boolean = false, inStartPlay:Boolean = false) : void
    • Add an external sound for specified name.
  • playSound (inName:String, inLoop:Boolean = false, inPlayCount:int = 1) : void
    • Play sound with specified name; if the sound is already playing, it is stopped to prevent stacking.
  • playExternalSound (inURL:String, inLoop:Boolean = false, inVolume:Number = 1) : void
    • Play an external sound without explicit name - inURL is defined as name for sound; if a sound with specified url is already playing, it is stopped and removed.
  • stopSound (inName:String) : void
    • Stop sound with specified name.
  • setSoundVolume (inName:String, inVolume:Number) : void
    • Set volume of sound with specified name.
  • setOverallVolume (inVolume:Number) : void
    • Set multiplication factor for all sounds.
  • muteAllSounds () : void
    • Mute all sounds that have been added to the SoundManager.
  • unmuteAllSounds () : void
    • Unmute all sounds that have been added to the SoundManager.
  • removeSound (inName:String) : void
    • Remove sound with specified name.
  • setMuteSwitch (inSwitch:ISelectable) : void
    • Set mute switch; any class that implements ISelectable can be used for this.
  • setPan (inSoundName:String, inPanning:Number) : void
  • toString () : String

Constructor

SoundManager

function SoundManager()

Class properties

doShowErrors

static doShowErrors:Boolean = true(read,write)

If true, an error is logged when a sound is not found for playing, stopping, setting volume etc. Errors for adding sounds, or load errors, are always logged.

Class methods

getInstance

static function getInstance() : SoundManager

Instance methods

addExternalSound

function addExternalSound(inURL:String, inName:String, inStartLoad:Boolean = false, inStartPlay:Boolean = false) : void

Add an external sound for specified name.

Parameters
inURL :url of sound to be added
inName :unique identifier for sound
inStartLoad:when true, the sound starts loading immediately
inStartPlay:when true, the sound starts playing when enough data has been loaded

addSound

function addSound(inSound:Sound, inName:String) : void

Add a sound for specified name.

Parameters
inSound:Sound object to add
inName :unique identifier for sound

muteAllSounds

function muteAllSounds() : void

Mute all sounds that have been added to the SoundManager.

playExternalSound

function playExternalSound(inURL:String, inLoop:Boolean = false, inVolume:Number = 1) : void

Play an external sound without explicit name - inURL is defined as name for sound; if a sound with specified url is already playing, it is stopped and removed.

Parameters
inURL :url of sound to be played
inLoop :if true, sound will be looped indefinitely
inVolume:value for sound volume

playSound

function playSound(inName:String, inLoop:Boolean = false, inPlayCount:int = 1) : void

Play sound with specified name; if the sound is already playing, it is stopped to prevent stacking.

Parameters
inName :unique identifier of previously added sound
inLoop :if true, the sound is looped
inPlayCount:number of times to play the sound; ignored if inLoop == true

removeSound

function removeSound(inName:String) : void

Remove sound with specified name.

Parameters
inName:unique identifier of previously added sound

setMuteSwitch

function setMuteSwitch(inSwitch:ISelectable) : void

Set mute switch; any class that implements ISelectable can be used for this. The state of the switch is updated according to the current mute state.

setOverallVolume

function setOverallVolume(inVolume:Number) : void

Set multiplication factor for all sounds. Normally this would fall in the range 0 < inVolume < 1.

setPan

function setPan(inSoundName:String, inPanning:Number) : void
Parameters
inSoundName:the name of the added sound
inPanning :The left-to-right panning of the sound, ranging from -1 (full pan left) to 1 (full pan right). Thanks to Jankees van Woezik hhtp://www.base24.nl)

setSoundVolume

function setSoundVolume(inName:String, inVolume:Number) : void

Set volume of sound with specified name.

Parameters
inName :unique identifier of previously added sound
inVolume:volume of sound (0 < inVolume < 1)

stopSound

function stopSound(inName:String) : void

Stop sound with specified name.

Parameters
inName:unique identifier of previously added sound

toString

override function toString() : String
Overrides
  • EventDispatcher.toString

unmuteAllSounds

function unmuteAllSounds() : void

Unmute all sounds that have been added to the SoundManager.