Class: Sound

Members

context

Reference to AudioContext instance.

Properties:

Name	Type	Description
context	AudioContext

Default Value:

• null

Source:

• sound/Sound.js, line 67

currentMarker

Description.

Properties:

Name	Type	Description
currentMarker	string

Source:

• sound/Sound.js, line 156

currentTime

Description.

Properties:

Name	Type	Description
currentTime	number

Default Value:

• 0

Source:

• sound/Sound.js, line 110

duration

Description.

Properties:

Name	Type	Description
duration	number

Default Value:

• 0

Source:

• sound/Sound.js, line 117

game

A reference to the currently running Game.

Properties:

Name	Type	Description
game	Phaser.Game

Source:

• sound/Sound.js, line 27

<readonly> isDecoded

Properties:

Name	Type	Description
isDecoded	boolean	Returns true if the sound file has decoded.

Source:

• sound/Sound.js, line 736

<readonly> isDecoding

Properties:

Name	Type	Description
isDecoding	boolean	Returns true if the sound file is still decoding.

Source:

• sound/Sound.js, line 723

isPlaying

Description.

Properties:

Name	Type	Description
isPlaying	boolean

Default Value:

• false

Source:

• sound/Sound.js, line 149

key

Asset key for the sound.

Properties:

Name	Type	Description
key	string

Source:

• sound/Sound.js, line 40

loop

Whether or not the sound will loop.

Properties:

Name	Type	Description
loop	boolean

Source:

• sound/Sound.js, line 46

markers

The sound markers, empty by default.

Properties:

Name	Type	Description
markers	object

Source:

• sound/Sound.js, line 59

mute

Properties:

Name	Type	Description
mute	boolean	Gets or sets the muted state of this sound.

Source:

• sound/Sound.js, line 749

name

Name of the sound.

Properties:

Name	Type	Description
name	string

Default Value:

• key

Source:

• sound/Sound.js, line 34

onDecoded

Description.

Properties:

Name	Type	Description
onDecoded	Phaser.Signal

Source:

• sound/Sound.js, line 223

onLoop

Description.

Properties:

Name	Type	Description
onLoop	Phaser.Signal

Source:

• sound/Sound.js, line 247

onMarkerComplete

Description.

Properties:

Name	Type	Description
onMarkerComplete	Phaser.Signal

Source:

• sound/Sound.js, line 265

onMute

Description.

Properties:

Name	Type	Description
onMute	Phaser.Signal

Source:

• sound/Sound.js, line 259

onPause

Description.

Properties:

Name	Type	Description
onPause	Phaser.Signal

Source:

• sound/Sound.js, line 235

onPlay

Description.

Properties:

Name	Type	Description
onPlay	Phaser.Signal

Source:

• sound/Sound.js, line 229

onResume

Description.

Properties:

Name	Type	Description
onResume	Phaser.Signal

Source:

• sound/Sound.js, line 241

onStop

Description.

Properties:

Name	Type	Description
onStop	Phaser.Signal

Source:

• sound/Sound.js, line 253

override

Description.

Properties:

Name	Type	Description
override	boolean

Default Value:

• false

Source:

• sound/Sound.js, line 170

paused

Description.

Properties:

Name	Type	Description
paused	boolean

Default Value:

• false

Source:

• sound/Sound.js, line 130

pausedPosition

Description.

Properties:

Name	Type	Description
pausedPosition	number

Source:

• sound/Sound.js, line 136

pausedTime

Description.

Properties:

Name	Type	Description
pausedTime	number

Source:

• sound/Sound.js, line 142

pendingPlayback

Description.

Properties:

Name	Type	Description
pendingPlayback	boolean

Default Value:

• false

Source:

• sound/Sound.js, line 163

startTime

Description.

Properties:

Name	Type	Description
startTime	number

Default Value:

• 0

Source:

• sound/Sound.js, line 103

stopTime

Description.

Properties:

Name	Type	Description
stopTime	number

Source:

• sound/Sound.js, line 123

totalDuration

The total duration of the sound, in milliseconds

Properties:

Name	Type	Description
totalDuration	number

Default Value:

• 0

Source:

• sound/Sound.js, line 96

usingAudioTag

Description.

Properties:

Name	Type	Description
usingAudioTag	Description

Source:

• sound/Sound.js, line 182

usingWebAudio

Description.

Properties:

Name	Type	Description
usingWebAudio	boolean

Source:

• sound/Sound.js, line 176

<readonly> volume

Properties:

Name	Type	Description
volume	number	Gets or sets the volume of this sound, a value between 0 and 1.

Source:

• sound/Sound.js, line 798

Methods

addMarker(name, start, stop, volume, loop)

Description.

Parameters:

Name	Type	Description
name	string	Description.
start	Description	Description.
stop	Description	Description.
volume	Description	Description.
loop	Description	Description. addMarker: function (name, start, stop, volume, loop) { volume = volume || 1; if (typeof loop == 'undefined') { loop = false; } this.markers[name] = { name: name, start: start, stop: stop, volume: volume, duration: stop - start, loop: loop }; },

Source:

• sound/Sound.js, line 288

addMarker(name, start, duration, volume, loop)

Adds a marker into the current Sound. A marker is represented by a unique key and a start time and duration. 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	Argument	Default	Description
name	string			A unique name for this marker, i.e. 'explosion', 'gunshot', etc.
start	number			The start point of this marker in the audio file, given in seconds. 2.5 = 2500ms, 0.5 = 500ms, etc.
duration	number			The duration of the marker in seconds. 2.5 = 2500ms, 0.5 = 500ms, etc.
volume	number	<optional>	1	The volume the sound will play back at, between 0 (silent) and 1 (full volume).
loop	boolean	<optional>	false	Sets if the sound will loop or not.

Source:

• sound/Sound.js, line 290

pause()

Pauses the sound

Source:

• sound/Sound.js, line 630

play(marker, position, volume, loop, forceRestart) → {Sound}

Play this sound, or a marked section of it.

Parameters:

Name	Type	Argument	Default	Description
marker	string	<optional>	''	If you want to play a marker then give the key here, otherwise leave blank to play the full sound.
position	number	<optional>	0	The starting position to play the sound from - this is ignored if you provide a marker.
volume	number	<optional>	1	Volume of the sound you want to play.
loop	boolean	<optional>	false	Loop when it finished playing?
forceRestart	boolean	<optional>	true	If the sound is already playing you can set forceRestart to restart it from the beginning.

Source:

• sound/Sound.js, line 414

Returns:

The playing sound object.

Type

Sound

removeMarker(name)

Removes a marker from the sound.

Parameters:

Name	Type	Description
name	string	The key of the marker to remove.

Source:

• sound/Sound.js, line 341

restart(marker, position, volume, loop)

Restart the sound, or a marked section of it.

Parameters:

Name	Type	Argument	Default	Description
marker	string	<optional>	''	If you want to play a marker then give the key here, otherwise leave blank to play the full sound.
position	number	<optional>	0	The starting position to play the sound from - this is ignored if you provide a marker.
volume	number	<optional>	1	Volume of the sound you want to play.
loop	boolean	<optional>	false	Loop when it finished playing?

Source:

• sound/Sound.js, line 611

resume()

Resumes the sound

Source:

• sound/Sound.js, line 648

<protected> soundHasUnlocked(key)

Called automatically when this sound is unlocked.

Parameters:

Name	Type	Description
key	string	Description.

Source:

• sound/Sound.js, line 271

stop()

Stop playing this sound.

Source:

• sound/Sound.js, line 687

<protected> update()

Called automatically by Phaser.SoundManager.

Source:

• sound/Sound.js, line 352