Class Player<Context, Plugins>

constructor

• new Player<Context, Plugins>(options): Player<Context, Plugins>

• Type Parameters

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

  Parameters

  • options: PlayerOptions<Plugins>

  Returns Player<Context, Plugins>

Readonly options

Readonly plugins

Readonly nodes

Readonly voices

Readonly queues

ready

• get ready(): boolean

• Whether the player is initialized and ready

  Returns boolean

clientId

• get clientId(): null | string

• The bot's client ID

  Returns null | string

init

• init(clientId): Promise<void>

• Initialize the player

  Parameters

  • clientId: string

    Bot client ID

  Returns Promise<void>

getQueue

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

• Returns the queue of a guild

  Parameters

  • guildId: string

    Id of the guild

  Returns undefined | Queue<Context>

createQueue

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

• Creates a queue from options

  Parameters

  • options: CreateQueueOptions<Context>

    Options to create from

  Returns Promise<Queue<Context>>

destroyQueue

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

• Destroys the queue of a guild

  Parameters

  • guildId: string

    Id of the guild
  • Optional reason: string

    Reason for destroying

  Returns Promise<void>

search

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

• Searches for results based on query and options

  Parameters

  • query: string

    Query (or URL as well)
  • Optional options: SearchOptions

    Options for customization

  Returns Promise<SearchResult>

play

• play(source, options): 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, CommonUserData>

    Options for customization

  Returns Promise<Queue<Context>>

jump

• jump(guildId, index): 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): Promise<boolean>

• Pauses the queue of a guild

  Parameters

  • guildId: string

    Id of the guild

  Returns Promise<boolean>

previous

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

• Plays the previous track in queue of a guild

  Parameters

  • guildId: string

    Id of the guild

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

resume

• resume(guildId): Promise<boolean>

• Resumes the queue of a guild

  Parameters

  • guildId: string

    Id of the guild

  Returns Promise<boolean>

seek

• seek(guildId, ms): 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, autoplay?): boolean

• Enables or disables autoplay for the queue of a guild

  Parameters

  • guildId: string

    Id of the guild
  • Optional autoplay: boolean

    Whether to enable autoplay

  Returns boolean

setRepeatMode

• setRepeatMode(guildId, 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, volume): 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, includePrevious?): Queue<Context>

• Shuffles tracks for the queue of a guild

  Parameters

  • guildId: string

    Id of the guild
  • Optional includePrevious: boolean

    Whether to pull previous tracks to current

  Returns Queue<Context>

next

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

• Plays the next track in queue of a guild

  Parameters

  • guildId: string

    Id of the guild

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

stop

• stop(guildId): Promise<void>

• Stops the queue of a guild

  Parameters

  • guildId: string

    Id of the guild

  Returns Promise<void>