Class QueueManager

Queue manager

Hierarchy (View Summary)

GuildIdManager<Queue>
- QueueManager

Index

Constructors

Properties

collection distube

Accessors

client handler options plugins queues size voices

Methods

add create debug emit emitError get has playSong remove

Constructors

constructor

new QueueManager(distube: DisTube): QueueManager
Parameters
- distube: DisTube
Returns QueueManager
Inherited from GuildIdManager.constructor
- Defined in src/core/DisTubeBase.ts:16

Properties

collection

collection: Collection<string, Queue> = ...

The collection of items for this manager.

distube

distube: DisTube

Accessors

client

get client(): Client
Discord.js client

Returns Client
Inherited from GuildIdManager.client
- Defined in src/core/DisTubeBase.ts:61

handler

get handler(): DisTubeHandler
DisTube handler

Returns DisTubeHandler
Inherited from GuildIdManager.handler
- Defined in src/core/DisTubeBase.ts:73

options

get options(): Options
DisTube options

Returns Options
Inherited from GuildIdManager.options
- Defined in src/core/DisTubeBase.ts:67

plugins

get plugins(): DisTubePlugin[]
DisTube plugins

Returns DisTubePlugin[]
Inherited from GuildIdManager.plugins
- Defined in src/core/DisTubeBase.ts:79

queues

get queues(): QueueManager
The queue manager

Returns QueueManager
Inherited from GuildIdManager.queues
- Defined in src/core/DisTubeBase.ts:49

size

get size(): number
The size of the collection.

Returns number
Inherited from GuildIdManager.size
- Defined in src/core/manager/BaseManager.ts:15

voices

get voices(): DisTubeVoiceManager
The voice manager

Returns DisTubeVoiceManager
Inherited from GuildIdManager.voices
- Defined in src/core/DisTubeBase.ts:55

Methods

add

add(idOrInstance: GuildIdResolvable, data: Queue): QueueManager
Parameters
- idOrInstance: GuildIdResolvable
- data: Queue
Returns QueueManager
Inherited from GuildIdManager.add
- Defined in src/core/manager/GuildIdManager.ts:9

create

create(
channel: VoiceBasedChannel,
textChannel?: GuildTextBasedChannel,
): Promise<Queue>
Create a Queue
Parameters
- channel: VoiceBasedChannel
  A voice channel
- OptionaltextChannel: GuildTextBasedChannel
  Default text channel
Returns Promise<Queue>
Returns true if encounter an error
- Defined in src/core/manager/QueueManager.ts:16

debug

debug(message: string): void
Emit debug event
Parameters
- message: string
  debug message
Returns void
Inherited from GuildIdManager.debug
- Defined in src/core/DisTubeBase.ts:43

emit

emit(eventName: keyof DisTubeEvents, ...args: any): boolean
Emit the DisTube of this base
Parameters
- eventName: keyof DisTubeEvents
  Event name
- ...args: any
  arguments
Returns boolean
Inherited from GuildIdManager.emit
- Defined in src/core/DisTubeBase.ts:27

emitError

emitError(error: Error, queue: Queue, song?: Song<unknown>): void
Emit error event
Parameters
- error: Error
  error
- queue: Queue
  The queue encountered the error
- Optionalsong: Song<unknown>
  The playing song when encountered the error
Returns void
Inherited from GuildIdManager.emitError
- Defined in src/core/DisTubeBase.ts:36

get

get(idOrInstance: GuildIdResolvable): undefined | Queue
Parameters
- idOrInstance: GuildIdResolvable
Returns undefined | Queue
Inherited from GuildIdManager.get
- Defined in src/core/manager/GuildIdManager.ts:16

has

has(idOrInstance: GuildIdResolvable): boolean
Parameters
- idOrInstance: GuildIdResolvable
Returns boolean
Inherited from GuildIdManager.has
- Defined in src/core/manager/GuildIdManager.ts:22

playSong

playSong(queue: Queue, emitPlaySong?: boolean): Promise<void>
Play a song on voice connection with queue properties
Parameters
- queue: Queue
  The guild queue to play
- emitPlaySong: boolean = true
  Whether or not emit Events.PLAY_SONG event
Returns Promise<void>
- Defined in src/core/manager/QueueManager.ts:145

remove

remove(idOrInstance: GuildIdResolvable): boolean
Parameters
- idOrInstance: GuildIdResolvable
Returns boolean
Inherited from GuildIdManager.remove
- Defined in src/core/manager/GuildIdManager.ts:19