Filter
Phaser . Sound . WebAudioSound
Constructor:
new WebAudioSound(manager, key, [config])
Parameters:
| name | type | arguments | Default | description |
|---|---|---|---|---|
| manager | Phaser.Sound.WebAudioSoundManager |
Reference to the WebAudio Sound Manager that owns this Sound instance. |
||
| key | string |
Asset key for the sound. |
||
| config | Phaser.Types.Sound.SoundConfig | <optional> | {} |
An optional config object containing default sound settings. |
Extends
Members
Description:
Audio buffer containing decoded data of the audio asset to be played.
Type:
Description:
Currently playing marker. 'null' if whole sound is playing.
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:
Description:
A value representing the duration, in seconds. It could be total sound duration or a marker duration.
Type:
Description:
Used for keeping track when sound source playback has ended so its state can be updated accordingly.
Type:
Description:
Used for keeping track when sound source has looped so its state can be updated accordingly.
Type:
Description:
Flag indicating if sound is currently paused.
Type:
Description:
Flag indicating if sound is currently playing.
Type:
Description:
Asset key for the sound.
Type:
Description:
Flag indicating whether or not the sound or current sound marker will loop.
Type:
Description:
A reference to a second audio source used for gapless looped playback.
Type:
Description:
The time at which the sound loop source should actually start playback.
Based on BaseAudioContext.currentTime value.
Type:
Description:
Local reference to the sound manager.
Description:
Object containing markers definitions.
Type:
Description:
Boolean indicating whether the sound is muted or not. Gets or sets the muted state of this sound.
Type:
Description:
Gain node responsible for controlling this sound's muting.
Type:
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:
Description:
Panner node responsible for controlling this sound's pan.
Doesn't work on iOS / Safari.
Type:
Description:
Flag indicating if destroy method was called on this sound.
Type:
Description:
The time at which the sound should have started playback from the beginning.
Treat this property as read-only.
Based on BaseAudioContext.currentTime value.
Type:
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:
Description:
An array where we keep track of all rate updates during playback.
Treat this property as read-only.
Array of object types: { time: number, rate: number }
Type:
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:
Description:
A reference to an audio source node used for playing back audio from audio data stored in Phaser.Sound.WebAudioSound#audioBuffer.
Type:
Description:
The Stereo Spatial Panner node.
Type:
Description:
If the Spatial Panner node has been set to track a vector or Game Object, this retains a reference to it.
Description:
The time at which the sound source should have actually started playback.
Treat this property as read-only.
Based on BaseAudioContext.currentTime value.
Type:
Description:
The total duration of the sound in seconds.
Type:
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:
Description:
Gets or sets the volume of this sound, a value between 0 (silence) and 1 (full volume).
Type:
Description:
Gain node responsible for controlling this sound's volume.
Type:
Description:
Sets the x position of this Sound in Spatial Audio space.
This only has any effect if the sound was created with a SpatialSoundConfig object.
Also see the WebAudioSoundManager.setListenerPosition method.
If you find that the sound becomes too quiet, too quickly, as it moves away from
the listener, then try different refDistance property values when configuring
the spatial sound.
Type:
Description:
Sets the y position of this Sound in Spatial Audio space.
This only has any effect if the sound was created with a SpatialSoundConfig object.
Also see the WebAudioSoundManager.setListenerPosition method.
If you find that the sound becomes too quiet, too quickly, as it moves away from
the listener, then try different refDistance property values when configuring
the spatial sound.
Type:
Methods
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:
Adds a marker into the current sound. A marker is represented by name, start time, duration, and optionally config object. 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 | description |
|---|---|---|
| marker | Phaser.Types.Sound.SoundMarker |
Marker object. |
Returns:
Description:
Whether the marker was added successfully.
Type:
- boolean
Description:
Method used internally for applying config values to some of the sound properties.
Description:
Method used internally to calculate total playback rate of the sound.
Description:
This method is only used internally and it creates a looping buffer source.
Description:
This method is only used internally and it creates a buffer source.
Type:
- AudioBufferSourceNode
Description:
Calls Phaser.Sound.BaseSound#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:
Method used internally for calculating current playback time of a playing sound.
Description:
Method used internally for calculating the time at witch the loop source should start playing.
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:
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 the sound.
Returns:
Description:
Whether the sound was paused successfully.
Type:
- boolean
Fires:
Description:
Play this sound, or a marked section of it.
It always plays the sound from the start. If you want to start playback from a specific time you can set 'seek' setting of the config object, provided to this call, to that value.
If you want to play the same sound simultaneously, then you need to create another instance of it and play that Sound.
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:
Whether the sound started playing successfully.
Type:
- boolean
Fires:
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:
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:
Removes a marker from the sound.
Parameters:
| name | type | description |
|---|---|---|
| markerName | string |
The name of the marker to remove. |
Returns:
Description:
Removed marker object or 'null' if there was no marker with provided name.
Description:
Method used internally for resetting values of some of the config properties.
Description:
Resumes the sound.
Returns:
Description:
Whether the sound was resumed successfully.
Type:
- boolean
Fires:
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.
Fires:
Description:
Sets the loop state of this Sound.
Parameters:
| name | type | description |
|---|---|---|
| value | boolean |
|
Returns:
Description:
This Sound instance.
Fires:
Description:
Sets the muted state of this Sound.
Parameters:
| name | type | description |
|---|---|---|
| value | boolean |
|
Returns:
Description:
This Sound instance.
Fires:
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.
Fires:
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.
Fires:
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.
Fires:
Description:
Sets the volume of this Sound.
Parameters:
| name | type | description |
|---|---|---|
| value | number |
The volume of the sound. |
Returns:
Description:
This Sound instance.
Fires:
Description:
Removes all listeners.
Description:
Stop playing this sound.
Returns:
Description:
Whether the sound was stopped successfully.
Type:
- boolean
Fires:
Description:
This method is only used internally and it stops and removes a buffer source.
Description:
This method is only used internally and it stops and removes a looping buffer source.
Description:
Update method called automatically by sound manager on every game step.
Description:
Updates previously added marker.
Parameters:
| name | type | description |
|---|---|---|
| marker | Phaser.Types.Sound.SoundMarker |
Marker object with updated values. |
Returns:
Description:
Whether the marker was updated successfully.
Type:
- boolean