Filter

Hide inherited members:

show private members:

Phaser . Sound . NoAudioSoundManager

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	description
game	Phaser.Game	Reference to the current game instance.

Since: 3.0.0

Source: src/sound/noaudio/NoAudioSoundManager.js (Line 14)

Extends

Phaser.Sound.BaseSoundManager

Members

<private> _detune: number

Description:

Property that actually holds the value of global detune.

Type:

number

Default: 0

Inherited from: Phaser.Sound.BaseSoundManager#_detune

Since: 3.0.0

Source: src/sound/BaseSoundManager.js (Line 117)

<private> _rate: number

Description:

Property that actually holds the value of global playback rate.

Type:

number

Default: 1

Inherited from: Phaser.Sound.BaseSoundManager#_rate

Since: 3.0.0

Source: src/sound/BaseSoundManager.js (Line 106)

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.

Type:

number

Default: 0

Inherited from: Phaser.Sound.BaseSoundManager#detune

Since: 3.0.0

Source: src/sound/BaseSoundManager.js (Line 803)

<readonly> game: Phaser.Game

Description:

Local reference to game.

Type:

Phaser.Game

Inherited from: Phaser.Sound.BaseSoundManager#game

Since: 3.0.0

Source: src/sound/BaseSoundManager.js (Line 44)

gameLostFocus: boolean

Description:

Flag used to track if the game has lost focus.

Type:

boolean

Default: false

Inherited from: Phaser.Sound.BaseSoundManager#gameLostFocus

Since: 3.60.0

Source: src/sound/BaseSoundManager.js (Line 152)

<readonly> jsonCache: Phaser.Cache.BaseCache

Description:

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

Type:

Phaser.Cache.BaseCache

Inherited from: Phaser.Sound.BaseSoundManager#jsonCache

Since: 3.7.0

Source: src/sound/BaseSoundManager.js (Line 54)

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.

Type:

Phaser.Math.Vector2

Inherited from: Phaser.Sound.BaseSoundManager#listenerPosition

Since: 3.60.0

Source: src/sound/BaseSoundManager.js (Line 162)

<readonly> 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.

Type:

boolean

Inherited from: Phaser.Sound.BaseSoundManager#locked

Since: 3.0.0

Source: src/sound/BaseSoundManager.js (Line 128)

mute: boolean

Description:

Global mute setting.

Type:

boolean

Default: false

Inherited from: Phaser.Sound.BaseSoundManager#mute

Since: 3.0.0

Source: src/sound/BaseSoundManager.js (Line 75)

pauseOnBlur: boolean

Description:

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

Type:

boolean

Default: true

Inherited from: Phaser.Sound.BaseSoundManager#pauseOnBlur

Since: 3.0.0

Source: src/sound/BaseSoundManager.js (Line 95)

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.

Type:

number

Default: 1

Inherited from: Phaser.Sound.BaseSoundManager#rate

Since: 3.0.0

Source: src/sound/BaseSoundManager.js (Line 753)

<private> sounds: Array.<Phaser.Sound.BaseSound>

Description:

An array containing all added sounds.

Type:

Array.<Phaser.Sound.BaseSound>

Default: []

Inherited from: Phaser.Sound.BaseSoundManager#sounds

Since: 3.0.0

Source: src/sound/BaseSoundManager.js (Line 64)

<private> unlocked: boolean

Description:

Flag used internally for handling when the audio system has been unlocked, if there ever was a need for it.

Type:

boolean

Default: false

Inherited from: Phaser.Sound.BaseSoundManager#unlocked

Since: 3.0.0

Source: src/sound/BaseSoundManager.js (Line 140)

volume: number

Description:

Global volume setting.

Type:

number

Default: 1

Inherited from: Phaser.Sound.BaseSoundManager#volume

Since: 3.0.0

Source: src/sound/BaseSoundManager.js (Line 85)

Methods

add(key, [config])

Description:

Adds a new sound into the sound manager.

Parameters:

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

Returns:

Description:

The new sound instance.

Type:

Phaser.Sound.NoAudioSound

