Class Queue

constructor

• new Queue(node: Node, guildId: string): Queue

  Parameters

  • node: Node
  • guildId: string

  Returns Queue

guildId

node

currentPlaybackPosition

• get currentPlaybackPosition(): number

  Gets the current playback position of the track.

  Returns number

  The current playback position of the track.

currentPlaybackTrack

• get currentPlaybackTrack(): null | Track

  Gets the current track being played.

  Returns null | Track

  The current track that is being played or null if none.

guildPlayer

• get guildPlayer(): GuildPlayer

  Gets the LavaPlayer instance associated with the queue.

  Returns GuildPlayer

  The LavaPlayer instance.

http

• get http(): HttpClient

  Returns HttpClient

isPlaying

• get isPlaying(): boolean

  Returns boolean

leaveOnFinish

• get leaveOnFinish(): boolean

  Leave voice channel when track finish

  Returns boolean

nextTrack

• get nextTrack(): undefined | Track

  Gets the next track in the queue.

  Returns undefined | Track

  The next track in the queue or undefined if the queue is empty.

repeatMode

• get repeatMode(): RepeatMode

  Gets the repeat mode of the queue.

  Returns RepeatMode

  The repeat mode.

rest

• get rest(): Rest

  Returns Rest

sessionId

• get sessionId(): string

  Returns string

size

• get size(): number

  Gets the size of the queue.

  Returns number

  The number of tracks in the queue.

tracks

• get tracks(): readonly Track[]

  Gets a read-only array of the tracks in the queue.

  Returns readonly Track[]

  The tracks in the queue.

addTrack

• addTrack(...tracks: Track[]): void

  Adds one or more tracks to the queue.

  Parameters

  • ...tracks: Track[]

    The tracks to be added to the queue.

  Returns void

addTrackFirst

• addTrackFirst(...tracks: Track[]): void

  Adds one or more tracks to top of the queue.

  Parameters

  • ...tracks: Track[]

    The tracks to be added to the queue.

  Returns void

changeTrackPosition

• changeTrackPosition(oldIndex: number, newIndex: number): void

  Changes the position of a track in the queue.

  Parameters

  • oldIndex: number

    The current index of the track.
  • newIndex: number

    The new index for the track.

  Returns void

  Throws

  Will throw an error if the indices are out of bounds.

exit

• exit(): Promise<void>

  Exits the player, clearing the queue and destroying the LavaPlayer instance.

  Returns Promise<void>

pause

• pause(): Promise<void>

  Pauses the current track.

  Returns Promise<void>

playNext

• playNext(): Promise<null | Track>

  Plays the next track in the queue.

  Returns Promise<null | Track>

  The next track that was played or null if the queue is empty.

removeAllTracks

• removeAllTracks(): void

  Removes all tracks from the queue.

  Returns void

removeTracks

• removeTracks(...indices: number[]): void

  Removes tracks from the queue by their indices.

  Parameters

  • ...indices: number[]

    The indices of the tracks to be removed.

  Returns void

resume

• resume(): Promise<void>

  Resumes playing the current track.

  Returns Promise<void>

search

• search(text: string): Promise<TrackResponse>

  Searches for tracks using Lavalink

  Parameters

  • text: string

    The search text input by the user.

  Returns Promise<TrackResponse>

  The response from the Lavalink search.

setPlaybackPosition

• setPlaybackPosition(time: number): void

  Sets the current playback position of the track.

  Parameters

  • time: number

    The new playback position.

  Returns void

setRepeatMode

• setRepeatMode(mode: RepeatMode): void

  Sets the repeat mode of the queue.

  Parameters

  • mode: RepeatMode

    The repeat mode to set.

  Returns void

setVolume

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

  Sets the volume of the player.

  Parameters

  • volume: number

    The new volume level.

  Returns Promise<void>

shuffleTracks

• shuffleTracks(): void

  Shuffles the tracks in the queue.

  Returns void