IAudioInstance
Defined in: plugins/audio/AudioInstance.ts:8
Type Parameters
Section titled “Type Parameters”C extends ChannelName = ChannelName
Properties
Section titled “Properties”channel
Section titled “channel”channel:
IAudioChannel
Defined in: plugins/audio/AudioInstance.ts:12
id:
string
Defined in: plugins/audio/AudioInstance.ts:14
isPlaying
Section titled “isPlaying”isPlaying:
boolean
Defined in: plugins/audio/AudioInstance.ts:21
manager
Section titled “manager”manager:
IAudioManagerPlugin<C>
Defined in: plugins/audio/AudioInstance.ts:15
media:
IMediaInstance
Defined in: plugins/audio/AudioInstance.ts:11
muted:
boolean
Defined in: plugins/audio/AudioInstance.ts:13
onEnd:
Signal<(instance) =>void>
Defined in: plugins/audio/AudioInstance.ts:18
onPaused
Section titled “onPaused”onPaused:
Signal<(instance) =>void>
Defined in: plugins/audio/AudioInstance.ts:19
onResumed
Section titled “onResumed”onResumed:
Signal<(instance) =>void>
Defined in: plugins/audio/AudioInstance.ts:20
onStart
Section titled “onStart”onStart:
Signal<(instance) =>void>
Defined in: plugins/audio/AudioInstance.ts:16
onStop
Section titled “onStop”onStop:
Signal<(instance) =>void>
Defined in: plugins/audio/AudioInstance.ts:17
storedVolume
Section titled “storedVolume”storedVolume:
number
Defined in: plugins/audio/AudioInstance.ts:10
volume
Section titled “volume”volume:
number
Defined in: plugins/audio/AudioInstance.ts:9
Methods
Section titled “Methods”addListeners()
Section titled “addListeners()”addListeners():
void
Defined in: plugins/audio/AudioInstance.ts:33
Returns
Section titled “Returns”void
destroy()
Section titled “destroy()”destroy():
void
Defined in: plugins/audio/AudioInstance.ts:27
Returns
Section titled “Returns”void
fadeTo()
Section titled “fadeTo()”fadeTo(
volume,duration):Tween
Defined in: plugins/audio/AudioInstance.ts:23
Parameters
Section titled “Parameters”volume
Section titled “volume”number
duration
Section titled “duration”number
Returns
Section titled “Returns”Tween
pause()
Section titled “pause()”pause():
void
Defined in: plugins/audio/AudioInstance.ts:37
Returns
Section titled “Returns”void
play()
Section titled “play()”play():
void
Defined in: plugins/audio/AudioInstance.ts:39
Returns
Section titled “Returns”void
remove()
Section titled “remove()”remove():
void
Defined in: plugins/audio/AudioInstance.ts:29
Returns
Section titled “Returns”void
removeListeners()
Section titled “removeListeners()”removeListeners():
void
Defined in: plugins/audio/AudioInstance.ts:35
Returns
Section titled “Returns”void
resume()
Section titled “resume()”resume():
void
Defined in: plugins/audio/AudioInstance.ts:41
Returns
Section titled “Returns”void
stop()
Section titled “stop()”stop():
void
Defined in: plugins/audio/AudioInstance.ts:25
Returns
Section titled “Returns”void
updateVolume()
Section titled “updateVolume()”updateVolume():
void
Defined in: plugins/audio/AudioInstance.ts:31
Returns
Section titled “Returns”void