Class: SoundManager

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3912

Manages all the sounds.

Constructors

Constructor

> new SoundManager(): SoundManager

Returns

SoundManager

Properties

_volume

> protected static _volume: number

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3923

---

aliases

> protected static aliases: WeakMap<Sound, { alias: string; library: SoundLibrary; }>

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3919

---

analysers

> static analysers: AnalyserNode[]

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3917

---

audios

> static audios: Sound[]

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3916

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

---

contexts

> static contexts: AudioContext[]

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3918

Accessors

volume

Get Signature

> get static volume(): number

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3927

Global volume that applies to all the sounds.

Returns

number

Set Signature

> set static volume(value): void

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3928

Parameters

value

number

Returns

void

Methods

add()

> static add(file, onError?): Promise<Sound | null>

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3935

Creates an audio element and adds it to the audios.

Parameters

file

string

URL of the sound file.

onError?

(e) => void

Callback invoked when error occurs.

Returns

Promise<Sound | null>

Created audio element.

---

addAnalyzer()

> static addAnalyzer(audio, context): AnalyserNode | undefined

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3942

Parameters

audio

Sound

context

AudioContext

Returns

AnalyserNode | undefined

---

analyze()

> static analyze(analyser?): number

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3948

Get volume for lip sync

Parameters

analyser?

AnalyserNode

An analyzer element.

Returns

number

Returns value to feed into lip sync

---

destroy()

> static destroy(): void

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3957

Destroys all managed audios.

Returns

void

---

dispose()

> static dispose(audio): void

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3953

Disposes an audio element and removes it from audios.

Parameters

audio

Sound

An audio element.

Returns

void

---

play()

> static play(audio, onFinish?): void

Defined in: node_modules/untitled-pixi-live2d-engine/types/index.d.ts:3941

Plays the sound.

Parameters

audio

Sound

An audio element.

onFinish?

() => void

Callback invoked when the playback has finished.

Returns

void