Class Queue

Represents a queue.

Hierarchy (View Summary)

DisTubeBase
- Queue

Constructors

constructor

new Queue(
    distube: DisTube,
    voice: DisTubeVoice,
    textChannel?: GuildTextBasedChannel,
): Queue
Create a queue for the guild
Parameters
- distube: DisTube
  DisTube
- voice: DisTubeVoice
  Voice connection
- OptionaltextChannel: GuildTextBasedChannel
  Default text channel
Returns Queue
Overrides DisTubeBase.constructor
- Defined in src/struct/Queue.ts:94

Properties

`Internal`_beginTime

_beginTime: number

What time in the song to begin (in seconds).

`Optional` `Internal`_listeners

_listeners?: DisTubeVoiceEvents

DisTubeVoice listener

`Internal`_manualUpdate

_manualUpdate: boolean

Whether or not the queue is being updated manually (skip, jump, previous)

`Internal`_taskQueue

_taskQueue: TaskQueue

Task queuing system

autoplay

autoplay: boolean

Whether or not the autoplay mode is enabled. Default value: false

distube

distube: DisTube

ffmpegArgs

ffmpegArgs: FFmpegArgs

FFmpeg arguments for the current queue. Default value is defined with DisTubeOptions.ffmpeg.args. af output argument will be replaced with Queue#filters manager

`Readonly`id

id: string

Queue id (Guild id)

paused

paused: boolean

Whether or not the stream is currently paused.

playing

playing: boolean

Whether or not the queue is active.

Note: This remains true when paused. It only becomes false when stopped.

Deprecated

Use !queue.paused to check if audio is playing. Will be removed in v6.0.

previousSongs

previousSongs: Song<unknown>[]

List of the previous songs.

repeatMode

repeatMode: RepeatMode

Type of repeat mode (0 is disabled, 1 is repeating a song, 2 is repeating all the queue). Default value: 0 (disabled)

songs

songs: Song<unknown>[]

List of songs in the queue (The first one is the playing song)

stopped

stopped: boolean

Whether stream is currently stopped.

`Optional`textChannel

textChannel?: GuildTextBasedChannel

The text channel of the Queue. (Default: where the first command is called).

voice

voice: DisTubeVoice

Voice connection of this queue.

Accessors

client

get client(): Client
Discord.js client

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

clientMember

get clientMember(): GuildMember | undefined
The client user as a GuildMember of this queue's guild

Returns GuildMember | undefined
- Defined in src/struct/Queue.ts:138

currentTime

get currentTime(): number
What time in the song is playing (in seconds).

Returns number
- Defined in src/struct/Queue.ts:162

duration

get duration(): number
Queue's duration.

Returns number
- Defined in src/struct/Queue.ts:156

filters

get filters(): FilterManager
The filter manager of the queue

Returns FilterManager
- Defined in src/struct/Queue.ts:144

formattedCurrentTime

get formattedCurrentTime(): string
Formatted Queue#currentTime string.

Returns string
- Defined in src/struct/Queue.ts:168

formattedDuration

get formattedDuration(): string
Formatted duration string.

Returns string
- Defined in src/struct/Queue.ts:150

handler

get handler(): DisTubeHandler
DisTube handler

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

options

get options(): Options
DisTube options

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

plugins

get plugins(): DisTubePlugin[]
DisTube plugins

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

queues

get queues(): QueueManager
The queue manager

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

voiceChannel

get voiceChannel(): VoiceBasedChannel | null
The voice channel playing in.

Returns VoiceBasedChannel | null
- Defined in src/struct/Queue.ts:174

voices

get voices(): DisTubeVoiceManager
The voice manager

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

volume

get volume(): number
Get or set the stream volume. Default value: 50.

Returns number
- Defined in src/struct/Queue.ts:180
set volume(value: number): void
Parameters
- value: number
Returns void
- Defined in src/struct/Queue.ts:183

Methods

_addRelatedSong

_addRelatedSong(song?: Song<unknown>): Promise<Song<unknown>>
Internal
Internal implementation of addRelatedSong without task queue protection. Used by methods that already hold the task queue lock.
Parameters
- Optionalsong: Song<unknown>
Returns Promise<Song<unknown>>
- Defined in src/struct/Queue.ts:399

addRelatedSong

addRelatedSong(song?: Song<unknown>): Promise<Song<unknown>>
Add a related song of the playing song to the queue
Parameters
- Optionalsong: Song<unknown>
  The song to get related songs from. Defaults to the current playing song.
Returns Promise<Song<unknown>>
The added song
- Defined in src/struct/Queue.ts:422

addToQueue

addToQueue(song: Song<unknown> | Song<unknown>[], position?: number): Queue
Parameters
- song: Song<unknown> | Song<unknown>[]
  Song to add
- position: number = 0
  Position to add, <= 0 to add to the end of the queue
Returns Queue
The guild queue

Throws
- Defined in src/struct/Queue.ts:192

