Class Queue

constructor

• new Queue(distube, voice, song, textChannel?): Queue

• Create a queue for the guild

  Parameters

  • distube: DisTube

    DisTube
  • voice: DisTubeVoice

    Voice connection
  • song: Song<unknown> | Song<unknown>[]

    First song(s)
  • Optional textChannel: GuildTextBasedChannel

    Default text channel

  Returns Queue

Optional _emptyTimeout

Optional _listeners

_next

_prev

_taskQueue

autoplay

beginTime

Readonly id

paused

playing

previousSongs

repeatMode

songs

stopped

Optional textChannel

voice

clientMember

• get clientMember(): undefined | GuildMember

• The client user as a GuildMember of this queue's guild

  Returns undefined | GuildMember

currentTime

• get currentTime(): number

• What time in the song is playing (in seconds).

  Returns number

duration

• get duration(): number

• Queue's duration.

  Returns number

filters

• get filters(): FilterManager

• The filter manager of the queue

  Returns FilterManager

formattedCurrentTime

• get formattedCurrentTime(): string

• Formatted Queue#currentTime string.

  Returns string

formattedDuration

• get formattedDuration(): string

• Formatted duration string.

  Returns string

voiceChannel

• get voiceChannel(): null | VoiceBasedChannel

• The voice channel playing in.

  Returns null | VoiceBasedChannel

volume

• get volume(): number

• Returns number

• set volume(value): void

• Parameters

  • value: number

  Returns void

addRelatedSong

• addRelatedSong(): Promise<Song<unknown>>

• Add a related song of the playing song to the queue

  Returns Promise<Song<unknown>>

  The added song

addToQueue

• addToQueue(song, position?): 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

jump

• jump(position): 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

  Returns Promise<Song<unknown>>

  The new Song will be played

pause

• pause(): Queue

• Pause the guild stream

  Returns Queue

  The guild queue

previous

• previous(): Promise<Song<unknown>>

• Play the previous song if exists

  Returns Promise<Song<unknown>>

  The guild queue

remove

• remove(): void

• Remove the queue from the manager (This does not leave the voice channel even if DisTubeOptions.leaveOnStop is enabled)

  Returns void

resume

• resume(): Queue

• Resume the guild stream

  Returns Queue

  The guild queue

seek

• seek(time): Queue

• Set the playing time to another position

  Parameters

  • time: number

    Time in seconds

  Returns Queue

  The guild queue

setRepeatMode

• setRepeatMode(mode?): RepeatMode

• Set the repeat mode of the guild queue. Toggle mode (Disabled -> Song -> Queue -> Disabled ->...) if mode is undefined

  Parameters

  • Optional mode: RepeatMode

    The repeat modes (toggle if undefined)

  Returns RepeatMode

  The new repeat mode

setVolume

• setVolume(percent): Queue

• Set the guild stream's volume

  Parameters

  • percent: number

    The percentage of volume you want to set

  Returns Queue

  The guild queue

shuffle

• shuffle(): Promise<Queue>

• Shuffle the queue's songs

  Returns Promise<Queue>

  The guild queue

skip

• skip(): 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.

  Returns Promise<Song<unknown>>

  The song will skip to

stop

• stop(): Promise<void>

• Stop the guild stream and delete the queue

  Returns Promise<void>

toggleAutoplay

• toggleAutoplay(): boolean

• Toggle autoplay mode

  Returns boolean

  Autoplay mode state