IAudioManagerPlugin
Defined in: plugins/audio/AudioManagerPlugin.ts:54
Extends
Section titled “Extends”Type Parameters
Section titled “Type Parameters”C extends ChannelName = ChannelName
Properties
Section titled “Properties”app:
IApplication
Defined in: plugins/Plugin.ts:10
Inherited from
Section titled “Inherited from”channels
Section titled “channels”channels:
Map<string,IAudioChannel>
Defined in: plugins/audio/AudioManagerPlugin.ts:64
id:
string
Defined in: plugins/Plugin.ts:8
Inherited from
Section titled “Inherited from”masterVolume
Section titled “masterVolume”masterVolume:
number
Defined in: plugins/audio/AudioManagerPlugin.ts:62
music:
IAudioChannel
Defined in: plugins/audio/AudioManagerPlugin.ts:65
muted:
boolean
Defined in: plugins/audio/AudioManagerPlugin.ts:63
onChannelMuted
Section titled “onChannelMuted”onChannelMuted:
Signal<(detail) =>void>
Defined in: plugins/audio/AudioManagerPlugin.ts:60
onChannelVolumeChanged
Section titled “onChannelVolumeChanged”onChannelVolumeChanged:
Signal<(detail) =>void>
Defined in: plugins/audio/AudioManagerPlugin.ts:58
onMasterVolumeChanged
Section titled “onMasterVolumeChanged”onMasterVolumeChanged:
Signal<(volume) =>void>
Defined in: plugins/audio/AudioManagerPlugin.ts:57
onMuted
Section titled “onMuted”onMuted:
Signal<(muted) =>void>
Defined in: plugins/audio/AudioManagerPlugin.ts:59
onSoundEnded
Section titled “onSoundEnded”onSoundEnded:
Signal<(detail) =>void>
Defined in: plugins/audio/AudioManagerPlugin.ts:56
onSoundStarted
Section titled “onSoundStarted”onSoundStarted:
Signal<(detail) =>void>
Defined in: plugins/audio/AudioManagerPlugin.ts:55
options
Section titled “options”
readonlyoptions:Partial<O>
Defined in: plugins/Plugin.ts:12
Inherited from
Section titled “Inherited from”paused
Section titled “paused”
readonlypaused:boolean
Defined in: plugins/audio/AudioManagerPlugin.ts:70
sfx:
IAudioChannel
Defined in: plugins/audio/AudioManagerPlugin.ts:66
vo:
IAudioChannel
Defined in: plugins/audio/AudioManagerPlugin.ts:68
voiceover
Section titled “voiceover”voiceover:
IAudioChannel
Defined in: plugins/audio/AudioManagerPlugin.ts:67
Methods
Section titled “Methods”add(
soundAsset):void
Defined in: plugins/audio/AudioManagerPlugin.ts:90
Parameters
Section titled “Parameters”soundAsset
Section titled “soundAsset”UnresolvedAsset
Returns
Section titled “Returns”void
addAllFromBundle()
Section titled “addAllFromBundle()”addAllFromBundle(
bundleName,manifest?):void
Defined in: plugins/audio/AudioManagerPlugin.ts:88
Parameters
Section titled “Parameters”bundleName
Section titled “bundleName”string
manifest?
Section titled “manifest?”string | AssetsManifest
Returns
Section titled “Returns”void
addAllFromManifest()
Section titled “addAllFromManifest()”addAllFromManifest(
manifest):void
Defined in: plugins/audio/AudioManagerPlugin.ts:86
Parameters
Section titled “Parameters”manifest
Section titled “manifest”AssetsManifest
Returns
Section titled “Returns”void
addSignalConnection()
Section titled “addSignalConnection()”addSignalConnection(…
args):void
Defined in: plugins/Plugin.ts:20
Parameters
Section titled “Parameters”…SignalConnection[]
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”clearSignalConnections()
Section titled “clearSignalConnections()”clearSignalConnections():
void
Defined in: plugins/Plugin.ts:22
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”IPlugin.clearSignalConnections
createChannel()
Section titled “createChannel()”createChannel(
name):void
Defined in: plugins/audio/AudioManagerPlugin.ts:72
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”void
crossFade()
Section titled “crossFade()”crossFade(
outSoundId,inSoundId,channelName,duration?):Promise<null|Tween>
Defined in: plugins/audio/AudioManagerPlugin.ts:98
Parameters
Section titled “Parameters”outSoundId
Section titled “outSoundId”string
inSoundId
Section titled “inSoundId”string
channelName
Section titled “channelName”C
duration?
Section titled “duration?”number
Returns
Section titled “Returns”Promise<null | Tween>
destroy()
Section titled “destroy()”destroy():
void
Defined in: plugins/Plugin.ts:18
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”fade()
Section titled “fade()”fade(
soundId,channelName,props?):Promise<null|Tween>
Defined in: plugins/audio/AudioManagerPlugin.ts:92
Parameters
Section titled “Parameters”soundId
Section titled “soundId”string
channelName
Section titled “channelName”C
props?
Section titled “props?”TweenVars
Returns
Section titled “Returns”Promise<null | Tween>
fadeIn()
Section titled “fadeIn()”fadeIn(
soundId,channelName,props?):Promise<null|Tween>
Defined in: plugins/audio/AudioManagerPlugin.ts:94
Parameters
Section titled “Parameters”soundId
Section titled “soundId”string
channelName
Section titled “channelName”C
props?
Section titled “props?”TweenVars
Returns
Section titled “Returns”Promise<null | Tween>
fadeOut()
Section titled “fadeOut()”fadeOut(
soundId,channelName,props?):Promise<null|Tween>
Defined in: plugins/audio/AudioManagerPlugin.ts:96
Parameters
Section titled “Parameters”soundId
Section titled “soundId”string
channelName
Section titled “channelName”C
props?
Section titled “props?”TweenVars
Returns
Section titled “Returns”Promise<null | Tween>
getAudioInstance()
Section titled “getAudioInstance()”getAudioInstance(
soundId,channelName):undefined|IAudioInstance<ChannelName>
Defined in: plugins/audio/AudioManagerPlugin.ts:112
Parameters
Section titled “Parameters”soundId
Section titled “soundId”string
channelName
Section titled “channelName”C
Returns
Section titled “Returns”undefined | IAudioInstance<ChannelName>
getChannel()
Section titled “getChannel()”getChannel(
name):undefined|IAudioChannel
Defined in: plugins/audio/AudioManagerPlugin.ts:84
Parameters
Section titled “Parameters”C
Returns
Section titled “Returns”undefined | IAudioChannel
initialize()
Section titled “initialize()”initialize(
options,app):void|Promise<void>
Defined in: plugins/Plugin.ts:14
Parameters
Section titled “Parameters”options
Section titled “options”Partial<O>
Returns
Section titled “Returns”void | Promise<void>
Inherited from
Section titled “Inherited from”isPlaying()
Section titled “isPlaying()”isPlaying(
soundId,channelName):boolean
Defined in: plugins/audio/AudioManagerPlugin.ts:76
Parameters
Section titled “Parameters”soundId
Section titled “soundId”string
channelName
Section titled “channelName”C
Returns
Section titled “Returns”boolean
load()
Section titled “load()”load(
soundId,channelName,options?):void
Defined in: plugins/audio/AudioManagerPlugin.ts:78
Parameters
Section titled “Parameters”soundId
Section titled “soundId”string | string[]
channelName
Section titled “channelName”C
options?
Section titled “options?”PlayOptions
Returns
Section titled “Returns”void
mute()
Section titled “mute()”mute():
void
Defined in: plugins/audio/AudioManagerPlugin.ts:100
Returns
Section titled “Returns”void
pause()
Section titled “pause()”pause():
void
Defined in: plugins/audio/AudioManagerPlugin.ts:104
Returns
Section titled “Returns”void
play()
Section titled “play()”play(
soundId,channelName,options?):Promise<IAudioInstance<ChannelName>>
Defined in: plugins/audio/AudioManagerPlugin.ts:74
Parameters
Section titled “Parameters”soundId
Section titled “soundId”string
channelName
Section titled “channelName”C
options?
Section titled “options?”PlayOptions
Returns
Section titled “Returns”Promise<IAudioInstance<ChannelName>>
postInitialize()
Section titled “postInitialize()”postInitialize(
_app):void|Promise<void>
Defined in: plugins/Plugin.ts:16
Parameters
Section titled “Parameters”Returns
Section titled “Returns”void | Promise<void>
Inherited from
Section titled “Inherited from”registerCoreFunctions()
Section titled “registerCoreFunctions()”registerCoreFunctions():
void
Defined in: plugins/Plugin.ts:24
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”registerCoreSignals()
Section titled “registerCoreSignals()”registerCoreSignals():
void
Defined in: plugins/Plugin.ts:26
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”restore()
Section titled “restore()”restore():
Promise<void>
Defined in: plugins/audio/AudioManagerPlugin.ts:110
Returns
Section titled “Returns”Promise<void>
resume()
Section titled “resume()”resume():
void
Defined in: plugins/audio/AudioManagerPlugin.ts:106
Returns
Section titled “Returns”void
setChannelVolume()
Section titled “setChannelVolume()”setChannelVolume(
channelName,volume):void
Defined in: plugins/audio/AudioManagerPlugin.ts:82
Parameters
Section titled “Parameters”channelName
Section titled “channelName”C | C[]
volume
Section titled “volume”number
Returns
Section titled “Returns”void
stop()
Section titled “stop()”stop(
soundId,channelName):undefined|IAudioInstance<ChannelName>
Defined in: plugins/audio/AudioManagerPlugin.ts:80
Parameters
Section titled “Parameters”soundId
Section titled “soundId”string
channelName
Section titled “channelName”C
Returns
Section titled “Returns”undefined | IAudioInstance<ChannelName>
stopAll()
Section titled “stopAll()”stopAll(
fade?,duration?,props?):void
Defined in: plugins/audio/AudioManagerPlugin.ts:114
Parameters
Section titled “Parameters”boolean
duration?
Section titled “duration?”number
props?
Section titled “props?”TweenVars
Returns
Section titled “Returns”void
suspend()
Section titled “suspend()”suspend():
void
Defined in: plugins/audio/AudioManagerPlugin.ts:108
Returns
Section titled “Returns”void
unmute()
Section titled “unmute()”unmute():
void
Defined in: plugins/audio/AudioManagerPlugin.ts:102
Returns
Section titled “Returns”void