Class RainlinkRest

constructor

• new RainlinkRest(manager, options, nodeManager): RainlinkRest

• The lavalink rest server handler class

  Parameters

  • manager: Rainlink

    The rainlink manager
  • options: RainlinkNodeOptions

    The rainlink node options, from RainlinkNodeOptions interface
  • nodeManager: RainlinkNode

    The rainlink's lavalink server handler class

  Returns RainlinkRest

manager

nodeManager

getPlayers

• getPlayers(): Promise<LavalinkPlayer[]>

• Gets all the player with the specified sessionId

  Returns Promise<LavalinkPlayer[]>

  Promise that resolves to an array of Lavalink players

getStatus

• getStatus(): Promise<undefined | LavalinkStats>

• Gets current lavalink status

  Returns Promise<undefined | LavalinkStats>

  Promise that resolves to an object of current lavalink status

decodeTrack

• decodeTrack(base64track): Promise<undefined | RawTrack>

• Decode a single track from "encoded" properties

  Parameters

  • base64track: string

  Returns Promise<undefined | RawTrack>

  Promise that resolves to an object of raw track

updatePlayer

• updatePlayer(data): Promise<void>

• Updates a Lavalink player

  Parameters

  • data: UpdatePlayerInfo

  Returns Promise<void>

  Promise that resolves to a Lavalink player

destroyPlayer

• destroyPlayer(guildId): Promise<void>

• Destroy a Lavalink player

  Parameters

  • guildId: string

  Returns Promise<void>

  Promise that resolves to a Lavalink player

resolver

• resolver(data): Promise<undefined | LavalinkResponse>

• A track resolver function to get track from lavalink

  Parameters

  • data: string

  Returns Promise<undefined | LavalinkResponse>

  LavalinkResponse

getRoutePlannerStatus

• getRoutePlannerStatus(): Promise<undefined | RoutePlanner>

• Get routeplanner status from Lavalink

  Returns Promise<undefined | RoutePlanner>

  Promise that resolves to a routeplanner response

unmarkFailedAddress

• unmarkFailedAddress(address): Promise<void>

• Release blacklisted IP address into pool of IPs

  Parameters

  • address: string

    IP address

  Returns Promise<void>

getInfo

• getInfo(): Promise<undefined | NodeInfo>

• Get Lavalink info

  Returns Promise<undefined | NodeInfo>