These docs are for Phaser 2.3.0 Phaser 3 docs can be found on GitHub pages.
Phaser CE docs can be found on the Phaser CE Documentation site.

Constructor

Phaser. SoundManager

new SoundManager(game)

The Sound Manager is responsible for playing back audio via either the Legacy HTML Audio tag or via Web Audio if the browser supports it. Note: On Firefox 25+ on Linux if you have media.gstreamer disabled in about:config then it cannot play back mp3 or m4a files. The audio file type and the encoding of those files are extremely important. Not all browsers can play all audio formats. There is a good guide to what's supported here: http://hpr.dogphilosophy.net/test/

If you are reloading a Phaser Game on a page that never properly refreshes (such as in an AngularJS project) then you will quickly run out of AudioContext nodes. If this is the case create a global var called PhaserGlobal on the window object before creating the game. The active AudioContext will then be saved to window.PhaserGlobal.audioContext when the Phaser game is destroyed, and re-used when it starts again.

Parameters
Name Type Description
game Phaser.Game

Reference to the current game instance.

Source code: sound/SoundManager.js (Line 21)

Public Properties

channels : number

The number of audio channels to use in playback.

Default Value
  • 32
Source code: sound/SoundManager.js (Line 131)

connectToMaster : boolean

Used in conjunction with Sound.externalNode this allows you to stop a Sound node being connected to the SoundManager master gain node.

Default Value
  • true
Source code: sound/SoundManager.js (Line 119)

context :AudioContext

The AudioContext being used for playback.

Default Value
  • null
Source code: sound/SoundManager.js (Line 95)

game : Phaser.Game

Local reference to game.

Source code: sound/SoundManager.js (Line 26)

mute : boolean

Gets or sets the muted state of the SoundManager. This effects all sounds in the game.

Source code: sound/SoundManager.js (Line 668)

noAudio : boolean

Has audio been disabled via the PhaserGlobal object? Useful if you need to use a 3rd party audio library instead.

Default Value
  • false
Source code: sound/SoundManager.js (Line 113)

onSoundDecode : Phaser.Signal

The event dispatched when a sound decodes (typically only for mp3 files)

Source code: sound/SoundManager.js (Line 31)

touchLocked : boolean

true if the audio system is currently locked awaiting a touch event.

Default Value
  • false
Source code: sound/SoundManager.js (Line 125)

[readonly] usingAudioTag : boolean

true if the sound is being played via the Audio tag.

Source code: sound/SoundManager.js (Line 107)

[readonly] usingWebAudio : boolean

true if this sound is being played with Web Audio.

Source code: sound/SoundManager.js (Line 101)

volume : number

Gets or sets the global volume of the SoundManager, a value between 0 and 1.

Source code: sound/SoundManager.js (Line 708)

Public Methods

add(key, volume, loop, connect) → {Phaser.Sound}

Adds a new Sound into the SoundManager.

Parameters
Name Type Argument Default Description
key string

Asset key for the sound.

volume number <optional>
1

Default value for the volume.

loop boolean <optional>
false

Whether or not the sound will loop.

connect boolean <optional>
true

Controls if the created Sound object will connect to the master gainNode of the SoundManager when running under WebAudio.

Returns

The new sound instance.

Source code: sound/SoundManager.js (Line 462)

addSprite(key) → {Phaser.AudioSprite}

Adds a new AudioSprite into the SoundManager.

Parameters
Name Type Description
key string

Asset key for the sound.

Returns

The new AudioSprite instance.

Source code: sound/SoundManager.js (Line 486)

<internal> boot()

Initialises the sound manager.

Internal:
  • This member is internal (protected) and may be modified or removed in the future.
Source code: sound/SoundManager.js (Line 137)

decode(key, sound)

Decode a sound by its asset key.

Parameters
Name Type Argument Description
key string

Assets key of the sound to be decoded.

sound Phaser.Sound <optional>

Its buffer will be set to decoded data.

Source code: sound/SoundManager.js (Line 327)

destroy()

Stops all the sounds in the game, then destroys them and finally clears up any callbacks.

Source code: sound/SoundManager.js (Line 635)

pauseAll()

Pauses all the sounds in the game.

Source code: sound/SoundManager.js (Line 293)

play(key, volume, loop) → {Phaser.Sound}

Adds a new Sound into the SoundManager and starts it playing.

Parameters
Name Type Argument Default Description
key string

Asset key for the sound.

volume number <optional>
1

Default value for the volume.

loop boolean <optional>
false

Whether or not the sound will loop.

Returns

The new sound instance.

Source code: sound/SoundManager.js (Line 553)

remove(sound) → {boolean}

Removes a Sound from the SoundManager. The removed Sound is destroyed before removal.

Parameters
Name Type Description
sound Phaser.Sound

The sound object to remove.

Returns
boolean -

True if the sound was removed successfully, otherwise false.

Source code: sound/SoundManager.js (Line 501)

removeByKey(key) → {number}

Removes all Sounds from the SoundManager that have an asset key matching the given value. The removed Sounds are destroyed before removal.

Parameters
Name Type Description
key string

The key to match when removing sound objects.

Returns
number -

The number of matching sound objects that were removed.

Source code: sound/SoundManager.js (Line 526)

resumeAll()

Resumes every sound in the game.

Source code: sound/SoundManager.js (Line 310)

setDecodedCallback(files, callback, callbackContext)

This method allows you to give the SoundManager a list of Sound files, or keys, and a callback. Once all of the Sound files have finished decoding the callback will be invoked. The amount of time spent decoding depends on the codec used and file size. If all of the files given have already decoded the callback is triggered immediately.

Parameters
Name Type Description
files string | array

An array containing either Phaser.Sound objects or their key strings as found in the Phaser.Cache.

callback function

The callback which will be invoked once all files have finished decoding.

callbackContext Object

The context in which the callback will run.

Source code: sound/SoundManager.js (Line 363)

stopAll()

Stops all the sounds in the game.

Source code: sound/SoundManager.js (Line 276)

unlock()

Enables the audio, usually after the first touch.

Source code: sound/SoundManager.js (Line 234)

update()

Updates every sound in the game.

Source code: sound/SoundManager.js (Line 413)