Filter

Hide inherited members:

show private members:

Phaser . Sound . BaseSoundManager

Base class for other Sound Manager classes.

Constructor:

new BaseSoundManager(game)

Parameters:

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

Since: 3.0.0

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

Extends

Phaser.Events.EventEmitter

Members

<private> _detune: number

Description:

Property that actually holds the value of global detune.

Type:

number

Default: 0

Since: 3.0.0

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

<private> _rate: number

Description:

Property that actually holds the value of global playback rate.

Type:

number

Default: 1

Since: 3.0.0

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

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

Since: 3.0.0

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

<readonly> game: Phaser.Game

Description:

Local reference to game.

Type:

Phaser.Game

Since: 3.0.0

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

<readonly> jsonCache: Phaser.Cache.BaseCache

Description:

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

Type:

Phaser.Cache.BaseCache

Since: 3.7.0

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

<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

Since: 3.0.0

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

mute: boolean

Description:

Global mute setting.

Type:

boolean

Default: false

Since: 3.0.0

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

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

Since: 3.0.0

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

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

Since: 3.0.0

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

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

Description:

An array containing all added sounds.

Type:

Array.<Phaser.Sound.BaseSound>

Default: []

Since: 3.0.0

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

<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

Since: 3.0.0

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

volume: number

Description:

Global volume setting.

Type:

number

Default: 1

Since: 3.0.0

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

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

Since: 3.0.0

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

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:

Since: 3.0.0

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

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

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.Events.EventEmitter#destroy

Since: 3.0.0

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

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.

Since: 3.0.0

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

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

Since: 3.23.0

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

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>

Since: 3.23.0

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

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

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

Inherited from: Phaser.Events.EventEmitter#on

Since: 3.0.0

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

<protected> onBlur()

Description:

Method used internally for pausing sound manager if Phaser.Sound.BaseSoundManager#pauseOnBlur is set to true.

Since: 3.0.0

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

<protected> onFocus()

Description:

Method used internally for resuming sound manager if Phaser.Sound.BaseSoundManager#pauseOnBlur is set to true.

Since: 3.0.0

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

<private> onGameBlur()

Description:

Internal handler for Phaser.Core.Events#BLUR.

Since: 3.23.0

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

<private> onGameFocus()

Description:

Internal handler for Phaser.Core.Events#FOCUS.

Since: 3.23.0

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

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

Inherited from: Phaser.Events.EventEmitter#once

Since: 3.0.0

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

pauseAll()

Description:

Pauses all the sounds in the game.

Fires:

Phaser.Sound.Events.PAUSE_ALL

Since: 3.0.0

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

play(key, [extra])

Description:

Adds a new sound to the sound manager and plays it. The sound will be automatically removed (destroyed) once playback ends. This lets you play a new sound on the fly without the need to keep a reference to it.

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:

Whether the sound started playing successfully.

Type:

boolean

Listens:

Phaser.Sound.Events.COMPLETE

Since: 3.0.0

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

playAudioSprite(key, spriteName, [config])

Description:

Adds a new audio sprite sound to the sound manager and plays it. The sprite will be automatically removed (destroyed) once playback ends. This lets you play a new sound on the fly without the need to keep a reference to it.

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:

Whether the audio sprite sound started playing successfully.

Type:

boolean

Listens:

Phaser.Sound.Events.COMPLETE

Since: 3.0.0

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

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

Since: 3.0.0

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

removeAll()

Description:

Removes all sounds from the manager, destroying the sounds.

Since: 3.23.0

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

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

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

Since: 3.0.0

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

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

Inherited from: Phaser.Events.EventEmitter#removeListener

Since: 3.0.0

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

resumeAll()

Description:

Resumes all the sounds in the game.

Fires:

Phaser.Sound.Events.RESUME_ALL

Since: 3.0.0

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

setDetune(value)

Description:

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

Parameters:

name	type	description
value	number	The range of the value is -1200 to 1200, but we recommend setting it to 50.

Returns:

Description:

This Sound Manager.

Type:

Phaser.Sound.BaseSoundManager

Fires:

Phaser.Sound.Events.GLOBAL_DETUNE

Since: 3.3.0

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

setRate(value)

Description:

Sets the global playback rate at which all the sounds will be played.

For example, a value of 1.0 plays the audio at full speed, 0.5 plays the audio at half speed and 2.0 doubles the audios playback speed.

Parameters:

name	type	description
value	number	Global playback rate at which all the sounds will be played.

Returns:

Description:

This Sound Manager.

Type:

Phaser.Sound.BaseSoundManager

Fires:

Phaser.Sound.Events.GLOBAL_RATE

Since: 3.3.0

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

shutdown()

Description:

Removes all listeners.

Inherited from: Phaser.Events.EventEmitter#shutdown

Since: 3.0.0

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

stopAll()

Description:

Stops all the sounds in the game.

Fires:

Phaser.Sound.Events.STOP_ALL

Since: 3.0.0

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

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

Since: 3.23.0

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

<protected> unlock()

Description:

Method used internally for unlocking audio playback on devices that require user interaction before any sound can be played on a web page.

Read more about how this issue is handled here in this article.

Since: 3.0.0

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

<protected> update(time, delta)

Description:

Update method called on every game step. Removes destroyed sounds and updates every active sound in the game.

Parameters:

name	type	description
time	number	The current timestamp as generated by the Request Animation Frame or SetTimeout.
delta	number	The delta time elapsed since the last frame.

Fires:

Phaser.Sound.Events.UNLOCKED

Since: 3.0.0

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

Possible examples