Skip to content

IAudioInstance

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

Type Parameters

C extends ChannelName = ChannelName

Properties

channel

channel: IAudioChannel

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


id

id: string

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


isPlaying

isPlaying: boolean

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


manager

manager: IAudioManagerPlugin<C>

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


media

media: IMediaInstance

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


muted

muted: boolean

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


onEnd

onEnd: Signal<(instance) => void>

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


onPaused

onPaused: Signal<(instance) => void>

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


onResumed

onResumed: Signal<(instance) => void>

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


onStart

onStart: Signal<(instance) => void>

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


onStop

onStop: Signal<(instance) => void>

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


storedVolume

storedVolume: number

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


volume

volume: number

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

Methods

addListeners()

addListeners(): void

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

Returns

void


destroy()

destroy(): void

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

Returns

void


fadeTo()

fadeTo(volume, duration): Tween

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

Parameters

volume

number

duration

number

Returns

Tween


pause()

pause(): void

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

Returns

void


play()

play(): void

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

Returns

void


remove()

remove(): void

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

Returns

void


removeListeners()

removeListeners(): void

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

Returns

void


resume()

resume(): void

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

Returns

void


stop()

stop(): void

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

Returns

void


updateVolume()

updateVolume(): void

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

Returns

void