Filter

Hide inherited members:

show private members:

Phaser . Sound . NoAudioSound

No audio implementation of the sound. 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 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 NoAudioSound(manager, key, [config])

Parameters:

name	type	arguments	Default	description
manager	Phaser.Sound.NoAudioSoundManager			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/noaudio/NoAudioSound.js (Line 29)

Extends

Phaser.Events.EventEmitter

Members

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/noaudio/NoAudioSound.js (Line 135)

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/noaudio/NoAudioSound.js (Line 154)

<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/noaudio/NoAudioSound.js (Line 260)

detune: number

Description:

The detune value of this Sound, given 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/noaudio/NoAudioSound.js (Line 200)

<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/noaudio/NoAudioSound.js (Line 114)

<readonly> isPaused: boolean

Description:

Flag indicating if sound is currently paused.

Type:

boolean

Default: false

Since: 3.0.0

Source: src/sound/noaudio/NoAudioSound.js (Line 90)

<readonly> isPlaying: boolean

Description:

Flag indicating if sound is currently playing.

Type:

boolean

Default: false

Since: 3.0.0

Source: src/sound/noaudio/NoAudioSound.js (Line 79)

<readonly> key: string

Description:

Asset key for the sound.

Type:

string

Since: 3.0.0

Source: src/sound/noaudio/NoAudioSound.js (Line 69)

loop: boolean

Description:

Flag indicating whether or not the sound or current sound marker will loop.

Type:

boolean

Default: false

Since: 3.0.0

Source: src/sound/noaudio/NoAudioSound.js (Line 225)

manager: Phaser.Sound.BaseSoundManager

Description:

Local reference to the sound manager.

Type:

Phaser.Sound.BaseSoundManager

Since: 3.0.0

Source: src/sound/noaudio/NoAudioSound.js (Line 60)

<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/noaudio/NoAudioSound.js (Line 249)

mute: boolean

Description:

Boolean indicating whether the sound is muted or not. Gets or sets the muted state of this sound.

Type:

boolean

Default: false

Since: 3.0.0

Source: src/sound/noaudio/NoAudioSound.js (Line 164)

pan: number

Description:

Gets or sets the pan of this sound, a value between -1 (full left pan) and 1 (full right pan).

Always returns zero on iOS / Safari as it doesn't support the stereo panner node.

Type:

number

Default: 0

Since: 3.50.0

Source: src/sound/noaudio/NoAudioSound.js (Line 236)

pendingRemove: boolean

Description:

Flag indicating if destroy method was called on this sound.

Type:

boolean

Default: false

Since: 3.0.0

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

rate: number

Description:

Rate at which this Sound 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 audios playback speed.

Type:

number

Default: 1

Since: 3.0.0

Source: src/sound/noaudio/NoAudioSound.js (Line 187)

seek: number

Description:

Property representing the position of playback for this sound, in seconds. Setting it to a specific value moves current playback to that position. The value given is clamped to the range 0 to current marker duration. Setting seek of a stopped sound has no effect.

Type:

number

Since: 3.0.0

Source: src/sound/noaudio/NoAudioSound.js (Line 212)

<readonly> totalDuration: number

Description:

The total duration of the sound in seconds.

Type:

number

Since: 3.0.0

Source: src/sound/noaudio/NoAudioSound.js (Line 125)

<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/noaudio/NoAudioSound.js (Line 101)

volume: number

Description:

Gets or sets the volume of this sound, a value between 0 (silence) and 1 (full volume).

Type:

number

Default: 1

Since: 3.0.0

Source: src/sound/noaudio/NoAudioSound.js (Line 176)

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

Inherited from: Phaser.Events.EventEmitter#addListener

Since: 3.0.0

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

addMarker(marker)

Parameters:

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

Returns:

Description:

false

Type:

boolean

Since: 3.0.0

Source: src/sound/noaudio/NoAudioSound.js (Line 283)

applyConfig()

Description:

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

Since: 3.0.0

Source: src/sound/noaudio/NoAudioSound.js (Line 442)

calculateRate()

Description:

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

Since: 3.0.0

Source: src/sound/noaudio/NoAudioSound.js (Line 470)

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/noaudio/NoAudioSound.js (Line 478)

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

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

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

Inherited from: Phaser.Events.EventEmitter#once

Since: 3.0.0

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

pause()

Returns:

Description:

false

Type:

boolean

Since: 3.0.0

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

play([markerName], [config])

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:

false

Type:

boolean

Since: 3.0.0

Source: src/sound/noaudio/NoAudioSound.js (Line 313)

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

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

Inherited from: Phaser.Events.EventEmitter#removeListener

Since: 3.0.0

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

removeMarker(markerName)

Parameters:

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

Returns:

Description:

null

Type:

null

Since: 3.0.0

Source: src/sound/noaudio/NoAudioSound.js (Line 303)

resetConfig()

Description:

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

Since: 3.0.0

Source: src/sound/noaudio/NoAudioSound.js (Line 450)

resume()

Description:

Resumes the sound.

Returns:

Description:

false

Type:

boolean

Since: 3.0.0

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

setDetune(value)

Description:

Sets the detune value of this Sound, given 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 instance.

Type:

Phaser.Sound.NoAudioSound

Since: 3.3.0

Source: src/sound/noaudio/NoAudioSound.js (Line 391)

setLoop(value)

Description:

Sets the loop state of this Sound.

Parameters:

name	type	description
value	boolean	`true` to loop this sound, `false` to not loop it.

Returns:

Description:

This Sound instance.

Type:

Phaser.Sound.NoAudioSound

Since: 3.4.0

Source: src/sound/noaudio/NoAudioSound.js (Line 416)

setMute(value)

Description:

Sets the muted state of this Sound.

Parameters:

name	type	description
value	boolean	`true` to mute this sound, `false` to unmute it.

Returns:

Description:

This Sound instance.

Type:

Phaser.Sound.NoAudioSound

Since: 3.4.0

Source: src/sound/noaudio/NoAudioSound.js (Line 352)

setPan(value)

Description:

Sets the pan of this sound, a value between -1 (full left pan) and 1 (full right pan).

Note: iOS / Safari doesn't support the stereo panner node.

Parameters:

name	type	description
value	number	The pan of the sound. A value between -1 (full left pan) and 1 (full right pan).

Returns:

Description:

This Sound instance.

Type:

Phaser.Sound.NoAudioSound

Since: 3.50.0

Source: src/sound/noaudio/NoAudioSound.js (Line 428)

setRate(value)

Description:

Sets the playback rate of this Sound.

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	The playback rate at of this Sound.

Returns:

Description:

This Sound instance.

Type:

Phaser.Sound.NoAudioSound

Since: 3.3.0

Source: src/sound/noaudio/NoAudioSound.js (Line 376)

setSeek(value)

Description:

Seeks to a specific point in this sound.

Parameters:

name	type	description
value	number	The point in the sound to seek to.

Returns:

Description:

This Sound instance.

Type:

Phaser.Sound.NoAudioSound

Since: 3.4.0

Source: src/sound/noaudio/NoAudioSound.js (Line 404)

setVolume(value)

Description:

Sets the volume of this Sound.

Parameters:

name	type	description
value	number	The volume of the sound.

Returns:

Description:

This Sound instance.

Type:

Phaser.Sound.NoAudioSound

Since: 3.4.0

Source: src/sound/noaudio/NoAudioSound.js (Line 364)

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:

false

Type:

boolean

Since: 3.0.0

Source: src/sound/noaudio/NoAudioSound.js (Line 342)

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/noaudio/NoAudioSound.js (Line 458)

updateMarker(marker)

Parameters:

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

Returns:

Description:

false

Type:

boolean

Since: 3.0.0

Source: src/sound/noaudio/NoAudioSound.js (Line 293)

Possible examples