Class Queue<Context>

constructor

• new Queue<Context>(player, guildId, context?): Queue<Context>

• Type Parameters

  • Context extends Record<string, unknown> = QueueContext

  Parameters

  • player: Player<QueueContext, []>
  • guildId: string
  • Optional context: Context

  Returns Queue<Context>

context

Readonly voice

Readonly filters

Readonly player

node

• get node(): undefined | LavalinkNode

• Returns undefined | LavalinkNode

rest

• get rest(): undefined | REST

• Returns undefined | REST

guildId

• get guildId(): string

• Returns string

volume

• get volume(): number

• Returns number

paused

• get paused(): boolean

• Returns boolean

stopped

• get stopped(): boolean

• Returns boolean

empty

• get empty(): boolean

• Returns boolean

playing

• get playing(): boolean

• Returns boolean

autoplay

• get autoplay(): boolean

• Returns boolean

finished

• get finished(): boolean

• Returns boolean

destroyed

• get destroyed(): boolean

• Returns boolean

repeatMode

• get repeatMode(): RepeatMode

• Returns RepeatMode

hasNext

• get hasNext(): boolean

• Returns boolean

hasPrevious

• get hasPrevious(): boolean

• Returns boolean

track

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

• Returns null | Track<CommonUserData, CommonPluginInfo>

previousTrack

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

• Returns null | Track<CommonUserData, CommonPluginInfo>

tracks

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

• Returns Track<CommonUserData, CommonPluginInfo>[]

previousTracks

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

• Returns Track<CommonUserData, CommonPluginInfo>[]

length

• get length(): number

• Returns number

totalLength

• get totalLength(): number

• Returns number

duration

• get duration(): number

• Returns number

formattedDuration

• get formattedDuration(): string

• Returns string

currentTime

• get currentTime(): number

• Returns number

formattedCurrentTime

• get formattedCurrentTime(): string

• Returns string

sync

• sync(target?): Promise<void>

• Sync queue state with Lavalink

  Parameters

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

    "local" to pull from Lavalink, "remote" to push to Lavalink

  Returns Promise<void>

search

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

• Search for tracks

  Parameters

  • query: string
  • prefix: string = ...

  Returns Promise<SearchResult>

add

• add(source, userData?): this

• Add tracks to the queue

  Parameters

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

  Returns this

addRelated

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

• Add related tracks (for autoplay)

  Parameters

  • Optional refTrack: Track<CommonUserData, CommonPluginInfo>

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

remove

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

• Remove tracks from the queue

  Parameters

  • index: number

  Returns undefined | Track<CommonUserData, CommonPluginInfo>
• remove(indices): Track<CommonUserData, CommonPluginInfo>[]

• Parameters

  • indices: number[]

  Returns Track<CommonUserData, CommonPluginInfo>[]

clear

• clear(type?): void

• Clear tracks from the queue

  Parameters

  • Optional type: "current" | "previous"

  Returns void

jump

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

• Jump to a specific track

  Parameters

  • index: number

  Returns Promise<Track<CommonUserData, CommonPluginInfo>>

pause

• pause(): Promise<boolean>

• Pause playback

  Returns Promise<boolean>

resume

• resume(): Promise<boolean>

• Resume playback

  Returns Promise<boolean>

seek

• seek(ms): Promise<number>

• Seek to a position

  Parameters

  • ms: number

  Returns Promise<number>

next

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

• Play next track

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

previous

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

• Play previous track

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

shuffle

• shuffle(includePrevious?): this

• Shuffle tracks

  Parameters

  • includePrevious: boolean = false

  Returns this

setVolume

• setVolume(volume): Promise<number>

• Set volume

  Parameters

  • volume: number

  Returns Promise<number>

setAutoplay

• setAutoplay(autoplay?): boolean

• Set autoplay

  Parameters

  • autoplay: boolean = false

  Returns boolean

setRepeatMode

• setRepeatMode(repeatMode?): RepeatMode

• Set repeat mode

  Parameters

  • repeatMode: RepeatMode = "none"

  Returns RepeatMode

stop

• stop(): Promise<void>

• Stop playback

  Returns Promise<void>

destroy

• destroy(reason?): Promise<void>

• Destroy the queue

  Parameters

  • Optional reason: string

  Returns Promise<void>

move

• move(from, to): null | Track<CommonUserData, CommonPluginInfo>

• Move a track from one position to another

  Parameters

  • from: number

    Current position of the track
  • to: number

    New position for the track

  Returns null | Track<CommonUserData, CommonPluginInfo>

splice

• splice(index, amount, tracks?): Track<CommonUserData, CommonPluginInfo>[]

• Splice tracks - remove and/or add tracks at a specific position

  Parameters

  • index: number

    Position to start
  • amount: number

    Number of tracks to remove
  • Optional tracks: Track<CommonUserData, CommonPluginInfo> | Track<CommonUserData, CommonPluginInfo>[]

    Tracks to add at the position

  Returns Track<CommonUserData, CommonPluginInfo>[]

sortBy

• sortBy(sortBy, order?): this

• Sort tracks by a property or custom function

  Parameters

  • sortBy: "title" | "author" | "duration" | ((a, b) => number)

    Property name or comparator function
  • order: "asc" | "desc" = "asc"

    Sort order (asc/desc)

  Returns this

toSortedBy

• toSortedBy(sortBy, order?): Track<CommonUserData, CommonPluginInfo>[]

• Get a sorted copy without modifying the original queue

  Parameters

  • sortBy: "title" | "author" | "duration" | ((a, b) => number)
  • order: "asc" | "desc" = "asc"

  Returns Track<CommonUserData, CommonPluginInfo>[]

filterTracks

• filterTracks(predicate): {
      track: Track<CommonUserData, CommonPluginInfo>;
      index: number;
  }[]

• Filter tracks by predicate or criteria

  Parameters

  • predicate: {
        title?: string;
        author?: string;
        duration?: number | {
            min?: number;
            max?: number;
        };
        uri?: string;
        identifier?: string;
        sourceName?: string;
        isStream?: boolean;
        isSeekable?: boolean;
    } | ((track, index) => boolean)

  Returns {
      track: Track<CommonUserData, CommonPluginInfo>;
      index: number;
  }[]

findTrack

• findTrack(predicate): null | {
      track: Track<CommonUserData, CommonPluginInfo>;
      index: number;
  }

• Find a track by predicate or criteria

  Parameters

  • predicate: {
        title?: string;
        author?: string;
        duration?: number | {
            min?: number;
            max?: number;
        };
        uri?: string;
        identifier?: string;
        sourceName?: string;
        isStream?: boolean;
        isSeekable?: boolean;
    } | ((track, index) => boolean)

  Returns null | {
      track: Track<CommonUserData, CommonPluginInfo>;
      index: number;
  }

getTracks

• getTracks(start, end?): Track<CommonUserData, CommonPluginInfo>[]

• Get a range of tracks

  Parameters

  • start: number
  • Optional end: number

  Returns Track<CommonUserData, CommonPluginInfo>[]

shiftPrevious

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

• Shift from previous tracks

  Returns null | Track<CommonUserData, CommonPluginInfo>