discord-player 6.6.5-dev.0 → 6.6.5-dev.3

package/dist/index.d.ts

@@ -13,9 +13,17 @@ import { BridgeProvider } from '@discord-player/extractor';
 export * from '@discord-player/ffmpeg';
 
 declare class PlayerEventsEmitter<L extends ListenerSignature<L> = DefaultListener> extends EventEmitter<L> {
+    #private;
     requiredEvents: Array<keyof L>;
     constructor(requiredEvents?: Array<keyof L>);
+    on<K extends keyof L>(name: K, listener: L[K]): this;
+    once<K extends keyof L>(name: K, listener: L[K]): this;
+    addListener<K extends keyof L>(name: K, listener: L[K]): this;
+    off<K extends keyof L>(name: K, listener: L[K]): this;
+    removeListener<K extends keyof L>(name: K, listener: L[K]): this;
+    removeAllListeners<K extends keyof L>(name?: K): this;
     emit<K extends keyof L>(name: K, ...args: Parameters<L[K]>): boolean;
+    get hasDebugger(): boolean;
 }
 
 interface CreateStreamOps {
@@ -322,6 +330,10 @@ interface ResourcePlayOptions {
     seek?: number;
     transitionMode?: boolean;
 }
+interface SkipOptions {
+    reason: TrackSkipReason;
+    description: string;
+}
 interface PlayerTimestamp {
     current: {
         label: string;
@@ -435,7 +447,7 @@ declare class GuildQueuePlayerNode<Meta = unknown> {
     /**
      * Skip current track
      */
-    skip(): boolean;
+    skip(options?: SkipOptions): boolean;
     /**
      * Remove the given track from queue
      * @param track The track to remove
@@ -668,7 +680,7 @@ declare class AFilterGraph<Meta = unknown> {
     constructor(af: GuildQueueAudioFilters<Meta>);
     get ffmpeg(): (keyof QueueFilters)[];
     get equalizer(): EqualizerBand[];
-    get biquad(): null;
+    get biquad(): "SinglePoleLowPassApprox" | "SinglePoleLowPass" | "LowPass" | "HighPass" | "BandPass" | "Notch" | "AllPass" | "LowShelf" | "HighShelf" | "PeakingEQ" | null;
     get filters(): ("8D" | "Tremolo" | "Vibrato")[];
     get volume(): _discord_player_equalizer.VolumeTransformer | null;
     get resampler(): _discord_player_equalizer.PCMResampler | null;
@@ -723,7 +735,6 @@ interface GuildNodeInit<Meta = unknown> {
     filterer: PCMFilters[] | boolean;
     ffmpegFilters: FiltersName[];
     disableHistory: boolean;
-    skipOnNoStream: boolean;
     onBeforeCreateStream?: OnBeforeCreateStreamHandler;
     onAfterCreateStream?: OnAfterCreateStreamHandler;
     repeatMode?: QueueRepeatMode;
@@ -879,6 +890,14 @@ declare const GuildQueueEvent: {
      */
     readonly willAutoPlay: "willAutoPlay";
 };
+declare enum TrackSkipReason {
+    NoStream = "ERR_NO_STREAM",
+    Manual = "MANUAL",
+    SEEK_OVER_THRESHOLD = "SEEK_OVER_THRESHOLD",
+    Jump = "JUMPED_TO_ANOTHER_TRACK",
+    SkipTo = "SKIP_TO_ANOTHER_TRACK",
+    HistoryNext = "HISTORY_NEXT_TRACK"
+}
 interface GuildQueueEvents<Meta = any> {
     /**
      * Emitted when audio track is added to the queue
@@ -964,8 +983,10 @@ interface GuildQueueEvents<Meta = any> {
      * Emitted when the audio player skips current track
      * @param queue The queue where this event occurred
      * @param track The track that was skipped
+     * @param reason The reason for skipping
+     * @param description The description for skipping
      */
-    playerSkip: (queue: GuildQueue<Meta>, track: Track) => unknown;
+    playerSkip: (queue: GuildQueue<Meta>, track: Track, reason: TrackSkipReason, description: string) => unknown;
     /**
      * Emitted when the audio player is triggered
      * @param queue The queue where this event occurred
@@ -1238,6 +1259,27 @@ declare class GuildQueue<Meta = unknown> {
      * @param options Join config
      */
     connect(channelResolvable: GuildVoiceChannelResolvable, options?: VoiceConnectConfig): Promise<this>;
+    /**
+     * Enable shuffle mode for this queue
+     * @param dynamic Whether to shuffle the queue dynamically. Defaults to `true`.
+     * Dynamic shuffling will shuffle the queue when the current track ends, without mutating the queue.
+     * If set to `false`, the queue will be shuffled immediately in-place, which cannot be undone.
+     */
+    enableShuffle(dynamic?: boolean): boolean;
+    /**
+     * Disable shuffle mode for this queue.
+     */
+    disableShuffle(): boolean;
+    /**
+     * Toggle shuffle mode for this queue.
+     * @param dynamic Whether to shuffle the queue dynamically. Defaults to `true`.
+     * @returns Whether shuffle is enabled or disabled.
+     */
+    toggleShuffle(dynamic?: boolean): boolean;
+    /**
+     * Whether shuffle mode is enabled for this queue.
+     */
+    get isShuffling(): boolean;
     /**
      * The voice connection latency of this queue
      */
@@ -1904,7 +1946,6 @@ declare class Player extends PlayerEventsEmitter<PlayerEvents> {
      * @param {PlayerInitOptions} [options] The player init options
      */
     constructor(client: Client, options?: PlayerInitOptions);
-    get hasDebugger(): boolean;
     /**
      * Override default voice state update handler
      * @param handler The handler callback
@@ -2064,7 +2105,6 @@ interface GuildNodeCreateOptions<T = unknown> {
     biquad?: BiquadFilters;
     resampler?: number;
     disableHistory?: boolean;
-    skipOnNoStream?: boolean;
     onBeforeCreateStream?: OnBeforeCreateStreamHandler;
     onAfterCreateStream?: OnAfterCreateStreamHandler;
     repeatMode?: QueueRepeatMode;
@@ -2615,6 +2655,10 @@ interface PlayerInitOptions {
      * Skip ffmpeg process when possible
      */
     skipFFmpeg?: boolean;
+    /**
+     * The probe timeout in milliseconds. Defaults to 5000.
+     */
+    probeTimeout?: number;
 }
 
 declare class AudioFilters {
@@ -2715,6 +2759,7 @@ declare class Util {
     static getFetch(): Promise<any>;
     static warn(message: string, code?: string, detail?: string): void;
     static randomChoice<T>(src: T[]): T;
+    static arrayCloneShuffle<T>(src: T[]): T[];
 }
 declare const VALIDATE_QUEUE_CAP: (queue: GuildQueue, items: Playlist | Track | Track[]) => void;
 
@@ -2752,6 +2797,10 @@ declare class QueryResolver {
         soundcloudPlaylistRegex: RegExp;
         youtubePlaylistRegex: RegExp;
     };
+    /**
+     * Pre-resolve redirect urls
+     */
+    static preResolve(query: string, maxDepth?: number): Promise<string>;
     /**
      * Resolves the given search query
      * @param {string} query The query
@@ -2854,4 +2903,4 @@ declare function createHook<T extends HookDeclaration<(...args: any[]) => any>>(
 
 declare const version: string;
 
-export { AFilterGraph, AsyncQueue, AsyncQueueAcquisitionOptions, AsyncQueueEntry, AsyncQueueExceptionHandler, AudioFilters, BaseExtractor, CreateStreamOps, DiscordPlayerQueryResultCache, Encodable, EqualizerConfigurationPreset, ExtractorExecutionContext, ExtractorExecutionEvents, ExtractorExecutionFN, ExtractorExecutionResult, ExtractorInfo, 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, 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, StreamConfig, StreamDispatcher, TimeData, TimelineDispatcherOptions, Track, TrackJSON, TrackLike, TrackResolvable, TrackSource, TypeUtil, Util, VALIDATE_QUEUE_CAP, VoiceConnectConfig, VoiceEvents, VoiceReceiverNode, VoiceReceiverOptions, VoiceStateHandler, VoiceUtils, WithMetadata, createFFmpegStream, createHook, decode, deserialize, encode, onAfterCreateStream, onBeforeCreateStream, serialize, tryIntoThumbnailString, useHistory, useMainPlayer, useMasterPlayer, useMetadata, usePlayer, useQueue, useTimeline, useVolume, version };
+export { AFilterGraph, AsyncQueue, AsyncQueueAcquisitionOptions, AsyncQueueEntry, AsyncQueueExceptionHandler, AudioFilters, BaseExtractor, CreateStreamOps, DiscordPlayerQueryResultCache, Encodable, EqualizerConfigurationPreset, ExtractorExecutionContext, ExtractorExecutionEvents, ExtractorExecutionFN, ExtractorExecutionResult, ExtractorInfo, 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, 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, SkipOptions, StreamConfig, StreamDispatcher, TimeData, TimelineDispatcherOptions, Track, TrackJSON, TrackLike, TrackResolvable, TrackSkipReason, TrackSource, TypeUtil, Util, VALIDATE_QUEUE_CAP, VoiceConnectConfig, VoiceEvents, VoiceReceiverNode, VoiceReceiverOptions, VoiceStateHandler, VoiceUtils, WithMetadata, createFFmpegStream, createHook, decode, deserialize, encode, onAfterCreateStream, onBeforeCreateStream, serialize, tryIntoThumbnailString, useHistory, useMainPlayer, useMasterPlayer, useMetadata, usePlayer, useQueue, useTimeline, useVolume, version };