Class SoundManager

Manages all the sounds.

Hierarchy

SoundManager

Index

Constructors

Properties

Accessors

Methods

add destroy dispose play

Constructors

constructor

new SoundManager(): SoundManager
Returns SoundManager

Properties

`Static` `Protected` _volume

_volume: number = VOLUME

`Static` audios

audios: HTMLAudioElement[] = []

Audio elements playing or pending to play. Finished audios will be removed automatically.

Accessors

`Static` volume

get volume(): number
Global volume that applies to all the sounds.

Returns number
- Defined in src/cubism-common/SoundManager.ts:20
set volume(value: number): void
Parameters
- value: number
Returns void
- Defined in src/cubism-common/SoundManager.ts:24

Methods

`Static` add

add(file: string, onFinish?: (() => void), onError?: ((e: Error) => void)): HTMLAudioElement
Creates an audio element and adds it to the audios.

Returns
Created audio element.
Parameters
- file: string
  
  URL of the sound file.
- Optional onFinish: (() => void)
  
  Callback invoked when the playback has finished.
  - - (): void
    - Returns void
- Optional onError: ((e: Error) => void)
  
  Callback invoked when error occurs.
  - - (e: Error): void
    - Parameters
      
      e: Error
      
      Returns void
Returns HTMLAudioElement
- Defined in src/cubism-common/SoundManager.ts:37

`Static` destroy

destroy(): void
Destroys all managed audios.

Returns void
- Defined in src/cubism-common/SoundManager.ts:94

`Static` dispose

dispose(audio: HTMLAudioElement): void
Disposes an audio element and removes it from audios.
Parameters
- audio: HTMLAudioElement
  
  An audio element.
Returns void
- Defined in src/cubism-common/SoundManager.ts:84

`Static` play

play(audio: HTMLAudioElement): Promise<void>
Plays the sound.

Returns
Promise that resolves when the audio is ready to play, rejects when error occurs.
Parameters
- audio: HTMLAudioElement
  
  An audio element.
Returns Promise<void>
- Defined in src/cubism-common/SoundManager.ts:64

Generated using TypeDoc