IAudioManagerPlugin

Defined in: plugins/audio/AudioManagerPlugin.ts:19

Extends

• IPlugin

Type Parameters

• C extends ChannelName = ChannelName

Properties

app

app: IApplication

Defined in: plugins/Plugin.ts:10

Inherited from

IPlugin.app

---

channels

channels: Map<string, IAudioChannel>

Defined in: plugins/audio/AudioManagerPlugin.ts:29

---

id

id: string

Defined in: plugins/Plugin.ts:8

Inherited from

IPlugin.id

---

masterVolume

masterVolume: number

Defined in: plugins/audio/AudioManagerPlugin.ts:27

---

music

music: IAudioChannel

Defined in: plugins/audio/AudioManagerPlugin.ts:30

---

muted

muted: boolean

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

---

onChannelMuted

onChannelMuted: Signal<(detail) => void>

Defined in: plugins/audio/AudioManagerPlugin.ts:25

---

onChannelVolumeChanged

onChannelVolumeChanged: Signal<(detail) => void>

Defined in: plugins/audio/AudioManagerPlugin.ts:23

---

onMasterVolumeChanged

onMasterVolumeChanged: Signal<(volume) => void>

Defined in: plugins/audio/AudioManagerPlugin.ts:22

---

onMuted

onMuted: Signal<(muted) => void>

Defined in: plugins/audio/AudioManagerPlugin.ts:24

---

onSoundEnded

onSoundEnded: Signal<(detail) => void>

Defined in: plugins/audio/AudioManagerPlugin.ts:21

---

onSoundStarted

onSoundStarted: Signal<(detail) => void>

Defined in: plugins/audio/AudioManagerPlugin.ts:20

---

sfx

sfx: IAudioChannel

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

---

vo

vo: IAudioChannel

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

---

voiceover

voiceover: IAudioChannel

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

Methods

add()

add(soundAsset): void

Defined in: plugins/audio/AudioManagerPlugin.ts:53

Parameters

soundAsset

UnresolvedAsset

Returns

void

---

addAllFromBundle()

addAllFromBundle(bundleName, manifest?): void

Defined in: plugins/audio/AudioManagerPlugin.ts:51

Parameters

bundleName

string

manifest?

string | AssetsManifest

Returns

void

---

addAllFromManifest()

addAllFromManifest(manifest): void

Defined in: plugins/audio/AudioManagerPlugin.ts:49

Parameters

manifest

AssetsManifest

Returns

void

---

addSignalConnection()

addSignalConnection(…args): void

Defined in: plugins/Plugin.ts:18

Parameters

args

…SignalConnection[]

Returns

void

Inherited from

IPlugin.addSignalConnection

---

clearSignalConnections()

clearSignalConnections(): void

Defined in: plugins/Plugin.ts:20

Returns

void

Inherited from

IPlugin.clearSignalConnections

---

createChannel()

createChannel(name): void

Defined in: plugins/audio/AudioManagerPlugin.ts:35

Parameters

name

string

Returns

void

---

crossFade()

crossFade(outSoundId, inSoundId, channelName, duration?): Promise<null | Tween>

Defined in: plugins/audio/AudioManagerPlugin.ts:61

Parameters

outSoundId

string

inSoundId

string

channelName

C

duration?

number

Returns

Promise<null | Tween>

---

destroy()

destroy(): void

Defined in: plugins/Plugin.ts:16

Returns

void

Inherited from

IPlugin.destroy

---

fade()

fade(soundId, channelName, props?): Promise<null | Tween>

Defined in: plugins/audio/AudioManagerPlugin.ts:55

Parameters

soundId

string

channelName

C

props?

TweenVars

Returns

Promise<null | Tween>

---

fadeIn()

fadeIn(soundId, channelName, props?): Promise<null | Tween>

Defined in: plugins/audio/AudioManagerPlugin.ts:57

Parameters

soundId

string

channelName

C

props?

TweenVars

Returns

Promise<null | Tween>

---

fadeOut()

fadeOut(soundId, channelName, props?): Promise<null | Tween>

Defined in: plugins/audio/AudioManagerPlugin.ts:59

Parameters

soundId

string

channelName

C

props?

TweenVars

Returns

Promise<null | Tween>

---

getAudioInstance()

getAudioInstance(soundId, channelName): undefined | IAudioInstance

Defined in: plugins/audio/AudioManagerPlugin.ts:75

Parameters

soundId

string

channelName

C

Returns

undefined | IAudioInstance

---

getChannel()

getChannel(name): undefined | IAudioChannel

Defined in: plugins/audio/AudioManagerPlugin.ts:47

Parameters

name

C

Returns

undefined | IAudioChannel

---

initialize()

initialize(_app, options?): void | Promise<void>

Defined in: plugins/Plugin.ts:12

Parameters

_app

IApplication

options?

any

Returns

void | Promise<void>

Inherited from

IPlugin.initialize

---

isPlaying()

isPlaying(soundId, channelName): boolean

Defined in: plugins/audio/AudioManagerPlugin.ts:39

Parameters

soundId

string

channelName

C

Returns

boolean

---

load()

load(soundId, channelName, options?): void

Defined in: plugins/audio/AudioManagerPlugin.ts:41

Parameters

soundId

string | string[]

channelName

C

options?

PlayOptions

Returns

void

---

mute()

mute(): void

Defined in: plugins/audio/AudioManagerPlugin.ts:63

Returns

void

---

pause()

pause(): void

Defined in: plugins/audio/AudioManagerPlugin.ts:67

Returns

void

---

play()

play(soundId, channelName, options?): Promise<IAudioInstance>

Defined in: plugins/audio/AudioManagerPlugin.ts:37

Parameters

soundId

string

channelName

C

options?

PlayOptions

Returns

Promise<IAudioInstance>

---

postInitialize()

postInitialize(_app): void | Promise<void>

Defined in: plugins/Plugin.ts:14

Parameters

_app

IApplication

Returns

void | Promise<void>

Inherited from

IPlugin.postInitialize

---

registerCoreFunctions()

registerCoreFunctions(): void

Defined in: plugins/Plugin.ts:22

Returns

void

Inherited from

IPlugin.registerCoreFunctions

---

registerCoreSignals()

registerCoreSignals(): void

Defined in: plugins/Plugin.ts:24

Returns

void

Inherited from

IPlugin.registerCoreSignals

---

restore()

restore(): Promise<void>

Defined in: plugins/audio/AudioManagerPlugin.ts:73

Returns

Promise<void>

---

resume()

resume(): void

Defined in: plugins/audio/AudioManagerPlugin.ts:69

Returns

void

---

setChannelVolume()

setChannelVolume(channelName, volume): void

Defined in: plugins/audio/AudioManagerPlugin.ts:45

Parameters

channelName

C | C[]

volume

number

Returns

void

---

stop()

stop(soundId, channelName): undefined | IAudioInstance

Defined in: plugins/audio/AudioManagerPlugin.ts:43

Parameters

soundId

string

channelName

C

Returns

undefined | IAudioInstance

---

stopAll()

stopAll(fade?, duration?, props?): void

Defined in: plugins/audio/AudioManagerPlugin.ts:77

Parameters

fade?

boolean

duration?

number

props?

TweenVars

Returns

void

---

suspend()

suspend(): void

Defined in: plugins/audio/AudioManagerPlugin.ts:71

Returns

void

---

unmute()

unmute(): void

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

Returns

void