Class Queue<Context>

constructor

• new Queue<Context extends Record<string, unknown> = QueueContext>(
      player: Player,
      guildId: string,
      context?: Context,
  ): Queue<Context>

  Type Parameters

  • Context extends Record<string, unknown> = QueueContext

  Parameters

  • player: Player
  • guildId: string
  • Optionalcontext: Context

  Returns Queue<Context>

context

Readonlyvoice

Readonlyfilters

Readonlyplayer

[LastTrackSymbol]

node

• get node(): Node

  Node of this queue

  Returns Node

rest

• get rest(): REST

  Alias for node.rest

  Returns REST

guildId

• get guildId(): string

  Id of the guild

  Returns string

volume

• get volume(): number

  Volume of the lavalink player

  Returns number

paused

• get paused(): boolean

  Whether the lavalink player is paused

  Returns boolean

stopped

• get stopped(): boolean

  Whether the queue has a track but the lavalink player doesn't

  Returns boolean

empty

• get empty(): boolean

  Whether the queue is truly empty (no previous, current, or next tracks)

  Returns boolean

playing

• get playing(): boolean

  Whether a track is present and also playing in the lavalink player

  Returns boolean

autoplay

• get autoplay(): boolean

  Whether autoplay is enabled

  Returns boolean

finished

• get finished(): boolean

  Whether the queue has no current or next tracks

  Returns boolean

destroyed

• get destroyed(): boolean

  Whether this queue instance is destroyed

  Returns boolean

repeatMode

• get repeatMode(): RepeatMode

  The repeat mode of this queue

  Returns RepeatMode

hasNext

• get hasNext(): boolean

  Whether the queue has a next track

  Returns boolean

hasPrevious

• get hasPrevious(): boolean

  Whether the queue has a previous track

  Returns boolean

track

• get track(): Track<CommonUserData, CommonPluginInfo> | null

  The current track

  Returns Track<CommonUserData, CommonPluginInfo> | null

previousTrack

• get previousTrack(): Track<CommonUserData, CommonPluginInfo> | null

  The previous track

  Returns Track<CommonUserData, CommonPluginInfo> | null

tracks

• get tracks(): Track<CommonUserData, CommonPluginInfo>[]

  Current and next tracks

  Returns Track<CommonUserData, CommonPluginInfo>[]

previousTracks

• get previousTracks(): Track<CommonUserData, CommonPluginInfo>[]

  Previous tracks

  Returns Track<CommonUserData, CommonPluginInfo>[]

length

• get length(): number

  Number of current and next tracks

  Returns number

totalLength

• get totalLength(): number

  Number of previous, current, and next tracks

  Returns number

duration

• get duration(): number

  Duration of current and next tracks (excluding live tracks)

  Returns number

formattedDuration

• get formattedDuration(): string

  Formatted duration of current and next tracks (excluding live tracks)

  Returns string

currentTime

• get currentTime(): number

  Position in milliseconds of the current track

  Returns number

formattedCurrentTime

• get formattedCurrentTime(): string

  Formatted position in milliseconds of the current track

  Returns string

sync

• sync(target?: "local" | "remote"): Promise<void>

  Sync lavalink player data

  Parameters

  • target: "local" | "remote" = "local"

    Target to update (local for queue, remote for node)

  Returns Promise<void>

search

• search(query: string, prefix?: string): Promise<SearchResult>

  Search for tracks with the queue's node

  Parameters

  • query: string

    Search terms or url

  • prefix: string = ...

    Query prefix

  Returns Promise<SearchResult>

add

• add(
      source:
          | Track<CommonUserData, CommonPluginInfo>
          | Track<CommonUserData, CommonPluginInfo>[]
          | Playlist<CommonPluginInfo>,
      userData?: JsonObject,
  ): Queue<Context>

  Add a track, list of tracks, or playlist to the queue

  Parameters

  • source:
        | Track<CommonUserData, CommonPluginInfo>
        | Track<CommonUserData, CommonPluginInfo>[]
        | Playlist<CommonPluginInfo>

    track, list of tracks, or playlist

  • OptionaluserData: JsonObject

    Object to shallow merge in all track's user data

  Returns Queue<Context>

addRelated

• addRelated(
      refTrack?: Track<CommonUserData, CommonPluginInfo>,
  ): Promise<Track<CommonUserData, CommonPluginInfo>[]>

  Add related tracks to the queue

  Parameters

  • OptionalrefTrack: Track<CommonUserData, CommonPluginInfo>

    Track to use as reference

  Returns Promise<Track<CommonUserData, CommonPluginInfo>[]>

remove

• remove(index: number): Track<CommonUserData, CommonPluginInfo> | undefined

  Remove one track from the queue

  Parameters

  • index: number

    zero-based position of the track

  Returns Track<CommonUserData, CommonPluginInfo> | undefined

• remove(indices: number[]): Track<CommonUserData, CommonPluginInfo>[]

  Remove multiple tracks from the queue

  Parameters

  • indices: number[]

    zero-based positions of tracks to remove

  Returns Track<CommonUserData, CommonPluginInfo>[]

clear

• clear(type?: "current" | "previous"): void

  Remove tracks by type (all if none specified)

  Parameters

  • Optionaltype: "current" | "previous"

    Type of tracks (current for current and next, previous for previous)

  Returns void

  Remarks

  current track is only removed if its stopped

jump

• jump(index: number): Promise<Track<CommonUserData, CommonPluginInfo>>

  Jump to a specific track in queue

  Parameters

  • index: number

    zero-based position of the track

  Returns Promise<Track<CommonUserData, CommonPluginInfo>>

  Remarks

  this will absolutely play and trigger corresponding track events

pause

• pause(): Promise<boolean>

  Pause the lavalink player

  Returns Promise<boolean>

resume

• resume(): Promise<boolean>

  Unpause the lavalink player and play the current track if its present but stopped

  Returns Promise<boolean>

seek

• seek(ms: number): Promise<number>

  Jump to a specific position in the current track

  Parameters

  • ms: number

    Position in milliseconds

  Returns Promise<number>

next

• next(): Promise<Track<CommonUserData, CommonPluginInfo> | null>

  Play the next track in queue

  Returns Promise<Track<CommonUserData, CommonPluginInfo> | null>

previous

• previous(): Promise<Track<CommonUserData, CommonPluginInfo> | null>

  Play the previous track in queue

  Returns Promise<Track<CommonUserData, CommonPluginInfo> | null>

shuffle

• shuffle(includePrevious?: boolean): Queue<Context>

  Shuffle the next tracks in queue

  Parameters

  • includePrevious: boolean = false

    Whether to include previous tracks

  Returns Queue<Context>

setVolume

• setVolume(volume: number): Promise<number>

  Set the lavalink player's volume

  Parameters

  • volume: number

    Numeric value between 0 and 1000

  Returns Promise<number>

setAutoplay

• setAutoplay(autoplay?: boolean): boolean

  Set autoplay mode

  Parameters

  • autoplay: boolean = false

    Whether autoplay should be enabled

  Returns boolean

setRepeatMode

• setRepeatMode(repeatMode?: RepeatMode): RepeatMode

  Set repeat mode

  Parameters

  • repeatMode: RepeatMode = "none"

    Repeat mode (none for default, track for track, queue for queue)

  Returns RepeatMode

stop

• stop(): Promise<void>

  Stop the current track in lavalink player

  Returns Promise<void>

destroy

• destroy(reason?: string): Promise<void>

  Destroy this queue instance

  Parameters

  • Optionalreason: string

    Reason for destroying

  Returns Promise<void>