Audio sprite sound type.
name | type | description |
---|---|---|
spritemap | object |
Local reference to 'spritemap' object form json file generated by audiosprite tool. |
A Audio Data object.
You can pass an array of these objects to the WebAudioSoundManager decodeAudio
method to have it decode
them all at once.
name | type | description |
---|---|---|
key | string |
The string-based key to be used to reference the decoded audio in the audio cache. |
data | ArrayBuffer | string |
The audio data, either a base64 encoded string, an audio media-type data uri, or an ArrayBuffer instance. |
name | type | description |
---|---|---|
manager | Phaser.Sound.BaseSoundManager |
The SoundManager |
sound | Phaser.Sound.BaseSound |
The current active Sound |
index | number |
The index of the current active Sound |
sounds | Array.<Phaser.Sound.BaseSound> |
All sounds |
Config object containing various sound settings.
name | type | arguments | Default | description |
---|---|---|---|---|
mute | boolean | <optional> | false |
Boolean indicating whether the sound should be muted or not. |
volume | number | <optional> | 1 |
A value between 0 (silence) and 1 (full volume). |
rate | number | <optional> | 1 |
Defines the speed at which the sound should be played. |
detune | number | <optional> | 0 |
Represents detuning of sound in cents. |
seek | number | <optional> | 0 |
Position of playback for this sound, in seconds. |
loop | boolean | <optional> | false |
Whether or not the sound or current sound marker should loop. |
delay | number | <optional> | 0 |
Time, in seconds, that should elapse before the sound actually starts its playback. |
pan | number | <optional> | 0 |
A value between -1 (full left pan) and 1 (full right pan). 0 means no pan. |
Marked section of a sound represented by name, and optionally start time, duration, and config object.
name | type | arguments | description |
---|---|---|---|
name | string |
Unique identifier of a sound marker. |
|
start | number | <optional> |
Sound position offset at witch playback should start. |
duration | number | <optional> |
Playback duration of this marker. |
config | Phaser.Types.Sound.SoundConfig | <optional> |
An optional config object containing default marker settings. |