Class SessionAPI

client

• get client(): LavalinkHttpClient

• Returns LavalinkHttpClient

constructor

• new SessionAPI(lavalink, id): SessionAPI

• Parameters

  • lavalink: LavalinkAPI

  • id: string

  Returns SessionAPI

player

• player(id): PlayerAPI

• Parameters

  • id: string

  Returns PlayerAPI

players

• players(): Promise<readonly {
      filters: {
          channelMix?: {
              leftToLeft?: number;
              leftToRight?: number;
              rightToLeft?: number;
              rightToRight?: number;
          };
          distortion?: {
              cosOffset?: number;
              cosScale?: number;
              offset?: number;
              scale?: number;
              sinOffset?: number;
              sinScale?: number;
              tanOffset?: number;
              tanScale?: number;
          };
          equalizer?: readonly { readonly band: number; readonly gain?: number; }[];
          karaoke?: {
              filterBand?: number;
              filterWidth?: number;
              level?: number;
              monoLevel?: number;
          };
          lowPass?: {
              smoothing?: number;
          };
          pluginFilters?: {
              [x: string]: unknown;
          };
          rotation?: {
              rotationHz?: number;
          };
          timescale?: {
              pitch?: number;
              rate?: number;
              speed?: number;
          };
          tremolo?: {
              depth?: number;
              frequency?: number;
          };
          vibrato?: {
              depth?: number;
              frequency?: number;
          };
          volume?: number;
      };
      guildId: string;
      paused: boolean;
      state: {
          connected: boolean;
          ping: number;
          position: number;
          time: number;
      };
      track: {
          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;
          };
      };
      voice: {
          endpoint: string;
          sessionId: string;
          token: string;
      };
      volume: number;
  }[]>

• Returns Promise<readonly {
      filters: {
          channelMix?: {
              leftToLeft?: number;
              leftToRight?: number;
              rightToLeft?: number;
              rightToRight?: number;
          };
          distortion?: {
              cosOffset?: number;
              cosScale?: number;
              offset?: number;
              scale?: number;
              sinOffset?: number;
              sinScale?: number;
              tanOffset?: number;
              tanScale?: number;
          };
          equalizer?: readonly { readonly band: number; readonly gain?: number; }[];
          karaoke?: {
              filterBand?: number;
              filterWidth?: number;
              level?: number;
              monoLevel?: number;
          };
          lowPass?: {
              smoothing?: number;
          };
          pluginFilters?: {
              [x: string]: unknown;
          };
          rotation?: {
              rotationHz?: number;
          };
          timescale?: {
              pitch?: number;
              rate?: number;
              speed?: number;
          };
          tremolo?: {
              depth?: number;
              frequency?: number;
          };
          vibrato?: {
              depth?: number;
              frequency?: number;
          };
          volume?: number;
      };
      guildId: string;
      paused: boolean;
      state: {
          connected: boolean;
          ping: number;
          position: number;
          time: number;
      };
      track: {
          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;
          };
      };
      voice: {
          endpoint: string;
          sessionId: string;
          token: string;
      };
      volume: number;
  }[]>

update

• update(body): Promise<{
      resuming: boolean;
      timeout: number;
  }>

• Parameters

  • body: {
        resuming?: boolean;
        timeout?: number;
    }

    • Optional Readonly resuming?: boolean

    • Optional Readonly timeout?: number

  Returns Promise<{
      resuming: boolean;
      timeout: number;
  }>

Readonly id

Readonly lavalink