MusicPlayer

The MusicPlayer is designed to control the looping and playing of background music in a game

Play a single music file in a loop on repeat

Calling play with a different filename will fade out the current instance and fade in the the new

Shuffle option available if you have an Array of Music Files to play

• MusicPlayer
  • new MusicPlayer(volume)
  • .volume - Setter
  • .volume - Getter
  • .instance
  • .instanceName
  • .fadeTime - Setter
  • .fadeTime - Getter
  • .shuffle(audio)
  • .shufflePlaylist()
  • .random(array)
  • .play(audio)
  • .pause()
  • .resume()
  • .stop()
  • .fadeOutMusic(time)
  • .fadeInMusic(time)

new MusicPlayer(volume)

Constructor

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

musicPlayer.volume - Setter

Set the volume for this and the current instance playing

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

musicPlayer.volume - Getter

Return the current volume level set on the VOPlayer

musicPlayer.instance

Return the current instance of Music playing

musicPlayer.instanceName

Return the current UID for the music of the Music playing

musicPlayer.fadeTime - Setter

Set the fade time between songs

musicPlayer.fadeTime - Getter

Get the fade time between songs

musicPlayer.shuffle(audio)

Shuffle the music between a list of songs provided

| Param | Type | | --- | --- | | audio | Array |

musicPlayer.shufflePlaylist()

Shuffle the current playlist stored on this MusicPlayer

musicPlayer.random(array)

Return a random position in the Array provided

| Param | Type | | --- | --- | | array | Array |

musicPlayer.play(audio)

Stop the current instance and play the new audio instance

| Param | Type | Description | | --- | --- | --- | | audio | String | audio string UID name |

musicPlayer.pause()

Pause the current Music instance

musicPlayer.resume()

Resume the current Music instance

musicPlayer.stop()

Stop the currently playing instance

musicPlayer.fadeOutMusic(time)

Fade out the sound to a volume of 0

| Param | Type | Description | | --- | --- | --- | | time | Number | milliseconds |

musicPlayer.fadeInMusic(time)

Fade in the sound to a volume of the volume for this player

| Param | Type | Description | | --- | --- | --- | | time | Number | milliseconds |