Class: NoAudioSoundManager

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.


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

Members


detune :number

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
Since: 3.0.0
Inherited From:
Default Value:
  • 0
Source: src/sound/BaseSoundManager.js (Line 629)

<readonly> game :Phaser.Game

Local reference to game.

Type:
Since: 3.0.0
Inherited From:
Source: src/sound/BaseSoundManager.js (Line 57)

<readonly> jsonCache :Phaser.Cache.BaseCache

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

Type:
Since: 3.7.0
Inherited From:
Source: src/sound/BaseSoundManager.js (Line 67)

<readonly> locked :boolean

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
Inherited From:
Source: src/sound/BaseSoundManager.js (Line 141)

mute :boolean

Global mute setting.

Type:
  • boolean
Since: 3.0.0
Inherited From:
Default Value:
  • false
Source: src/sound/BaseSoundManager.js (Line 88)

pauseOnBlur :boolean

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

Type:
  • boolean
Since: 3.0.0
Inherited From:
Default Value:
  • true
Source: src/sound/BaseSoundManager.js (Line 108)

rate :number

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
Since: 3.0.0
Inherited From:
Default Value:
  • 1
Source: src/sound/BaseSoundManager.js (Line 573)

volume :number

Global volume setting.

Type:
  • number
Since: 3.0.0
Inherited From:
Default Value:
  • 1
Source: src/sound/BaseSoundManager.js (Line 98)

Methods


add(key [, config])

Adds a new sound into the sound manager.

Parameters:
Name Type Argument Description
key string

Asset key for the sound.

config SoundConfig <optional>

An optional config object containing default sound settings.

Since: 3.0.0
Inherited From:
Source: src/sound/BaseSoundManager.js (Line 185)
Returns:

The new sound instance.

Type
Phaser.Sound.BaseSound

addAudioSprite(key [, config])

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 Argument Description
key string

Asset key for the sound.

config SoundConfig <optional>

An optional config object containing default sound settings.

Since: 3.0.0
Inherited From:
Source: src/sound/BaseSoundManager.js (Line 199)
Returns:

The new audio sprite sound instance.

Type
Phaser.Sound.BaseSound.AudioSpriteSound

addListener(event, fn [, context])

Add a listener for a given event.

Parameters:
Name Type Argument Default Description
event string | symbol

The event name.

fn function

The listener function.

context * <optional>
this

The context to invoke the listener with.

Since: 3.0.0
Inherited From:
Source: src/events/EventEmitter.js (Line 111)
Returns:

this.

Type
Phaser.Events.EventEmitter

destroy()

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

Since: 3.0.0
Inherited From:
Source: src/sound/BaseSoundManager.js (Line 502)

emit(event [, args])

Calls each of the listeners registered for a given event.

Parameters:
Name Type Argument Description
event string | symbol

The event name.

args * <optional>
<repeatable>

Additional arguments that will be passed to the event handler.

Since: 3.0.0
Inherited From:
Source: src/events/EventEmitter.js (Line 86)
Returns:

true if the event had listeners, else false.

Type
boolean

eventNames()

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

Since: 3.0.0
Inherited From:
Source: src/events/EventEmitter.js (Line 55)
Returns:
Type
array

listenerCount(event)

Return the number of listeners listening to a given event.

Parameters:
Name Type Description
event string | symbol

The event name.

Since: 3.0.0
Inherited From:
Source: src/events/EventEmitter.js (Line 75)
Returns:

The number of listeners.

Type
number

listeners(event)

Return the listeners registered for a given event.

Parameters:
Name Type Description
event string | symbol

The event name.

Since: 3.0.0
Inherited From:
Source: src/events/EventEmitter.js (Line 64)
Returns:

The registered listeners.

Type
array

off(event, fn, context, once)

Remove the listeners of a given event.

Parameters:
Name Type Description
event string | symbol

The event name.

fn function

Only remove the listeners that match this function.

context *

Only remove the listeners that have this context.

once boolean

Only remove one-time listeners.

Since: 3.0.0
Inherited From:
Source: src/events/EventEmitter.js (Line 151)
Returns:

this.

Type
Phaser.Events.EventEmitter

on(event, fn [, context])

Add a listener for a given event.

Parameters:
Name Type Argument Default Description
event string | symbol

The event name.

fn function

The listener function.

context * <optional>
this

The context to invoke the listener with.

Since: 3.0.0
Inherited From:
Source: src/events/EventEmitter.js (Line 98)
Returns:

this.

Type
Phaser.Events.EventEmitter

<protected> onBlur()

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

Since: 3.0.0
Inherited From:
Source: src/sound/BaseSoundManager.js (Line 441)

once(event, fn [, context])

Add a one-time listener for a given event.

Parameters:
Name Type Argument Default Description
event string | symbol

The event name.

fn function

The listener function.

context * <optional>
this

The context to invoke the listener with.

Since: 3.0.0
Inherited From:
Source: src/events/EventEmitter.js (Line 124)
Returns:

this.

Type
Phaser.Events.EventEmitter

<protected> onFocus()

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

