Class QueueManager

Queue manager

Hierarchy (view full)

GuildIdManager<Queue>
- QueueManager

Index

Constructors

Properties

collection distube

Accessors

client handler options queues size voices

Methods

#emitPlaySong #handlePlayingError #handleSongFinish #voiceEventHandler add create createStream emit emitError get has playSong remove

Constructors

constructor

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

Properties

collection

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

The collection of items for this manager.

distube

distube: DisTube

Accessors

client

get client(): Client<boolean>
Discord.js client

Returns Client<boolean>
Inherited from GuildIdManager.client
- Defined in src/core/DisTubeBase.ts:48

handler

get handler(): DisTubeHandler
DisTube handler

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

options

get options(): Options
DisTube options

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

queues

get queues(): QueueManager
The queue manager

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

size

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

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

voices

get voices(): DisTubeVoiceManager
The voice manager

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

Methods

`Private` #emitPlaySong

#emitPlaySong(queue): boolean
Whether or not emit playSong event
Parameters
- queue: Queue
  Queue
Returns boolean
- Defined in src/core/manager/QueueManager.ts:76

`Private` #handlePlayingError

#handlePlayingError(queue, error): void
Handle error while playing
Parameters
- queue: Queue
  queue
- error: Error
  error
Returns void
- Defined in src/core/manager/QueueManager.ts:137

`Private` #handleSongFinish

#handleSongFinish(queue): Promise<void>
Handle the queue when a Song finish
Parameters
- queue: Queue
  queue
Returns Promise<void>
- Defined in src/core/manager/QueueManager.ts:89

`Private` #voiceEventHandler

#voiceEventHandler(queue): void
Listen to DisTubeVoice events and handle the Queue
Parameters
- queue: Queue
  Queue
Returns void
- Defined in src/core/manager/QueueManager.ts:56

add

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

create

create(channel, song, textChannel?): Promise<true | Queue>
Create a Queue
Parameters
- channel: VoiceBasedChannel
  A voice channel
- song: Song<unknown> | Song<unknown>[]
  First song
- Optional textChannel: GuildTextBasedChannel
  Default text channel
Returns Promise<true | Queue>
Returns true if encounter an error
- Defined in src/core/manager/QueueManager.ts:23

createStream

createStream(queue): DisTubeStream
Create a ytdl stream
Parameters
- queue: Queue
  Queue
Returns DisTubeStream
- Defined in src/core/manager/QueueManager.ts:162

emit

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

emitError

emitError(error, channel?): void
Emit error event
Parameters
- error: Error
  error
- Optional channel: GuildTextBasedChannel
  Text channel where the error is encountered.
Returns void
Inherited from GuildIdManager.emitError
- Defined in src/core/DisTubeBase.ts:30

get

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

has

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

playSong

playSong(queue): Promise<boolean>
Play a song on voice connection
Parameters
- queue: Queue
  The guild queue
Returns Promise<boolean>
error?
- Defined in src/core/manager/QueueManager.ts:190

remove

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