Class QueueManager<Context>

Manages all queues across guilds Handles queue creation, destruction, synchronization, and event forwarding

Type Parameters

Context extends Record<string, unknown> = QueueContext

Hierarchy

EventEmitter
- QueueManager

Index

Constructors

Accessors

Methods

get has keys values entries create destroy relocate syncAll [LookupSymbol] [OnStateUpdateSymbol] [OnEventUpdateSymbol]

Constructors

constructor

new QueueManager<Context>(player): QueueManager<Context>
Type Parameters
- Context extends Record<string, unknown> = QueueContext
Parameters
- player: Player<QueueContext, []>
Returns QueueManager<Context>
Overrides EventEmitter.constructor
- Defined in audio/QueueController.ts:36

Accessors

all

get all(): Queue<Context>[]
Returns Queue<Context>[]
- Defined in audio/QueueController.ts:49

size

get size(): number
Returns number
- Defined in audio/QueueController.ts:53

Methods

get

get(guildId): undefined | Queue<Context>
Parameters
- guildId: string
Returns undefined | Queue<Context>
- Defined in audio/QueueController.ts:41

has

has(guildId): boolean
Parameters
- guildId: string
Returns boolean
- Defined in audio/QueueController.ts:45

keys

keys(): IterableIterator<string>
Returns IterableIterator<string>
- Defined in audio/QueueController.ts:57

values

values(): IterableIterator<Queue<Context>>
Returns IterableIterator<Queue<Context>>
- Defined in audio/QueueController.ts:61

entries

entries(): IterableIterator<[string, Queue<Context>]>
Returns IterableIterator<[string, Queue<Context>]>
- Defined in audio/QueueController.ts:65

create

create(options): Promise<Queue<Context>>
Parameters
- options: CreateQueueOptions<Context>
Returns Promise<Queue<Context>>
- Defined in audio/QueueController.ts:69

destroy

destroy(guildId, reason?): Promise<void>
Parameters
- guildId: string
- reason: string = "destroyed"
Returns Promise<void>
- Defined in audio/QueueController.ts:114

relocate

relocate(guildId, nodeName): Promise<void>
Parameters
- guildId: string
- nodeName: string
Returns Promise<void>
- Defined in audio/QueueController.ts:133

syncAll

syncAll(): Promise<void>
Returns Promise<void>
- Defined in audio/QueueController.ts:147

[LookupSymbol]

[LookupSymbol](guildId): undefined | APIPlayer
Parameters
- guildId: string
Returns undefined | APIPlayer
- Defined in audio/QueueController.ts:157

[OnStateUpdateSymbol]

[OnStateUpdateSymbol](guildId, state): void
Parameters
- guildId: string
- state: PlayerState
Returns void
- Defined in audio/QueueController.ts:161

[OnEventUpdateSymbol]

[OnEventUpdateSymbol](guildId, event): void
Parameters
- guildId: string
- event: EventPayload
Returns void
- Defined in audio/QueueController.ts:185