SFXPlayer

An audio player for controlling SFX playback in a Game

Used to play, stop and set volume on multiple sound instances or Arrays of instances

Designed around Springroll 2.0 but not required to use

• SFXPlayer
  • new SFXPlayer(player, volume)
  • .volume Setter
  • .volume Getter
  • .play(audio, options)
  • .pause()
  • .resume()
  • .stop()
  • .handleInstanceComplete(event)
  • .handleChainComplete()

new SFXPlayer(volume)

Constructor

| Param | Type | Description | | --- | --- | --- | | volume | Number | volume to play sound instances at default 1 |

sfxPlayer.volume - Setter

Set the volume for this and the current instances playing

| Param | Type | Description | | --- | --- | --- | | volume | Number | volume to set |

sfxPlayer.volume - Getter

Returns: the volume of the SFXplayer

sfxPlayer.play(audio, options)

Play an audio instance and push it to our array for tracking

Returns: The created Chain or the Abstract Sound Instance

| Param | Type | Description | | --- | --- | --- | | audio | String | audio string UID name | | options | Object | options for playing audio - default empty Object |

sfxPlayer.pause()

Pause all SFX instances

sfxPlayer.resume()

Resume all SFX instances

sfxPlayer.stop()

Stop all currently playing sound instances

sfxPlayer.handleInstanceComplete(event)

(Private) Handle complete event called from sound instance Remove Event Listeners Remove the instance from our array

| Param | Type | | --- | --- | | event | Event |

sfxPlayer.handleChainComplete()

SFX has completed playing - Dispatches the 'complete' event