Variable RoutesConst

Routes: {
    websocket(): "/websocket";
    trackLoading(): "/loadtracks";
    trackDecoding(multiple?): "/decodetrack" | "/decodetracks";
    player(sessionId, guildId?): string;
    session(sessionId): string;
    info(): "/info";
    stats(): "/stats";
    routePlanner(free?): string;
    version(): "/version";
} = ...

An object holding methods that construct API routes based on params

Type declaration

  • websocket:function
  • trackLoading:function
    • Track loading endpoint

      Returns "/loadtracks"

      /loadtracks

  • trackDecoding:function
    • Track decoding endpoint

      Parameters

      • Optional multiple: boolean

        Whether to decode multiple tracks

      Returns "/decodetrack" | "/decodetracks"

      /decodetrack or /decodetracks

  • player:function
    • Player endpoint

      Parameters

      • sessionId: string

        Lavalink session ID

      • Optional guildId: string

        Optional guild ID for specific player

      Returns string

      /sessions/{sessionId}/players or /sessions/{sessionId}/players/{guildId}

  • session:function
    • Session endpoint

      Parameters

      • sessionId: string

        Lavalink session ID

      Returns string

      /sessions/{sessionId}

  • info:function
  • stats:function
  • routePlanner:function
    • Route planner endpoint

      Parameters

      • Optional free: "address" | "all"

        Optional action: address or all

      Returns string

      /routeplanner/status or /routeplanner/free/{action}

  • version:function