debug

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

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 DisTubeBase.emit
- Defined in src/core/DisTubeBase.ts:24

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 DisTubeBase.emitError
- Defined in src/core/DisTubeBase.ts:33

isPaused

isPaused(): boolean
Returns boolean
true if the queue is paused

Deprecated
Use queue.paused property instead. Will be removed in v6.0.
- Defined in src/struct/Queue.ts:221

isPlaying

isPlaying(): boolean
Returns boolean
true if the queue is active (not stopped)

Deprecated
Use !queue.paused to check if audio is playing. Will be removed in v6.0.
- Defined in src/struct/Queue.ts:214

jump

jump(position: number, options?: JumpOptions): Promise<Song<unknown>>
Jump to the song position in the queue. The next one is 1, 2,... The previous one is -1, -2,... if num is invalid number
Parameters
- position: number
  The song position to play
- Optionaloptions: JumpOptions
  Skip options
Returns Promise<Song<unknown>>
The new Song will be played
- Defined in src/struct/Queue.ts:324

pause

pause(): Promise<Queue>
Pause the guild stream

Returns Promise<Queue>
The guild queue
- Defined in src/struct/Queue.ts:228

play

play(emitPlaySong?: boolean): Promise<void>
Play the first song in the queue
Parameters
- emitPlaySong: boolean = true
  Whether or not emit Events.PLAY_SONG event
Returns Promise<void>
- Defined in src/struct/Queue.ts:467

previous(): Promise<Song<unknown>>
Play the previous song if exists

Returns Promise<Song<unknown>>
The guild queue
- Defined in src/struct/Queue.ts:279

remove

remove(): void
Remove the queue from the manager

Returns void
- Defined in src/struct/Queue.ts:445

resume

resume(): Promise<Queue>
Resume the guild stream

Returns Promise<Queue>
The guild queue
- Defined in src/struct/Queue.ts:243

seek

seek(time: number): Promise<Queue>
Set the playing time to another position
Parameters
- time: number
  Time in seconds
Returns Promise<Queue>
The guild queue
- Defined in src/struct/Queue.ts:377

setRepeatMode

setRepeatMode(mode?: RepeatMode): RepeatMode
Set the repeat mode of the guild queue. Toggle mode (Disabled -> Song -> Queue -> Disabled ->...) if mode is undefined
Parameters
- Optionalmode: RepeatMode
  The repeat modes (toggle if undefined)
Returns RepeatMode
The new repeat mode
- Defined in src/struct/Queue.ts:363

setVolume

setVolume(percent: number): Queue
Set the guild stream's volume
Parameters
- percent: number
  The percentage of volume you want to set
Returns Queue
The guild queue
- Defined in src/struct/Queue.ts:259

shuffle

shuffle(): Promise<Queue>
Shuffle the queue's songs

Returns Promise<Queue>
The guild queue
- Defined in src/struct/Queue.ts:301

skip

skip(options?: JumpOptions): Promise<Song<unknown>>
Skip the playing song if there is a next song in the queue. If Queue#autoplay is true and there is no up next song, DisTube will add and play a related song.
Parameters
- Optionaloptions: JumpOptions
  Skip options
Returns Promise<Song<unknown>>
The song will skip to
- Defined in src/struct/Queue.ts:271

stop

stop(): Promise<void>
Stop the guild stream and delete the queue

Returns Promise<void>
- Defined in src/struct/Queue.ts:433

toggleAutoplay

toggleAutoplay(): boolean
Toggle autoplay mode

Returns boolean
Autoplay mode state
- Defined in src/struct/Queue.ts:459

Class Queue

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns Queue

Properties

Internal_beginTime

Optional Internal_listeners

Internal_manualUpdate

Internal_taskQueue

autoplay

distube

ffmpegArgs

Readonlyid

paused

playing

Deprecated

previousSongs

repeatMode

songs

stopped

OptionaltextChannel

voice

Accessors

client

Returns Client

clientMember

Returns GuildMember | undefined

currentTime

Returns number

duration

Returns number

filters

Returns FilterManager

formattedCurrentTime

Returns string

formattedDuration

Returns string

handler

Returns DisTubeHandler

options

Returns Options

plugins

Returns DisTubePlugin[]

queues

Returns QueueManager

voiceChannel

Returns VoiceBasedChannel | null

voices

Returns DisTubeVoiceManager

volume

Returns number

Parameters

Returns void

Methods

_addRelatedSong

Parameters

Returns Promise<Song<unknown>>

addRelatedSong

Parameters

Returns Promise<Song<unknown>>

addToQueue

Parameters

Returns Queue

Throws

debug

Parameters

Returns void

emit

Parameters

Returns boolean

emitError

Parameters

Returns void

`Internal`_beginTime

`Optional` `Internal`_listeners

`Internal`_manualUpdate

`Internal`_taskQueue

`Readonly`id

`Optional`textChannel