Filter
Web Audio API implementation of the Sound Manager.
Not all browsers can play all audio formats.
There is a good guide to what's supported: Cross-browser audio basics: Audio codec support.
Constructor:
new WebAudioSoundManager(game)
Parameters:
| name | type | description |
|---|---|---|
| game | Phaser.Game |
Reference to the current game instance. |
Extends
Members
Description:
The AudioContext being used for playback.
Type:
Description:
Destination node for connecting individual sounds to.
Type:
Description:
Global detuning of all sounds in cents. The range of the value is -1200 to 1200, but we recommend setting it to 50.
Type:
Description:
Local reference to game.
Type:
Description:
Flag used to track if the game has lost focus.
Type:
Description:
Local reference to the JSON Cache, as used by Audio Sprites.
Type:
Description:
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.
Type:
Description:
Mobile 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.
Type:
Description:
Gain node responsible for controlling global muting.
Type:
Description:
Gain node responsible for controlling global volume.
Type:
Description:
Flag indicating if sounds should be paused when game looses focus, for instance when user switches to another tab/program/app.
Type:
Description:
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.
Type:
Methods
Description:
Adds a new sound into the sound manager.
Parameters:
| name | type | arguments | description |
|---|---|---|---|
| key | string |
Asset key for the sound. |
|
| config | Phaser.Types.Sound.SoundConfig | <optional> |
An optional config object containing default sound settings. |
Returns:
Description:
The new sound instance.
Description:
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
Parameters:
| name | type | arguments | description |
|---|---|---|---|
| key | string |
Asset key for the sound. |
|
| config | Phaser.Types.Sound.SoundConfig | <optional> |
An optional config object containing default sound settings. |
Returns:
Description:
The new audio sprite sound instance.
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.
Description:
Method responsible for instantiating and returning AudioContext instance. If an instance of an AudioContext class was provided through the game config, that instance will be returned instead. This can come in handy if you are reloading a Phaser game on a page that never properly refreshes (such as in an SPA project) and you want to reuse already instantiated AudioContext.
Parameters:
| name | type | description |
|---|---|---|
| game | Phaser.Game |
Reference to the current game instance. |
Returns:
Description:
The AudioContext instance to be used for playback.
Type:
- AudioContext
Description:
Decode audio data into a format ready for playback via Web Audio.
The audio data can be a base64 encoded string, an audio media-type data uri, or an ArrayBuffer instance.
The audioKey is the key that will be used to save the decoded audio to the audio cache.
Instead of passing a single entry you can instead pass an array of Phaser.Types.Sound.DecodeAudioConfig
objects as the first and only argument.
Decoding is an async process, so be sure to listen for the events to know when decoding has completed.
Once the audio has decoded it can be added to the Sound Manager or played via its key.
Parameters:
| name | type | arguments | description |
|---|---|---|---|
| audioKey | string | Array.<Phaser.Types.Sound.DecodeAudioConfig> | <optional> |
The string-based key to be used to reference the decoded audio in the audio cache, or an array of audio config objects. |
| audioData | ArrayBuffer | string | <optional> |
The audio data, either a base64 encoded string, an audio media-type data uri, or an ArrayBuffer instance. |
Description:
Calls Phaser.Sound.BaseSoundManager#destroy method and cleans up all Web Audio API related stuff.
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
Description:
Return an array listing the events for which the emitter has registered listeners.
Type:
- Array.<(string
- symbol)>
Description:
Gets the first sound in this Sound Manager that matches the given key.
If none can be found it returns null.
Parameters:
| name | type | description |
|---|---|---|
| key | string |
Sound asset key. |
Returns:
Description:
- The sound, or null.
Type:
Description:
Gets all sounds in this Sound Manager.
You can optionally specify a key, in which case only Sound instances that match the given key will be returned.
Parameters:
| name | type | arguments | description |
|---|---|---|---|
| key | string | <optional> |
Optional asset key. If given, only Sound instances with this key will be returned. |
Returns:
Description:
- The sounds, or an empty array.
Type:
- Array.<Phaser.Sound.BaseSound>
Description:
Returns all sounds from this Sound Manager that are currently
playing. That is, Sound instances that have their isPlaying
property set to true.
Returns:
Description:
- All currently playing sounds, or an empty array.
Type:
- Array.<Phaser.Sound.BaseSound>
Description:
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.
Parameters:
| name | type | description |
|---|---|---|
| key | string |
Sound asset key. |
Returns:
Description:
- Per the key argument, true if any matching sound is playing, otherwise false.
Type:
- boolean
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
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()>
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.
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.
Description:
Method used internally for pausing sound manager if Phaser.Sound.WebAudioSoundManager#pauseOnBlur is set to true.
Description:
Method used internally for resuming sound manager if Phaser.Sound.WebAudioSoundManager#pauseOnBlur is set to true.
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.
Description:
Pauses all the sounds in the game.
Description:
Adds a new sound to the sound manager and plays it.
The sound will be automatically removed (destroyed) once playback ends.
This lets you play a new sound on the fly without the need to keep a reference to it.
Parameters:
| name | type | arguments | description |
|---|---|---|---|
| key | string |
Asset key for the sound. |
|
| extra | Phaser.Types.Sound.SoundConfig | Phaser.Types.Sound.SoundMarker | <optional> |
An optional additional object containing settings to be applied to the sound. It could be either config or marker object. |
Returns:
Description:
Whether the sound started playing successfully.
Type:
- boolean
Listens:
Description:
Adds a new audio sprite sound to the sound manager and plays it. The sprite will be automatically removed (destroyed) once playback ends. This lets you play a new sound on the fly without the need to keep a reference to it.
Parameters:
| name | type | arguments | description |
|---|---|---|---|
| key | string |
Asset key for the sound. |
|
| spriteName | string |
The name of the sound sprite to play. |
|
| config | Phaser.Types.Sound.SoundConfig | <optional> |
An optional config object containing default sound settings. |
Returns:
Description:
Whether the audio sprite sound started playing successfully.
Type:
- boolean
Listens:
Description:
Removes a sound from the sound manager. The removed sound is destroyed before removal.
Parameters:
| name | type | description |
|---|---|---|
| sound | Phaser.Sound.BaseSound |
The sound object to remove. |
Returns:
Description:
True if the sound was removed successfully, otherwise false.
Type:
- boolean
Description:
Removes all sounds from the manager, destroying the sounds.
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.
Description:
Removes all sounds from the sound manager that have an asset key matching the given value. The removed sounds are destroyed before removal.
Parameters:
| name | type | description |
|---|---|---|
| key | string |
The key to match when removing sound objects. |
Returns:
Description:
The number of matching sound objects that were removed.
Type:
- number
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.
Description:
Resumes all the sounds in the game.
Description:
This method takes a new AudioContext reference and then sets this Sound Manager to use that context for all playback.
As part of this call it also disconnects the master mute and volume nodes and then re-creates them on the new given context.
Parameters:
| name | type | description |
|---|---|---|
| context | AudioContext |
Reference to an already created AudioContext instance. |
Returns:
Description:
The WebAudioSoundManager instance.
Description:
Sets the global detuning of all sounds 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 Manager.
Description:
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.
Parameters:
| name | type | arguments | description |
|---|---|---|---|
| x | number | <optional> |
The x position of the Spatial Audio listener. |
| y | number | <optional> |
The y position of the Spatial Audio listener. |
Description:
Sets the muted state of all this Sound Manager.
Parameters:
| name | type | description |
|---|---|---|
| value | boolean |
|
Returns:
Description:
This Sound Manager.
Description:
Sets the global playback rate at which all the sounds will be played.
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 |
Global playback rate at which all the sounds will be played. |
Returns:
Description:
This Sound Manager.
Description:
Sets the volume of this Sound Manager.
Parameters:
| name | type | description |
|---|---|---|
| value | number |
The global volume of this Sound Manager. |
Returns:
Description:
This Sound Manager.
Description:
Removes all listeners.
Description:
Stops all the sounds in the game.
Fires:
Description:
Stops any sounds matching the given key.
Parameters:
| name | type | description |
|---|---|---|
| key | string |
Sound asset key. |
Returns:
Description:
- How many sounds were stopped.
Type:
- number
Description:
Unlocks Web Audio API on the initial input event.
Read more about how this issue is handled here in this article.
Description:
Update method called on every game step.
Removes destroyed sounds and updates every active sound in the game.
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. |
Fires: