Skip to content

AudioChannel

Defined in: plugins/audio/AudioChannel.ts:28

Type Parameters

C extends ChannelName = ChannelName

Constructors

new AudioChannel()

new AudioChannel<C>(name, manager): AudioChannel<C>

Defined in: plugins/audio/AudioChannel.ts:31

Parameters

name

C

manager

IAudioManagerPlugin<C>

Returns

AudioChannel<C>

Properties

manager

manager: IAudioManagerPlugin<C>

Defined in: plugins/audio/AudioChannel.ts:33


name

name: C

Defined in: plugins/audio/AudioChannel.ts:32

Accessors

instances

Get Signature

get instances(): IAudioInstance[]

Defined in: plugins/audio/AudioChannel.ts:38

Returns

IAudioInstance[]


muted

Get Signature

get muted(): boolean

Defined in: plugins/audio/AudioChannel.ts:44

Returns

boolean

Set Signature

set muted(value): void

Defined in: plugins/audio/AudioChannel.ts:48

Parameters
value

boolean

Returns

void


volume

Get Signature

get volume(): number

Defined in: plugins/audio/AudioChannel.ts:56

Returns

number

Set Signature

set volume(value): void

Defined in: plugins/audio/AudioChannel.ts:60

Parameters
value

number

Returns

void

Methods

_setMuted()

_setMuted(): void

Defined in: plugins/audio/AudioChannel.ts:103

Returns

void


add()

add(id, instance): IAudioInstance

Defined in: plugins/audio/AudioChannel.ts:65

Parameters

id

string

instance

IAudioInstance

Returns

IAudioInstance


destroy()

destroy(): void

Defined in: plugins/audio/AudioChannel.ts:124

Returns

void


get()

get(id): undefined | IAudioInstance

Defined in: plugins/audio/AudioChannel.ts:70

Parameters

id

string

Returns

undefined | IAudioInstance


pause()

pause(): void

Defined in: plugins/audio/AudioChannel.ts:83

Returns

void


remove()

remove(id): undefined | IAudioInstance

Defined in: plugins/audio/AudioChannel.ts:74

Parameters

id

string

Returns

undefined | IAudioInstance


restore()

restore(): void

Defined in: plugins/audio/AudioChannel.ts:118

Returns

void


resume()

resume(): void

Defined in: plugins/audio/AudioChannel.ts:93

Returns

void


updateVolume()

updateVolume(): void

Defined in: plugins/audio/AudioChannel.ts:109

Returns

void