Reference to the current sound manager instance.
Asset key for the sound.
Optionalconfig: SoundConfig
An optional config object containing default sound settings. Default {}.
A config object used to store default sound settings' values. Default values will be set by properties' setters.
Reference to the currently used config. It could be default config or marker config.
ReadonlycurrentCurrently playing marker. 'null' if whole sound is playing.
ReadonlydurationA value representing the duration, in seconds. It could be total sound duration or a marker duration.
ReadonlyisFlag indicating if sound is currently paused.
ReadonlyisFlag indicating if sound is currently playing.
ReadonlykeyAsset key for the sound.
Flag indicating whether or not the sound or current sound marker will loop.
Local reference to the sound manager.
ReadonlymarkersObject containing markers definitions.
Boolean indicating whether the sound is muted or not. Gets or sets the muted state of this sound.
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.
Flag indicating if destroy method was called on this sound.
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.
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.
ReadonlytotalThe total duration of the sound in seconds.
ReadonlytotalA 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.
Gets or sets the volume of this sound, a value between 0 (silence) and 1 (full volume).
Add a listener for a given event.
The event name.
The listener function.
Optionalcontext: any
The context to invoke the listener with. Default this.
this.
Adds a marker to this sound. Markers allow you to define sections within a sound clip and play them back independently.
Marker object.
false
Method used internally for applying config values to some of the sound properties.
Method used internally to calculate total playback rate of the sound.
Destroys this sound and all associated events and marks it for removal from the sound manager.
Calls each of the listeners registered for a given event.
The event name.
Additional arguments that will be passed to the event handler.
true if the event had listeners, else false.
Return an array listing the events for which the emitter has registered listeners.undefined
undefined
Return the number of listeners listening to a given event.
The event name.
The number of listeners.
Return the listeners registered for a given event.
The event name.
The registered listeners.
Remove the listeners of a given event.
The event name.
Optionalfn: Function
Only remove the listeners that match this function.
Optionalcontext: any
Only remove the listeners that have this context.
Optionalonce: boolean
Only remove one-time listeners.
this.
Add a listener for a given event.
The event name.
The listener function.
Optionalcontext: any
The context to invoke the listener with. Default this.
this.
Add a one-time listener for a given event. The listener is automatically removed the first time the event is emitted, so it will never be called more than once.
The event name.
The listener function.
Optionalcontext: any
The context to invoke the listener with. Default this.
this.
Pauses this sound.undefined
false
Plays this sound, or a specific marker within it. An optional config object can override default playback settings for this call.
OptionalmarkerName: string | SoundConfig
If you want to play a marker then provide the marker name here. Alternatively, this parameter can be a SoundConfig object. Default ''.
Optionalconfig: SoundConfig
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.
false
Remove all listeners, or those of the specified event.
Optionalevent: string | symbol
The event name.
this.
Remove the listeners of a given event.
The event name.
Optionalfn: Function
Only remove the listeners that match this function.
Optionalcontext: any
Only remove the listeners that have this context.
Optionalonce: boolean
Only remove one-time listeners.
this.
Removes a marker from this sound by name.
The name of the marker to remove.
null
Method used internally for resetting values of some of the config properties.
Resumes the sound.undefined
false
Sets the loop state of this Sound.
true to loop this sound, false to not loop it.
This Sound instance.
Sets the muted state of this Sound.
true to mute this sound, false to unmute it.
This Sound instance.
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.
The pan of the sound. A value between -1 (full left pan) and 1 (full right pan).
This Sound instance.
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.
The playback rate of this Sound.
This Sound instance.
Seeks to a specific point in this sound.
The point in the sound to seek to, in seconds.
This Sound instance.
Sets the volume of this Sound.
The volume of the sound, between 0 (silence) and 1 (full volume).
This Sound instance.
Removes all listeners from this EventEmitter. This method is called automatically by the Scene Systems when the parent Scene shuts down, ensuring that all event bindings are cleared and no stale references remain.
Stop playing this sound.undefined
false
Update method called automatically by sound manager on every game step.
The current timestamp as generated by the Request Animation Frame or SetTimeout.
The delta time elapsed since the last frame.
Updates the values of an existing marker in this sound.
Marker object with updated values.
false
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.