Filter

Hide inherited members:

show private members:

Phaser . Sound . BaseSound

Class containing all the shared state and behavior of a sound object, independent of the implementation.

Constructor:

new BaseSound(manager, key, [config])

Parameters:

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

Since: 3.0.0

Source: src/sound/BaseSound.js (Line 14)

Extends

Phaser.Events.EventEmitter

Members

<private> config: Phaser.Types.Sound.SoundConfig

Description:

A config object used to store default sound settings' values. Default values will be set by properties' setters.

Type:

Phaser.Types.Sound.SoundConfig

Since: 3.0.0

Source: src/sound/BaseSound.js (Line 113)

<private> currentConfig: Phaser.Types.Sound.SoundConfig

Description:

Reference to the currently used config. It could be default config or marker config.

Type:

Phaser.Types.Sound.SoundConfig

Since: 3.0.0

Source: src/sound/BaseSound.js (Line 135)

<readonly> currentMarker: Phaser.Types.Sound.SoundMarker

Description:

Currently playing marker. 'null' if whole sound is playing.

Type:

Phaser.Types.Sound.SoundMarker

Default: null

Since: 3.0.0

Source: src/sound/BaseSound.js (Line 159)

<readonly> duration: number

Description:

A value representing the duration, in seconds. It could be total sound duration or a marker duration.

Type:

number

Since: 3.0.0

Source: src/sound/BaseSound.js (Line 92)

<readonly> isPaused: boolean

Description:

Flag indicating if sound is currently paused.

Type:

boolean

Default: false

Since: 3.0.0

Source: src/sound/BaseSound.js (Line 68)

<readonly> isPlaying: boolean

Description:

Flag indicating if sound is currently playing.

Type:

boolean

Default: false

Since: 3.0.0

Source: src/sound/BaseSound.js (Line 57)

<readonly> key: string

Description:

Asset key for the sound.

Type:

string

Since: 3.0.0

Source: src/sound/BaseSound.js (Line 47)

manager: Phaser.Sound.BaseSoundManager

Description:

Local reference to the sound manager.

Type:

Phaser.Sound.BaseSoundManager

Since: 3.0.0

Source: src/sound/BaseSound.js (Line 38)

<readonly> markers: Object.<string, Phaser.Types.Sound.SoundMarker>

Description:

Object containing markers definitions.

Type:

Object.<string, Phaser.Types.Sound.SoundMarker>

Default: {}

Since: 3.0.0

Source: src/sound/BaseSound.js (Line 148)

pendingRemove: boolean

Description:

Flag indicating if destroy method was called on this sound.

Type:

boolean

Default: false

Since: 3.0.0

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

<readonly> totalDuration: number

Description:

The total duration of the sound in seconds.

Type:

number

Since: 3.0.0

Source: src/sound/BaseSound.js (Line 103)

<readonly> totalRate: number

Description:

A property that holds the value of sound's actual playback rate, after its rate and detune values has been combined with global rate and detune values.

Type:

number

Default: 1

Since: 3.0.0

Source: src/sound/BaseSound.js (Line 79)

Methods

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

Inherited from: Phaser.Events.EventEmitter#addListener

Since: 3.0.0

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

addMarker(marker)

Description:

Adds a marker into the current sound. A marker is represented by name, start time, duration, and optionally config object. This allows you to bundle multiple sounds together into a single audio file and use markers to jump between them for playback.

Parameters:

name	type	description
marker	Phaser.Types.Sound.SoundMarker	Marker object.

Returns:

Description:

Whether the marker was added successfully.

Type:

boolean

Since: 3.0.0

Source: src/sound/BaseSound.js (Line 182)

applyConfig()

Description:

Method used internally for applying config values to some of the sound properties.

Since: 3.0.0

Source: src/sound/BaseSound.js (Line 412)

calculateRate()

Description:

Method used internally to calculate total playback rate of the sound.

Since: 3.0.0

Source: src/sound/BaseSound.js (Line 451)

destroy()

Description:

Destroys this sound and all associated events and marks it for removal from the sound manager.

Overrides: Phaser.Events.EventEmitter#destroy

Fires:

Phaser.Sound.Events.DESTROY

Since: 3.0.0

Source: src/sound/BaseSound.js (Line 466)

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)

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

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

Inherited from: Phaser.Events.EventEmitter#on

Since: 3.0.0

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

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

Inherited from: Phaser.Events.EventEmitter#once

Since: 3.0.0

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

pause()

Description:

Pauses the sound. This only works if the sound is currently playing.

You can inspect the isPlaying and isPaused properties to check the state.

Returns:

Description:

Whether the sound was paused successfully.

Type:

boolean

Since: 3.0.0

Source: src/sound/BaseSound.js (Line 343)

play([markerName], [config])

Description:

Play this sound, or a marked section of it.

It always plays the sound from the start. If you want to start playback from a specific time you can set 'seek' setting of the config object, provided to this call, to that value.

Parameters:

name	type	arguments	Default	description
markerName	string \| Phaser.Types.Sound.SoundConfig	<optional>	''	If you want to play a marker then provide the marker name here. Alternatively, this parameter can be a SoundConfig object.
config	Phaser.Types.Sound.SoundConfig	<optional>		Optional sound config object to be applied to this marker or entire sound if no marker name is provided. It gets memorized for future plays of current section of the sound.

Returns:

Description:

Whether the sound started playing successfully.

Type:

boolean

Since: 3.0.0

Source: src/sound/BaseSound.js (Line 283)

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

Inherited from: Phaser.Events.EventEmitter#removeAllListeners

Since: 3.0.0

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

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

Inherited from: Phaser.Events.EventEmitter#removeListener

Since: 3.0.0

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

removeMarker(markerName)

Description:

Removes a marker from the sound.

Parameters:

name	type	description
markerName	string	The name of the marker to remove.

Returns:

Description:

Removed marker object or 'null' if there was no marker with provided name.

Type:

Phaser.Types.Sound.SoundMarker

Since: 3.0.0

Source: src/sound/BaseSound.js (Line 259)

resetConfig()

Description:

Method used internally for resetting values of some of the config properties.

Since: 3.0.0

Source: src/sound/BaseSound.js (Line 428)

resume()

Description:

Resumes the sound. This only works if the sound is paused and not already playing.

You can inspect the isPlaying and isPaused properties to check the state.

Returns:

Description:

Whether the sound was resumed successfully.

Type:

boolean

Since: 3.0.0

Source: src/sound/BaseSound.js (Line 366)

shutdown()

Description:

Removes all listeners.

Inherited from: Phaser.Events.EventEmitter#shutdown

Since: 3.0.0

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

stop()

Description:

Stop playing this sound.

Returns:

Description:

Whether the sound was stopped successfully.

Type:

boolean

Since: 3.0.0

Source: src/sound/BaseSound.js (Line 389)

update(time, delta)

Description:

Update method called automatically by sound manager on every game step.

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

Source: src/sound/BaseSound.js (Line 440)

updateMarker(marker)

Description:

Updates previously added marker.

Parameters:

name	type	description
marker	Phaser.Types.Sound.SoundMarker	Marker object with updated values.

Returns:

Description:

Whether the marker was updated successfully.

Type:

boolean

Since: 3.0.0

Source: src/sound/BaseSound.js (Line 229)

Possible examples