Class LavalinkAPI

constructor

• new LavalinkAPI(client): LavalinkAPI

• Parameters

  • client: LavalinkHttpClient

  Returns LavalinkAPI

decodeTrack

• decodeTrack(encodedTrack): Promise<{
      encoded: string;
      info: {
          artworkUrl: string;
          author: string;
          identifier: string;
          isSeekable: boolean;
          isStream: boolean;
          isrc: string;
          length: number;
          position: number;
          sourceName: string;
          title: string;
          uri: string;
      };
      pluginInfo: {
          [x: string]: unknown;
      };
      userData: {
          [x: string]: unknown;
      };
  }>

• Parameters

  • encodedTrack: string

  Returns Promise<{
      encoded: string;
      info: {
          artworkUrl: string;
          author: string;
          identifier: string;
          isSeekable: boolean;
          isStream: boolean;
          isrc: string;
          length: number;
          position: number;
          sourceName: string;
          title: string;
          uri: string;
      };
      pluginInfo: {
          [x: string]: unknown;
      };
      userData: {
          [x: string]: unknown;
      };
  }>

decodeTracks

• decodeTracks(encodedTracks): Promise<readonly {
      encoded: string;
      info: {
          artworkUrl: string;
          author: string;
          identifier: string;
          isSeekable: boolean;
          isStream: boolean;
          isrc: string;
          length: number;
          position: number;
          sourceName: string;
          title: string;
          uri: string;
      };
      pluginInfo: {
          [x: string]: unknown;
      };
      userData: {
          [x: string]: unknown;
      };
  }[]>

• Parameters

  • encodedTracks: string[]

  Returns Promise<readonly {
      encoded: string;
      info: {
          artworkUrl: string;
          author: string;
          identifier: string;
          isSeekable: boolean;
          isStream: boolean;
          isrc: string;
          length: number;
          position: number;
          sourceName: string;
          title: string;
          uri: string;
      };
      pluginInfo: {
          [x: string]: unknown;
      };
      userData: {
          [x: string]: unknown;
      };
  }[]>

info

• info(): Promise<{
      buildTime: number;
      filters: readonly string[];
      git: {
          branch: string;
          commit: string;
          commitTime: number;
      };
      jvm: string;
      lavaplayer: string;
      plugins: readonly {
          name: string;
          version: string;
      }[];
      sourceManagers: readonly string[];
      version: {
          major: number;
          minor: number;
          patch: number;
          preRelease: string;
          semver: string;
      };
  }>

• Returns Promise<{
      buildTime: number;
      filters: readonly string[];
      git: {
          branch: string;
          commit: string;
          commitTime: number;
      };
      jvm: string;
      lavaplayer: string;
      plugins: readonly {
          name: string;
          version: string;
      }[];
      sourceManagers: readonly string[];
      version: {
          major: number;
          minor: number;
          patch: number;
          preRelease: string;
          semver: string;
      };
  }>

loadTracks

• loadTracks(identifier): Promise<{
      data: {
          encoded: string;
          info: {
              artworkUrl: string;
              author: string;
              identifier: string;
              isSeekable: boolean;
              isStream: boolean;
              isrc: string;
              length: number;
              position: number;
              sourceName: string;
              title: string;
              uri: string;
          };
          pluginInfo: {
              [x: string]: unknown;
          };
          userData: {
              [x: string]: unknown;
          };
      };
      loadType: "track";
  } | {
      data: {
          info: {
              name: string;
              selectedTrack: number;
          };
          pluginInfo: {
              [x: string]: unknown;
          };
          tracks: readonly {
              encoded: string;
              info: {
                  artworkUrl: string;
                  author: string;
                  identifier: string;
                  isSeekable: boolean;
                  isStream: boolean;
                  isrc: string;
                  length: number;
                  position: number;
                  sourceName: string;
                  title: string;
                  uri: string;
              };
              pluginInfo: {
                  [x: string]: unknown;
              };
              userData: {
                  [x: string]: unknown;
              };
          }[];
      };
      loadType: "playlist";
  } | {
      data: readonly {
          encoded: string;
          info: {
              artworkUrl: string;
              author: string;
              identifier: string;
              isSeekable: boolean;
              isStream: boolean;
              isrc: string;
              length: number;
              position: number;
              sourceName: string;
              title: string;
              uri: string;
          };
          pluginInfo: {
              [x: string]: unknown;
          };
          userData: {
              [x: string]: unknown;
          };
      }[];
      loadType: "search";
  } | {
      data: null;
      loadType: "empty";
  } | {
      data: {
          cause: string;
          message: string;
          severity: "common" | "suspicious" | "fault";
      };
      loadType: "error";
  }>

• Parameters

  • identifier: string

  Returns Promise<{
      data: {
          encoded: string;
          info: {
              artworkUrl: string;
              author: string;
              identifier: string;
              isSeekable: boolean;
              isStream: boolean;
              isrc: string;
              length: number;
              position: number;
              sourceName: string;
              title: string;
              uri: string;
          };
          pluginInfo: {
              [x: string]: unknown;
          };
          userData: {
              [x: string]: unknown;
          };
      };
      loadType: "track";
  } | {
      data: {
          info: {
              name: string;
              selectedTrack: number;
          };
          pluginInfo: {
              [x: string]: unknown;
          };
          tracks: readonly {
              encoded: string;
              info: {
                  artworkUrl: string;
                  author: string;
                  identifier: string;
                  isSeekable: boolean;
                  isStream: boolean;
                  isrc: string;
                  length: number;
                  position: number;
                  sourceName: string;
                  title: string;
                  uri: string;
              };
              pluginInfo: {
                  [x: string]: unknown;
              };
              userData: {
                  [x: string]: unknown;
              };
          }[];
      };
      loadType: "playlist";
  } | {
      data: readonly {
          encoded: string;
          info: {
              artworkUrl: string;
              author: string;
              identifier: string;
              isSeekable: boolean;
              isStream: boolean;
              isrc: string;
              length: number;
              position: number;
              sourceName: string;
              title: string;
              uri: string;
          };
          pluginInfo: {
              [x: string]: unknown;
          };
          userData: {
              [x: string]: unknown;
          };
      }[];
      loadType: "search";
  } | {
      data: null;
      loadType: "empty";
  } | {
      data: {
          cause: string;
          message: string;
          severity: "common" | "suspicious" | "fault";
      };
      loadType: "error";
  }>

session

• session(id): SessionAPI

• Parameters

  • id: string

  Returns SessionAPI

stats

• stats(): Promise<{
      cpu: {
          cores: number;
          lavalinkLoad: number;
          systemLoad: number;
      };
      frameStats: {
          deficit: number;
          nulled: number;
          sent: number;
      };
      memory: {
          allocated: number;
          free: number;
          reservable: number;
          used: number;
      };
      players: number;
      playingPlayers: number;
      uptime: number;
  }>

• Returns Promise<{
      cpu: {
          cores: number;
          lavalinkLoad: number;
          systemLoad: number;
      };
      frameStats: {
          deficit: number;
          nulled: number;
          sent: number;
      };
      memory: {
          allocated: number;
          free: number;
          reservable: number;
          used: number;
      };
      players: number;
      playingPlayers: number;
      uptime: number;
  }>

version

• version(): Promise<string>

• Returns Promise<string>

Readonly client