lavalink-client 2.3.4 → 2.3.6

package/README.md

@@ -106,6 +106,198 @@ Check out the [Documentation](https://lc4.gitbook.io/lavalink-client) | or the [
 
 ***
 
+# Sample Configuration
+
+
+<details><summary>Complete Configuration Example, with all available options</summary>
+
+```ts
+import { LavalinkManager, QueueChangesWatcher, QueueStoreManager } from "lavalink-client";
+import { RedisClientType } from "redis"; // example for custom queue store
+import { Client, GatewayIntentBits } from "discord.js"; // example for a discord bot
+
+// you might want to extend the types of the client, to bind lavalink to it.
+const client = new Client({
+    intents: [
+        GatewayIntentBits.Guilds,
+        GatewayIntentBits.GuildVoiceStates,
+    ]
+});
+
+const previouslyUsedSessions = new Map<string, string>(); //nodeManager.on("connect", node => previouslyUsedSessions.set(node.id, node.sessionId))
+
+client.lavalink = new LavalinkManager({
+    nodes: [
+        {
+            authorization: "localhoist",
+            host: "localhost",
+            port: 2333,
+            id: "testnode",
+            // get the previously used session, to restart with "resuming" enabled
+            sessionId: previouslyUsedSessions.get("testnode"),
+            requestSignalTimeoutMS: 3000,
+            closeOnError: true,
+            heartBeatInterval: 30_000,
+            enablePingOnStatsCheck: true,
+            retryDelay: 10e3,
+            secure: false,
+            retryAmount: 5,
+        }
+    ],
+    sendToShard: (guildId, payload) => client.guilds.cache.get(guildId)?.shard?.send(payload),
+    autoSkip: true,
+    client: { // client: client.user
+        id: envConfig.clientId, // REQUIRED! (at least after the .init)
+        username: "TESTBOT",
+    },
+    autoSkipOnResolveError: true, // skip song, if resolving an unresolved song fails
+    emitNewSongsOnly: true, // don't emit "looping songs"
+    playerOptions: {
+        // These are the default prevention methods
+        maxErrorsPerTime: {
+            threshold: 10_000,
+            maxAmount: 3,
+        },
+        // only allow an autoplay function to execute, if the previous function was longer ago than this number.
+        minAutoPlayMs: 10_000,
+
+        applyVolumeAsFilter: false,
+        clientBasedPositionUpdateInterval: 50, // in ms to up-calc player.position
+        defaultSearchPlatform: "ytmsearch",
+        volumeDecrementer: 0.75, // on client 100% == on lavalink 75%
+        requesterTransformer: requesterTransformer,
+        onDisconnect: {
+            autoReconnect: true, // automatically attempts a reconnect, if the bot disconnects from the voice channel, if it fails, it get's destroyed
+            destroyPlayer: false // overrides autoReconnect and directly destroys the player if the bot disconnects from the vc
+        },
+        onEmptyQueue: {
+            destroyAfterMs: 30_000, // 0 === instantly destroy | don't provide the option, to don't destroy the player
+            autoPlayFunction: autoPlayFunction,
+        },
+        useUnresolvedData: true,
+    },
+    queueOptions: {
+        maxPreviousTracks: 10,
+        // only needed if you want and need external storage, don't provide if you don't need to
+        queueStore: new myCustomStore(client.redis), // client.redis = new redis()
+        // only needed, if you want to watch changes in the queue via a custom class,
+        queueChangesWatcher: new myCustomWatcher(client)
+    },
+    linksAllowed: true,
+    // example: don't allow p*rn / youtube links., you can also use a regex pattern if you want.
+    // linksBlacklist: ["porn", "youtube.com", "youtu.be"],
+    linksBlacklist: [],
+    linksWhitelist: [],
+    advancedOptions: {
+        enableDebugEvents: true,
+        maxFilterFixDuration: 600_000, // only allow instafixfilterupdate for tracks sub 10mins
+        debugOptions: {
+            noAudio: false,
+            playerDestroy: {
+                dontThrowError: false,
+                debugLog: false,
+            },
+            logCustomSearches: false,
+        }
+    }
+});
+
+
+client.on("raw", d => client.lavalink.sendRawData(d)); // send raw data to lavalink-client to handle stuff
+
+client.on("ready", () => {
+    client.lavalink.init(client.user); // init lavalink
+});
+
+// for the custom queue Store create a redis instance
+client.redis = createClient({ url: "redis://localhost:6379", password: "securepass" });
+client.redis.connect();
+
+
+// Custom external queue Store
+export class myCustomStore implements QueueStoreManager {
+    private redis:RedisClientType;
+    constructor(redisClient:RedisClientType) {
+        this.redis = redisClient;
+    }
+    async get(guildId): Promise<any> {
+        return await this.redis.get(this.id(guildId));
+    }
+    async set(guildId, stringifiedQueueData): Promise<any> {
+        return await this.redis.set(this.id(guildId), stringifiedQueueData);
+    }
+    async delete(guildId): Promise<any> {
+        return await this.redis.del(this.id(guildId));
+    }
+    async parse(stringifiedQueueData): Promise<Partial<StoredQueue>> {
+        return JSON.parse(stringifiedQueueData);
+    }
+    async stringify(parsedQueueData): Promise<any> {
+        return JSON.stringify(parsedQueueData);
+    }
+    private id(guildId) {
+        return `lavalinkqueue_${guildId}`; // transform the id to your belikings
+    }
+}
+
+// Custom Queue Watcher Functions
+export class myCustomWatcher implements QueueChangesWatcher {
+    constructor() {
+    }
+    shuffled(guildId, oldStoredQueue, newStoredQueue) {
+        console.log(`${this.client.guilds.cache.get(guildId)?.name || guildId}: Queue got shuffled`)
+    }
+    tracksAdd(guildId, tracks, position, oldStoredQueue, newStoredQueue) {
+        console.log(`${this.client.guilds.cache.get(guildId)?.name || guildId}: ${tracks.length} Tracks got added into the Queue at position #${position}`);
+    }
+    tracksRemoved(guildId, tracks, position, oldStoredQueue, newStoredQueue) {
+        console.log(`${this.client.guilds.cache.get(guildId)?.name || guildId}: ${tracks.length} Tracks got removed from the Queue at position #${position}`);
+    }
+}
+```
+
+</details>
+
+
+
+```ts
+import { LavalinkManager } from "lavalink-client";
+import { Client, GatewayIntentBits } from "discord.js"; // example for a discord bot
+
+// you might want to extend the types of the client, to bind lavalink to it.
+const client = new Client({
+    intents: [
+        GatewayIntentBits.Guilds,
+        GatewayIntentBits.GuildVoiceStates,
+    ]
+});
+
+// create instance
+client.lavalink = new LavalinkManager({
+    nodes: [
+        {
+            authorization: "localhoist",
+            host: "localhost",
+            port: 2333,
+            id: "testnode",
+        }
+    ],
+    sendToShard: (guildId, payload) => client.guilds.cache.get(guildId)?.shard?.send(payload),
+    autoSkip: true,
+    client: {
+        id: envConfig.clientId,
+        username: "TESTBOT",
+    },
+});
+
+client.on("raw", d => client.lavalink.sendRawData(d)); // send raw data to lavalink-client to handle stuff
+
+client.on("ready", () => {
+    client.lavalink.init(client.user); // init lavalink
+});
+
+```
+
 # All Events:
 
 ## On **Lavalink-Manager**:
@@ -493,7 +685,7 @@ if(previousTrack) {
 - Fixed Export, where types of Manager weren't exported correctly
 - Fixed Dist Folder containing old, left over not needed files
 
-## **Version 2.3.2**
+## **Version 2.3.2** / **Version 2.3.3**
 - Added Missing function calls for the QueueWatcher of tracksRemoved within the queue.remove() function:
 - Added new DestroyReasons:
     - TrackStuckMaxTracksErroredPerTime
@@ -516,4 +708,35 @@ if(previousTrack) {
     - The **` functionLayer `** string will show you where the debug event was triggered from
     - The **` message `** string will show what is debugged
     - The **` error `** object will show you the error that happened, if there was one.
-    - *This took quite some time to code, and i am sure there are still many logs you might want, feel free to open an issue or commit with an PR, if you think something is missing!*
+    - *This took quite some time to code, and i am sure there are still many logs you might want, feel free to open an issue
+
+
+## **Version 2.3.4**
+- Improved the package bundling with tsc-alias, to export files with file types
+- Added package.json to exported dist, for easier parsing ability and compatibility with older and newer node versions
+- Added error handling for resolving unresolved tracks on trackend
+
+
+## **Version 2.3.5**
+- FIXED not able to import :: Accidentally removed tsc-alias configuration, which made importing not work
+- FIXED autoplay not working :: Accidentally added an invalid if statement, which made autoplay not working anymore (during the if statement  to not prevent autoplay spam)
+- Added a new AutoplayExecution Debug Log
+- Added more samples to the Testbot related configuration
+
+
+## **Version 2.3.6
+- Added Lyrics Support:
+  - New Player Functions:
+    - **` const lyrics = await player.getCurrentLyrics(false); `** -> *Get lyrics of current playing track*
+    - **` const lyrics = await player.getLyrics(track, true); `** -> *Get lyrics of a specific track with ignoring it's sources*
+    - **` player.subscribeLyrics(); `** -> *Subscribe this guild to retrieve "live lyrics" as the song is *playing
+    - **` player.unsubscribeLyrics(); `** -> *Unsubscribe from lyrics
+  - New Node Functions ( same as from player, just so you can access it without player too ):*
+    - **` const lyrics = await player.node.lyrics.getCurrent(player.guildId, false); `**
+    - **` const lyrics = await player.node.lyrics.get(track, true); `**
+    - **` player.node.lyrics.subscribe(player.guildId); `**
+    - **` player.node.lyrics.unsubscribe(player.guildId); `**
+  - New Manager Event sfor Lyrics:
+    - **` lavalink.on("LyricsLine", (player, track, lyricsLine) => {}); `**
+    - **` lavalink.on("LyricsFound", (player, track, data) => {}); `**
+    - **` lavalink.on("LyricsNotFound", (player, track, lyricsLine) => {}); `**

package/dist/cjs/index.d.ts

@@ -1,16 +1,16 @@
-export * from "./structures/LavalinkManager";
-export * from "./structures/Filters";
-export * from "./structures/LavalinkManagerStatics";
-export * from "./structures/Node";
-export * from "./structures/NodeManager";
-export * from "./structures/Player";
-export * from "./structures/Queue";
-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";
-export * from "./structures/Types/Manager";
+export * from "./structures/LavalinkManager.js";
+export * from "./structures/Filters.js";
+export * from "./structures/LavalinkManagerStatics.js";
+export * from "./structures/Node.js";
+export * from "./structures/NodeManager.js";
+export * from "./structures/Player.js";
+export * from "./structures/Queue.js";
+export * from "./structures/Utils.js";
+export * from "./structures/Types/Track.js";
+export * from "./structures/Types/Utils.js";
+export * from "./structures/Types/Filters.js";
+export * from "./structures/Types/Player.js";
+export * from "./structures/Types/Queue.js";
+export * from "./structures/Types/Node.js";
+export * from "./structures/Constants.js";
+export * from "./structures/Types/Manager.js";

package/dist/cjs/index.js

@@ -1,19 +1,19 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 const tslib_1 = require("tslib");
-tslib_1.__exportStar(require("./structures/LavalinkManager"), exports);
-tslib_1.__exportStar(require("./structures/Filters"), exports);
-tslib_1.__exportStar(require("./structures/LavalinkManagerStatics"), exports);
-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/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);
-tslib_1.__exportStar(require("./structures/Types/Manager"), exports);
+tslib_1.__exportStar(require("./structures/LavalinkManager.js"), exports);
+tslib_1.__exportStar(require("./structures/Filters.js"), exports);
+tslib_1.__exportStar(require("./structures/LavalinkManagerStatics.js"), exports);
+tslib_1.__exportStar(require("./structures/Node.js"), exports);
+tslib_1.__exportStar(require("./structures/NodeManager.js"), exports);
+tslib_1.__exportStar(require("./structures/Player.js"), exports);
+tslib_1.__exportStar(require("./structures/Queue.js"), exports);
+tslib_1.__exportStar(require("./structures/Utils.js"), exports);
+tslib_1.__exportStar(require("./structures/Types/Track.js"), exports);
+tslib_1.__exportStar(require("./structures/Types/Utils.js"), exports);
+tslib_1.__exportStar(require("./structures/Types/Filters.js"), exports);
+tslib_1.__exportStar(require("./structures/Types/Player.js"), exports);
+tslib_1.__exportStar(require("./structures/Types/Queue.js"), exports);
+tslib_1.__exportStar(require("./structures/Types/Node.js"), exports);
+tslib_1.__exportStar(require("./structures/Constants.js"), exports);
+tslib_1.__exportStar(require("./structures/Types/Manager.js"), exports);

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

@@ -1,8 +1,9 @@
-import type { AudioOutputs, ChannelMixFilter, EQBand } from "./Types/Filters";
+import type { AudioOutputs, ChannelMixFilter, EQBand } from "./Types/Filters.js";
 export declare enum DebugEvents {
     SetSponsorBlock = "SetSponsorBlock",
     DeleteSponsorBlock = "DeleteSponsorBlock",
     TrackEndReplaced = "TrackEndReplaced",
+    AutoplayExecution = "AutoplayExecution",
     AutoplayNoSongsAdded = "AutoplayNoSongsAdded",
     AutoplayThresholdSpamLimiter = "AutoplayThresholdSpamLimiter",
     TriggerQueueEmptyInterval = "TriggerQueueEmptyInterval",

package/dist/cjs/structures/Constants.js

@@ -6,6 +6,7 @@ var DebugEvents;
     DebugEvents["SetSponsorBlock"] = "SetSponsorBlock";
     DebugEvents["DeleteSponsorBlock"] = "DeleteSponsorBlock";
     DebugEvents["TrackEndReplaced"] = "TrackEndReplaced";
+    DebugEvents["AutoplayExecution"] = "AutoplayExecution";
     DebugEvents["AutoplayNoSongsAdded"] = "AutoplayNoSongsAdded";
     DebugEvents["AutoplayThresholdSpamLimiter"] = "AutoplayThresholdSpamLimiter";
     DebugEvents["TriggerQueueEmptyInterval"] = "TriggerQueueEmptyInterval";

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

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

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

@@ -1,5 +1,5 @@
-import type { Player } from "./Player";
-import type { AudioOutputs, EQBand, FilterData, PlayerFilters, TimescaleFilter } from "./Types/Filters";
+import type { Player } from "./Player.js";
+import type { AudioOutputs, EQBand, FilterData, PlayerFilters, TimescaleFilter } from "./Types/Filters.js";
 /**
  * The FilterManager for each player
  */

package/dist/cjs/structures/Filters.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.FilterManager = void 0;
-const Constants_1 = require("./Constants");
+const Constants_1 = require("./Constants.js");
 /**
  * The FilterManager for each player
  */

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

@@ -1,11 +1,11 @@
 /// <reference types="node" />
 import { EventEmitter } from "events";
-import { NodeManager } from "./NodeManager";
-import { Player } from "./Player";
-import { ManagerUtils, MiniMap } from "./Utils";
-import type { BotClientOptions, LavalinkManagerEvents, ManagerOptions } from "./Types/Manager";
-import type { PlayerOptions } from "./Types/Player";
-import type { ChannelDeletePacket, VoicePacket, VoiceServer, VoiceState } from "./Types/Utils";
+import { NodeManager } from "./NodeManager.js";
+import { Player } from "./Player.js";
+import { ManagerUtils, MiniMap } from "./Utils.js";
+import type { BotClientOptions, LavalinkManagerEvents, ManagerOptions } from "./Types/Manager.js";
+import type { PlayerOptions } from "./Types/Player.js";
+import type { ChannelDeletePacket, VoicePacket, VoiceServer, VoiceState } from "./Types/Utils.js";
 export declare class LavalinkManager extends EventEmitter {
     /**
      * Emit an event

package/dist/cjs/structures/LavalinkManager.js

@@ -2,11 +2,11 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.LavalinkManager = void 0;
 const events_1 = require("events");
-const Constants_1 = require("./Constants");
-const NodeManager_1 = require("./NodeManager");
-const Player_1 = require("./Player");
-const Queue_1 = require("./Queue");
-const Utils_1 = require("./Utils");
+const Constants_1 = require("./Constants.js");
+const NodeManager_1 = require("./NodeManager.js");
+const Player_1 = require("./Player.js");
+const Queue_1 = require("./Queue.js");
+const Utils_1 = require("./Utils.js");
 class LavalinkManager extends events_1.EventEmitter {
     /**
      * Emit an event

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

@@ -1,4 +1,4 @@
-import type { ClientCustomSearchPlatformUtils, LavalinkSearchPlatform, SearchPlatform, SourcesRegex } from "./Types/Utils";
+import type { ClientCustomSearchPlatformUtils, LavalinkSearchPlatform, SearchPlatform, SourcesRegex } from "./Types/Utils.js";
 /** Default Sources Record, to allow source parsing with multiple inputs. */
 export declare const DefaultSources: Record<SearchPlatform, LavalinkSearchPlatform | ClientCustomSearchPlatformUtils>;
 /** Lavalink Plugins definiton */
@@ -7,7 +7,9 @@ export declare const LavalinkPlugins: {
     LavaSrc: string;
     GoogleCloudTTS: string;
     LavaSearch: string;
+    Jiosaavn_Plugin: string;
     LavalinkFilterPlugin: string;
+    JavaTimedLyricsPlugin: string;
 };
 /** Lavalink Sources regexes for url validations */
 export declare const SourceLinksRegexes: Record<SourcesRegex, RegExp>;

package/dist/cjs/structures/LavalinkManagerStatics.js

@@ -65,7 +65,12 @@ exports.DefaultSources = {
     "http": "http",
     "https": "https",
     "link": "link",
-    "uri": "uri"
+    "uri": "uri",
+    // jiosaavn
+    "jiosaavn": "jssearch",
+    "js": "jssearch",
+    "jssearch": "jssearch",
+    "jsrec": "jsrec"
 };
 /** Lavalink Plugins definiton */
 exports.LavalinkPlugins = {
@@ -73,7 +78,9 @@ exports.LavalinkPlugins = {
     LavaSrc: "lavasrc-plugin",
     GoogleCloudTTS: "tts-plugin",
     LavaSearch: "lavasearch-plugin",
-    LavalinkFilterPlugin: "lavalink-filter-plugin"
+    Jiosaavn_Plugin: "jiosaavn-plugin",
+    LavalinkFilterPlugin: "lavalink-filter-plugin",
+    JavaTimedLyricsPlugin: "java-lyrics-plugin"
 };
 /** Lavalink Sources regexes for url validations */
 exports.SourceLinksRegexes = {
@@ -111,6 +118,8 @@ exports.SourceLinksRegexes = {
     SpotifyAlbumRegex: /(https?:\/\/)(www\.)?open\.spotify\.com\/((?<region>[a-zA-Z-]+)\/)?(user\/(?<user>[a-zA-Z0-9-_]+)\/)?album\/(?<identifier>[a-zA-Z0-9-_]+)/,
     AllSpotifyRegex: /(https?:\/\/)(www\.)?open\.spotify\.com\/((?<region>[a-zA-Z-]+)\/)?(user\/(?<user>[a-zA-Z0-9-_]+)\/)?(?<type>track|album|playlist|artist|episode|show)\/(?<identifier>[a-zA-Z0-9-_]+)/,
     appleMusic: /https?:\/\/?(?:www\.)?music\.apple\.com\/(\S+)/,
+    /** From jiosaavn-plugin */
+    jiosaavn: /(https?:\/\/)(www\.)?jiosaavn\.com\/(?<type>song|album|featured|artist)\/([a-zA-Z0-9-_\/,]+)/,
     /** FROM DUNCTE BOT PLUGIN */
     tiktok: /https:\/\/www\.tiktok\.com\//,
     mixcloud: /https:\/\/www\.mixcloud\.com\//,

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

@@ -1,9 +1,9 @@
-import type { Player } from "./Player";
-import type { DestroyReasonsType } from "./Types/Player";
-import type { Track } from "./Types/Track";
-import type { Base64, InvalidLavalinkRestRequest, LavalinkPlayer, LavaSearchQuery, LavaSearchResponse, PlayerUpdateInfo, RoutePlanner, SearchQuery, SearchResult, Session } from "./Types/Utils";
-import type { NodeManager } from "./NodeManager";
-import type { BaseNodeStats, LavalinkInfo, LavalinkNodeOptions, ModifyRequest, NodeStats, SponsorBlockSegment } from "./Types/Node";
+import type { Player } from "./Player.js";
+import type { DestroyReasonsType } from "./Types/Player.js";
+import type { Track } from "./Types/Track.js";
+import type { Base64, InvalidLavalinkRestRequest, LavalinkPlayer, LavaSearchQuery, LavaSearchResponse, PlayerUpdateInfo, RoutePlanner, SearchQuery, SearchResult, Session } from "./Types/Utils.js";
+import type { NodeManager } from "./NodeManager.js";
+import type { BaseNodeStats, LavalinkInfo, LavalinkNodeOptions, LyricsResult, ModifyRequest, NodeStats, SponsorBlockSegment } from "./Types/Node.js";
 /**
  * Lavalink Node creator class
  */
@@ -271,6 +271,62 @@ export declare class LavalinkNode {
          */
         multipleTracks: (encodeds: Base64[], requester: unknown) => Promise<Track[]>;
     };
+    lyrics: {
+        /**
+         * Get the lyrics of a track
+         * @param track the track to get the lyrics for
+         * @param skipTrackSource wether to skip the track source or not
+         * @returns the lyrics of the track
+         * @example
+         *
+         * ```ts
+         * const lyrics = await player.node.lyrics.get(track, true);
+         * // use it of player instead:
+         * // const lyrics = await player.getLyrics(track, true);
+         * ```
+         */
+        get: (track: Track, skipTrackSource?: boolean) => Promise<LyricsResult>;
+        /**
+         * Get the lyrics of the current playing track
+         *
+         * @param guildId the guild id of the player
+         * @param skipTrackSource wether to skip the track source or not
+         * @returns the lyrics of the current playing track
+         * @example
+         * ```ts
+         * const lyrics = await player.node.lyrics.getCurrent(guildId);
+         * // use it of player instead:
+         * // const lyrics = await player.getCurrentLyrics();
+         * ```
+         */
+        getCurrent: (guildId: string, skipTrackSource?: boolean) => Promise<LyricsResult>;
+        /**
+         * subscribe to lyrics updates for a guild
+         * @param guildId the guild id of the player
+         * @returns request data of the request
+         *
+         * @example
+         * ```ts
+         * await player.node.lyrics.subscribe(guildId);
+         * // use it of player instead:
+         * // const lyrics = await player.subscribeLyrics();
+         * ```
+         */
+        subscribe: (guildId: string) => Promise<any>;
+        /**
+         * unsubscribe from lyrics updates for a guild
+         * @param guildId the guild id of the player
+         * @returns request data of the request
+         *
+         * @example
+         * ```ts
+         * await player.node.lyrics.unsubscribe(guildId);
+         * // use it of player instead:
+         * // const lyrics = await player.unsubscribeLyrics();
+         * ```
+         */
+        unsubscribe: (guildId: string) => Promise<any>;
+    };
     /**
      * Request Lavalink statistics.
      * @returns the lavalink node stats
@@ -432,4 +488,28 @@ export declare class LavalinkNode {
     deleteSponsorBlock(player: Player): Promise<void>;
     /** private util function for handling the queue end event */
     private queueEnd;
+    /**
+     * Emitted whenever a line of lyrics gets emitted
+     * @event
+     * @param {Player} player The player that emitted the event
+     * @param {Track} track The track that emitted the event
+     * @param {LyricsLineEvent} payload The payload of the event
+     */
+    private LyricsLine;
+    /**
+     * Emitted whenever the lyrics for a track got found
+     * @event
+     * @param {Player} player The player that emitted the event
+     * @param {Track} track The track that emitted the event
+     * @param {LyricsFoundEvent} payload The payload of the event
+     */
+    private LyricsFound;
+    /**
+     * Emitted whenever the lyrics for a track got not found
+     * @event
+     * @param {Player} player The player that emitted the event
+     * @param {Track} track The track that emitted the event
+     * @param {LyricsNotFoundEvent} payload The payload of the event
+     */
+    private LyricsNotFound;
 }