Class Player<Context, Plugins>

constructor

• new Player<
      Context extends Record<string, unknown> = QueueContext,
      Plugins extends PlayerPlugin<{}>[] = [],
  >(
      options: PlayerOptions<Plugins>,
  ): Player<Context, Plugins>

  Type Parameters

  • Context extends Record<string, unknown> = QueueContext
  • Plugins extends PlayerPlugin<{}>[] = []

  Parameters

  • options: PlayerOptions<Plugins>

  Returns Player<Context, Plugins>

Readonlyoptions

Readonlyplugins

Readonlynodes

Readonlyvoices

Readonlyqueues

ready

• get ready(): boolean

  Returns boolean

clientId

• get clientId(): string | null

  Returns string | null

init

• init(clientId: string): Promise<void>

  Parameters

  • clientId: string

  Returns Promise<void>

getQueue

• getQueue(guildId: string): Queue<Context> | undefined

  Returns the queue of a guild

  Parameters

  • guildId: string

    Id of the guild

  Returns Queue<Context> | undefined

createQueue

• createQueue(options: CreateQueueOptions<Context>): Promise<Queue<Context>>

  Creates a queue from options

  Parameters

  • options: CreateQueueOptions<Context>

    Options to create from

  Returns Promise<Queue<Context>>

destroyQueue

• destroyQueue(guildId: string, reason?: string): Promise<void>

  Destroys the queue of a guild

  Parameters

  • guildId: string

    Id of the guild

  • Optionalreason: string

    Reason for destroying

  Returns Promise<void>

search

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

  Searches for results based on query and options

  Parameters

  • query: string

    Query (or URL as well)

  • Optionaloptions: SearchOptions

    Options for customization

  Returns Promise<SearchResult>

play

• play(
      source:
          | string
          | Track<CommonUserData, CommonPluginInfo>
          | Track<CommonUserData, CommonPluginInfo>[]
          | Playlist<CommonPluginInfo>,
      options: PlayOptions<Context>,
  ): Promise<Queue<Context>>

  Adds or searches if source is query and resumes the queue if stopped

  Parameters

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

    Source to play from

  • options: PlayOptions<Context>

    Options for customization

  Returns Promise<Queue<Context>>

jump

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

  Jumps to the specified index in queue of a guild

  Parameters

  • guildId: string

    Id of the guild

  • index: number

    Index to jump to

  Returns Promise<Track<CommonUserData, CommonPluginInfo>>

pause

• pause(guildId: string): Promise<boolean>

  Pauses the queue of a guild

  Parameters

  • guildId: string

    Id of the guild

  Returns Promise<boolean>

previous

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

  Plays the previous track in queue of a guild

  Parameters

  • guildId: string

    Id of the guild

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

resume

• resume(guildId: string): Promise<boolean>

  Resumes the queue of a guild

  Parameters

  • guildId: string

    Id of the guild

  Returns Promise<boolean>

seek

• seek(guildId: string, ms: number): Promise<number>

  Seeks to a position in the current track of a guild

  Parameters

  • guildId: string

    Id of the guild

  • ms: number

    Position in milliseconds

  Returns Promise<number>

setAutoplay

• setAutoplay(guildId: string, autoplay?: boolean): boolean

  Enables or disables autoplay for the queue of a guild

  Parameters

  • guildId: string

    Id of the guild

  • Optionalautoplay: boolean

    Whether to enable autoplay

  Returns boolean

setRepeatMode

• setRepeatMode(guildId: string, repeatMode: RepeatMode): RepeatMode

  Sets the repeat mode for the queue of a guild

  Parameters

  • guildId: string

    Id of the guild

  • repeatMode: RepeatMode

    The repeat mode

  Returns RepeatMode

setVolume

• setVolume(guildId: string, volume: number): Promise<number>

  Sets the volume of the queue of a guild

  Parameters

  • guildId: string

    Id of the guild

  • volume: number

    The volume to set

  Returns Promise<number>

shuffle

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

  Shuffles tracks for the queue of a guild

  Parameters

  • guildId: string

    Id of the guild

  • OptionalincludePrevious: boolean

    Whether to pull previous tracks to current

  Returns Queue<Context>