Overrides: Phaser.Sound.BaseSoundManager#add

Since: 3.60.0

Source: src/sound/noaudio/NoAudioSoundManager.js (Line 51)

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	arguments	description
key	string		Asset key for the sound.
config	Phaser.Types.Sound.SoundConfig	<optional>	An optional config object containing default sound settings.

Returns:

Description:

The new audio sprite sound instance.

Type:

Phaser.Sound.NoAudioSound

Overrides: Phaser.Sound.BaseSoundManager#addAudioSprite

Since: 3.60.0

Source: src/sound/noaudio/NoAudioSoundManager.js (Line 71)

addListener(event, fn, [context])

Description:

Add a listener for a given event.

Parameters:

name	type	arguments	Default	description
event	string \| symbol			The event name.
fn	function			The listener function.
context	*	<optional>	this	The context to invoke the listener with.

Returns:

Description:

this.

Type:

Phaser.Sound.NoAudioSoundManager

Inherited from: Phaser.Events.EventEmitter#addListener

Since: 3.0.0

Source: src/events/EventEmitter.js (Line 111)

destroy()

Description:

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

Overrides: Phaser.Sound.BaseSoundManager#destroy

Since: 3.0.0

Source: src/sound/noaudio/NoAudioSoundManager.js (Line 347)

emit(event, [args])

Description:

Calls each of the listeners registered for a given event.

Parameters:

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

Returns:

Description:

true if the event had listeners, else false.

Type:

boolean

Inherited from: Phaser.Events.EventEmitter#emit

Since: 3.0.0

Source: src/events/EventEmitter.js (Line 86)

eventNames()

Description:

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

Type:

Array.<(string
symbol)>

Inherited from: Phaser.Events.EventEmitter#eventNames

Since: 3.0.0

Source: src/events/EventEmitter.js (Line 55)

<private> forEachActiveSound(callback, [scope])

Description:

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

Parameters:

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

Overrides: Phaser.Sound.BaseSoundManager#forEachActiveSound

Since: 3.0.0

Source: src/sound/noaudio/NoAudioSoundManager.js (Line 332)

get(key)

Description:

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

Parameters:

name	type	description
key	string	Sound asset key.

Returns:

Description:

The sound, or null.

Type:

Phaser.Sound.BaseSound

Overrides: Phaser.Sound.BaseSoundManager#get

Since: 3.23.0

Source: src/sound/noaudio/NoAudioSoundManager.js (Line 93)

getAll(key)

Description:

Gets any sounds in the manager matching the given key.

Parameters:

name	type	description
key	string	Sound asset key.

Returns:

Description:

The sounds, or an empty array.

Type:

Array.<Phaser.Sound.BaseSound>

Overrides: Phaser.Sound.BaseSoundManager#getAll

Since: 3.23.0

Source: src/sound/noaudio/NoAudioSoundManager.js (Line 111)

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.

Returns:

Description:

All currently playing sounds, or an empty array.

Type:

Array.<Phaser.Sound.BaseSound>

Inherited from: Phaser.Sound.BaseSoundManager#getAllPlaying

Since: 3.60.0

Source: src/sound/BaseSoundManager.js (Line 288)

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	description
key	string	Sound asset key.

Returns:

Description:

Per the key argument, true if any matching sound is playing, otherwise false.

Type:

boolean

Inherited from: Phaser.Sound.BaseSoundManager#isPlaying

Since: 3.85.0

Source: src/sound/BaseSoundManager.js (Line 536)

listenerCount(event)

Description:

Return the number of listeners listening to a given event.

Parameters:

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

Returns:

Description:

The number of listeners.

Type:

number

Inherited from: Phaser.Events.EventEmitter#listenerCount

Since: 3.0.0

Source: src/events/EventEmitter.js (Line 75)

listeners(event)

Description:

Return the listeners registered for a given event.

Parameters:

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

Returns:

Description:

The registered listeners.

Type:

Array.<function()>

Inherited from: Phaser.Events.EventEmitter#listeners

Since: 3.0.0

Source: src/events/EventEmitter.js (Line 64)

