Module background/methods/sound

Index

Functions

Functions

audioOnOff

audioOnOff(audioID: string): void

- Defined in src/background/methods/sound.js:40
Description

Toggles (Start/Stop) given HTML audio element

Usage

This function is used by:
- the FF-MusicController
  Function
Parameters
- audioID: string
  
  ID of the HTML audio player element
Returns void

pauseAudioByID

pauseAudioByID(audioID: string): void

- Defined in src/background/methods/sound.js:17
Pauses audio of given HTML audio element
example
```
pauseAudioByID("dune_OST_player");
```
Parameters
- audioID: string
  
  ID of the HTML audio player element
Returns void

playAudioByID

playAudioByID(audioID: string): void

- Defined in src/background/methods/sound.js:5
Plays audio of given HTML audio element

Parameters
- audioID: string
  
  ID of the HTML audio player element
Returns void

setAudioVolumeByID

setAudioVolumeByID(audioID: string, volume: any): void

- Defined in src/background/methods/sound.js:26
Sets audio volume of given HTML audio element

Parameters
- audioID: string
  
  ID of the HTML audio player element
- volume: any
  
  The volume to set the audio to.
Returns void

Generated using TypeDoc version 0.22.15, the 4/20/2022