Since: 3.0.0
Inherited From:
Source: src/sound/BaseSoundManager.js (Line 452)

pauseAll()

Pauses all the sounds in the game.

Since: 3.0.0
Inherited From:
Source: src/sound/BaseSoundManager.js (Line 367)
Fires:

play(key [, extra])

Enables playing sound on the fly without the need to keep a reference to it.
Sound will auto destroy once its playback ends.

Parameters:
Name Type Argument Description
key string

Asset key for the sound.

extra SoundConfig | SoundMarker <optional>

An optional additional object containing settings to be applied to the sound. It could be either config or marker object.

Since: 3.0.0
Inherited From:
Source: src/sound/BaseSoundManager.js (Line 244)
Returns:

Whether the sound started playing successfully.

Type
boolean

playAudioSprite(key, spriteName [, config])

Enables playing audio sprite sound on the fly without the need to keep a reference to it.
Sound will auto destroy once its playback ends.

Parameters:
Name Type Argument Description
key string

Asset key for the sound.

spriteName string

The name of the sound sprite to play.

config SoundConfig <optional>

An optional config object containing default sound settings.

Since: 3.0.0
Inherited From:
Source: src/sound/BaseSoundManager.js (Line 281)
Returns:

Whether the audio sprite sound started playing successfully.

Type
boolean

remove(sound)

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.

Since: 3.0.0
Inherited From:
Source: src/sound/BaseSoundManager.js (Line 303)
Returns:

True if the sound was removed successfully, otherwise false.

Type
boolean

removeAllListeners( [event])

Remove all listeners, or those of the specified event.

Parameters:
Name Type Argument Description
event string | symbol <optional>

The event name.

Since: 3.0.0
Inherited From:
Source: src/events/EventEmitter.js (Line 165)
Returns:

this.

Type
Phaser.Events.EventEmitter

removeByKey(key)

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.

Since: 3.0.0
Inherited From:
Source: src/sound/BaseSoundManager.js (Line 330)
Returns:

The number of matching sound objects that were removed.

Type
number

removeListener(event, fn, context, once)

Remove the listeners of a given event.

Parameters:
Name Type Description
event string | symbol

The event name.

fn function

Only remove the listeners that match this function.

context *

Only remove the listeners that have this context.

once boolean

Only remove one-time listeners.

Since: 3.0.0
Inherited From:
Source: src/events/EventEmitter.js (Line 137)
Returns:

this.

Type
Phaser.Events.EventEmitter

resumeAll()

Resumes all the sounds in the game.

Since: 3.0.0
Inherited From:
Source: src/sound/BaseSoundManager.js (Line 389)
Fires:

setDetune(value)

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.

Since: 3.3.0
Inherited From:
Source: src/sound/BaseSoundManager.js (Line 604)
Fires:
Returns:

This Sound Manager.

Type
Phaser.Sound.BaseSoundManager

setRate(value)

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.

Since: 3.3.0
Inherited From:
Source: src/sound/BaseSoundManager.js (Line 552)
Fires:
Returns:

This Sound Manager.

Type
Phaser.Sound.BaseSoundManager

shutdown()

Removes all listeners.

Since: 3.0.0
Inherited From:
Source: src/events/EventEmitter.js (Line 31)

stopAll()

Stops all the sounds in the game.

Since: 3.0.0
Inherited From:
Source: src/sound/BaseSoundManager.js (Line 411)
Fires:

<protected> unlock()

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
Inherited From:
Source: src/sound/BaseSoundManager.js (Line 428)

<protected> update(time, delta)

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.

Since: 3.0.0
Inherited From:
Source: src/sound/BaseSoundManager.js (Line 463)

Events


detune

Parameters:
Name Type Description
soundManager Phaser.Sound.BaseSoundManager

Reference to the sound manager that emitted event.

value number

An updated value of Phaser.Sound.BaseSoundManager#detune property.

Inherited From:
Source: src/sound/BaseSoundManager.js (Line 623)

pauseall

Parameters:
Name Type Description
soundManager Phaser.Sound.BaseSoundManager

Reference to the sound manager that emitted event.

Inherited From:
Source: src/sound/BaseSoundManager.js (Line 362)

rate

Parameters:
Name Type Description
soundManager Phaser.Sound.BaseSoundManager

Reference to the sound manager that emitted event.

value number

An updated value of Phaser.Sound.BaseSoundManager#rate property.

Inherited From:
Source: src/sound/BaseSoundManager.js (Line 546)

resumeall

Parameters:
Name Type Description
soundManager Phaser.Sound.BaseSoundManager

Reference to the sound manager that emitted event.

Inherited From:
Source: src/sound/BaseSoundManager.js (Line 384)

stopall

Parameters:
Name Type Description
soundManager Phaser.Sound.BaseSoundManager

Reference to the sound manager that emitted event.

Inherited From:
Source: src/sound/BaseSoundManager.js (Line 406)

unlocked

Parameters:
Name Type Description
soundManager Phaser.Sound.BaseSoundManager

Reference to the sound manager that emitted event.

Inherited From:
Source: src/sound/BaseSoundManager.js (Line 481)