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

node

• get node(): Node

  Returns Node

rest

• get rest(): REST

  Returns 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(): Track<CommonUserData, CommonPluginInfo> | null

  Returns Track<CommonUserData, CommonPluginInfo> | null

previousTrack

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

  Returns Track<CommonUserData, CommonPluginInfo> | null

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?: "local" | "remote"): Promise<void>

  Parameters

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

  Returns Promise<void>

search

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

  Parameters

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

  Returns Promise<SearchResult>

add

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

  Parameters

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

  Returns Queue<Context>

addRelated

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

  Parameters

  • OptionalrefTrack: Track<CommonUserData, CommonPluginInfo>

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

remove

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

  Parameters

  • index: number

  Returns Track<CommonUserData, CommonPluginInfo> | undefined

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

  Parameters

  • indices: number[]

  Returns Track<CommonUserData, CommonPluginInfo>[]

clear

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

  Parameters

  • Optionaltype: "current" | "previous"

  Returns void

jump

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

  Parameters

  • index: number

  Returns Promise<Track<CommonUserData, CommonPluginInfo>>

pause

• pause(): Promise<boolean>

  Returns Promise<boolean>

resume

• resume(): Promise<boolean>

  Returns Promise<boolean>

seek

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

  Parameters

  • ms: number

  Returns Promise<number>

next

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

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

previous

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

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

shuffle

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

  Parameters

  • includePrevious: boolean = false

  Returns Queue<Context>

setVolume

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

  Parameters

  • volume: number

  Returns Promise<number>

setAutoplay

• setAutoplay(autoplay?: boolean): boolean

  Parameters

  • autoplay: boolean = false

  Returns boolean

setRepeatMode

• setRepeatMode(repeatMode?: RepeatMode): RepeatMode

  Parameters

  • repeatMode: RepeatMode = "none"

  Returns RepeatMode

stop

• stop(): Promise<void>

  Returns Promise<void>

destroy

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

  Parameters

  • Optionalreason: string

  Returns Promise<void>