Phaser Class: AudioSprite

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

Name	Type	Description
`game`	Phaser.Game	Reference to the current game instance.
`key`	string	Asset key for the sound.

autoplay :boolean

Is a sound set to autoplay or not?

Default Value:

autoplayKey :string

If a sound is set to auto play, this holds the marker key of it.

config :object

JSON audio atlas object.

A reference to the currently running Game.

key :string

Asset key for the Audio Sprite.

sounds :object

An object containing the Phaser.Sound objects for the Audio Sprite.

get(marker) → {Phaser.Sound}

Get a sound with the given name.

Name	Type	Description
`marker`	string	The name of sound to get.

Phaser.Sound -

The sound instance.

play(marker, volume) → {Phaser.Sound}

Play a sound with the given name.

Name	Type	Argument	Default	Description
`marker`	string	<optional>		The name of sound to play
`volume`	number	<optional>	1	Volume of the sound you want to play. If none is given it will use the volume given to the Sound when it was created (which defaults to 1 if none was specified).

Phaser.Sound -

This sound instance.

stop(marker)

Stop a sound with the given name.

Name	Type	Argument	Default	Description
`marker`	string	<optional>	''	The name of sound to stop. If none is given it will stop all sounds in the audio sprite.