No-audio implementation of the Sound Manager. It is used if audio has been disabled in the game config or the device doesn't support any audio.

It represents a graceful degradation of Sound Manager logic that provides minimal functionality and prevents Phaser projects that use audio from breaking on devices that don't support any audio playback technologies.

Constructor

new NoAudioSoundManager(game)

Parameters

name	type	optional	description
game	Phaser.Game	No	Reference to the current game instance.

Scope: static

Extends

Phaser.Sound.BaseSoundManager

Source: src/sound/noaudio/NoAudioSoundManager.js#L14
Since: 3.0.0

Public Methods

add

<instance> add(key, [config])

Description:

Adds a new sound into the sound manager.

Parameters:

name	type	optional	description
key	string	No	Asset key for the sound.
config	Phaser.Types.Sound.SoundConfig	Yes	An optional config object containing default sound settings.

Overrides: Phaser.Sound.BaseSoundManager#add

Returns: Phaser.Sound.NoAudioSound - The new sound instance.

Source: src/sound/noaudio/NoAudioSoundManager.js#L51
Since: 3.60.0

addAudioSprite

<instance> addAudioSprite(key, [config])

Description:

Adds a new audio sprite sound into the sound manager. Audio Sprites are a combination of audio files and a JSON configuration. The JSON follows the format of that created by https://github.com/tonistiigi/audiosprite

Parameters:

name	type	optional	description
key	string	No	Asset key for the sound.
config	Phaser.Types.Sound.SoundConfig	Yes	An optional config object containing default sound settings.

Overrides: Phaser.Sound.BaseSoundManager#addAudioSprite

Returns: Phaser.Sound.NoAudioSound - The new audio sprite sound instance.

Source: src/sound/noaudio/NoAudioSoundManager.js#L71
Since: 3.60.0

addListener

<instance> addListener(event, fn, [context])

Description:

Add a listener for a given event.

Parameters:

name	type	optional	default	description
event	string \| symbol	No		The event name.
fn	function	No		The listener function.
context	*	Yes	"this"	The context to invoke the listener with.

Returns: Phaser.Sound.NoAudioSoundManager - this.

Inherits: Phaser.Events.EventEmitter#addListener

Source: src/events/EventEmitter.js#L111
Since: 3.0.0

destroy

<instance> destroy()

Description:

Destroys all the sounds in the game and all associated events.

Overrides: Phaser.Sound.BaseSoundManager#destroy

Source: src/sound/noaudio/NoAudioSoundManager.js#L347
Since: 3.0.0

emit

<instance> emit(event, [args])

Description:

Calls each of the listeners registered for a given event.

Parameters:

name	type	optional	description
event	string \| symbol	No	The event name.
args	*	Yes	Additional arguments that will be passed to the event handler.

Returns: boolean - true if the event had listeners, else false.

Inherits: Phaser.Events.EventEmitter#emit

Source: src/events/EventEmitter.js#L86
Since: 3.0.0

eventNames

<instance> eventNames()

Description:

Return an array listing the events for which the emitter has registered listeners.

Returns: Array.<(string | symbol)> - undefined

Inherits: Phaser.Events.EventEmitter#eventNames

Source: src/events/EventEmitter.js#L55
Since: 3.0.0

get

<instance> get(key)

Description:

Gets the first sound in the manager matching the given key, if any.

Tags:

generic
genericUse

Parameters:

name	type	optional	description
key	string	No	Sound asset key.

Overrides: Phaser.Sound.BaseSoundManager#get

Returns: Phaser.Sound.BaseSound - - The sound, or null.

Source: src/sound/noaudio/NoAudioSoundManager.js#L93
Since: 3.23.0

getAll

<instance> getAll(key)

Description:

Gets any sounds in the manager matching the given key.

Tags:

generic
genericUse

Parameters:

name	type	optional	description
key	string	No	Sound asset key.

Overrides: Phaser.Sound.BaseSoundManager#getAll

Returns: Array.<Phaser.Sound.BaseSound> - - The sounds, or an empty array.

Source: src/sound/noaudio/NoAudioSoundManager.js#L111
Since: 3.23.0

getAllPlaying

<instance> getAllPlaying()

Description:

Returns all sounds from this Sound Manager that are currently playing. That is, Sound instances that have their isPlaying property set to true.

Tags:

generic
genericUse

Returns: Array.<Phaser.Sound.BaseSound> - - All currently playing sounds, or an empty array.

Inherits: Phaser.Sound.BaseSoundManager#getAllPlaying

Source: src/sound/BaseSoundManager.js#L288
Since: 3.60.0

isPlaying

<instance> isPlaying(key)

Description:

When a key is given, returns true if any sound with that key is playing.