off(event, [fn], [context], [once])

Description:

Remove the listeners of a given event.

Parameters:

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

Returns:

Description:

this.

Type:

Phaser.Sound.NoAudioSoundManager

Inherited from: Phaser.Events.EventEmitter#off

Since: 3.0.0

Source: src/events/EventEmitter.js (Line 151)

on(event, fn, [context])

Description:

Add a listener for a given event.

Parameters:

name	type	arguments	Default	description
event	string \| symbol			The event name.
fn	function			The listener function.
context	*	<optional>	this	The context to invoke the listener with.

Returns:

Description:

this.

Type:

Phaser.Sound.NoAudioSoundManager

Inherited from: Phaser.Events.EventEmitter#on

Since: 3.0.0

Source: src/events/EventEmitter.js (Line 98)

onBlur()

Description:

Empty function for the No Audio Sound Manager.

Overrides: Phaser.Sound.BaseSoundManager#onBlur

Since: 3.0.0

Source: src/sound/noaudio/NoAudioSoundManager.js (Line 224)

onFocus()

Description:

Empty function for the No Audio Sound Manager.

Overrides: Phaser.Sound.BaseSoundManager#onFocus

Since: 3.0.0

Source: src/sound/noaudio/NoAudioSoundManager.js (Line 232)

onGameBlur()

Description:

Empty function for the No Audio Sound Manager.

Overrides: Phaser.Sound.BaseSoundManager#onGameBlur

Since: 3.0.0

Source: src/sound/noaudio/NoAudioSoundManager.js (Line 240)

onGameFocus()

Description:

Empty function for the No Audio Sound Manager.

Overrides: Phaser.Sound.BaseSoundManager#onGameFocus

Since: 3.0.0

Source: src/sound/noaudio/NoAudioSoundManager.js (Line 248)

once(event, fn, [context])

Description:

Add a one-time listener for a given event.

Parameters:

name	type	arguments	Default	description
event	string \| symbol			The event name.
fn	function			The listener function.
context	*	<optional>	this	The context to invoke the listener with.

Returns:

Description:

this.

Type:

Phaser.Sound.NoAudioSoundManager

Inherited from: Phaser.Events.EventEmitter#once

Since: 3.0.0

Source: src/events/EventEmitter.js (Line 124)

pauseAll()

Description:

Empty function for the No Audio Sound Manager.

Overrides: Phaser.Sound.BaseSoundManager#pauseAll

Since: 3.0.0

Source: src/sound/noaudio/NoAudioSoundManager.js (Line 256)

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	arguments	description
key	string		Asset key for the sound.
extra	Phaser.Types.Sound.SoundConfig \| Phaser.Types.Sound.SoundMarker	<optional>	An optional additional object containing settings to be applied to the sound. It could be either config or marker object.

Returns:

Description:

Always 'false' for the No Audio Sound Manager.

Type:

boolean

Overrides: Phaser.Sound.BaseSoundManager#play

Since: 3.0.0

Source: src/sound/noaudio/NoAudioSoundManager.js (Line 129)

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	arguments	description
key	string		Asset key for the sound.
spriteName	string		The name of the sound sprite to play.
config	Phaser.Types.Sound.SoundConfig	<optional>	An optional config object containing default sound settings.

Returns:

Description:

Always 'false' for the No Audio Sound Manager.

Type:

boolean

Overrides: Phaser.Sound.BaseSoundManager#playAudioSprite

Since: 3.0.0

Source: src/sound/noaudio/NoAudioSoundManager.js (Line 147)

remove(sound)

Description:

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

Parameters:

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

Returns:

Description:

True if the sound was removed successfully, otherwise false.

Type:

boolean

Overrides: Phaser.Sound.BaseSoundManager#remove

Since: 3.0.0

Source: src/sound/noaudio/NoAudioSoundManager.js (Line 166)

removeAll()

Description:

Removes all sounds from the manager, destroying the sounds.

Overrides: Phaser.Sound.BaseSoundManager#removeAll

Since: 3.23.0

