discord-player 6.8.0-dev.0 → 7.0.0-dev.0

package/dist/index.d.ts

@@ -1,18 +1,17 @@
 import * as discord_js from 'discord.js';
-import { Client, VoiceChannel, StageChannel, UserResolvable, Guild, VoiceState, VoiceBasedChannel, GuildVoiceChannelResolvable, User, Snowflake, GuildResolvable } from 'discord.js';
+import { Client, VoiceChannel, StageChannel, Guild, VoiceState, VoiceBasedChannel, GuildVoiceChannelResolvable, User, Snowflake, GuildResolvable, UserResolvable } from 'discord.js';
 import Eris from 'eris';
 import { ListenerSignature, DefaultListener, EventEmitter, Queue, QueueStrategy, Collection } from '@discord-player/utils';
 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 as Readable$1 } from 'node:stream';
-import { StreamType, AudioPlayerError, AudioResource, VoiceConnection, AudioPlayer, AudioPlayerStatus, EndBehaviorType } from 'discord-voip';
-export { AudioPlayer, CreateAudioPlayerOptions, createAudioPlayer, getVoiceConnection, getVoiceConnections } from 'discord-voip';
 import * as stream from 'stream';
 import { Readable, Duplex } from 'stream';
 import * as _discord_player_extractor from '@discord-player/extractor';
 import { BridgeProvider } from '@discord-player/extractor';
 import { RequestOptions } from 'http';
+import { StreamType, AudioPlayerError, AudioResource, VoiceConnection, AudioPlayer, AudioPlayerStatus } from 'discord-voip';
+export { AudioPlayer, CreateAudioPlayerOptions, JoinConfig, JoinVoiceChannelOptions, createAudioPlayer, getVoiceConnection, getVoiceConnections, joinVoiceChannel } from 'discord-voip';
 import * as _discord_player_ffmpeg from '@discord-player/ffmpeg';
 import { FFmpeg } from '@discord-player/ffmpeg';
 export * from '@discord-player/ffmpeg';