When no key is given, returns true if any sound is playing.

Parameters:

name	type	optional	description
key	string	No	Sound asset key.

Returns: boolean - - Per the key argument, true if any matching sound is playing, otherwise false.

Inherits: Phaser.Sound.BaseSoundManager#isPlaying

Source: src/sound/BaseSoundManager.js#L536
Since: 3.85.0

listenerCount

<instance> listenerCount(event)

Description:

Return the number of listeners listening to a given event.

Parameters:

name	type	optional	description
event	string \| symbol	No	The event name.

Returns: number - The number of listeners.

Inherits: Phaser.Events.EventEmitter#listenerCount

Source: src/events/EventEmitter.js#L75
Since: 3.0.0

listeners

<instance> listeners(event)

Description:

Return the listeners registered for a given event.

Parameters:

name	type	optional	description
event	string \| symbol	No	The event name.

Returns: Array.<function()> - The registered listeners.

Inherits: Phaser.Events.EventEmitter#listeners

Source: src/events/EventEmitter.js#L64
Since: 3.0.0

off

<instance> off(event, [fn], [context], [once])

Description:

Remove the listeners of a given event.

Parameters:

name	type	optional	description
event	string \| symbol	No	The event name.
fn	function	Yes	Only remove the listeners that match this function.
context	*	Yes	Only remove the listeners that have this context.
once	boolean	Yes	Only remove one-time listeners.

Returns: Phaser.Sound.NoAudioSoundManager - this.

Inherits: Phaser.Events.EventEmitter#off

Source: src/events/EventEmitter.js#L151
Since: 3.0.0

on

<instance> on(event, fn, [context])

Description:

Add a listener for a given event.

Parameters:

name	type	optional	default	description
event	string \| symbol	No		The event name.
fn	function	No		The listener function.
context	*	Yes	"this"	The context to invoke the listener with.

Returns: Phaser.Sound.NoAudioSoundManager - this.

Inherits: Phaser.Events.EventEmitter#on

Source: src/events/EventEmitter.js#L98
Since: 3.0.0

onBlur

<instance> onBlur()

Description:

Empty function for the No Audio Sound Manager.

Overrides: Phaser.Sound.BaseSoundManager#onBlur

Source: src/sound/noaudio/NoAudioSoundManager.js#L224
Since: 3.0.0

once

<instance> once(event, fn, [context])

Description:

Add a one-time listener for a given event.

Parameters:

name	type	optional	default	description
event	string \| symbol	No		The event name.
fn	function	No		The listener function.
context	*	Yes	"this"	The context to invoke the listener with.

Returns: Phaser.Sound.NoAudioSoundManager - this.

Inherits: Phaser.Events.EventEmitter#once

Source: src/events/EventEmitter.js#L124
Since: 3.0.0

onFocus

<instance> onFocus()

Description:

Empty function for the No Audio Sound Manager.

Overrides: Phaser.Sound.BaseSoundManager#onFocus

Source: src/sound/noaudio/NoAudioSoundManager.js#L232
Since: 3.0.0

onGameBlur

<instance> onGameBlur()

Description:

Empty function for the No Audio Sound Manager.

Overrides: Phaser.Sound.BaseSoundManager#onGameBlur

Source: src/sound/noaudio/NoAudioSoundManager.js#L240
Since: 3.0.0

onGameFocus

<instance> onGameFocus()

Description:

Empty function for the No Audio Sound Manager.

Overrides: Phaser.Sound.BaseSoundManager#onGameFocus

Source: src/sound/noaudio/NoAudioSoundManager.js#L248
Since: 3.0.0

pauseAll

<instance> pauseAll()

Description:

Empty function for the No Audio Sound Manager.

Overrides: Phaser.Sound.BaseSoundManager#pauseAll

Source: src/sound/noaudio/NoAudioSoundManager.js#L256
Since: 3.0.0

play

<instance> play(key, [extra])

Description:

This method does nothing but return 'false' for the No Audio Sound Manager, to maintain compatibility with the other Sound Managers.

Parameters:

name	type	optional	description
key	string	No	Asset key for the sound.
extra	Phaser.Types.Sound.SoundConfig \| Phaser.Types.Sound.SoundMarker	Yes	An optional additional object containing settings to be applied to the sound. It could be either config or marker object.

Overrides: Phaser.Sound.BaseSoundManager#play

Returns: boolean - Always 'false' for the No Audio Sound Manager.

Source: src/sound/noaudio/NoAudioSoundManager.js#L129
Since: 3.0.0

playAudioSprite

<instance> playAudioSprite(key, spriteName, [config])

Description:

