discord-player 7.0.0-dev.2 → 7.0.0-dev.3

package/dist/index.d.ts

@@ -7,11 +7,10 @@ import { EqualizerBand, BiquadFilters, PCMFilters, FiltersChain } from '@discord
 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 * 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 { BridgeProvider } from '@discord-player/extractor';
 import { FFmpegLib } from '@discord-player/ffmpeg';
 export * from '@discord-player/ffmpeg';
 
@@ -1815,8 +1814,8 @@ declare function useHistory<Meta = unknown>(): GuildQueueHistory<Meta> | null;
 declare function usePlayer<Meta = unknown>(): GuildQueuePlayerNode<Meta> | null;
 
 /**
- * Fetch guild queue
- * @param node Guild queue node resolvable
+ * Fetch guild queue.
+ * @param node Guild queue node resolvable. Defaults to inferred guild from context.
  */
 declare function useQueue<Meta = unknown>(): GuildQueue<Meta> | null;
 
@@ -1835,13 +1834,9 @@ declare function useMetadata<T = unknown>(): MetadataDispatch<T>;
 
 interface TimelineDispatcherOptions {
     ignoreFilters: boolean;
+    node: NodeResolvable;
 }
-/**
- * Fetch or manipulate current track
- * @param node Guild queue node resolvable
- * @param options Options for timeline dispatcher
- */
-declare function useTimeline(options?: Partial<TimelineDispatcherOptions>): {
+interface GuildQueueTimeline {
     readonly timestamp: PlayerTimestamp;
     readonly volume: number;
     readonly paused: boolean;
@@ -1850,7 +1845,12 @@ declare function useTimeline(options?: Partial<TimelineDispatcherOptions>): {
     resume(): boolean;
     setVolume(vol: number): boolean;
     setPosition(time: number): Promise<boolean>;
-} | null;
+}
+/**
+ * Fetch or manipulate current track
+ * @param options Options for timeline dispatcher
+ */
+declare function useTimeline(): GuildQueueTimeline | null;
 
 /**
  * Global onAfterCreateStream handler
@@ -1872,10 +1872,6 @@ type VolumeDispatch = readonly [() => number, (volume: number | SetterFN) => boo
  */
 declare function useVolume(): VolumeDispatch;
 
-declare const knownExtractorKeys: readonly ["SpotifyExtractor", "AppleMusicExtractor", "SoundCloudExtractor", "VimeoExtractor", "ReverbnationExtractor", "AttachmentExtractor"];
-type ExtractorLoaderOptionDict = {
-    [K in (typeof knownExtractorKeys)[number]]?: ConstructorParameters<typeof _discord_player_extractor[K]>[1];
-};
 interface ExtractorSession {
     id: string;
     attemptedExtractors: Set<string>;
@@ -1929,13 +1925,14 @@ declare class ExtractorExecutionContext extends PlayerEventsEmitter<ExtractorExe
      * Get the current execution context
      */
     getContext(): ExtractorSession | null;
+    loadDefault(): Promise<void>;
     /**
-     * Load default extractors from `@discord-player/extractor`
+     * Load a bundle of extractors.
+     * @example import { DefaultExtractors } from '@discord-player/extractor';
+     *
+     * await player.extractors.loadMulti(DefaultExtractors);
      */
-    loadDefault(filter?: (ext: (typeof knownExtractorKeys)[number]) => boolean | null, options?: ExtractorLoaderOptionDict): Promise<{
-        success: boolean;
-        error: Error;
-    } | {
+    loadMulti<O extends object, T extends (typeof BaseExtractor<O>)[], R extends Record<T[number]['identifier'], ConstructorParameters<T[number]>[1]>>(bundle: T, options?: R): Promise<{
         success: boolean;
         error: null;
     }>;
@@ -2554,7 +2551,7 @@ declare class GuildNodeManager<Meta = unknown> {
      * Resolve queue
      * @param node Queue resolvable
      */
-    resolve<T = Meta>(node: NodeResolvable): GuildQueue<unknown> | undefined;
+    resolve<T = Meta>(node: NodeResolvable): GuildQueue<T> | undefined;
     /**
      * Resolve queue id
      * @param node Queue resolvable
@@ -3053,6 +3050,10 @@ interface PlayerInitOptions {
      * Configure ffmpeg path
      */
     ffmpegPath?: string;
+    /**
+     * Whether to override the fallback context. Defaults to `true`.
+     */
+    overrideFallbackContext?: boolean;
 }
 
 declare class AudioFilters {
@@ -3254,6 +3255,7 @@ interface DependenciesReport {
         'libsodium-wrappers': MaybeNull<string>;
         'sodium-javascript': MaybeNull<string>;
         '@stablelib/xchacha20poly1305': MaybeNull<string>;
+        '@nobel/ciphers': MaybeNull<string>;
     };
     ffmpeg: FFmpegReport;
 }
@@ -3294,4 +3296,4 @@ declare const DependencyReportGenerator: {
 
 declare const version: string;
 
-export { AFilterGraph, AsyncQueue, AsyncQueueAcquisitionOptions, AsyncQueueEntry, AsyncQueueExceptionHandler, AudioFilters, BaseExtractor, Context, ContextReceiver, CreateStreamOps, DependenciesReport, DependencyReportGenerator, DiscordPlayerQueryResultCache, Encodable, EqualizerConfigurationPreset, ExtractorExecutionContext, ExtractorExecutionEvents, ExtractorExecutionFN, ExtractorExecutionResult, ExtractorInfo, ExtractorLoaderOptionDict, ExtractorResolvable, ExtractorSearchContext, ExtractorSession, ExtractorStreamable, FFMPEG_ARGS_PIPED, FFMPEG_ARGS_STRING, FFMPEG_SRATE_REGEX, FFmpegFilterer, FFmpegReport, FFmpegStreamOptions, FilterGraph, FiltersName, GuildNodeCreateOptions, GuildNodeInit, GuildNodeManager, GuildQueue, GuildQueueAFiltersCache, GuildQueueAudioFilters, GuildQueueEvent, GuildQueueEvents, GuildQueueHistory, GuildQueuePlayerNode, GuildQueueStatistics, GuildQueueStatisticsMetadata, LrcGetParams, LrcGetResult, LrcLib, LrcSearchParams, LrcSearchResult, MaybeNull, MetadataDispatch, NextFunction, NodeResolvable, OnAfterCreateStreamHandler, OnBeforeCreateStreamHandler, PackageJSON, 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, decode, deserialize, encode, isErisProxy, onAfterCreateStream, onBeforeCreateStream, serialize, tryIntoThumbnailString, useContext, useHistory, useMainPlayer, useMetadata, usePlayer, useQueue, useTimeline, useVolume, version };
+export { AFilterGraph, AsyncQueue, AsyncQueueAcquisitionOptions, AsyncQueueEntry, AsyncQueueExceptionHandler, AudioFilters, BaseExtractor, Context, ContextReceiver, CreateStreamOps, DependenciesReport, DependencyReportGenerator, DiscordPlayerQueryResultCache, Encodable, EqualizerConfigurationPreset, ExtractorExecutionContext, ExtractorExecutionEvents, ExtractorExecutionFN, ExtractorExecutionResult, ExtractorInfo, ExtractorResolvable, ExtractorSearchContext, ExtractorSession, ExtractorStreamable, FFMPEG_ARGS_PIPED, FFMPEG_ARGS_STRING, FFMPEG_SRATE_REGEX, FFmpegFilterer, FFmpegReport, FFmpegStreamOptions, FilterGraph, FiltersName, GuildNodeCreateOptions, GuildNodeInit, GuildNodeManager, GuildQueue, GuildQueueAFiltersCache, GuildQueueAudioFilters, GuildQueueEvent, GuildQueueEvents, GuildQueueHistory, GuildQueuePlayerNode, GuildQueueStatistics, GuildQueueStatisticsMetadata, GuildQueueTimeline, LrcGetParams, LrcGetResult, LrcLib, LrcSearchParams, LrcSearchResult, MaybeNull, MetadataDispatch, NextFunction, NodeResolvable, OnAfterCreateStreamHandler, OnBeforeCreateStreamHandler, PackageJSON, 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, decode, deserialize, encode, isErisProxy, onAfterCreateStream, onBeforeCreateStream, serialize, tryIntoThumbnailString, useContext, useHistory, useMainPlayer, useMetadata, usePlayer, useQueue, useTimeline, useVolume, version };