next

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

  Plays the next track in queue of a guild

  Parameters

  • guildId: string

    Id of the guild

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

stop

• stop(guildId: string): Promise<void>

  Stops the queue of a guild

  Parameters

  • guildId: string

    Id of the guild

  Returns Promise<void>

init

• init(): void

  Returns void

nodeConnect

• nodeConnect(node: Node, reconnects: number): void

  Parameters

  • node: Node
  • reconnects: number

  Returns void

nodeReady

• nodeReady(node: Node, resumed: boolean, sessionId: string): void

  Parameters

  • node: Node
  • resumed: boolean
  • sessionId: string

  Returns void

nodeDispatch

• nodeDispatch(node: Node, payload: MessagePayload): void

  Parameters

  • node: Node
  • payload: MessagePayload

  Returns void

nodeError

• nodeError(node: Node, error: Error): void

  Parameters

  • node: Node
  • error: Error

  Returns void

nodeClose

• nodeClose(node: Node, code: number, reason: string): void

  Parameters

  • node: Node
  • code: number
  • reason: string

  Returns void

nodeDisconnect

• nodeDisconnect(node: Node, code: number, reason: string, byLocal: boolean): void

  Parameters

  • node: Node
  • code: number
  • reason: string
  • byLocal: boolean

  Returns void

voiceConnect

• voiceConnect(voice: VoiceState): void

  Parameters

  • voice: VoiceState

  Returns void

voiceClose

• voiceClose(
      voice: VoiceState,
      code: number,
      reason: string,
      byRemote: boolean,
  ): void

  Parameters

  • voice: VoiceState
  • code: number
  • reason: string
  • byRemote: boolean

  Returns void

voiceChange

• voiceChange(voice: VoiceState, previousNode: Node, wasPlaying: boolean): void

  Parameters

  • voice: VoiceState
  • previousNode: Node
  • wasPlaying: boolean

  Returns void

voiceDestroy

• voiceDestroy(voice: VoiceState, reason: string): void

  Parameters

  • voice: VoiceState
  • reason: string

  Returns void

queueCreate

• queueCreate(queue: Queue<QueueContext>): void

  Parameters

  • queue: Queue<QueueContext>

  Returns void

queueUpdate

• queueUpdate(queue: Queue<QueueContext>, state: PlayerState): void

  Parameters

  • queue: Queue<QueueContext>
  • state: PlayerState

  Returns void

queueFinish

• queueFinish(queue: Queue<QueueContext>): void

  Parameters

  • queue: Queue<QueueContext>

  Returns void

queueDestroy

• queueDestroy(queue: Queue<QueueContext>, reason: string): void

  Parameters

  • queue: Queue<QueueContext>
  • reason: string

  Returns void

trackStart

• trackStart(
      queue: Queue<QueueContext>,
      track: Track<CommonUserData, CommonPluginInfo>,
      inQueue: boolean,
  ): void

  Parameters

  • queue: Queue<QueueContext>
  • track: Track<CommonUserData, CommonPluginInfo>
  • inQueue: boolean

  Returns void

trackStuck

• trackStuck(
      queue: Queue<QueueContext>,
      track: Track<CommonUserData, CommonPluginInfo>,
      thresholdMs: number,
      inQueue: boolean,
  ): void

  Parameters

  • queue: Queue<QueueContext>
  • track: Track<CommonUserData, CommonPluginInfo>
  • thresholdMs: number
  • inQueue: boolean

  Returns void

trackError

• trackError(
      queue: Queue<QueueContext>,
      track: Track<CommonUserData, CommonPluginInfo>,
      exception: Exception,
      inQueue: boolean,
  ): void

  Parameters

  • queue: Queue<QueueContext>
  • track: Track<CommonUserData, CommonPluginInfo>
  • exception: Exception
  • inQueue: boolean

  Returns void

trackFinish

• trackFinish(
      queue: Queue<QueueContext>,
      track: Track<CommonUserData, CommonPluginInfo>,
      reason: TrackEndReason,
      inQueue: boolean,
  ): void

  Parameters

  • queue: Queue<QueueContext>
  • track: Track<CommonUserData, CommonPluginInfo>
  • reason: TrackEndReason
  • inQueue: boolean

  Returns void