This method does nothing but return 'false' for the No Audio Sound Manager, to maintain compatibility with the other Sound Managers.

Parameters:

name	type	optional	description
key	string	No	Asset key for the sound.
spriteName	string	No	The name of the sound sprite to play.
config	Phaser.Types.Sound.SoundConfig	Yes	An optional config object containing default sound settings.

Overrides: Phaser.Sound.BaseSoundManager#playAudioSprite

Returns: boolean - Always 'false' for the No Audio Sound Manager.

Source: src/sound/noaudio/NoAudioSoundManager.js#L147
Since: 3.0.0

remove

<instance> remove(sound)

Description:

Removes a sound from the sound manager. The removed sound is destroyed before removal.

Parameters:

name	type	optional	description
sound	Phaser.Sound.BaseSound	No	The sound object to remove.

Overrides: Phaser.Sound.BaseSoundManager#remove

Returns: boolean - True if the sound was removed successfully, otherwise false.

Source: src/sound/noaudio/NoAudioSoundManager.js#L166
Since: 3.0.0

removeAll

<instance> removeAll()

Description:

Removes all sounds from the manager, destroying the sounds.

Overrides: Phaser.Sound.BaseSoundManager#removeAll

Source: src/sound/noaudio/NoAudioSoundManager.js#L182
Since: 3.23.0

removeAllListeners

<instance> removeAllListeners([event])

Description:

Remove all listeners, or those of the specified event.

Parameters:

name	type	optional	description
event	string \| symbol	Yes	The event name.

Returns: Phaser.Sound.NoAudioSoundManager - this.

Inherits: Phaser.Events.EventEmitter#removeAllListeners

Source: src/events/EventEmitter.js#L165
Since: 3.0.0

removeByKey

<instance> removeByKey(key)

Description:

Removes all sounds from the sound manager that have an asset key matching the given value. The removed sounds are destroyed before removal.

Parameters:

name	type	optional	description
key	string	No	The key to match when removing sound objects.

Overrides: Phaser.Sound.BaseSoundManager#removeByKey

Returns: number - The number of matching sound objects that were removed.

Source: src/sound/noaudio/NoAudioSoundManager.js#L193
Since: 3.0.0

removeListener

<instance> removeListener(event, [fn], [context], [once])

Description:

Remove the listeners of a given event.

Parameters:

name	type	optional	description
event	string \| symbol	No	The event name.
fn	function	Yes	Only remove the listeners that match this function.
context	*	Yes	Only remove the listeners that have this context.
once	boolean	Yes	Only remove one-time listeners.

Returns: Phaser.Sound.NoAudioSoundManager - this.

Inherits: Phaser.Events.EventEmitter#removeListener

Source: src/events/EventEmitter.js#L137
Since: 3.0.0

resumeAll

<instance> resumeAll()

Description:

Empty function for the No Audio Sound Manager.

Overrides: Phaser.Sound.BaseSoundManager#resumeAll

Source: src/sound/noaudio/NoAudioSoundManager.js#L264
Since: 3.0.0

setDetune

<instance> setDetune()

Description:

Empty function for the No Audio Sound Manager.

Overrides: Phaser.Sound.BaseSoundManager#setDetune

Returns: Phaser.Sound.NoAudioSoundManager - This Sound Manager.

Source: src/sound/noaudio/NoAudioSoundManager.js#L298
Since: 3.0.0

setListenerPosition

<instance> setListenerPosition([x], [y])

Description:

Sets the X and Y position of the Spatial Audio listener on this Web Audios context.

If you call this method with no parameters it will default to the center-point of the game canvas. Depending on the type of game you're making, you may need to call this method constantly to reset the listener position as the camera scrolls.

Calling this method does nothing on HTML5Audio.

Parameters:

name	type	optional	description
x	number	Yes	The x position of the Spatial Audio listener.
y	number	Yes	The y position of the Spatial Audio listener.

Inherits: Phaser.Sound.BaseSoundManager#setListenerPosition

Source: src/sound/BaseSoundManager.js#L480
Since: 3.60.0

setMute

<instance> setMute()

Description:

Empty function for the No Audio Sound Manager.

Source: src/sound/noaudio/NoAudioSoundManager.js#L308
Since: 3.0.0

setRate

<instance> setRate()

Description:

Empty function for the No Audio Sound Manager.

Overrides: Phaser.Sound.BaseSoundManager#setRate

Returns: Phaser.Sound.NoAudioSoundManager - This Sound Manager.

Source: src/sound/noaudio/NoAudioSoundManager.js#L288
Since: 3.0.0

setVolume

<instance> setVolume()

Description:

Empty function for the No Audio Sound Manager.

Source: src/sound/noaudio/NoAudioSoundManager.js#L316
Since: 3.0.0

