Filter

Hide inherited members:

show private members:

Phaser . Sound . HTML5AudioSoundManager

HTML5AudioSoundManager

Constructor:

new HTML5AudioSoundManager(game)

Parameters:

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

Since: 3.0.0

Source: src/sound/html5/HTML5AudioSoundManager.js (Line 37)

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 116)

<private> _mute: boolean

Description:

Property that actually holds the value of global mute for HTML5 Audio sound manager implementation.

Type:

boolean

Default: false

Since: 3.0.0

Source: src/sound/html5/HTML5AudioSoundManager.js (Line 115)

<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 105)

<private> _volume: boolean

Description:

Property that actually holds the value of global volume for HTML5 Audio sound manager implementation.

Type:

boolean

Default: 1

Since: 3.0.0

Source: src/sound/html5/HTML5AudioSoundManager.js (Line 127)

audioPlayDelay: number

Description:

Value representing time difference, in seconds, between calling play method on an audio tag and when it actually starts playing. It is used to achieve more accurate delayed sound playback.

You might need to tweak this value to get the desired results since audio play delay varies depending on the browser/platform.

Type:

number

Default: 0.1

Since: 3.0.0

Source: src/sound/html5/HTML5AudioSoundManager.js (Line 58)

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 676)

<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 43)

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

Inherited from: Phaser.Sound.BaseSoundManager#locked

Since: 3.0.0

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

<private> lockedActionsQueue: array

Description:

A queue of all actions performed on sound objects while audio was locked. Once the audio gets unlocked, after an explicit user interaction, all actions will be performed in chronological order. Array of object types: { sound: Phaser.Sound.HTML5AudioSound, name: string, value?: * }

Type:

array

Since: 3.0.0

Source: src/sound/html5/HTML5AudioSoundManager.js (Line 102)

loopEndOffset: number

Description:

A value by which we should offset the loop end marker of the looping sound to compensate for lag, caused by changing audio tag playback position, in order to achieve gapless looping.

You might need to tweak this value to get the desired results since loop lag varies depending on the browser/platform.

Type:

number

Default: 0.05

Since: 3.0.0

Source: src/sound/html5/HTML5AudioSoundManager.js (Line 73)

mute: boolean

Type:

boolean

Overrides: Phaser.Sound.BaseSoundManager#mute

Since: 3.0.0

Source: src/sound/html5/HTML5AudioSoundManager.js (Line 389)

<private> onBlurPausedSounds: Array.<Phaser.Sound.HTML5AudioSound>

Description:

An array for keeping track of all the sounds that were paused when game lost focus.

Type:

Array.<Phaser.Sound.HTML5AudioSound>

Default: []

Since: 3.0.0

Source: src/sound/html5/HTML5AudioSoundManager.js (Line 88)

override: boolean

Description:

Flag indicating whether if there are no idle instances of HTML5 Audio tag, for any particular sound, if one of the used tags should be hijacked and used for succeeding playback or if succeeding Phaser.Sound.HTML5AudioSound#play call should be ignored.

Type:

boolean

Default: true

Since: 3.0.0

Source: src/sound/html5/HTML5AudioSoundManager.js (Line 45)

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

Inherited from: Phaser.Sound.BaseSoundManager#rate

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: []

Inherited from: Phaser.Sound.BaseSoundManager#sounds

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

Inherited from: Phaser.Sound.BaseSoundManager#unlocked

Since: 3.0.0

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

volume: number

Type:

number

Overrides: Phaser.Sound.BaseSoundManager#volume

Since: 3.0.0

Source: src/sound/html5/HTML5AudioSoundManager.js (Line 434)

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

Overrides: Phaser.Sound.BaseSoundManager#add

Since: 3.0.0

Source: src/sound/html5/HTML5AudioSoundManager.js (Line 142)

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:

Inherited from: Phaser.Sound.BaseSoundManager#addAudioSprite

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

Inherited from: Phaser.Events.EventEmitter#addListener

Since: 3.0.0

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

destroy()

Description:

Calls Phaser.Sound.BaseSoundManager#destroy method and cleans up all HTML5 Audio related stuff.

Overrides: Phaser.Sound.BaseSoundManager#destroy

Since: 3.0.0

Source: src/sound/html5/HTML5AudioSoundManager.js (Line 325)

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.

Inherited from: Phaser.Sound.BaseSoundManager#forEachActiveSound

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

Inherited from: Phaser.Sound.BaseSoundManager#get

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>

Inherited from: Phaser.Sound.BaseSoundManager#getAll

Since: 3.23.0

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

<protected> isLocked(sound, prop, [value])

Description:

Method used internally by Phaser.Sound.HTML5AudioSound class methods and property setters to check if sound manager is locked and then either perform action immediately or queue it to be performed once the sound manager gets unlocked.

Parameters:

name	type	arguments	description
sound	Phaser.Sound.HTML5AudioSound		Sound object on which to perform queued action.
prop	string		Name of the method to be called or property to be assigned a value to.
value	*	<optional>	An optional parameter that either holds an array of arguments to be passed to the method call or value to be set to the property.

Returns:

Description:

Whether the sound manager is locked.

Type:

boolean

Since: 3.0.0

Source: src/sound/html5/HTML5AudioSoundManager.js (Line 340)

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

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

Inherited from: Phaser.Events.EventEmitter#on

Since: 3.0.0

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

<private> onBlur()

Description:

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

Overrides: Phaser.Sound.BaseSoundManager#onBlur

Since: 3.0.0

Source: src/sound/html5/HTML5AudioSound.js (Line 409)

<protected> onBlur()

Description:

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

Overrides: Phaser.Sound.BaseSoundManager#onBlur

Since: 3.0.0

Source: src/sound/html5/HTML5AudioSoundManager.js (Line 287)

<protected> onFocus()

Description:

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

Overrides: Phaser.Sound.BaseSoundManager#onFocus

Since: 3.0.0

Source: src/sound/html5/HTML5AudioSoundManager.js (Line 307)

<private> onGameBlur()

Description:

Internal handler for Phaser.Core.Events#BLUR.

Inherited from: Phaser.Sound.BaseSoundManager#onGameBlur

Since: 3.23.0

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

<private> onGameFocus()

Description:

Internal handler for Phaser.Core.Events#FOCUS.

Inherited from: Phaser.Sound.BaseSoundManager#onGameFocus

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

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.

Inherited from: Phaser.Sound.BaseSoundManager#pauseAll

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

Inherited from: Phaser.Sound.BaseSoundManager#play

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

Inherited from: Phaser.Sound.BaseSoundManager#playAudioSprite

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

Inherited from: Phaser.Sound.BaseSoundManager#remove

Since: 3.0.0

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

removeAll()

Description:

Removes all sounds from the manager, destroying the sounds.

Inherited from: Phaser.Sound.BaseSoundManager#removeAll

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

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

Inherited from: Phaser.Sound.BaseSoundManager#removeByKey

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.