discord-player 6.6.2 → 6.6.3-dev.0

package/README.md

@@ -1,6 +1,6 @@
 # Discord Player
 
-Discord Player is a robust framework for developing Discord Music bots using JavaScript and TypeScript. It is built on top of the [@discordjs/voice](https://npm.im/@discordjs/voice) library and offers a comprehensive set of customizable tools, making it one of the most feature enrich framework in town.
+Discord Player is a robust framework for developing Discord Music bots using JavaScript and TypeScript. It is built on top of the [discord-voip](https://npm.im/discord-voip) library and offers a comprehensive set of customizable tools, making it one of the most feature enrich framework in town.
 
 [![downloadsBadge](https://img.shields.io/npm/dt/discord-player?style=for-the-badge)](https://npmjs.com/discord-player)
 [![versionBadge](https://img.shields.io/npm/v/discord-player?style=for-the-badge)](https://npmjs.com/discord-player)

package/dist/index.d.ts

@@ -5,8 +5,8 @@ import * as _discord_player_equalizer from '@discord-player/equalizer';
 import { EqualizerBand, BiquadFilters, PCMFilters, FiltersChain } from '@discord-player/equalizer';
 export { AF_NIGHTCORE_RATE, AF_VAPORWAVE_RATE, BASS_EQ_BANDS, FilterType as BiquadFilterType, BiquadFilters, FiltersChain, AudioFilters as PCMAudioFilters, PCMFilters, Q_BUTTERWORTH, VolumeTransformer } from '@discord-player/equalizer';
 import { Readable, Duplex } from 'stream';
-import { StreamType, AudioPlayerError, AudioResource, VoiceConnection, AudioPlayer, AudioPlayerStatus, EndBehaviorType } from '@discordjs/voice';
-export { AudioPlayer, CreateAudioPlayerOptions, createAudioPlayer } from '@discordjs/voice';
+import { StreamType, AudioPlayerError, AudioResource, VoiceConnection, AudioPlayer, AudioPlayerStatus, EndBehaviorType } from 'discord-voip';
+export { AudioPlayer, CreateAudioPlayerOptions, createAudioPlayer } from 'discord-voip';
 import { RequestOptions } from 'http';
 import { downloadOptions } from 'ytdl-core';
 import { BridgeProvider } from '@discord-player/extractor';
@@ -1267,6 +1267,131 @@ declare class GuildQueue<Meta = unknown> {
     get hasDebugger(): boolean;
 }
 
+type TrackResolvable = Track | string | number;
+type WithMetadata<T extends object, M> = T & {
+    metadata: M;
+    requestMetadata(): Promise<M>;
+};
+declare class Track<T = unknown> {
+    readonly player: Player;
+    title: string;
+    description: string;
+    author: string;
+    url: string;
+    thumbnail: string;
+    duration: string;
+    views: number;
+    requestedBy: User | null;
+    playlist?: Playlist;
+    queryType: SearchQueryType | null | undefined;
+    raw: RawTrackData;
+    extractor: BaseExtractor | null;
+    readonly id: string;
+    private __metadata;
+    private __reqMetadataFn;
+    /**
+     * Track constructor
+     * @param player The player that instantiated this Track
+     * @param data Track data
+     */
+    constructor(player: Player, data: Partial<WithMetadata<RawTrackData, T>>);
+    /**
+     * Request metadata for this track
+     */
+    requestMetadata(): Promise<T | null>;
+    /**
+     * Set metadata for this track
+     */
+    setMetadata(m: T | null): void;
+    /**
+     * Metadata of this track
+     */
+    get metadata(): T | null;
+    /**
+     * If this track has metadata
+     */
+    get hasMetadata(): boolean;
+    /**
+     * The queue in which this track is located
+     */
+    get queue(): GuildQueue;
+    /**
+     * The track duration in millisecond
+     */
+    get durationMS(): number;
+    /**
+     * Discord hyperlink representation of this track
+     */
+    toHyperlink(): string;
+    /**
+     * Returns source of this track
+     */
+    get source(): TrackSource;
+    /**
+     * String representation of this track
+     */
+    toString(): string;
+    /**
+     * Raw JSON representation of this track
+     */
+    toJSON(hidePlaylist?: boolean): TrackJSON;
+    /**
+     * Get belonging queues of this track
+     */
+    getBelongingQueues(): Collection<string, GuildQueue<unknown>>;
+    /**
+     * Play this track to the given voice channel. If queue exists and another track is being played, this track will be added to the queue.
+     * @param channel Voice channel on which this track shall be played
+     * @param options Node initialization options
+     */
+    play<T = unknown>(channel: GuildVoiceChannelResolvable, options?: PlayerNodeInitializerOptions<T>): Promise<PlayerNodeInitializationResult<T>>;
+}
+
+declare class Playlist {
+    readonly player: Player;
+    tracks: Track[];
+    title: string;
+    description: string;
+    thumbnail: string;
+    type: 'album' | 'playlist';
+    source: TrackSource;
+    author: {
+        name: string;
+        url: string;
+    };
+    id: string;
+    url: string;
+    readonly rawPlaylist?: any;
+    /**
+     * Playlist constructor
+     * @param {Player} player The player
+     * @param {PlaylistInitData} data The data
+     */
+    constructor(player: Player, data: PlaylistInitData);
+    [Symbol.iterator](): Generator<Track<unknown>, void, undefined>;
+    /**
+     * Estimated duration of this playlist
+     */
+    get estimatedDuration(): number;
+    /**
+     * Formatted estimated duration of this playlist
+     */
+    get durationFormatted(): string;
+    /**
+     * JSON representation of this playlist
+     * @param {boolean} [withTracks=true] If it should build json with tracks
+     * @returns {PlaylistJSON}
+     */
+    toJSON(withTracks?: boolean): PlaylistJSON;
+    /**
+     * Play this playlist to the given voice channel. If queue exists and another track is being played, this playlist will be added to the queue.
+     * @param channel Voice channel on which this playlist shall be played
+     * @param options Node initialization options
+     */
+    play<T = unknown>(channel: GuildVoiceChannelResolvable, options?: PlayerNodeInitializerOptions<T>): Promise<PlayerNodeInitializationResult<T>>;
+}
+
+declare const knownExtractorKeys: readonly ["SpotifyExtractor", "AppleMusicExtractor", "SoundCloudExtractor", "YouTubeExtractor", "VimeoExtractor", "ReverbnationExtractor", "AttachmentExtractor"];
 interface ExtractorExecutionEvents {
     /**
      * Emitted when a extractor is registered
@@ -1306,7 +1431,7 @@ declare class ExtractorExecutionContext extends PlayerEventsEmitter<ExtractorExe
     /**
      * Load default extractors from `@discord-player/extractor`
      */
-    loadDefault(): Promise<{
+    loadDefault(filter?: (ext: (typeof knownExtractorKeys)[number]) => boolean): Promise<{
         success: boolean;
         error: Error;
     } | {
@@ -1446,130 +1571,6 @@ interface ExtractorSearchContext {
     requestOptions?: RequestOptions;
 }
 
-type TrackResolvable = Track | string | number;
-type WithMetadata<T extends object, M> = T & {
-    metadata: M;
-    requestMetadata(): Promise<M>;
-};
-declare class Track<T = unknown> {
-    readonly player: Player;
-    title: string;
-    description: string;
-    author: string;
-    url: string;
-    thumbnail: string;
-    duration: string;
-    views: number;
-    requestedBy: User | null;
-    playlist?: Playlist;
-    queryType: SearchQueryType | null | undefined;
-    raw: RawTrackData;
-    extractor: BaseExtractor | null;
-    readonly id: string;
-    private __metadata;
-    private __reqMetadataFn;
-    /**
-     * Track constructor
-     * @param player The player that instantiated this Track
-     * @param data Track data
-     */
-    constructor(player: Player, data: Partial<WithMetadata<RawTrackData, T>>);
-    /**
-     * Request metadata for this track
-     */
-    requestMetadata(): Promise<T | null>;
-    /**
-     * Set metadata for this track
-     */
-    setMetadata(m: T | null): void;
-    /**
-     * Metadata of this track
-     */
-    get metadata(): T | null;
-    /**
-     * If this track has metadata
-     */
-    get hasMetadata(): boolean;
-    /**
-     * The queue in which this track is located
-     */
-    get queue(): GuildQueue;
-    /**
-     * The track duration in millisecond
-     */
-    get durationMS(): number;
-    /**
-     * Discord hyperlink representation of this track
-     */
-    toHyperlink(): string;
-    /**
-     * Returns source of this track
-     */
-    get source(): TrackSource;
-    /**
-     * String representation of this track
-     */
-    toString(): string;
-    /**
-     * Raw JSON representation of this track
-     */
-    toJSON(hidePlaylist?: boolean): TrackJSON;
-    /**
-     * Get belonging queues of this track
-     */
-    getBelongingQueues(): Collection<string, GuildQueue<unknown>>;
-    /**
-     * Play this track to the given voice channel. If queue exists and another track is being played, this track will be added to the queue.
-     * @param channel Voice channel on which this track shall be played
-     * @param options Node initialization options
-     */
-    play<T = unknown>(channel: GuildVoiceChannelResolvable, options?: PlayerNodeInitializerOptions<T>): Promise<PlayerNodeInitializationResult<T>>;
-}
-
-declare class Playlist {
-    readonly player: Player;
-    tracks: Track[];
-    title: string;
-    description: string;
-    thumbnail: string;
-    type: 'album' | 'playlist';
-    source: TrackSource;
-    author: {
-        name: string;
-        url: string;
-    };
-    id: string;
-    url: string;
-    readonly rawPlaylist?: any;
-    /**
-     * Playlist constructor
-     * @param {Player} player The player
-     * @param {PlaylistInitData} data The data
-     */
-    constructor(player: Player, data: PlaylistInitData);
-    [Symbol.iterator](): Generator<Track<unknown>, void, undefined>;
-    /**
-     * Estimated duration of this playlist
-     */
-    get estimatedDuration(): number;
-    /**
-     * Formatted estimated duration of this playlist
-     */
-    get durationFormatted(): string;
-    /**
-     * JSON representation of this playlist
-     * @param {boolean} [withTracks=true] If it should build json with tracks
-     * @returns {PlaylistJSON}
-     */
-    toJSON(withTracks?: boolean): PlaylistJSON;
-    /**
-     * Play this playlist to the given voice channel. If queue exists and another track is being played, this playlist will be added to the queue.
-     * @param channel Voice channel on which this playlist shall be played
-     * @param options Node initialization options
-     */
-    play<T = unknown>(channel: GuildVoiceChannelResolvable, options?: PlayerNodeInitializerOptions<T>): Promise<PlayerNodeInitializationResult<T>>;
-}
-
 interface SearchResultData {
     query: string;
     queryType?: SearchQueryType | QueryExtractorSearch | null;
@@ -1641,6 +1642,39 @@ declare class SearchResult {
     };
 }
 
+interface QueryCacheOptions {
+    checkInterval?: number;
+}
+interface QueryCacheProvider<T> {
+    getData(): Promise<DiscordPlayerQueryResultCache<T>[]>;
+    addData(data: SearchResult): Promise<void>;
+    resolve(context: QueryCacheResolverContext): Promise<SearchResult>;
+}
+declare class QueryCache implements QueryCacheProvider<Track> {
+    #private;
+    player: Player;
+    options: QueryCacheOptions;
+    timer: NodeJS.Timer;
+    constructor(player: Player, options?: QueryCacheOptions);
+    get checkInterval(): number;
+    cleanup(): Promise<void>;
+    clear(): Promise<void>;
+    getData(): Promise<DiscordPlayerQueryResultCache<Track<unknown>>[]>;
+    addData(data: SearchResult): Promise<void>;
+    resolve(context: QueryCacheResolverContext): Promise<SearchResult>;
+}
+declare class DiscordPlayerQueryResultCache<T = unknown> {
+    data: T;
+    expireAfter: number;
+    constructor(data: T, expireAfter?: number);
+    hasExpired(): boolean;
+}
+interface QueryCacheResolverContext {
+    query: string;
+    requestedBy?: User;
+    queryType?: SearchQueryType | `ext:${string}`;
+}
+
 declare class VoiceUtils {
     player: Player;
     /**
@@ -1692,34 +1726,6 @@ declare class VoiceUtils {
     getConnection(guild: Snowflake, group?: string): VoiceConnection | undefined;
 }
 
-interface QueryCacheOptions {
-    checkInterval?: number;
-}
-declare class QueryCache {
-    #private;
-    player: Player;
-    options: QueryCacheOptions;
-    timer: NodeJS.Timer;
-    constructor(player: Player, options?: QueryCacheOptions);
-    get checkInterval(): number;
-    cleanup(): Promise<void>;
-    clear(): Promise<void>;
-    getData(): Promise<DiscordPlayerQueryResultCache<Track<unknown>>[]>;
-    addData(data: SearchResult): Promise<void>;
-    resolve(context: QueryCacheResolverContext): Promise<SearchResult>;
-}
-declare class DiscordPlayerQueryResultCache<T = unknown> {
-    data: T;
-    expireAfter: number;
-    constructor(data: T, expireAfter?: number);
-    hasExpired(): boolean;
-}
-interface QueryCacheResolverContext {
-    query: string;
-    requestedBy?: User;
-    queryType?: SearchQueryType | `ext:${string}`;
-}
-
 interface PlayerNodeInitializationResult<T = unknown> {
     track: Track;
     extractor: BaseExtractor | null;
@@ -1782,7 +1788,7 @@ declare class Player extends PlayerEventsEmitter<PlayerEvents> {
     /**
      * The current query cache provider in use
      */
-    get queryCache(): QueryCache | null;
+    get queryCache(): QueryCacheProvider<any> | null;
     /**
      * Alias to `Player.nodes`.
      */
@@ -1888,7 +1894,7 @@ declare class Player extends PlayerEventsEmitter<PlayerEvents> {
      */
     search(searchQuery: string | Track | Track[] | Playlist | SearchResult, options?: SearchOptions): Promise<SearchResult>;
     /**
-     * Generates a report of the dependencies used by the `@discordjs/voice` module. Useful for debugging.
+     * Generates a report of the dependencies used by the `discord-voip` module. Useful for debugging.
      * @example ```typescript
      * console.log(player.scanDeps());
      * // -> logs dependencies report
@@ -2300,7 +2306,7 @@ interface PlayerInitOptions {
     lockVoiceStateHandler?: boolean;
     blockExtractors?: string[];
     blockStreamFrom?: string[];
-    queryCache?: QueryCache | null;
+    queryCache?: QueryCacheProvider<any> | null;
     ignoreInstance?: boolean;
     useLegacyFFmpeg?: boolean;
     bridgeProvider?: BridgeProvider;
@@ -2543,4 +2549,4 @@ declare function createHook<T extends HookDeclaration<(...args: any[]) => any>>(
 
 declare const version: string;
 
-export { AFilterGraph, AsyncQueue, AsyncQueueAcquisitionOptions, AsyncQueueEntry, AsyncQueueExceptionHandler, AudioFilters, BaseExtractor, CreateStreamOps, DiscordPlayerQueryResultCache, EqualizerConfigurationPreset, ExtractorExecutionContext, ExtractorExecutionEvents, ExtractorExecutionFN, ExtractorExecutionResult, ExtractorInfo, ExtractorSearchContext, 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, NextFunction, NodeResolvable, OnAfterCreateStreamHandler, OnBeforeCreateStreamHandler, PlayOptions, Player, PlayerEvent, PlayerEvents, PlayerEventsEmitter, PlayerInitOptions, PlayerNodeInitializationResult, PlayerNodeInitializerOptions, PlayerProgressbarOptions, PlayerSearchResult, PlayerTimestamp, PlayerTriggeredReason, Playlist, PlaylistInitData, PlaylistJSON, PostProcessedResult, QueryCache, QueryCacheOptions, QueryCacheResolverContext, QueryExtractorSearch, QueryResolver, QueryType, QueueFilters, QueueRepeatMode, RawTrackData, RawTrackInit, ResolvedQuery, ResourcePlayOptions, SearchOptions, SearchQueryType, SearchResult, SearchResultData, StreamConfig, StreamDispatcher, TimeData, TimelineDispatcherOptions, Track, TrackJSON, TrackLike, TrackResolvable, TrackSource, TypeUtil, Util, VALIDATE_QUEUE_CAP, VoiceConnectConfig, VoiceEvents, VoiceReceiverNode, VoiceReceiverOptions, VoiceStateHandler, VoiceUtils, WithMetadata, createFFmpegStream, createHook, onAfterCreateStream, onBeforeCreateStream, useHistory, useMainPlayer, useMasterPlayer, useMetadata, usePlayer, useQueue, useTimeline, useVolume, version };
+export { AFilterGraph, AsyncQueue, AsyncQueueAcquisitionOptions, AsyncQueueEntry, AsyncQueueExceptionHandler, AudioFilters, BaseExtractor, CreateStreamOps, DiscordPlayerQueryResultCache, EqualizerConfigurationPreset, ExtractorExecutionContext, ExtractorExecutionEvents, ExtractorExecutionFN, ExtractorExecutionResult, ExtractorInfo, ExtractorSearchContext, 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, 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, StreamConfig, StreamDispatcher, TimeData, TimelineDispatcherOptions, Track, TrackJSON, TrackLike, TrackResolvable, TrackSource, TypeUtil, Util, VALIDATE_QUEUE_CAP, VoiceConnectConfig, VoiceEvents, VoiceReceiverNode, VoiceReceiverOptions, VoiceStateHandler, VoiceUtils, WithMetadata, createFFmpegStream, createHook, onAfterCreateStream, onBeforeCreateStream, useHistory, useMainPlayer, useMasterPlayer, useMetadata, usePlayer, useQueue, useTimeline, useVolume, version };