shutdown

<instance> shutdown()

Description:

Removes all listeners.

Inherits: Phaser.Events.EventEmitter#shutdown

Source: src/events/EventEmitter.js#L31
Since: 3.0.0

stopAll

<instance> stopAll()

Description:

Empty function for the No Audio Sound Manager.

Overrides: Phaser.Sound.BaseSoundManager#stopAll

Source: src/sound/noaudio/NoAudioSoundManager.js#L272
Since: 3.0.0

stopByKey

<instance> stopByKey(key)

Description:

Stops any sounds matching the given key.

Parameters:

name	type	optional	description
key	string	No	Sound asset key.

Overrides: Phaser.Sound.BaseSoundManager#stopByKey

Returns: number - - How many sounds were stopped.

Source: src/sound/noaudio/NoAudioSoundManager.js#L209
Since: 3.23.0

unlock

<instance> unlock()

Description:

Empty function for the No Audio Sound Manager.

Overrides: Phaser.Sound.BaseSoundManager#unlock

Source: src/sound/noaudio/NoAudioSoundManager.js#L324
Since: 3.0.0

update

<instance> update()

Description:

Empty function for the No Audio Sound Manager.

Overrides: Phaser.Sound.BaseSoundManager#update

Source: src/sound/noaudio/NoAudioSoundManager.js#L280
Since: 3.0.0

Private Methods

forEachActiveSound

<instance> forEachActiveSound(callback, [scope])

Description:

Method used internally for iterating only over active sounds and skipping sounds that are marked for removal.

Access: private

Parameters:

name	type	optional	description
callback	Phaser.Types.Sound.EachActiveSoundCallback	No	Callback function. (manager: Phaser.Sound.BaseSoundManager, sound: Phaser.Sound.BaseSound, index: number, sounds: Phaser.Manager.BaseSound[]) => void
scope	*	Yes	Callback context.

Overrides: Phaser.Sound.BaseSoundManager#forEachActiveSound

Source: src/sound/noaudio/NoAudioSoundManager.js#L332
Since: 3.0.0

Public Members

detune

detune: number

Description:

Global detuning of all sounds in cents. The range of the value is -1200 to 1200, but we recommend setting it to 50.

Inherits: Phaser.Sound.BaseSoundManager#detune

Source: src/sound/BaseSoundManager.js#L803
Since: 3.0.0

game

game: Phaser.Game

Description:

Local reference to game.

Inherits: Phaser.Sound.BaseSoundManager#game

Source: src/sound/BaseSoundManager.js#L44
Since: 3.0.0

gameLostFocus

gameLostFocus: boolean

Description:

Flag used to track if the game has lost focus.

Inherits: Phaser.Sound.BaseSoundManager#gameLostFocus

Source: src/sound/BaseSoundManager.js#L152
Since: 3.60.0

jsonCache

jsonCache: Phaser.Cache.BaseCache

Description:

Local reference to the JSON Cache, as used by Audio Sprites.

Inherits: Phaser.Sound.BaseSoundManager#jsonCache

Source: src/sound/BaseSoundManager.js#L54
Since: 3.7.0

listenerPosition

listenerPosition: Phaser.Math.Vector2

Description:

The Spatial Audio listener position.

Only available with WebAudio.

You can modify the x/y properties of this Vec2 directly to adjust the listener position within the game world.

Inherits: Phaser.Sound.BaseSoundManager#listenerPosition

Source: src/sound/BaseSoundManager.js#L162
Since: 3.60.0

locked

locked: boolean

Description:

Mobile devices require sounds to be triggered from an explicit user action, such as a tap, before any sound can be loaded/played on a web page. Set to true if the audio system is currently locked awaiting user interaction.

Inherits: Phaser.Sound.BaseSoundManager#locked

Source: src/sound/BaseSoundManager.js#L128
Since: 3.0.0

mute

mute: boolean

Description:

Global mute setting.

Inherits: Phaser.Sound.BaseSoundManager#mute

Source: src/sound/BaseSoundManager.js#L75
Since: 3.0.0

pauseOnBlur

pauseOnBlur: boolean

Description:

Flag indicating if sounds should be paused when game looses focus, for instance when user switches to another tab/program/app.

Inherits: Phaser.Sound.BaseSoundManager#pauseOnBlur

Source: src/sound/BaseSoundManager.js#L95
Since: 3.0.0

rate

rate: number

Description:

Global playback rate at which all the sounds will be played. Value of 1.0 plays the audio at full speed, 0.5 plays the audio at half speed and 2.0 doubles the audio's playback speed.

Inherits: Phaser.Sound.BaseSoundManager#rate