discord-player 7.1.1-dev.0 → 7.2.0-dev.0

package/dist/index.d.ts

@@ -1,10 +1,11 @@
 import * as discord_js from 'discord.js';
 import { Client, User, UserResolvable, GuildVoiceChannelResolvable, VoiceChannel, StageChannel, Guild, VoiceState, VoiceBasedChannel, GuildResolvable, Snowflake } from 'discord.js';
 import Eris from 'eris';
+import * as Oceanic from 'oceanic.js';
 import { ListenerSignature, DefaultListener, EventEmitter, Collection, Queue, QueueStrategy } from '@discord-player/utils';
 import { Readable, Duplex } from 'stream';
 import * as _discord_player_equalizer from '@discord-player/equalizer';
-import { EqualizerBand, BiquadFilters, PCMFilters, FiltersChain } from '@discord-player/equalizer';
+import { SeekEvent, EqualizerBand, BiquadFilters, PCMFilters, CommonResamplerFilterPreset, ResampleParameters, CompressorParameters, ReverbParameters, SeekerParameters, 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 { AudioResource, StreamType, AudioPlayerError, VoiceConnection, AudioPlayer, AudioPlayerStatus } from 'discord-voip';
 export { AudioPlayer, CreateAudioPlayerOptions, JoinConfig, JoinVoiceChannelOptions, StreamType, createAudioPlayer, createAudioResource, getVoiceConnection, getVoiceConnections, joinVoiceChannel } from 'discord-voip';
@@ -13,7 +14,6 @@ import { RequestOptions } from 'http';
 import { FFmpegLib } from '@discord-player/ffmpeg';
 export * from '@discord-player/ffmpeg';
 
-declare function isErisProxy(client: any): client is Eris.Client;
 /**
  * Allows Eris clients to be used with discord-player. When this method is called, discord-player creates a proxy object that intercepts certain methods and properties to make it compatible with discord-player.
  * @param client The Eris client to be used.
@@ -21,6 +21,16 @@ declare function isErisProxy(client: any): client is Eris.Client;
  */
 declare function createErisCompat(client: Eris.Client): Client;
 
+/**
+ * Allows Oceanic.js clients to be used with discord-player. When this method is called, discord-player creates a proxy object that intercepts certain methods and properties to make it compatible with discord-player.
+ * @param client The Oceanic.js client to be used.
+ * @returns The Oceanic.js client with discord-player compatibility.
+ */
+declare function createOceanicCompat(client: Oceanic.Client): Client;
+
+declare function isErisProxy(client: any): boolean;
+declare function isOceanicProxy(client: any): boolean;
+
 declare class PlayerEventsEmitter<L extends ListenerSignature<L> = DefaultListener> extends EventEmitter<L> {
     #private;
     requiredEvents: Array<keyof L>;
@@ -492,6 +502,20 @@ declare class Track<T = unknown> {
      * @param data Track data
      */
     constructor(player: Player, data: Partial<WithMetadata<RawTrackData, T>>);
+    /**
+     * Whether this track can be seeked
+     */
+    get seekable(): boolean;
+    /**
+     * Set the onSeek event
+     * @param fn The onSeek event
+     */
+    handleSeek(fn: (event: SeekEvent) => Awaited<void>): void;
+    /**
+     * Request seek
+     * @param event The seek event
+     */
+    seek(event: SeekEvent): Promise<void>;
     /**
      * Sets audio resource for this track. This is not useful outside of the library.
      * @param resource Audio resource
@@ -589,14 +613,36 @@ interface CreateStreamOps {
     disableVolume?: boolean;
     disableEqualizer?: boolean;
     disableBiquad?: boolean;
+    disableCompressor?: boolean;
+    disableResampler?: boolean;
+    disableReverb?: boolean;
+    disableSeeker?: boolean;
     eq?: EqualizerBand[];
     biquadFilter?: BiquadFilters;
     disableFilters?: boolean;
     defaultFilters?: PCMFilters[];
     volume?: number;
-    disableResampler?: boolean;
     sampleRate?: number;
+    sampleRateFilters?: CommonResamplerFilterPreset;
     skipFFmpeg?: boolean;
+    compressor?: {
+        threshold: number;
+        ratio: number;
+        attack: number;
+        release: number;
+        makeupGain: number;
+        kneeWidth: number;
+    };
+    reverb?: {
+        roomSize: number;
+        damping: number;
+        wetLevel: number;
+        dryLevel: number;
+    };
+    seeker?: {
+        seekTarget: number | null;
+        totalDuration: number;
+    };
 }
 interface VoiceEvents {
     error: (error: AudioPlayerError) => any;
@@ -605,8 +651,11 @@ interface VoiceEvents {
     finish: (resource: AudioResource<Track>) => any;
     dsp: (filters: PCMFilters[]) => any;
     eqBands: (filters: EqualizerBand[]) => any;
-    sampleRate: (filters: number) => any;
+    sampleRate: (filters: ResampleParameters) => any;
     biquad: (filters: BiquadFilters) => any;
+    compressor: (filters: CompressorParameters) => any;
+    reverb: (filters: ReverbParameters) => any;
+    seeker: (filters: SeekerParameters) => any;
     volume: (volume: number) => any;
     destroyed: () => any;
 }
@@ -678,6 +727,9 @@ declare class StreamDispatcher extends EventEmitter<VoiceEvents> {
     get filters(): _discord_player_equalizer.AudioFilter | null;
     get biquad(): _discord_player_equalizer.BiquadStream | null;
     get equalizer(): _discord_player_equalizer.EqualizerStream | null;
+    get compressor(): _discord_player_equalizer.CompressorTransformer | null;
+    get reverb(): _discord_player_equalizer.ReverbTransformer | null;
+    get seeker(): _discord_player_equalizer.PCMSeekerTransformer | null;
     /**
      * The player status
      * @type {AudioPlayerStatus}
@@ -1061,6 +1113,11 @@ declare class GuildQueuePlayerNode<Meta = any> {
      * @param force Whether or not to forcefully stop the playback
      */
     stop(force?: boolean): boolean;
+    /**
+     * Request the source to seek
+     * @param data The seek parameters
+     */
+    requestSeek(data: SeekEvent): Promise<boolean | void>;
     /**
      * Play the given track
      * @param res The track to play
@@ -1199,6 +1256,9 @@ interface GuildQueueAFiltersCache {
     filters: PCMFilters[];
     volume: number;
     sampleRate: number;
+    sampleRateFilter: StreamConfig['dispatcherConfig']['sampleRateFilters'] | null;
+    compressor: StreamConfig['dispatcherConfig']['compressor'] | null;
+    reverb: StreamConfig['dispatcherConfig']['reverb'] | null;
 }
 declare class GuildQueueAudioFilters<Meta = any> {
     queue: GuildQueue<Meta>;
@@ -1227,6 +1287,18 @@ declare class GuildQueueAudioFilters<Meta = any> {
      * Audio resampler
      */
     get resampler(): _discord_player_equalizer.PCMResampler | null;
+    /**
+     * Compressor transformer
+     */
+    get compressor(): _discord_player_equalizer.CompressorTransformer | null;
+    /**
+     * Reverb transformer
+     */
+    get reverb(): _discord_player_equalizer.ReverbTransformer | null;
+    /**
+     * PCM Seeker transformer
+     */
+    get seeker(): _discord_player_equalizer.PCMSeekerTransformer | null;
     /**
      * Replay current track in transition mode
      * @param seek The duration to seek to
@@ -1506,6 +1578,9 @@ interface GuildNodeInit<Meta = any> {
     disableFilterer: boolean;
     disableBiquad: boolean;
     disableResampler: boolean;
+    disableCompressor: boolean;
+    disableReverb: boolean;
+    disableSeeker: boolean;
     disableFallbackStream: boolean;
     enableStreamInterceptor: boolean;
     verifyFallbackStream: boolean;
@@ -1644,6 +1719,22 @@ declare const GuildQueueEvent: {
      * Emitted when sample rate is updated
      */
     readonly SampleRateUpdate: "sampleRateUpdate";
+    /**
+     * Emitted when a named sample rate filter is updated
+     */
+    readonly SampleRateFilterUpdate: "sampleRateFilterUpdate";
+    /**
+     * Emitted when reverb filter is updated
+     */
+    readonly ReverbUpdate: "reverbUpdate";
+    /**
+     * Emitted when compressor filter is updated
+     */
+    readonly CompressorUpdate: "compressorUpdate";
+    /**
+     * Emitted when seek is performed
+     */
+    readonly PlayerSeek: "playerSeek";
 };
 type GuildQueueEvent = (typeof GuildQueueEvent)[keyof typeof GuildQueueEvent];
 declare enum TrackSkipReason {
@@ -1839,6 +1930,33 @@ interface GuildQueueEvents<Meta = any> {
      * @param newRate The new sample rate
      */
     [GuildQueueEvent.SampleRateUpdate]: (queue: GuildQueue<Meta>, oldRate: number, newRate: number) => unknown;
+    /**
+     * Emitted when a named sample rate filter is updated
+     * @param queue The queue where this event occurred
+     * @param oldRate The old sample rate filter
+     * @param newRate The new sample rate filter
+     */
+    [GuildQueueEvent.SampleRateFilterUpdate]: (queue: GuildQueue<Meta>, oldFilter: CommonResamplerFilterPreset | null, newFilter: CommonResamplerFilterPreset | null) => unknown;
+    /**
+     * Emitted when reverb filter is updated
+     * @param queue The queue where this event occurred
+     * @param oldFilter The old reverb filter
+     * @param newFilter The new reverb filter
+     */
+    [GuildQueueEvent.ReverbUpdate]: (queue: GuildQueue<Meta>, oldFilter: ReverbParameters | null, newFilter: ReverbParameters | null) => unknown;
+    /**
+     * Emitted when compressor filter is updated
+     * @param queue The queue where this event occurred
+     * @param oldFilter The old compressor filter
+     * @param newFilter The new compressor filter
+     */
+    [GuildQueueEvent.CompressorUpdate]: (queue: GuildQueue<Meta>, oldFilter: CompressorParameters | null, newFilter: CompressorParameters | null) => unknown;
+    /**
+     * Emitted when seek is performed
+     * @param queue The queue where this event occurred
+     * @param position The seek position
+     */
+    [GuildQueueEvent.PlayerSeek]: (queue: GuildQueue<Meta>, parameters: SeekerParameters) => unknown;
 }
 /**
  * The queue repeat mode. This can be one of:
@@ -2168,6 +2286,9 @@ interface GuildNodeCreateOptions<T = any> {
     disableFilterer?: boolean;
     disableBiquad?: boolean;
     disableResampler?: boolean;
+    disableCompressor?: boolean;
+    disableSeeker?: boolean;
+    disableReverb?: boolean;
     disableFallbackStream?: boolean;
     enableStreamInterceptor?: boolean;
     verifyFallbackStream?: boolean;
@@ -3440,4 +3561,4 @@ declare const DependencyReportGenerator: {
 
 declare const version: string;
 
-export { AFilterGraph, AsyncQueue, type AsyncQueueAcquisitionOptions, AsyncQueueEntry, type AsyncQueueExceptionHandler, AudioFilters, BaseExtractor, Context, type ContextReceiver, type CreateStreamOps, type DependenciesReport, DependencyReportGenerator, DiscordPlayerQueryResultCache, type Encodable, EqualizerConfigurationPreset, ExtractorExecutionContext, type ExtractorExecutionEvents, type ExtractorExecutionFN, type ExtractorExecutionResult, type ExtractorInfo, type ExtractorResolvable, type ExtractorSearchContext, type ExtractorSession, type ExtractorStreamable, FFMPEG_ARGS_PIPED, FFMPEG_ARGS_STRING, FFMPEG_SRATE_REGEX, FFmpegFilterer, type FFmpegReport, type FFmpegStreamOptions, type FilterGraph, type FiltersName, type GuildNodeCreateOptions, type GuildNodeInit, GuildNodeManager, GuildQueue, type GuildQueueAFiltersCache, GuildQueueAudioFilters, GuildQueueEvent, type GuildQueueEvents, GuildQueueHistory, GuildQueuePlayerNode, GuildQueueStatistics, type GuildQueueStatisticsMetadata, type GuildQueueTimeline, InterceptedStream, type LrcGetParams, type LrcGetResult, LrcLib, type LrcSearchParams, type LrcSearchResult, type MaybeNull, type MetadataDispatch, type NextFunction, type NodeResolvable, type OnAfterCreateStreamHandler, type OnBeforeCreateStreamHandler, type OnInterceptedStreamHandler, type PackageJSON, type PlayOptions, Player, PlayerEvent, type PlayerEvents, PlayerEventsEmitter, type PlayerInitOptions, type PlayerNodeInitializationResult, type PlayerNodeInitializerOptions, type PlayerProgressbarOptions, type PlayerSearchResult, PlayerStreamInterceptor, type PlayerStreamInterceptorOptions, type PlayerTimestamp, type PlayerTriggeredReason, Playlist, type PlaylistInitData, type PlaylistJSON, type PostProcessedResult, QueryCache, type QueryCacheOptions, type QueryCacheProvider, type QueryCacheResolverContext, type QueryExtractorSearch, QueryResolver, QueryType, type QueueFilters, QueueRepeatMode, type RawTrackData, type RequestEntity, type ResolvedQuery, type ResourcePlayOptions, type Runtime, type RuntimeType, type SearchOptions, type SearchQueryType, SearchResult, type SearchResultData, SequentialBucket, type SerializedPlaylist, type SerializedTrack, SerializedType, type SetterFN$1 as SetterFN, type ShouldInterceptFunction, type SkipOptions, type StreamConfig, StreamDispatcher, type TimeData, type TimelineDispatcherOptions, Track, type TrackJSON, type TrackLike, type TrackResolvable, TrackSkipReason, type TrackSource, TypeUtil, Util, VALIDATE_QUEUE_CAP, type VoiceConnectConfig, type VoiceEvents, type VoiceStateHandler, VoiceUtils, type WithMetadata, createContext, createErisCompat, createFFmpegStream, decode, deserialize, encode, isErisProxy, onAfterCreateStream, onBeforeCreateStream, serialize, tryIntoThumbnailString, useContext, useHistory, useMainPlayer, useMetadata, usePlayer, useQueue, useTimeline, useVolume, version };
+export { AFilterGraph, AsyncQueue, type AsyncQueueAcquisitionOptions, AsyncQueueEntry, type AsyncQueueExceptionHandler, AudioFilters, BaseExtractor, Context, type ContextReceiver, type CreateStreamOps, type DependenciesReport, DependencyReportGenerator, DiscordPlayerQueryResultCache, type Encodable, EqualizerConfigurationPreset, ExtractorExecutionContext, type ExtractorExecutionEvents, type ExtractorExecutionFN, type ExtractorExecutionResult, type ExtractorInfo, type ExtractorResolvable, type ExtractorSearchContext, type ExtractorSession, type ExtractorStreamable, FFMPEG_ARGS_PIPED, FFMPEG_ARGS_STRING, FFMPEG_SRATE_REGEX, FFmpegFilterer, type FFmpegReport, type FFmpegStreamOptions, type FilterGraph, type FiltersName, type GuildNodeCreateOptions, type GuildNodeInit, GuildNodeManager, GuildQueue, type GuildQueueAFiltersCache, GuildQueueAudioFilters, GuildQueueEvent, type GuildQueueEvents, GuildQueueHistory, GuildQueuePlayerNode, GuildQueueStatistics, type GuildQueueStatisticsMetadata, type GuildQueueTimeline, InterceptedStream, type LrcGetParams, type LrcGetResult, LrcLib, type LrcSearchParams, type LrcSearchResult, type MaybeNull, type MetadataDispatch, type NextFunction, type NodeResolvable, type OnAfterCreateStreamHandler, type OnBeforeCreateStreamHandler, type OnInterceptedStreamHandler, type PackageJSON, type PlayOptions, Player, PlayerEvent, type PlayerEvents, PlayerEventsEmitter, type PlayerInitOptions, type PlayerNodeInitializationResult, type PlayerNodeInitializerOptions, type PlayerProgressbarOptions, type PlayerSearchResult, PlayerStreamInterceptor, type PlayerStreamInterceptorOptions, type PlayerTimestamp, type PlayerTriggeredReason, Playlist, type PlaylistInitData, type PlaylistJSON, type PostProcessedResult, QueryCache, type QueryCacheOptions, type QueryCacheProvider, type QueryCacheResolverContext, type QueryExtractorSearch, QueryResolver, QueryType, type QueueFilters, QueueRepeatMode, type RawTrackData, type RequestEntity, type ResolvedQuery, type ResourcePlayOptions, type Runtime, type RuntimeType, type SearchOptions, type SearchQueryType, SearchResult, type SearchResultData, SequentialBucket, type SerializedPlaylist, type SerializedTrack, SerializedType, type SetterFN$1 as SetterFN, type ShouldInterceptFunction, type SkipOptions, type StreamConfig, StreamDispatcher, type TimeData, type TimelineDispatcherOptions, Track, type TrackJSON, type TrackLike, type TrackResolvable, TrackSkipReason, type TrackSource, TypeUtil, Util, VALIDATE_QUEUE_CAP, type VoiceConnectConfig, type VoiceEvents, type VoiceStateHandler, VoiceUtils, type WithMetadata, createContext, createErisCompat, createFFmpegStream, createOceanicCompat, decode, deserialize, encode, isErisProxy, isOceanicProxy, onAfterCreateStream, onBeforeCreateStream, serialize, tryIntoThumbnailString, useContext, useHistory, useMainPlayer, useMetadata, usePlayer, useQueue, useTimeline, useVolume, version };