Skip to content

SOUND.md

Latest commit

 

History

History
81 lines (45 loc) · 1.59 KB

SOUND.md

File metadata and controls

81 lines (45 loc) · 1.59 KB

Sound

Manages loading and playback of an audio file.

Constructor

new Sound(audioManager, src, label, onReady);

Arguments

  • audioManager — AudioManager The audio manager that will parent this Sound.
  • src — string The source of the audio.
  • label — string The unique label to identify this sound.
  • onReady — function An optional method to call when the audio file is ready to play. Passed the sound object.

Methods

get playbackRate

Get the audio's playback rate.

set playbackRate(value)

Set the audio's playback rate.

get volume()

Get the volume of playback.

set volume(value)

Set the volume of playback.

Arguments

  • value — number The volume level to set. Must be between 0 and 1.

get playing()

Get whether the audio is playing.

get muted()

Get the mute state of the audio.

get loop()

Get the loop value of the audio element.

set loop(value)

Set the loop value of the audio element.

Arguments

  • value — boolean The loop state to set.

mute()

Mute the audio without stopping playback.

play(config)

Begin audio playback.

Arguments

  • config — Object Playback configuration data.
    • allowConcurrentPlayback — boolean Whether to allow the sound to be played, even if it is already playing.
    • volume — number Optionally overwrite the current volume level before playing.
    • loop — boolean Whether to loop audio playback.

stop()

Stop audio playback.