Source: src/sound/noaudio/NoAudioSoundManager.js (Line 182)

removeAllListeners([event])

Description:

Remove all listeners, or those of the specified event.

Parameters:

name	type	arguments	description
event	string \| symbol	<optional>	The event name.

Returns:

Description:

this.

Type:

Phaser.Sound.NoAudioSoundManager

Inherited from: Phaser.Events.EventEmitter#removeAllListeners

Since: 3.0.0

Source: src/events/EventEmitter.js (Line 165)

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	description
key	string	The key to match when removing sound objects.

Returns:

Description:

The number of matching sound objects that were removed.

Type:

number

Overrides: Phaser.Sound.BaseSoundManager#removeByKey

Since: 3.0.0

Source: src/sound/noaudio/NoAudioSoundManager.js (Line 193)

removeListener(event, [fn], [context], [once])

Description:

Remove the listeners of a given event.

Parameters:

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

Returns:

Description:

this.

Type:

Phaser.Sound.NoAudioSoundManager

Inherited from: Phaser.Events.EventEmitter#removeListener

Since: 3.0.0

Source: src/events/EventEmitter.js (Line 137)

resumeAll()

Description:

Empty function for the No Audio Sound Manager.

Overrides: Phaser.Sound.BaseSoundManager#resumeAll

Since: 3.0.0

Source: src/sound/noaudio/NoAudioSoundManager.js (Line 264)

setDetune()

Description:

Empty function for the No Audio Sound Manager.

Returns:

Description:

This Sound Manager.

Type:

Phaser.Sound.NoAudioSoundManager

Overrides: Phaser.Sound.BaseSoundManager#setDetune

Since: 3.0.0

Source: src/sound/noaudio/NoAudioSoundManager.js (Line 298)

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	arguments	description
x	number	<optional>	The x position of the Spatial Audio listener.
y	number	<optional>	The y position of the Spatial Audio listener.

Inherited from: Phaser.Sound.BaseSoundManager#setListenerPosition

Since: 3.60.0

Source: src/sound/BaseSoundManager.js (Line 480)

setMute()

Description:

Empty function for the No Audio Sound Manager.

Since: 3.0.0

Source: src/sound/noaudio/NoAudioSoundManager.js (Line 308)

setRate()

Description:

Empty function for the No Audio Sound Manager.

Returns:

Description:

This Sound Manager.

Type:

Phaser.Sound.NoAudioSoundManager

Overrides: Phaser.Sound.BaseSoundManager#setRate

Since: 3.0.0

Source: src/sound/noaudio/NoAudioSoundManager.js (Line 288)

setVolume()

Description:

Empty function for the No Audio Sound Manager.

Since: 3.0.0

Source: src/sound/noaudio/NoAudioSoundManager.js (Line 316)

shutdown()

Description:

Removes all listeners.

Inherited from: Phaser.Events.EventEmitter#shutdown

Since: 3.0.0

Source: src/events/EventEmitter.js (Line 31)

stopAll()

Description:

Empty function for the No Audio Sound Manager.

Overrides: Phaser.Sound.BaseSoundManager#stopAll

Since: 3.0.0

Source: src/sound/noaudio/NoAudioSoundManager.js (Line 272)

stopByKey(key)

Description:

Stops any sounds matching the given key.

Parameters:

name	type	description
key	string	Sound asset key.

Returns:

Description:

How many sounds were stopped.

Type:

number

Overrides: Phaser.Sound.BaseSoundManager#stopByKey

Since: 3.23.0

Source: src/sound/noaudio/NoAudioSoundManager.js (Line 209)

unlock()

Description:

Empty function for the No Audio Sound Manager.

Overrides: Phaser.Sound.BaseSoundManager#unlock

Since: 3.0.0

Source: src/sound/noaudio/NoAudioSoundManager.js (Line 324)

update()

Description:

Empty function for the No Audio Sound Manager.

Overrides: Phaser.Sound.BaseSoundManager#update

Since: 3.0.0

Source: src/sound/noaudio/NoAudioSoundManager.js (Line 280)

Possible examples