Class Queue<T>

constructor

• new Queue<T extends Track = Track>(node: Node, guildId: string): Queue<T>

  Type Parameters

  • T extends Track = Track

  Parameters

  • node: Node
  • guildId: string

  Returns Queue<T>

guildId

node

client

• get client(): Client

  Returns Client

currentPlaybackTrack

• get currentPlaybackTrack(): null | T

  Returns null | T

isPlaying

• get isPlaying(): boolean

  Returns boolean

leaveOnFinish

• get leaveOnFinish(): boolean

  Returns boolean

nextTrack

• get nextTrack(): null | T

  Returns null | T

playbackInfo

• get playbackInfo(): null | PlaybackInfoAudioNodePayload

  Returns null | PlaybackInfoAudioNodePayload

playerState

• get playerState(): AudioPlayerStatus

  Returns AudioPlayerStatus

repeatMode

• get repeatMode(): RepeatMode

  Returns RepeatMode

size

• get size(): number

  Returns number

tracks

• get tracks(): readonly T[]

  Returns readonly T[]

volume

• get volume(): number

  Returns number

addTrack

• addTrack(...track: T[]): void

  Adds tracks to the end of the queue.

  Parameters

  • ...track: T[]

    The tracks to be added.

  Returns void

addTrackFirst

• addTrackFirst(...track: T[]): void

  Adds tracks to the beginning of the queue.

  Parameters

  • ...track: T[]

    The tracks to be added.

  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(): void

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

  Returns void

join

• join(data: Omit<JoinData, "guildId">): void

  Joins a voice channel.

  Parameters

  • data: Omit<JoinData, "guildId">

    The data required to join the channel.

  Returns void

leave

• leave(): void

  Leaves the voice channel.

  Returns void

pause

• pause(): void

  Pauses the playback.

  Returns void

playNext

• playNext(): null | T

  Plays the next track in the queue.

  Returns null | T

  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(): void

  Resumes the playback.

  Returns void

seek

• seek(seconds: number): null | T

  Seek the playback to specific position

  Parameters

  • seconds: number

    in milliseconds

  Returns null | T

setLeaveOnFinish

• setLeaveOnFinish(value: boolean): void

  Set leave on finish state

  Parameters

  • value: boolean

  Returns void

setPlaybackInfo

• setPlaybackInfo(info: PlaybackInfoAudioNodePayload): void

  Set playback info

  Parameters

  • info: PlaybackInfoAudioNodePayload

  Returns void

setPlayerState

• setPlayerState(state: AudioPlayerStatus): void

  set player state

  Parameters

  • state: AudioPlayerStatus

  Returns void

setRepeatMode

• setRepeatMode(mode: RepeatMode): void

  Sets the repeat mode for the queue.

  Parameters

  • mode: RepeatMode

    The repeat mode to be set.

  Returns void

setVolume

• setVolume(volume: number): void

  Sets the volume for playback.

  Parameters

  • volume: number

    The volume level to be set.

  Returns void

shuffleTracks

• shuffleTracks(): void

  Shuffles the tracks in the queue.

  Returns void

skip

• skip(): void

  Skips the current track.

  Returns void

startPing

• startPing(): void

  Starts a ping to keep the playback information updated.

  Returns void

stopPing

• stopPing(): void

  Stops the ping for updating playback information.

  Returns void