@@ -72,7 +71,6 @@ declare class StreamDispatcher extends EventEmitter<VoiceEvents> {
     readonly connectionTimeout: number;
     voiceConnection: VoiceConnection;
     audioPlayer: AudioPlayer;
-    receiver: VoiceReceiverNode;
     channel: VoiceChannel | StageChannel;
     audioResource?: AudioResource<Track> | null;
     dsp: FiltersChain;
@@ -190,30 +188,6 @@ declare class StreamDispatcher extends EventEmitter<VoiceEvents> {
     get streamTime(): number;
 }
 
-interface VoiceReceiverOptions {
-    mode?: 'opus' | 'pcm';
-    end?: EndBehaviorType;
-    silenceDuration?: number;
-    crc?: boolean;
-}
-type RawTrackInit = Partial<Omit<RawTrackData, 'author' | 'playlist' | 'source' | 'engine' | 'raw' | 'queryType' | 'description' | 'views'>>;
-declare class VoiceReceiverNode {
-    dispatcher: StreamDispatcher;
-    constructor(dispatcher: StreamDispatcher);
-    createRawTrack(stream: Readable$1, data?: RawTrackInit): Track<unknown>;
-    /**
-     * Merge multiple streams together
-     * @param streams The array of streams to merge
-     */
-    mergeRecordings(streams: Readable$1[]): void;
-    /**
-     * Record a user in voice channel
-     * @param user The user to record
-     * @param options Recording options
-     */
-    recordUser(user: UserResolvable, options?: VoiceReceiverOptions): Readable$1;
-}
-
 declare class GuildQueueHistory<Meta = unknown> {
     queue: GuildQueue<Meta>;
     tracks: Queue<Track<unknown>>;
@@ -963,6 +937,7 @@ interface GuildNodeInit<Meta = unknown> {
     disableFilterer: boolean;
     disableBiquad: boolean;
     disableResampler: boolean;
+    disableFallbackStream: boolean;
 }
 interface VoiceConnectConfig {
     deaf?: boolean;
@@ -1338,10 +1313,6 @@ declare class GuildQueue<Meta = unknown> {
      * Formatted duration of this queue
      */
     get durationFormatted(): string;
-    /**
-     * 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' });
@@ -1606,6 +1577,8 @@ declare class Track<T = unknown> {
     private __reqMetadataFn;
     cleanTitle: string;
     live: boolean;
+    bridgedExtractor: BaseExtractor | null;
+    bridgedTrack: Track | null;
     /**
      * Track constructor
      * @param player The player that instantiated this Track
@@ -1751,7 +1724,7 @@ declare class Playlist {
         title: string;
         description: string;
         thumbnail: any;
-        type: "playlist" | "album";
+        type: "album" | "playlist";
         source: TrackSource;
         author: {
             name: string;
@@ -1776,10 +1749,165 @@ declare class Playlist {
     play<T = unknown>(channel: GuildVoiceChannelResolvable, options?: PlayerNodeInitializerOptions<T>): Promise<PlayerNodeInitializationResult<T>>;
 }
 
+type unsafe = any;
+/**
+ * The receiver function that will be called when the context is provided
+ */
+type ContextReceiver<R> = () => R;
+declare class Context<T> {
+    private defaultValue?;
+    private storage;
+    constructor(defaultValue?: T | undefined);
+    /**
+     * Exit out of this context
+     */
+    exit(scope: ContextReceiver<void>): void;
+    /**
+     * Whether the context is lost
+     */
+    get isLost(): boolean;
+    /**
+     * Get the current value of the context. If the context is lost and no default value is provided, undefined will be returned.
+     */
+    consume(): T | undefined;
+    /**
+     * Run a function within the context of this provider
+     */
+    provide<R = unsafe>(value: T, receiver: ContextReceiver<R>): R;
+}
+/**
+ * Create a new context. The default value is optional.
+ * @param defaultValue The default value of the context
+ * @example const userContext = createContext();
+ *
+ *  // the value to provide
+ *  const user = {
+ *   id: 1,
+ *   name: 'John Doe'
+ *  };
+ *
+ *  // provide the context value to the receiver
+ *  context.provide(user, handler);
+ *
+ *  function handler() {
+ *    // get the context value
+ *    const { id, name } = useContext(context);
+ *
+ *    console.log(id, name); // 1, John Doe
+ *  }
+ */
+declare function createContext<T = unsafe>(defaultValue?: T): Context<T>;
+/**
+ * Get the current value of the context. If the context is lost and no default value is provided, undefined will be returned.
+ * @param context The context to get the value from
+ * @example const value = useContext(context);
+ */
+declare function useContext<T = unsafe>(context: Context<T>): T | undefined;
+
+/**
+ * Fetch guild queue history
+ * @param node guild queue node resolvable
+ */
+declare function useHistory<Meta = unknown>(): GuildQueueHistory<Meta> | null;
+declare function useHistory<Meta = unknown>(node: NodeResolvable): GuildQueueHistory<Meta> | null;
+
+/**
+ * Fetch guild queue player node
+ * @param node Guild queue node resolvable
+ */
+declare function usePlayer<Meta = unknown>(): GuildQueuePlayerNode<Meta> | null;
+declare function usePlayer<Meta = unknown>(node: NodeResolvable): GuildQueuePlayerNode<Meta> | null;
+
+/**
+ * Fetch guild queue
+ * @param node Guild queue node resolvable
+ */
+declare function useQueue<Meta = unknown>(): GuildQueue<Meta> | null;
+declare function useQueue<Meta = unknown>(node: NodeResolvable): GuildQueue<Meta> | null;
+
+/**
+ * Fetch main player instance
+ * @deprecated
+ */
+declare function useMasterPlayer(): Player;
+/**
+ * Fetch main player instance
+ */
+declare function useMainPlayer(): Player;
+
+type SetterFN$1<T, P> = (previous: P) => T;
+type MetadataDispatch<T> = readonly [() => T, (metadata: T | SetterFN$1<T, T>) => void];
+/**
+ * Fetch or manipulate guild queue metadata
+ * @param node Guild queue node resolvable
+ */
+declare function useMetadata<T = unknown>(): MetadataDispatch<T>;
+declare function useMetadata<T = unknown>(node: NodeResolvable): MetadataDispatch<T>;
+
+interface TimelineDispatcherOptions {
+    ignoreFilters: boolean;
+}
+/**
+ * Fetch or manipulate current track
+ * @param node Guild queue node resolvable
+ * @param options Options for timeline dispatcher
+ */
+declare function useTimeline(node?: NodeResolvable, options?: Partial<TimelineDispatcherOptions>): {
+    readonly timestamp: PlayerTimestamp;
+    readonly volume: number;
+    readonly paused: boolean;
+    readonly track: Track<unknown> | null;
+    pause(): boolean;
+    resume(): boolean;
+    setVolume(vol: number): boolean;
+    setPosition(time: number): Promise<boolean>;
+} | null;
+
+/**
+ * Global onAfterCreateStream handler
+ * @param handler The handler callback
+ */
+declare function onAfterCreateStream(handler: OnAfterCreateStreamHandler): void;
+
+/**
+ * Global onBeforeCreateStream handler
+ * @param handler The handler callback
+ */
+declare function onBeforeCreateStream(handler: OnBeforeCreateStreamHandler): void;
+
+type SetterFN = (previous: number) => number;
+type VolumeDispatch = readonly [() => number, (volume: number | SetterFN) => boolean | undefined];
+/**
+ * Fetch or manipulate player volume
+ * @param node Guild queue node resolvable
+ */
+declare function useVolume(): VolumeDispatch;
+declare function useVolume(node: NodeResolvable): VolumeDispatch;
+
+declare const instances: Collection<string, Player>;
+
+declare const getPlayer: () => Player | null;
+interface HooksCtx {
+    guild: Guild;
+}
+declare const getQueue: <T = unknown>(node: NodeResolvable) => GuildQueue<T> | null;
+interface HookDeclarationContext {
+    getQueue: typeof getQueue;
+    getPlayer: typeof getPlayer;
+    instances: typeof instances;
+}
+type HookDeclaration<T extends (...args: any[]) => any> = (context: HookDeclarationContext) => T;
+declare function createHook<T extends HookDeclaration<(...args: any[]) => any>>(hook: T): ReturnType<T>;
+
 declare const knownExtractorKeys: readonly ["SpotifyExtractor", "AppleMusicExtractor", "SoundCloudExtractor", "YouTubeExtractor", "VimeoExtractor", "ReverbnationExtractor", "AttachmentExtractor"];
 type ExtractorLoaderOptionDict = {
     [K in (typeof knownExtractorKeys)[number]]?: ConstructorParameters<typeof _discord_player_extractor[K]>[1];
 };
+interface ExtractorSession {
+    id: string;
+    attemptedExtractors: Set<string>;
+    bridgeAttemptedExtractors: Set<string>;
+}
 interface ExtractorExecutionEvents {
     /**
      * Emitted when a extractor is registered
@@ -1818,7 +1946,16 @@ declare class ExtractorExecutionContext extends PlayerEventsEmitter<ExtractorExe
      * The extractors store
      */
     store: Collection<string, BaseExtractor<object>>;
+    readonly context: Context<ExtractorSession>;
     constructor(player: Player);
+    /**
+     * Get the current execution id
+     */
+    getExecutionId(): string | null;
+    /**
+     * Get the current execution context
+     */
+    getContext(): ExtractorSession | null;
     /**
      * Load default extractors from `@discord-player/extractor`
      */
@@ -1869,7 +2006,7 @@ declare class ExtractorExecutionContext extends PlayerEventsEmitter<ExtractorExe
      * @param track The track to request bridge for
      * @param sourceExtractor The source extractor of the track
      */
-    requestBridge(track: Track, sourceExtractor?: BaseExtractor | null): Promise<ExtractorExecutionResult<false> | ExtractorExecutionResult<ExtractorStreamable> | undefined>;
+    requestBridge(track: Track, sourceExtractor?: BaseExtractor | null): Promise<ExtractorExecutionResult<ExtractorStreamable>>;
     /**
      * Request bridge from the specified extractor
      * @param track The track to request bridge for
@@ -2212,156 +2349,6 @@ declare class IPRotator {
     static getRandomIP(address: string, start?: number, end?: number): string;
 }
 
-type unsafe = any;
-/**
- * The receiver function that will be called when the context is provided
- */
-type ContextReceiver<R> = () => R;
-declare class Context<T> {
-    private defaultValue?;
-    private storage;
-    constructor(defaultValue?: T | undefined);
-    /**
-     * Exit out of this context
-     */
-    exit(scope: ContextReceiver<void>): void;
-    /**
-     * Whether the context is lost
-     */
-    get isLost(): boolean;
-    /**
-     * Get the current value of the context. If the context is lost and no default value is provided, undefined will be returned.
-     */
-    consume(): T | undefined;
-    /**
-     * Run a function within the context of this provider
-     */
-    provide<R = unsafe>(value: T, receiver: ContextReceiver<R>): R;
-}
-/**
- * Create a new context. The default value is optional.
- * @param defaultValue The default value of the context
- * @example const userContext = createContext();
- *
- *  // the value to provide
- *  const user = {
- *   id: 1,
- *   name: 'John Doe'
- *  };
- *
- *  // provide the context value to the receiver
- *  context.provide(user, handler);
- *
- *  function handler() {
- *    // get the context value
- *    const { id, name } = useContext(context);
- *
- *    console.log(id, name); // 1, John Doe
- *  }
- */
-declare function createContext<T = unsafe>(defaultValue?: T): Context<T>;
-/**
- * Get the current value of the context. If the context is lost and no default value is provided, undefined will be returned.
- * @param context The context to get the value from
- * @example const value = useContext(context);
- */
-declare function useContext<T = unsafe>(context: Context<T>): T | undefined;
-
-/**
- * Fetch guild queue history
- * @param node guild queue node resolvable
- */
-declare function useHistory<Meta = unknown>(): GuildQueueHistory<Meta> | null;
-declare function useHistory<Meta = unknown>(node: NodeResolvable): GuildQueueHistory<Meta> | null;
-
-/**
- * Fetch guild queue player node
- * @param node Guild queue node resolvable
- */
-declare function usePlayer<Meta = unknown>(): GuildQueuePlayerNode<Meta> | null;
-declare function usePlayer<Meta = unknown>(node: NodeResolvable): GuildQueuePlayerNode<Meta> | null;
-
-/**
- * Fetch guild queue
- * @param node Guild queue node resolvable
- */
-declare function useQueue<Meta = unknown>(): GuildQueue<Meta> | null;
-declare function useQueue<Meta = unknown>(node: NodeResolvable): GuildQueue<Meta> | null;
-
-/**
- * Fetch main player instance
- * @deprecated
- */
-declare function useMasterPlayer(): Player;
-/**
- * Fetch main player instance
- */
-declare function useMainPlayer(): Player;
-
-type SetterFN$1<T, P> = (previous: P) => T;
-type MetadataDispatch<T> = readonly [() => T, (metadata: T | SetterFN$1<T, T>) => void];
-/**
- * Fetch or manipulate guild queue metadata
- * @param node Guild queue node resolvable
- */
-declare function useMetadata<T = unknown>(): MetadataDispatch<T>;
-declare function useMetadata<T = unknown>(node: NodeResolvable): MetadataDispatch<T>;
-
-interface TimelineDispatcherOptions {
-    ignoreFilters: boolean;
-}
-/**
- * Fetch or manipulate current track
- * @param node Guild queue node resolvable
- * @param options Options for timeline dispatcher
- */
-declare function useTimeline(node?: NodeResolvable, options?: Partial<TimelineDispatcherOptions>): {
-    readonly timestamp: PlayerTimestamp;
-    readonly volume: number;
-    readonly paused: boolean;
-    readonly track: Track<unknown> | null;
-    pause(): boolean;
-    resume(): boolean;
-    setVolume(vol: number): boolean;
-    setPosition(time: number): Promise<boolean>;
-} | null;
-
-/**
- * Global onAfterCreateStream handler
- * @param handler The handler callback
- */
-declare function onAfterCreateStream(handler: OnAfterCreateStreamHandler): void;
-
-/**
- * Global onBeforeCreateStream handler
- * @param handler The handler callback
- */
-declare function onBeforeCreateStream(handler: OnBeforeCreateStreamHandler): void;
-
-type SetterFN = (previous: number) => number;
-type VolumeDispatch = readonly [() => number, (volume: number | SetterFN) => boolean | undefined];
-/**
- * Fetch or manipulate player volume
- * @param node Guild queue node resolvable
- */
-declare function useVolume(): VolumeDispatch;
-declare function useVolume(node: NodeResolvable): VolumeDispatch;
-
-declare const instances: Collection<string, Player>;
-
-declare const getPlayer: () => Player | null;
-interface HooksCtx {
-    guild: Guild;
-}
-declare const getQueue: <T = unknown>(node: NodeResolvable) => GuildQueue<T> | null;
-interface HookDeclarationContext {
-    getQueue: typeof getQueue;
-    getPlayer: typeof getPlayer;
-    instances: typeof instances;
-}
-type HookDeclaration<T extends (...args: any[]) => any> = (context: HookDeclarationContext) => T;
-declare function createHook<T extends HookDeclaration<(...args: any[]) => any>>(hook: T): ReturnType<T>;
-
 interface PlayerNodeInitializationResult<T = unknown> {
     track: Track;
     extractor: BaseExtractor | null;
@@ -2621,6 +2608,7 @@ interface GuildNodeCreateOptions<T = unknown> {
     disableFilterer?: boolean;
     disableBiquad?: boolean;
     disableResampler?: boolean;
+    disableFallbackStream?: boolean;
 }
 type NodeResolvable = GuildQueue | GuildResolvable;
 declare class GuildNodeManager<Meta = unknown> {
@@ -3343,4 +3331,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, 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, createErisCompat, createFFmpegStream, createHook, decode, deserialize, encode, isErisProxy, 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, ExtractorSession, 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, 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, VoiceStateHandler, VoiceUtils, WithMetadata, createContext, createErisCompat, createFFmpegStream, createHook, decode, deserialize, encode, isErisProxy, onAfterCreateStream, onBeforeCreateStream, serialize, tryIntoThumbnailString, useContext, useHistory, useMainPlayer, useMasterPlayer, useMetadata, usePlayer, useQueue, useTimeline, useVolume, version };