Class VoiceLineQueue

Index

Methods

create enqueue cancelLine cancelChannel pauseChannel resumeChannel setChannelMute isMuted getActive isPlaying channelIds activeChannels queueLength tick clear dispose

Methods

`Static`create

create(opts?: VoiceLineQueueOptions): VoiceLineQueue
Parameters
- opts: VoiceLineQueueOptions = {}
Returns VoiceLineQueue
- Defined in runtime/voice-line-queue.ts:119

enqueue

enqueue(spec: VOLineSpec): boolean
Parameters
- spec: VOLineSpec
Returns boolean
- Defined in runtime/voice-line-queue.ts:123

cancelLine

cancelLine(id: string): boolean
Parameters
- id: string
Returns boolean
- Defined in runtime/voice-line-queue.ts:177

cancelChannel

cancelChannel(channelId: string): boolean
Parameters
- channelId: string
Returns boolean
- Defined in runtime/voice-line-queue.ts:200

pauseChannel

pauseChannel(channelId: string): boolean
Parameters
- channelId: string
Returns boolean
- Defined in runtime/voice-line-queue.ts:209

resumeChannel

resumeChannel(channelId: string): boolean
Parameters
- channelId: string
Returns boolean
- Defined in runtime/voice-line-queue.ts:217

setChannelMute

setChannelMute(channelId: string, muted: boolean): boolean
Parameters
- channelId: string
- muted: boolean
Returns boolean
- Defined in runtime/voice-line-queue.ts:225

isMuted

isMuted(channelId: string): boolean
Parameters
- channelId: string
Returns boolean
- Defined in runtime/voice-line-queue.ts:233

getActive

getActive(channelId: string): VOLineSnapshot | null
Parameters
- channelId: string
Returns VOLineSnapshot | null
- Defined in runtime/voice-line-queue.ts:239

isPlaying

isPlaying(channelId?: string): boolean
Parameters
- OptionalchannelId: string
Returns boolean
- Defined in runtime/voice-line-queue.ts:246

channelIds

channelIds(): string[]
Returns string[]
- Defined in runtime/voice-line-queue.ts:261

activeChannels

activeChannels(): VOLineSnapshot[]
Returns VOLineSnapshot[]
- Defined in runtime/voice-line-queue.ts:273

queueLength

queueLength(channelId: string): number
Parameters
- channelId: string
Returns number
- Defined in runtime/voice-line-queue.ts:287

tick

tick(dtMs: number): void
Parameters
- dtMs: number
Returns void
- Defined in runtime/voice-line-queue.ts:295

clear

clear(): void
Returns void
- Defined in runtime/voice-line-queue.ts:315

dispose

dispose(): void
Returns void
- Defined in runtime/voice-line-queue.ts:320