AudioInstance
Defined in: plugins/audio/AudioInstance.ts:44
Type Parameters
Section titled “Type Parameters”C extends ChannelName = ChannelName
Implements
Section titled “Implements”Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new AudioInstance<
C>(id,channel,manager):AudioInstance<C>
Defined in: plugins/audio/AudioInstance.ts:53
Parameters
Section titled “Parameters”string
channel
Section titled “channel”manager
Section titled “manager”Returns
Section titled “Returns”AudioInstance<C>
Properties
Section titled “Properties”channel
Section titled “channel”channel:
IAudioChannel
Defined in: plugins/audio/AudioInstance.ts:55
Implementation of
Section titled “Implementation of”id:
string
Defined in: plugins/audio/AudioInstance.ts:54
Implementation of
Section titled “Implementation of”manager
Section titled “manager”manager:
IAudioManagerPlugin
Defined in: plugins/audio/AudioInstance.ts:56
Implementation of
Section titled “Implementation of”onEnd:
Signal<(instance) =>void>
Defined in: plugins/audio/AudioInstance.ts:48
Implementation of
Section titled “Implementation of”onPaused
Section titled “onPaused”onPaused:
Signal<(instance) =>void>
Defined in: plugins/audio/AudioInstance.ts:49
Implementation of
Section titled “Implementation of”onProgress
Section titled “onProgress”onProgress:
Signal<(instance) =>void>
Defined in: plugins/audio/AudioInstance.ts:51
onResumed
Section titled “onResumed”onResumed:
Signal<(instance) =>void>
Defined in: plugins/audio/AudioInstance.ts:50
Implementation of
Section titled “Implementation of”onStart
Section titled “onStart”onStart:
Signal<(instance) =>void>
Defined in: plugins/audio/AudioInstance.ts:46
Implementation of
Section titled “Implementation of”onStop
Section titled “onStop”onStop:
Signal<(instance) =>void>
Defined in: plugins/audio/AudioInstance.ts:47
Implementation of
Section titled “Implementation of”storedVolume
Section titled “storedVolume”storedVolume:
number
Defined in: plugins/audio/AudioInstance.ts:45
Implementation of
Section titled “Implementation of”Accessors
Section titled “Accessors”isPlaying
Section titled “isPlaying”Get Signature
Section titled “Get Signature”get isPlaying():
boolean
Defined in: plugins/audio/AudioInstance.ts:107
Returns
Section titled “Returns”boolean
Set Signature
Section titled “Set Signature”set isPlaying(
value):void
Defined in: plugins/audio/AudioInstance.ts:111
Parameters
Section titled “Parameters”boolean
Returns
Section titled “Returns”void
Implementation of
Section titled “Implementation of”Get Signature
Section titled “Get Signature”get media():
IMediaInstance
Defined in: plugins/audio/AudioInstance.ts:64
Returns
Section titled “Returns”IMediaInstance
Set Signature
Section titled “Set Signature”set media(
value):void
Defined in: plugins/audio/AudioInstance.ts:68
Parameters
Section titled “Parameters”IMediaInstance
Returns
Section titled “Returns”void
Implementation of
Section titled “Implementation of”Get Signature
Section titled “Get Signature”get muted():
boolean
Defined in: plugins/audio/AudioInstance.ts:94
Returns
Section titled “Returns”boolean
Set Signature
Section titled “Set Signature”set muted(
value):void
Defined in: plugins/audio/AudioInstance.ts:98
Parameters
Section titled “Parameters”boolean
Returns
Section titled “Returns”void
Implementation of
Section titled “Implementation of”volume
Section titled “volume”Get Signature
Section titled “Get Signature”get volume():
number
Defined in: plugins/audio/AudioInstance.ts:81
Returns
Section titled “Returns”number
Set Signature
Section titled “Set Signature”set volume(
value):void
Defined in: plugins/audio/AudioInstance.ts:85
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”void
Implementation of
Section titled “Implementation of”Methods
Section titled “Methods”addListeners()
Section titled “addListeners()”addListeners():
void
Defined in: plugins/audio/AudioInstance.ts:146
Returns
Section titled “Returns”void
Implementation of
Section titled “Implementation of”destroy()
Section titled “destroy()”destroy():
void
Defined in: plugins/audio/AudioInstance.ts:169
Returns
Section titled “Returns”void
Implementation of
Section titled “Implementation of”fadeTo()
Section titled “fadeTo()”fadeTo(
volume,duration):Tween
Defined in: plugins/audio/AudioInstance.ts:174
Parameters
Section titled “Parameters”volume
Section titled “volume”number
duration
Section titled “duration”number
Returns
Section titled “Returns”Tween
Implementation of
Section titled “Implementation of”pause()
Section titled “pause()”pause():
void
Defined in: plugins/audio/AudioInstance.ts:115
Returns
Section titled “Returns”void
Implementation of
Section titled “Implementation of”play()
Section titled “play()”play(
time?):void
Defined in: plugins/audio/AudioInstance.ts:178
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”void
Implementation of
Section titled “Implementation of”remove()
Section titled “remove()”remove():
void
Defined in: plugins/audio/AudioInstance.ts:129
Returns
Section titled “Returns”void
Implementation of
Section titled “Implementation of”removeListeners()
Section titled “removeListeners()”removeListeners():
void
Defined in: plugins/audio/AudioInstance.ts:156
Returns
Section titled “Returns”void
Implementation of
Section titled “Implementation of”IAudioInstance.removeListeners
resume()
Section titled “resume()”resume():
void
Defined in: plugins/audio/AudioInstance.ts:122
Returns
Section titled “Returns”void
Implementation of
Section titled “Implementation of”stop()
Section titled “stop()”stop():
void
Defined in: plugins/audio/AudioInstance.ts:134
Returns
Section titled “Returns”void
Implementation of
Section titled “Implementation of”updateVolume()
Section titled “updateVolume()”updateVolume():
void
Defined in: plugins/audio/AudioInstance.ts:142
Returns
Section titled “Returns”void