AudioInstance

Defined in: plugins/audio/AudioInstance.ts:44

Type Parameters

• C extends ChannelName = ChannelName

Implements

• IAudioInstance

Constructors

new AudioInstance()

new AudioInstance<C>(id, channel, manager): AudioInstance<C>

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

Parameters

id

string

channel

IAudioChannel

manager

IAudioManagerPlugin

Returns

AudioInstance<C>

Properties

channel

channel: IAudioChannel

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

Implementation of

IAudioInstance.channel

---

id

id: string

Defined in: plugins/audio/AudioInstance.ts:54

Implementation of

IAudioInstance.id

---

manager

manager: IAudioManagerPlugin

Defined in: plugins/audio/AudioInstance.ts:56

Implementation of

IAudioInstance.manager

---

onEnd

onEnd: Signal<(instance) => void>

Defined in: plugins/audio/AudioInstance.ts:48

Implementation of

IAudioInstance.onEnd

---

onPaused

onPaused: Signal<(instance) => void>

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

Implementation of

IAudioInstance.onPaused

---

onProgress

onProgress: Signal<(instance) => void>

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

---

onResumed

onResumed: Signal<(instance) => void>

Defined in: plugins/audio/AudioInstance.ts:50

Implementation of

IAudioInstance.onResumed

---

onStart

onStart: Signal<(instance) => void>

Defined in: plugins/audio/AudioInstance.ts:46

Implementation of

IAudioInstance.onStart

---

onStop

onStop: Signal<(instance) => void>

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

Implementation of

IAudioInstance.onStop

---

storedVolume

storedVolume: number

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

Implementation of

IAudioInstance.storedVolume

Accessors

isPlaying

Get Signature

get isPlaying(): boolean

Defined in: plugins/audio/AudioInstance.ts:107

Returns

boolean

Set Signature

set isPlaying(value): void

Defined in: plugins/audio/AudioInstance.ts:111

Parameters

value

boolean

Returns

void

Implementation of

IAudioInstance.isPlaying

---

media

Get Signature

get media(): IMediaInstance

Defined in: plugins/audio/AudioInstance.ts:64

Returns

IMediaInstance

Set Signature

set media(value): void

Defined in: plugins/audio/AudioInstance.ts:68

Parameters

value

IMediaInstance

Returns

void

Implementation of

IAudioInstance.media

---

muted

Get Signature

get muted(): boolean

Defined in: plugins/audio/AudioInstance.ts:94

Returns

boolean

Set Signature

set muted(value): void

Defined in: plugins/audio/AudioInstance.ts:98

Parameters

value

boolean

Returns

void

Implementation of

IAudioInstance.muted

---

volume

Get Signature

get volume(): number

Defined in: plugins/audio/AudioInstance.ts:81

Returns

number

Set Signature

set volume(value): void

Defined in: plugins/audio/AudioInstance.ts:85

Parameters

value

number

Returns

void

Implementation of

IAudioInstance.volume

Methods

addListeners()

addListeners(): void

Defined in: plugins/audio/AudioInstance.ts:146

Returns

void

Implementation of

IAudioInstance.addListeners

---

destroy()

destroy(): void

Defined in: plugins/audio/AudioInstance.ts:169

Returns

void

Implementation of

IAudioInstance.destroy

---

fadeTo()

fadeTo(volume, duration): Tween

Defined in: plugins/audio/AudioInstance.ts:174

Parameters

volume

number

duration

number

Returns

Tween

Implementation of

IAudioInstance.fadeTo

---

pause()

pause(): void

Defined in: plugins/audio/AudioInstance.ts:115

Returns

void

Implementation of

IAudioInstance.pause

---

play()

play(time?): void

Defined in: plugins/audio/AudioInstance.ts:178

Parameters

time?

number

Returns

void

Implementation of

IAudioInstance.play

---

remove()

remove(): void

Defined in: plugins/audio/AudioInstance.ts:129

Returns

void

Implementation of

IAudioInstance.remove

---

removeListeners()

removeListeners(): void

Defined in: plugins/audio/AudioInstance.ts:156

Returns

void

Implementation of

IAudioInstance.removeListeners

---

resume()

resume(): void

Defined in: plugins/audio/AudioInstance.ts:122

Returns

void

Implementation of

IAudioInstance.resume

---

stop()

stop(): void

Defined in: plugins/audio/AudioInstance.ts:134

Returns

void

Implementation of

IAudioInstance.stop

---

updateVolume()

updateVolume(): void

Defined in: plugins/audio/AudioInstance.ts:142

Returns

void

Implementation of

IAudioInstance.updateVolume