Reference to the current game instance.
ReadonlygameLocal reference to game.
Flag used to track if the game has lost focus.
ReadonlyjsonLocal reference to the JSON Cache, as used by Audio Sprites.
The Spatial Audio listener position.
Only available with WebAudio.
You can modify the x/y properties of this Vec2 directly to adjust the listener position within the game world.
ReadonlylockedMobile 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.
Global mute setting.
Flag indicating if sounds should be paused when game looses focus, for instance when user switches to another tab/program/app.
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.
Global volume setting.
Adds a new sound into the sound manager.
Asset key for the sound.
Optionalconfig: SoundConfigAn optional config object containing default sound settings.
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
Asset key for the sound.
Optionalconfig: SoundConfigAn optional config object containing default sound settings.
Add a listener for a given event.
The event name.
The listener function.
Optionalcontext: anyThe context to invoke the listener with. Default this.
Destroys all the sounds in the game and all associated events.
Calls each of the listeners registered for a given event.
The event name.
Additional arguments that will be passed to the event handler.
Return an array listing the events for which the emitter has registered listeners.
When a key is given, returns true if any sound with that key is playing.
When no key is given, returns true if any sound is playing.
Sound asset key.
Return the number of listeners listening to a given event.
The event name.
Return the listeners registered for a given event.
The event name.
Remove the listeners of a given event.
The event name.
Optionalfn: FunctionOnly remove the listeners that match this function.
Optionalcontext: anyOnly remove the listeners that have this context.
Optionalonce: booleanOnly remove one-time listeners.
Add a listener for a given event.
The event name.
The listener function.
Optionalcontext: anyThe context to invoke the listener with. Default this.
Empty function for the No Audio Sound Manager.
Add a one-time listener for a given event.
The event name.
The listener function.
Optionalcontext: anyThe context to invoke the listener with. Default this.
Empty function for the No Audio Sound Manager.
Empty function for the No Audio Sound Manager.
Empty function for the No Audio Sound Manager.
Empty function for the No Audio Sound Manager.
This method does nothing but return 'false' for the No Audio Sound Manager, to maintain compatibility with the other Sound Managers.
Asset key for the sound.
Optionalextra: SoundConfig | SoundMarkerAn optional additional object containing settings to be applied to the sound. It could be either config or marker object.
This method does nothing but return 'false' for the No Audio Sound Manager, to maintain compatibility with the other Sound Managers.
Asset key for the sound.
The name of the sound sprite to play.
Optionalconfig: SoundConfigAn optional config object containing default sound settings.
Removes a sound from the sound manager. The removed sound is destroyed before removal.
The sound object to remove.
Removes all sounds from the manager, destroying the sounds.
Remove all listeners, or those of the specified event.
Optionalevent: string | symbolThe event name.
Removes all sounds from the sound manager that have an asset key matching the given value. The removed sounds are destroyed before removal.
The key to match when removing sound objects.
Remove the listeners of a given event.
The event name.
Optionalfn: FunctionOnly remove the listeners that match this function.
Optionalcontext: anyOnly remove the listeners that have this context.
Optionalonce: booleanOnly remove one-time listeners.
Empty function for the No Audio Sound Manager.
Empty function for the No Audio Sound Manager.
Sets the X and Y position of the Spatial Audio listener on this Web Audios context.
If you call this method with no parameters it will default to the center-point of the game canvas. Depending on the type of game you're making, you may need to call this method constantly to reset the listener position as the camera scrolls.
Calling this method does nothing on HTML5Audio.
Optionalx: numberThe x position of the Spatial Audio listener.
Optionaly: numberThe y position of the Spatial Audio listener.
Empty function for the No Audio Sound Manager.
Empty function for the No Audio Sound Manager.
Empty function for the No Audio Sound Manager.
Removes all listeners.
Empty function for the No Audio Sound Manager.
Stops any sounds matching the given key.
Sound asset key.
Empty function for the No Audio Sound Manager.
Empty function for the No Audio Sound Manager.
No-audio implementation of the Sound Manager. 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 Manager logic that provides minimal functionality and prevents Phaser projects that use audio from breaking on devices that don't support any audio playback technologies.