lavalink-client 2.2.2 → 2.3.0

package/README.md

@@ -146,7 +146,7 @@ client.lavalink.on("error", (node, error, payload) => {
 - `error` ➡️ `(node, error, payload) => {}`
 - `resumed` ➡️ `(node, payload, players) => {}`
   - Resuming needs to be handled manually by you *(aka add the players to the manager)*
-- e.g.:
+- e.g. of listening to node events:
 ```js
 client.lavalink.nodeManager.on("create", (node, payload) => {
   console.log(`The Lavalink Node #${node.id} connected`);
@@ -212,6 +212,74 @@ client.lavalink.nodeManager.on("resumed", (node, payload, fetchedPlayers) => {
 })
 ```
 
+## Resuming full Example
+Full code sample: can be found on the [Testbot in here](https://github.com/Tomato6966/lavalink-client/blob/main/testBot/Utils/handleResuming.ts)
+```js
+// but here is the schema:
+client.lavalink.nodeManager.on("connect", (node) => node.updateSession(true, 360e3));
+client.lavalink.nodeManager.on("resumed", (node, payload, fetchedPlayers) => {
+  // create players:
+  for(const fetchedPlayer of fetchedPlayers) {
+    // fetchedPlayer is the live data from lavalink
+    // saved Player data is the config you should save in a database / file or smt
+    const savedPlayerData = await getSavedPlayerData(fetchedPlayer.guildId);
+    const player = client.lavalink.createPlayer({
+       guildId: fetchedPlayer.guildId,
+    });
+    // if lavalink says the bot got disconnected, we can skip the resuming, or force reconnect whatever you want!, here we choose to not do anything and thus delete the saved player data
+    if(!data.state.connected) {
+        console.log("skipping resuming player, because it already disconnected");
+        await deletedSavedPlayerData(data.guildId);
+        continue;
+    }
+    // now you can create the player based on the live and saved data
+    const player = client.lavalink.createPlayer({
+        guildId: data.guildId,
+        node: node.id,
+        // you need to update the volume of the player by the volume of lavalink which might got decremented by the volume decrementer
+        volume: client.lavalink.options.playerOptions?.volumeDecrementer
+        ? Math.round(data.volume / client.lavalink.options.playerOptions.volumeDecrementer)
+        : data.volume,
+        // all of the following options are needed to be provided by some sort of player saving
+        voiceChannelId: dataOfSaving.voiceChannelId,
+        textChannelId: dataOfSaving.textChannelId,
+        // all of the following options can either be saved too, or you can use pre-defined defaults
+        selfDeaf: dataOfSaving.options?.selfDeaf || true,
+        selfMute: dataOfSaving.options?.selfMute || false,
+
+        applyVolumeAsFilter: dataOfSaving.options.applyVolumeAsFilter,
+        instaUpdateFiltersFix: dataOfSaving.options.instaUpdateFiltersFix,
+        vcRegion: dataOfSaving.options.vcRegion,
+    });
+
+    // player.voice = data.voice;
+    // normally just player.voice is enough, but if you restart the entire bot, you need to create a new connection, thus call player.connect();
+    await player.connect();
+
+    player.filterManager.data = data.filters; // override the filters data
+    await player.queue.utils.sync(true, false); // get the queue data including the current track (for the requester)
+    // override the current track with the data from lavalink
+    if(data.track) player.queue.current = client.lavalink.utils.buildTrack(data.track, player.queue.current?.requester || client.user);
+    // override the position of the player
+    player.lastPosition = data.state.position;
+    player.lastPositionChange = Date.now();
+    // you can also override the ping of the player, or wait about 30s till it's done automatically
+    player.ping.lavalink = data.state.ping;
+    // important to have skipping work correctly later
+    player.paused = data.paused;
+    player.playing = !data.paused && !!data.track;
+    // That's about it
+  }
+})
+client.lavalink.on("playerUpdate", (oldPlayer, newPlayer) => { // automatically sync player data on updates. if you don'T want to save everything you can instead also just save the data on playerCreate
+    setSavedPlayerData(newPlayer.toJSON());
+});
+// delete the player again
+client.lavalink.on("playerDestroy", (player) => {
+    deleteSavedPlayerData(player.guildId);
+})
+```
+
 ***
 
 
@@ -410,3 +478,29 @@ if(previousTrack) {
     await player.play({ clientTrack: previousTrack });
 }
 ```
+
+
+## **Version 2.3.0**
+
+- Added a heartbeat + ping-pong system to check wether the client is still connected to the node, if the node doesn't receive a ping in time, it will destroy the node and thus cause a reconnect.
+- For that following new nodeOptions got added:
+  - `enablePingOnStatsCheck: boolean` (default: true)
+  - `heartBeatInterval: number` (default: 30_000)
+  - Added new Property on a node:
+    - `isAlive: boolean` (if it's false, then it's not connected to the node anymore, and will AUTOMATICALLY Cause a reconnect within the heartBeatInterval)
+    - `heartBeatPing: number` (the ping it takes lavalink to respond to the acknowledge of heartbeat)
+  - Added new NodeManager Events:
+    - `reconnectinprogress` (when the client internal reconnect system is triggered, the actual reconnect gets triggered by the node after your retryDelay)
+- Refactored internal code for better readability and maintainability
+- Removed several intermediate promises
+- Added new types for better type safety
+- Updated types for better type safety
+- Reduced default retryDelay from 30s to 10s
+- Added example on the testbot how to store player data easily and how to use the resume feature, and updated the Resuming Example in the README [jump](#how-to-do-resuming) by adding a [full example](#resuming-full-example)
+
+- **"Breaking Change" for providing track / clientTrack for player.play()**
+  - Instead of adding the track to the queue and skipping to it, they get directly played by lavalink through replacing the track.
+  - To make this work, we need to pass the transformed requester object to the userData of the track. (all handled by the client)
+  - *This is technically better than skipping to a track but i wanted to point it out.*
+    - You can play with clientTrack like this: `player.play({ clientTrack: searchResult.tracks[0] })`
+    - You can play with just track like this: `player.play({ track: { encoded: "base64string..." }, requester: interaction.user })`

package/dist/cjs/index.d.ts

@@ -5,5 +5,11 @@ export * from "./structures/Node";
 export * from "./structures/NodeManager";
 export * from "./structures/Player";
 export * from "./structures/Queue";
-export * from "./structures/Track";
 export * from "./structures/Utils";
+export * from "./structures/Types/Track";
+export * from "./structures/Types/Utils";
+export * from "./structures/Types/Filters";
+export * from "./structures/Types/Player";
+export * from "./structures/Types/Queue";
+export * from "./structures/Types/Node";
+export * from "./structures/Constants";

package/dist/cjs/index.js

@@ -8,5 +8,11 @@ tslib_1.__exportStar(require("./structures/Node"), exports);
 tslib_1.__exportStar(require("./structures/NodeManager"), exports);
 tslib_1.__exportStar(require("./structures/Player"), exports);
 tslib_1.__exportStar(require("./structures/Queue"), exports);
-tslib_1.__exportStar(require("./structures/Track"), exports);
 tslib_1.__exportStar(require("./structures/Utils"), exports);
+tslib_1.__exportStar(require("./structures/Types/Track"), exports);
+tslib_1.__exportStar(require("./structures/Types/Utils"), exports);
+tslib_1.__exportStar(require("./structures/Types/Filters"), exports);
+tslib_1.__exportStar(require("./structures/Types/Player"), exports);
+tslib_1.__exportStar(require("./structures/Types/Queue"), exports);
+tslib_1.__exportStar(require("./structures/Types/Node"), exports);
+tslib_1.__exportStar(require("./structures/Constants"), exports);

package/dist/cjs/structures/Constants.d.ts

@@ -0,0 +1,40 @@
+import type { AudioOutputs, ChannelMixFilter, EQBand } from "./Types/Filters";
+export declare enum DestroyReasons {
+    QueueEmpty = "QueueEmpty",
+    NodeDestroy = "NodeDestroy",
+    NodeDeleted = "NodeDeleted",
+    LavalinkNoVoice = "LavalinkNoVoice",
+    NodeReconnectFail = "NodeReconnectFail",
+    Disconnected = "Disconnected",
+    PlayerReconnectFail = "PlayerReconnectFail",
+    ChannelDeleted = "ChannelDeleted",
+    DisconnectAllNodes = "DisconnectAllNodes",
+    ReconnectAllNodes = "ReconnectAllNodes"
+}
+export declare const validSponsorBlocks: string[];
+/**  The audio Outputs Data map declaration */
+export declare const audioOutputsData: Record<AudioOutputs, ChannelMixFilter>;
+export declare const EQList: {
+    /** A Bassboost Equalizer, so high it distorts the audio */
+    BassboostEarrape: EQBand[];
+    /** A High and decent Bassboost Equalizer */
+    BassboostHigh: EQBand[];
+    /** A decent Bassboost Equalizer */
+    BassboostMedium: EQBand[];
+    /** A slight Bassboost Equalizer */
+    BassboostLow: EQBand[];
+    /** Makes the Music slightly "better" */
+    BetterMusic: EQBand[];
+    /** Makes the Music sound like rock music / sound rock music better */
+    Rock: EQBand[];
+    /** Makes the Music sound like Classic music / sound Classic music better */
+    Classic: EQBand[];
+    /** Makes the Music sound like Pop music / sound Pop music better */
+    Pop: EQBand[];
+    /** Makes the Music sound like Electronic music / sound Electronic music better */
+    Electronic: EQBand[];
+    /** Boosts all Bands slightly for louder and fuller sound */
+    FullSound: EQBand[];
+    /** Boosts basses + lower highs for a pro gaming sound */
+    Gaming: EQBand[];
+};

package/dist/cjs/structures/Constants.js

@@ -0,0 +1,244 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EQList = exports.audioOutputsData = exports.validSponsorBlocks = exports.DestroyReasons = void 0;
+var DestroyReasons;
+(function (DestroyReasons) {
+    DestroyReasons["QueueEmpty"] = "QueueEmpty";
+    DestroyReasons["NodeDestroy"] = "NodeDestroy";
+    DestroyReasons["NodeDeleted"] = "NodeDeleted";
+    DestroyReasons["LavalinkNoVoice"] = "LavalinkNoVoice";
+    DestroyReasons["NodeReconnectFail"] = "NodeReconnectFail";
+    DestroyReasons["Disconnected"] = "Disconnected";
+    DestroyReasons["PlayerReconnectFail"] = "PlayerReconnectFail";
+    DestroyReasons["ChannelDeleted"] = "ChannelDeleted";
+    DestroyReasons["DisconnectAllNodes"] = "DisconnectAllNodes";
+    DestroyReasons["ReconnectAllNodes"] = "ReconnectAllNodes";
+})(DestroyReasons || (exports.DestroyReasons = DestroyReasons = {}));
+;
+exports.validSponsorBlocks = ["sponsor", "selfpromo", "interaction", "intro", "outro", "preview", "music_offtopic", "filler"];
+/**  The audio Outputs Data map declaration */
+exports.audioOutputsData = {
+    mono: {
+        leftToLeft: 0.5,
+        leftToRight: 0.5,
+        rightToLeft: 0.5,
+        rightToRight: 0.5,
+    },
+    stereo: {
+        leftToLeft: 1,
+        leftToRight: 0,
+        rightToLeft: 0,
+        rightToRight: 1,
+    },
+    left: {
+        leftToLeft: 1,
+        leftToRight: 0,
+        rightToLeft: 1,
+        rightToRight: 0,
+    },
+    right: {
+        leftToLeft: 0,
+        leftToRight: 1,
+        rightToLeft: 0,
+        rightToRight: 1,
+    },
+};
+exports.EQList = {
+    /** A Bassboost Equalizer, so high it distorts the audio */
+    BassboostEarrape: [
+        { band: 0, gain: 0.6 * 0.375 },
+        { band: 1, gain: 0.67 * 0.375 },
+        { band: 2, gain: 0.67 * 0.375 },
+        { band: 3, gain: 0.4 * 0.375 },
+        { band: 4, gain: -0.5 * 0.375 },
+        { band: 5, gain: 0.15 * 0.375 },
+        { band: 6, gain: -0.45 * 0.375 },
+        { band: 7, gain: 0.23 * 0.375 },
+        { band: 8, gain: 0.35 * 0.375 },
+        { band: 9, gain: 0.45 * 0.375 },
+        { band: 10, gain: 0.55 * 0.375 },
+        { band: 11, gain: -0.6 * 0.375 },
+        { band: 12, gain: 0.55 * 0.375 },
+        { band: 13, gain: -0.5 * 0.375 },
+        { band: 14, gain: -0.75 * 0.375 },
+    ],
+    /** A High and decent Bassboost Equalizer */
+    BassboostHigh: [
+        { band: 0, gain: 0.6 * 0.25 },
+        { band: 1, gain: 0.67 * 0.25 },
+        { band: 2, gain: 0.67 * 0.25 },
+        { band: 3, gain: 0.4 * 0.25 },
+        { band: 4, gain: -0.5 * 0.25 },
+        { band: 5, gain: 0.15 * 0.25 },
+        { band: 6, gain: -0.45 * 0.25 },
+        { band: 7, gain: 0.23 * 0.25 },
+        { band: 8, gain: 0.35 * 0.25 },
+        { band: 9, gain: 0.45 * 0.25 },
+        { band: 10, gain: 0.55 * 0.25 },
+        { band: 11, gain: -0.6 * 0.25 },
+        { band: 12, gain: 0.55 * 0.25 },
+        { band: 13, gain: -0.5 * 0.25 },
+        { band: 14, gain: -0.75 * 0.25 },
+    ],
+    /** A decent Bassboost Equalizer */
+    BassboostMedium: [
+        { band: 0, gain: 0.6 * 0.1875 },
+        { band: 1, gain: 0.67 * 0.1875 },
+        { band: 2, gain: 0.67 * 0.1875 },
+        { band: 3, gain: 0.4 * 0.1875 },
+        { band: 4, gain: -0.5 * 0.1875 },
+        { band: 5, gain: 0.15 * 0.1875 },
+        { band: 6, gain: -0.45 * 0.1875 },
+        { band: 7, gain: 0.23 * 0.1875 },
+        { band: 8, gain: 0.35 * 0.1875 },
+        { band: 9, gain: 0.45 * 0.1875 },
+        { band: 10, gain: 0.55 * 0.1875 },
+        { band: 11, gain: -0.6 * 0.1875 },
+        { band: 12, gain: 0.55 * 0.1875 },
+        { band: 13, gain: -0.5 * 0.1875 },
+        { band: 14, gain: -0.75 * 0.1875 },
+    ],
+    /** A slight Bassboost Equalizer */
+    BassboostLow: [
+        { band: 0, gain: 0.6 * 0.125 },
+        { band: 1, gain: 0.67 * 0.125 },
+        { band: 2, gain: 0.67 * 0.125 },
+        { band: 3, gain: 0.4 * 0.125 },
+        { band: 4, gain: -0.5 * 0.125 },
+        { band: 5, gain: 0.15 * 0.125 },
+        { band: 6, gain: -0.45 * 0.125 },
+        { band: 7, gain: 0.23 * 0.125 },
+        { band: 8, gain: 0.35 * 0.125 },
+        { band: 9, gain: 0.45 * 0.125 },
+        { band: 10, gain: 0.55 * 0.125 },
+        { band: 11, gain: -0.6 * 0.125 },
+        { band: 12, gain: 0.55 * 0.125 },
+        { band: 13, gain: -0.5 * 0.125 },
+        { band: 14, gain: -0.75 * 0.125 },
+    ],
+    /** Makes the Music slightly "better" */
+    BetterMusic: [
+        { band: 0, gain: 0.25 },
+        { band: 1, gain: 0.025 },
+        { band: 2, gain: 0.0125 },
+        { band: 3, gain: 0 },
+        { band: 4, gain: 0 },
+        { band: 5, gain: -0.0125 },
+        { band: 6, gain: -0.025 },
+        { band: 7, gain: -0.0175 },
+        { band: 8, gain: 0 },
+        { band: 9, gain: 0 },
+        { band: 10, gain: 0.0125 },
+        { band: 11, gain: 0.025 },
+        { band: 12, gain: 0.25 },
+        { band: 13, gain: 0.125 },
+        { band: 14, gain: 0.125 },
+    ],
+    /** Makes the Music sound like rock music / sound rock music better */
+    Rock: [
+        { band: 0, gain: 0.300 },
+        { band: 1, gain: 0.250 },
+        { band: 2, gain: 0.200 },
+        { band: 3, gain: 0.100 },
+        { band: 4, gain: 0.050 },
+        { band: 5, gain: -0.050 },
+        { band: 6, gain: -0.150 },
+        { band: 7, gain: -0.200 },
+        { band: 8, gain: -0.100 },
+        { band: 9, gain: -0.050 },
+        { band: 10, gain: 0.050 },
+        { band: 11, gain: 0.100 },
+        { band: 12, gain: 0.200 },
+        { band: 13, gain: 0.250 },
+        { band: 14, gain: 0.300 },
+    ],
+    /** Makes the Music sound like Classic music / sound Classic music better */
+    Classic: [
+        { band: 0, gain: 0.375 },
+        { band: 1, gain: 0.350 },
+        { band: 2, gain: 0.125 },
+        { band: 3, gain: 0 },
+        { band: 4, gain: 0 },
+        { band: 5, gain: 0.125 },
+        { band: 6, gain: 0.550 },
+        { band: 7, gain: 0.050 },
+        { band: 8, gain: 0.125 },
+        { band: 9, gain: 0.250 },
+        { band: 10, gain: 0.200 },
+        { band: 11, gain: 0.250 },
+        { band: 12, gain: 0.300 },
+        { band: 13, gain: 0.250 },
+        { band: 14, gain: 0.300 },
+    ],
+    /** Makes the Music sound like Pop music / sound Pop music better */
+    Pop: [
+        { band: 0, gain: 0.2635 },
+        { band: 1, gain: 0.22141 },
+        { band: 2, gain: -0.21141 },
+        { band: 3, gain: -0.1851 },
+        { band: 4, gain: -0.155 },
+        { band: 5, gain: 0.21141 },
+        { band: 6, gain: 0.22456 },
+        { band: 7, gain: 0.237 },
+        { band: 8, gain: 0.237 },
+        { band: 9, gain: 0.237 },
+        { band: 10, gain: -0.05 },
+        { band: 11, gain: -0.116 },
+        { band: 12, gain: 0.192 },
+        { band: 13, gain: 0 },
+    ],
+    /** Makes the Music sound like Electronic music / sound Electronic music better */
+    Electronic: [
+        { band: 0, gain: 0.375 },
+        { band: 1, gain: 0.350 },
+        { band: 2, gain: 0.125 },
+        { band: 3, gain: 0 },
+        { band: 4, gain: 0 },
+        { band: 5, gain: -0.125 },
+        { band: 6, gain: -0.125 },
+        { band: 7, gain: 0 },
+        { band: 8, gain: 0.25 },
+        { band: 9, gain: 0.125 },
+        { band: 10, gain: 0.15 },
+        { band: 11, gain: 0.2 },
+        { band: 12, gain: 0.250 },
+        { band: 13, gain: 0.350 },
+        { band: 14, gain: 0.400 },
+    ],
+    /** Boosts all Bands slightly for louder and fuller sound */
+    FullSound: [
+        { band: 0, gain: 0.25 + 0.375 },
+        { band: 1, gain: 0.25 + 0.025 },
+        { band: 2, gain: 0.25 + 0.0125 },
+        { band: 3, gain: 0.25 + 0 },
+        { band: 4, gain: 0.25 + 0 },
+        { band: 5, gain: 0.25 + -0.0125 },
+        { band: 6, gain: 0.25 + -0.025 },
+        { band: 7, gain: 0.25 + -0.0175 },
+        { band: 8, gain: 0.25 + 0 },
+        { band: 9, gain: 0.25 + 0 },
+        { band: 10, gain: 0.25 + 0.0125 },
+        { band: 11, gain: 0.25 + 0.025 },
+        { band: 12, gain: 0.25 + 0.375 },
+        { band: 13, gain: 0.25 + 0.125 },
+        { band: 14, gain: 0.25 + 0.125 },
+    ],
+    /** Boosts basses + lower highs for a pro gaming sound */
+    Gaming: [
+        { band: 0, gain: 0.350 },
+        { band: 1, gain: 0.300 },
+        { band: 2, gain: 0.250 },
+        { band: 3, gain: 0.200 },
+        { band: 4, gain: 0.150 },
+        { band: 5, gain: 0.100 },
+        { band: 6, gain: 0.050 },
+        { band: 7, gain: -0.0 },
+        { band: 8, gain: -0.050 },
+        { band: 9, gain: -0.100 },
+        { band: 10, gain: -0.150 },
+        { band: 11, gain: -0.200 },
+        { band: 12, gain: -0.250 },
+        { band: 13, gain: -0.300 },
+        { band: 14, gain: -0.350 },
+    ],
+};

package/dist/cjs/structures/CustomSearches/BandCampSearch.d.ts

@@ -1,3 +1,3 @@
-import { Player } from "../Player";
-import { UnresolvedSearchResult } from "../Utils";
+import type { Player } from "../Player";
+import type { UnresolvedSearchResult } from "../Types/Utils";
 export declare const bandCampSearch: (player: Player, query: string, requestUser: unknown) => Promise<UnresolvedSearchResult>;

package/dist/cjs/structures/Filters.d.ts

@@ -1,5 +1,5 @@
-import { Player } from "./Player";
-import { FloatNumber, IntegerNumber } from "./Utils";
+import type { Player } from "./Player";
+import type { AudioOutputs, EQBand, FilterData, PlayerFilters, TimescaleFilter } from "./Types/Filters";
 /**
  * The FilterManager for each player
  */
@@ -143,218 +143,3 @@ export declare class FilterManager {
     /** Clears the equalizer bands. */
     clearEQ(): Promise<this>;
 }
-/** The Audio Outputs type */
-export type AudioOutputs = "mono" | "stereo" | "left" | "right";
-/**  The audio Outputs Data map declaration */
-export declare const audioOutputsData: Record<AudioOutputs, ChannelMixFilter>;
-/** The "active" / "disabled" Player Filters */
-export interface PlayerFilters {
-    /** Sets nightcore to false, and vaporwave to false */
-    custom: boolean;
-    /** Sets custom to false, and vaporwave to false */
-    nightcore: boolean;
-    /** Sets custom to false, and nightcore to false */
-    vaporwave: boolean;
-    /** If rotation filter is enabled / not */
-    rotation: boolean;
-    /** if karaoke filter is enabled / not */
-    karaoke: boolean;
-    /** if tremolo filter is enabled / not */
-    tremolo: boolean;
-    /** if vibrato filter is enabled / not */
-    vibrato: boolean;
-    lowPass: boolean;
-    /** audio Output (default stereo, mono sounds the fullest and best for not-stereo tracks) */
-    audioOutput: AudioOutputs;
-    /** Lavalink Volume FILTER (not player Volume, think of it as a gain booster) */
-    volume: boolean;
-    /** Filters for the Lavalink Filter Plugin */
-    lavalinkFilterPlugin: {
-        /** if echo filter is enabled / not */
-        echo: boolean;
-        /** if reverb filter is enabled / not */
-        reverb: boolean;
-    };
-    lavalinkLavaDspxPlugin: {
-        /** if lowPass filter is enabled / not */
-        lowPass: boolean;
-        /** if highPass filter is enabled / not */
-        highPass: boolean;
-        /** if normalization filter is enabled / not */
-        normalization: boolean;
-        /** if echo filter is enabled / not */
-        echo: boolean;
-    };
-}
-/**
- * There are 15 bands (0-14) that can be changed.
- * "gain" is the multiplier for the given band.
- * The default value is 0.
- *  Valid values range from -0.25 to 1.0, where -0.25 means the given band is completely muted, and 0.25 means it is doubled.
- * Modifying the gain could also change the volume of the output.
- */
-export interface EQBand {
-    /** On what band position (0-14) it should work */
-    band: IntegerNumber | number;
-    /** The gain (-0.25 to 1.0) */
-    gain: FloatNumber | number;
-}
-/**
- * Uses equalization to eliminate part of a band, usually targeting vocals.
- */
-export interface KaraokeFilter {
-    /** The level (0 to 1.0 where 0.0 is no effect and 1.0 is full effect) */
-    level?: number;
-    /** The mono level (0 to 1.0 where 0.0 is no effect and 1.0 is full effect) */
-    monoLevel?: number;
-    /** The filter band (in Hz) */
-    filterBand?: number;
-    /**	The filter width */
-    filterWidth?: number;
-}
-/**
- * Changes the speed, pitch, and rate
- */
-export interface TimescaleFilter {
-    /** The playback speed 0.0 ≤ x */
-    speed?: number;
-    /** The pitch 0.0 ≤ x */
-    pitch?: number;
-    /** The rate 0.0 ≤ x */
-    rate?: number;
-}
-/**
- * Uses amplification to create a shuddering effect, where the volume quickly oscillates.
- * Demo: https://en.wikipedia.org/wiki/File:Fuse_Electronics_Tremolo_MK-III_Quick_Demo.ogv
- */
-export interface TremoloFilter {
-    /** The frequency 0.0 < x */
-    frequency?: number;
-    /** The tremolo depth 0.0 < x ≤ 1.0 */
-    depth?: number;
-}
-/**
- * Similar to tremolo. While tremolo oscillates the volume, vibrato oscillates the pitch.
- */
-export interface VibratoFilter {
-    /** The frequency 0.0 < x ≤ 14.0 */
-    frequency?: number;
-    /** The vibrato depth 0.0 < x ≤ 1.0 */
-    depth?: number;
-}
-/**
- * Rotates the sound around the stereo channels/user headphones (aka Audio Panning).
- * It can produce an effect similar to https://youtu.be/QB9EB8mTKcc (without the reverb).
- */
-export interface RotationFilter {
-    /** The frequency of the audio rotating around the listener in Hz. 0.2 is similar to the example video above */
-    rotationHz?: number;
-}
-/**
- * Distortion effect. It can generate some pretty unique audio effects.
- */
-export interface DistortionFilter {
-    sinOffset?: number;
-    sinScale?: number;
-    cosOffset?: number;
-    cosScale?: number;
-    tanOffset?: number;
-    tanScale?: number;
-    offset?: number;
-    scale?: number;
-}
-/**
- * Mixes both channels (left and right), with a configurable factor on how much each channel affects the other.
- * With the defaults, both channels are kept independent of each other.
- * Setting all factors to 0.5 means both channels get the same audio.
- */
-export interface ChannelMixFilter {
-    /** The left to left channel mix factor (0.0 ≤ x ≤ 1.0) */
-    leftToLeft?: number;
-    /** The left to right channel mix factor (0.0 ≤ x ≤ 1.0) */
-    leftToRight?: number;
-    /** The right to left channel mix factor (0.0 ≤ x ≤ 1.0) */
-    rightToLeft?: number;
-    /** The right to right channel mix factor (0.0 ≤ x ≤ 1.0) */
-    rightToRight?: number;
-}
-/**
- * Higher frequencies get suppressed, while lower frequencies pass through this filter, thus the name low pass.
- * Any smoothing values equal to or less than 1.0 will disable the filter.
- */
-export interface LowPassFilter {
-    /** The smoothing factor (1.0 < x) */
-    smoothing?: number;
-}
-/**
- * Filter Data stored in the Client and partially sent to Lavalink
- */
-export interface FilterData {
-    volume?: number;
-    karaoke?: KaraokeFilter;
-    timescale?: TimescaleFilter;
-    tremolo?: TremoloFilter;
-    vibrato?: VibratoFilter;
-    rotation?: RotationFilter;
-    distortion?: DistortionFilter;
-    channelMix?: ChannelMixFilter;
-    lowPass?: LowPassFilter;
-    pluginFilters?: {
-        "lavalink-filter-plugin"?: {
-            "echo"?: {
-                delay?: number;
-                decay?: number;
-            };
-            "reverb"?: {
-                delays?: number[];
-                gains?: number[];
-            };
-        };
-        "high-pass"?: {
-            cutoffFrequency?: number;
-            boostFactor?: number;
-        };
-        "low-pass"?: {
-            cutoffFrequency?: number;
-            boostFactor?: number;
-        };
-        normalization?: {
-            maxAmplitude?: number;
-            adaptive?: boolean;
-        };
-        echo?: {
-            echoLength?: number;
-            decay?: number;
-        };
-    };
-}
-/**
- * Actual Filter Data sent to Lavalink
- */
-export interface LavalinkFilterData extends FilterData {
-    equalizer?: EQBand[];
-}
-export declare const EQList: {
-    /** A Bassboost Equalizer, so high it distorts the audio */
-    BassboostEarrape: EQBand[];
-    /** A High and decent Bassboost Equalizer */
-    BassboostHigh: EQBand[];
-    /** A decent Bassboost Equalizer */
-    BassboostMedium: EQBand[];
-    /** A slight Bassboost Equalizer */
-    BassboostLow: EQBand[];
-    /** Makes the Music slightly "better" */
-    BetterMusic: EQBand[];
-    /** Makes the Music sound like rock music / sound rock music better */
-    Rock: EQBand[];
-    /** Makes the Music sound like Classic music / sound Classic music better */
-    Classic: EQBand[];
-    /** Makes the Music sound like Pop music / sound Pop music better */
-    Pop: EQBand[];
-    /** Makes the Music sound like Electronic music / sound Electronic music better */
-    Electronic: EQBand[];
-    /** Boosts all Bands slightly for louder and fuller sound */
-    FullSound: EQBand[];
-    /** Boosts basses + lower highs for a pro gaming sound */
-    Gaming: EQBand[];
-};