discord-player 6.6.8-dev.3 → 6.6.9-dev.0

package/dist/index.d.ts

@@ -726,6 +726,196 @@ declare class GuildQueueStatistics<Meta = unknown> {
     generate(): GuildQueueStatisticsMetadata;
 }
 
+type RequestEntity = () => Promise<Response>;
+declare class SequentialBucket {
+    limit: number;
+    remaining: number;
+    resetAfter: number;
+    queue: AsyncQueue;
+    MAX_RETRIES: number;
+    /**
+     * Checks if the bucket is rate limited.
+     */
+    isRateLimited(): boolean;
+    /**
+     * Enqueues a request.
+     * @param req The request function to enqueue
+     */
+    enqueue(req: RequestEntity): Promise<Response>;
+    private _request;
+    private _patchHeaders;
+}
+
+interface LrcSearchParams {
+    /**
+     * The query to search for. Either this or trackName is required.
+     */
+    q?: string;
+    /**
+     * The track name to search for. Either this or query is required.
+     */
+    trackName?: string;
+    /**
+     * The artist name
+     */
+    artistName?: string;
+    /**
+     * The album name
+     */
+    albumName?: string;
+}
+interface LrcGetParams extends Required<Omit<LrcSearchParams, 'query'>> {
+    /**
+     * The duration of the track
+     */
+    duration: number;
+}
+interface LrcSearchResult {
+    /**
+     * The track id
+     */
+    id: number;
+    /**
+     * The track name
+     */
+    name: string;
+    /**
+     * The artist name
+     */
+    trackName: string;
+    /**
+     * The album name
+     */
+    artistName: string;
+    /**
+     * The album name
+     */
+    albumName: string;
+    /**
+     * The duration of the track
+     */
+    duration: number;
+    /**
+     * The release date of the track
+     */
+    instrumental: boolean;
+    /**
+     * The release date of the track
+     */
+    plainLyrics: string;
+    /**
+     * The release date of the track
+     */
+    syncedLyrics?: string;
+}
+type LrcGetResult = Omit<LrcSearchResult, 'name'>;
+declare class LrcLib {
+    readonly player: Player;
+    /**
+     * The API URL
+     */
+    api: string;
+    /**
+     * The request timeout. Default is 15 seconds.
+     */
+    timeout: number;
+    /**
+     * The request bucket
+     */
+    bucket: SequentialBucket;
+    /**
+     * Creates a new LrcLib instance
+     * @param {Player} player The player instance
+     */
+    constructor(player: Player);
+    /**
+     * Sets the request timeout
+     * @param {number} timeout The timeout in milliseconds
+     */
+    setRequestTimeout(timeout: number): void;
+    /**
+     * Sets the retry limit. Default is 5.
+     * @param {number} limit The retry limit
+     */
+    setRetryLimit(limit: number): void;
+    /**
+     * Gets lyrics
+     * @param params The get params
+     */
+    get(params: LrcGetParams): Promise<LrcSearchResult>;
+    /**
+     * Gets lyrics by ID
+     * @param id The lyrics ID
+     */
+    getById(id: `${number}` | number): Promise<LrcSearchResult>;
+    /**
+     * Gets cached lyrics
+     * @param params The get params
+     */
+    getCached(params: LrcGetParams): Promise<LrcSearchResult>;
+    /**
+     * Searches for lyrics
+     * @param params The search params
+     */
+    search(params: LrcSearchParams): Promise<LrcSearchResult[]>;
+    /**
+     * Requests the API
+     * @param path The path
+     * @param options The request options
+     */
+    request<T>(path: string, options?: RequestInit): Promise<T>;
+}
+
+type LyricsData = Map<number, string>;
+type Unsubscribe = () => void;
+type LyricsCallback = (lyrics: string, timestamp: number) => unknown;
+type LyricsAt = {
+    timestamp: number;
+    line: string;
+};
+declare class SyncedLyricsProvider {
+    #private;
+    readonly queue: GuildQueue;
+    readonly raw?: LrcSearchResult | LrcGetResult | undefined;
+    interval: number;
+    readonly lyrics: LyricsData;
+    constructor(queue: GuildQueue, raw?: LrcSearchResult | LrcGetResult | undefined);
+    isSubscribed(): boolean;
+    load(lyrics: string): void;
+    /**
+     * Returns the lyrics at a specific time or at the closest time (±2 seconds)
+     * @param time The time in milliseconds
+     */
+    at(time: number): LyricsAt | null;
+    /**
+     * Callback for the lyrics change.
+     * @param callback The callback function
+     */
+    onChange(callback: LyricsCallback): void;
+    /**
+     * Callback to detect when the provider is unsubscribed.
+     * @param callback The callback function
+     */
+    onUnsubscribe(callback: Unsubscribe): void;
+    /**
+     * Unsubscribes from the queue.
+     */
+    unsubscribe(): void;
+    /**
+     * Subscribes to the queue to monitor the current time.
+     * @returns The unsubscribe function
+     */
+    subscribe(): Unsubscribe;
+    /**
+     * Pauses the lyrics provider.
+     */
+    pause(): boolean;
+    /**
+     * Resumes the lyrics provider.
+     */
+    resume(): boolean;
+}
+
 interface GuildNodeInit<Meta = unknown> {
     guild: Guild;
     queueStrategy: QueueStrategy;
@@ -1094,6 +1284,7 @@ declare class GuildQueue<Meta = unknown> {
     timeouts: Collection<string, NodeJS.Timeout>;
     stats: GuildQueueStatistics<Meta>;
     tasksQueue: AsyncQueue;
+    syncedLyricsProvider: SyncedLyricsProvider;
     constructor(player: Player, options: GuildNodeInit<Meta>);
     /**
      * Estimated duration of this queue in ms
@@ -1107,6 +1298,20 @@ declare class GuildQueue<Meta = unknown> {
      * The voice receiver for this queue
      */
     get voiceReceiver(): VoiceReceiverNode | null;
+    /**
+     * The sync lyrics provider for this queue.
+     * @example const lyrics = await player.lyrics.search({ q: 'Alan Walker Faded' });
+     * const syncedLyrics = queue.syncedLyrics(lyrics[0]);
+     * console.log(syncedLyrics.at(10_000));
+     * // subscribe to lyrics change
+     * const unsubscribe = syncedLyrics.onChange((lyrics, timestamp) => {
+     *    console.log(lyrics, timestamp);
+     * });
+     * // unsubscribe from lyrics change
+     * unsubscribe(); // or
+     * syncedLyrics.unsubscribe();
+     */
+    syncedLyrics(lyrics: LrcGetResult | LrcSearchResult): SyncedLyricsProvider;
     /**
      * Write a debug message to this queue
      * @param m The message to write
@@ -2113,16 +2318,51 @@ interface PlayerNodeInitializerOptions<T> extends SearchOptions {
 type VoiceStateHandler = (player: Player, queue: GuildQueue, oldVoiceState: VoiceState, newVoiceState: VoiceState) => Awaited<void>;
 declare class Player extends PlayerEventsEmitter<PlayerEvents> {
     #private;
+    /**
+     * The version of discord-player
+     */
     static readonly version: string;
     static _singletonKey: symbol;
+    /**
+     * The unique identifier of this player instance
+     */
     readonly id: string;
+    /**
+     * The discord.js client
+     */
     readonly client: Client;
+    /**
+     * The player options
+     */
     readonly options: PlayerInitOptions;
+    /**
+     * The player nodes (queue) manager
+     */
     nodes: GuildNodeManager<unknown>;
+    /**
+     * The voice api utilities
+     */
     readonly voiceUtils: VoiceUtils;
+    /**
+     * The extractors manager
+     */
     extractors: ExtractorExecutionContext;
+    /**
+     * The player events channel
+     */
     events: PlayerEventsEmitter<GuildQueueEvents<any>>;
+    /**
+     * The route planner
+     */
     routePlanner: IPRotator | null;
+    /**
+     * The player version
+     */
+    readonly version: string;
+    /**
+     * The lyrics api
+     */
+    readonly lyrics: LrcLib;
     /**
      * Creates new Discord Player
      * @param {Client} client The Discord Client
@@ -2882,11 +3122,20 @@ declare class AudioFilters {
     }[]): void;
 }
 
+type RuntimeType = 'node' | 'deno' | 'bun' | 'unknown';
+interface Runtime {
+    name: RuntimeType;
+    version: string;
+}
 declare class Util {
     /**
      * Utils
      */
     private constructor();
+    /**
+     * Gets the runtime information
+     */
+    static getRuntime(): Runtime;
     /**
      * Creates duration string
      * @param {object} durObj The duration object
@@ -3005,4 +3254,4 @@ declare class QueryResolver {
 
 declare const version: string;
 
-export { AFilterGraph, AsyncQueue, AsyncQueueAcquisitionOptions, AsyncQueueEntry, AsyncQueueExceptionHandler, AudioFilters, BaseExtractor, Context, ContextReceiver, CreateStreamOps, DiscordPlayerQueryResultCache, Encodable, EqualizerConfigurationPreset, ExtractorExecutionContext, ExtractorExecutionEvents, ExtractorExecutionFN, ExtractorExecutionResult, ExtractorInfo, ExtractorLoaderOptionDict, ExtractorResolvable, ExtractorSearchContext, ExtractorStreamable, FFMPEG_ARGS_PIPED, FFMPEG_ARGS_STRING, FFMPEG_SRATE_REGEX, FFmpegFilterer, FFmpegStreamOptions, FilterGraph, FiltersName, GuildNodeCreateOptions, GuildNodeInit, GuildNodeManager, GuildQueue, GuildQueueAFiltersCache, GuildQueueAudioFilters, GuildQueueEvent, GuildQueueEvents, GuildQueueHistory, GuildQueuePlayerNode, GuildQueueStatistics, GuildQueueStatisticsMetadata, HookDeclaration, HookDeclarationContext, IPBlock, IPRotationConfig, IPRotator, MetadataDispatch, NextFunction, NodeResolvable, OnAfterCreateStreamHandler, OnBeforeCreateStreamHandler, PlayOptions, Player, PlayerEvent, PlayerEvents, PlayerEventsEmitter, PlayerInitOptions, PlayerNodeInitializationResult, PlayerNodeInitializerOptions, PlayerProgressbarOptions, PlayerSearchResult, PlayerTimestamp, PlayerTriggeredReason, Playlist, PlaylistInitData, PlaylistJSON, PostProcessedResult, QueryCache, QueryCacheOptions, QueryCacheProvider, QueryCacheResolverContext, QueryExtractorSearch, QueryResolver, QueryType, QueueFilters, QueueRepeatMode, RawTrackData, RawTrackInit, ResolvedQuery, ResourcePlayOptions, SearchOptions, SearchQueryType, SearchResult, SearchResultData, SerializedPlaylist, SerializedTrack, SerializedType, SetterFN$1 as SetterFN, SkipOptions, StreamConfig, StreamDispatcher, TimeData, TimelineDispatcherOptions, Track, TrackJSON, TrackLike, TrackResolvable, TrackSkipReason, TrackSource, TypeUtil, Util, VALIDATE_QUEUE_CAP, VoiceConnectConfig, VoiceEvents, VoiceReceiverNode, VoiceReceiverOptions, VoiceStateHandler, VoiceUtils, WithMetadata, createContext, createFFmpegStream, createHook, decode, deserialize, encode, onAfterCreateStream, onBeforeCreateStream, serialize, tryIntoThumbnailString, useContext, useHistory, useMainPlayer, useMasterPlayer, useMetadata, usePlayer, useQueue, useTimeline, useVolume, version };
+export { AFilterGraph, AsyncQueue, AsyncQueueAcquisitionOptions, AsyncQueueEntry, AsyncQueueExceptionHandler, AudioFilters, BaseExtractor, Context, ContextReceiver, CreateStreamOps, DiscordPlayerQueryResultCache, Encodable, EqualizerConfigurationPreset, ExtractorExecutionContext, ExtractorExecutionEvents, ExtractorExecutionFN, ExtractorExecutionResult, ExtractorInfo, ExtractorLoaderOptionDict, ExtractorResolvable, ExtractorSearchContext, ExtractorStreamable, FFMPEG_ARGS_PIPED, FFMPEG_ARGS_STRING, FFMPEG_SRATE_REGEX, FFmpegFilterer, FFmpegStreamOptions, FilterGraph, FiltersName, GuildNodeCreateOptions, GuildNodeInit, GuildNodeManager, GuildQueue, GuildQueueAFiltersCache, GuildQueueAudioFilters, GuildQueueEvent, GuildQueueEvents, GuildQueueHistory, GuildQueuePlayerNode, GuildQueueStatistics, GuildQueueStatisticsMetadata, HookDeclaration, HookDeclarationContext, IPBlock, IPRotationConfig, IPRotator, LrcGetParams, LrcGetResult, LrcLib, LrcSearchParams, LrcSearchResult, MetadataDispatch, NextFunction, NodeResolvable, OnAfterCreateStreamHandler, OnBeforeCreateStreamHandler, PlayOptions, Player, PlayerEvent, PlayerEvents, PlayerEventsEmitter, PlayerInitOptions, PlayerNodeInitializationResult, PlayerNodeInitializerOptions, PlayerProgressbarOptions, PlayerSearchResult, PlayerTimestamp, PlayerTriggeredReason, Playlist, PlaylistInitData, PlaylistJSON, PostProcessedResult, QueryCache, QueryCacheOptions, QueryCacheProvider, QueryCacheResolverContext, QueryExtractorSearch, QueryResolver, QueryType, QueueFilters, QueueRepeatMode, RawTrackData, RawTrackInit, RequestEntity, ResolvedQuery, ResourcePlayOptions, Runtime, RuntimeType, SearchOptions, SearchQueryType, SearchResult, SearchResultData, SequentialBucket, SerializedPlaylist, SerializedTrack, SerializedType, SetterFN$1 as SetterFN, SkipOptions, StreamConfig, StreamDispatcher, TimeData, TimelineDispatcherOptions, Track, TrackJSON, TrackLike, TrackResolvable, TrackSkipReason, TrackSource, TypeUtil, Util, VALIDATE_QUEUE_CAP, VoiceConnectConfig, VoiceEvents, VoiceReceiverNode, VoiceReceiverOptions, VoiceStateHandler, VoiceUtils, WithMetadata, createContext, createFFmpegStream, createHook, decode, deserialize, encode, onAfterCreateStream, onBeforeCreateStream, serialize, tryIntoThumbnailString, useContext, useHistory, useMainPlayer, useMasterPlayer, useMetadata, usePlayer, useQueue, useTimeline, useVolume, version };