Class REST

constructor

• new REST(options): REST

• Parameters

  • options: RESTOptions

  Returns REST

Readonly userAgent

origin

• get origin(): string

• Returns string

sessionId

• get sessionId(): null | string

• Returns null | string

• set sessionId(value): void

• Parameters

  • value: null | string

  Returns void

loadTracks

• loadTracks(identifier): Promise<LoadResult>

• Load tracks from a query or URL

  Parameters

  • identifier: string

  Returns Promise<LoadResult>

decodeTrack

• decodeTrack(encoded): Promise<APITrack<CommonUserData, CommonPluginInfo>>

• Decode a single track

  Parameters

  • encoded: string

  Returns Promise<APITrack<CommonUserData, CommonPluginInfo>>

decodeTracks

• decodeTracks(encoded): Promise<APITrack<CommonUserData, CommonPluginInfo>[]>

• Decode multiple tracks

  Parameters

  • encoded: string[]

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

fetchPlayers

• fetchPlayers(): Promise<APIPlayer[]>

• Fetch all players for a session

  Returns Promise<APIPlayer[]>

fetchPlayer

• fetchPlayer(guildId): Promise<APIPlayer>

• Fetch a specific player

  Parameters

  • guildId: string

  Returns Promise<APIPlayer>

updatePlayer

• updatePlayer(guildId, data, params?): Promise<APIPlayer>

• Update a player

  Parameters

  • guildId: string
  • data: PlayerUpdateRequestBody
  • Optional params: PlayerUpdateQueryParams

  Returns Promise<APIPlayer>

destroyPlayer

• destroyPlayer(guildId): Promise<void>

• Destroy a player

  Parameters

  • guildId: string

  Returns Promise<void>

updateSession

• updateSession(data): Promise<Required<SessionUpdateRequestBody>>

• Update session configuration

  Parameters

  • data: SessionUpdateRequestBody

  Returns Promise<Required<SessionUpdateRequestBody>>

fetchInfo

• fetchInfo(): Promise<LavalinkInfo>

• Fetch Lavalink server info

  Returns Promise<LavalinkInfo>

fetchStats

• fetchStats(): Promise<NodeStats>

• Fetch node statistics

  Returns Promise<NodeStats>

fetchVersion

• fetchVersion(): Promise<string>

• Fetch Lavalink version

  Returns Promise<string>

fetchRoutePlannerStatus

• fetchRoutePlannerStatus(): Promise<RoutePlannerStatus>

• Fetch route planner status

  Returns Promise<RoutePlannerStatus>

freeRoutePlannerAddress

• freeRoutePlannerAddress(address): Promise<void>

• Free a specific address from the route planner

  Parameters

  • address: string

  Returns Promise<void>

freeAllRoutePlannerAddresses

• freeAllRoutePlannerAddresses(): Promise<void>

• Free all addresses from the route planner

  Returns Promise<void>

setSponsorBlock

• setSponsorBlock(guildId, segments): Promise<void>

• Set SponsorBlock segments for a player

  Parameters

  • guildId: string
  • segments: string[]

  Returns Promise<void>

getSponsorBlock

• getSponsorBlock(guildId): Promise<string[]>

• Get current SponsorBlock segments for a player

  Parameters

  • guildId: string

  Returns Promise<string[]>

deleteSponsorBlock

• deleteSponsorBlock(guildId): Promise<void>

• Delete SponsorBlock configuration for a player

  Parameters

  • guildId: string

  Returns Promise<void>