AudioChannel
Defined in: plugins/audio/AudioChannel.ts:28
Type Parameters
Section titled “Type Parameters”C extends ChannelName = ChannelName
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new AudioChannel<
C>(name,manager):AudioChannel<C>
Defined in: plugins/audio/AudioChannel.ts:31
Parameters
Section titled “Parameters”C
manager
Section titled “manager”Returns
Section titled “Returns”AudioChannel<C>
Properties
Section titled “Properties”manager
Section titled “manager”manager:
IAudioManagerPlugin<C>
Defined in: plugins/audio/AudioChannel.ts:33
name:
C
Defined in: plugins/audio/AudioChannel.ts:32
Accessors
Section titled “Accessors”instances
Section titled “instances”Get Signature
Section titled “Get Signature”get instances():
IAudioInstance<ChannelName>[]
Defined in: plugins/audio/AudioChannel.ts:38
Returns
Section titled “Returns”Get Signature
Section titled “Get Signature”get muted():
boolean
Defined in: plugins/audio/AudioChannel.ts:44
Returns
Section titled “Returns”boolean
Set Signature
Section titled “Set Signature”set muted(
value):void
Defined in: plugins/audio/AudioChannel.ts:48
Parameters
Section titled “Parameters”boolean
Returns
Section titled “Returns”void
volume
Section titled “volume”Get Signature
Section titled “Get Signature”get volume():
number
Defined in: plugins/audio/AudioChannel.ts:56
Returns
Section titled “Returns”number
Set Signature
Section titled “Set Signature”set volume(
value):void
Defined in: plugins/audio/AudioChannel.ts:60
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”void
Methods
Section titled “Methods”_setMuted()
Section titled “_setMuted()”_setMuted():
void
Defined in: plugins/audio/AudioChannel.ts:103
Returns
Section titled “Returns”void
add(
id,instance):IAudioInstance
Defined in: plugins/audio/AudioChannel.ts:65
Parameters
Section titled “Parameters”string
instance
Section titled “instance”Returns
Section titled “Returns”destroy()
Section titled “destroy()”destroy():
void
Defined in: plugins/audio/AudioChannel.ts:123
Returns
Section titled “Returns”void
get(
id):undefined|IAudioInstance<ChannelName>
Defined in: plugins/audio/AudioChannel.ts:70
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”undefined | IAudioInstance<ChannelName>
pause()
Section titled “pause()”pause():
void
Defined in: plugins/audio/AudioChannel.ts:83
Returns
Section titled “Returns”void
remove()
Section titled “remove()”remove(
id):undefined|IAudioInstance<ChannelName>
Defined in: plugins/audio/AudioChannel.ts:74
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”undefined | IAudioInstance<ChannelName>
restore()
Section titled “restore()”restore():
void
Defined in: plugins/audio/AudioChannel.ts:118
Returns
Section titled “Returns”void
resume()
Section titled “resume()”resume():
void
Defined in: plugins/audio/AudioChannel.ts:93
Returns
Section titled “Returns”void
updateVolume()
Section titled “updateVolume()”updateVolume():
void
Defined in: plugins/audio/AudioChannel.ts:109
Returns
Section titled “Returns”void