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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.d.ts CHANGED
@@ -13,9 +13,17 @@ import { BridgeProvider } from '@discord-player/extractor';
13
13
  export * from '@discord-player/ffmpeg';
14
14
 
15
15
  declare class PlayerEventsEmitter<L extends ListenerSignature<L> = DefaultListener> extends EventEmitter<L> {
16
+ #private;
16
17
  requiredEvents: Array<keyof L>;
17
18
  constructor(requiredEvents?: Array<keyof L>);
19
+ on<K extends keyof L>(name: K, listener: L[K]): this;
20
+ once<K extends keyof L>(name: K, listener: L[K]): this;
21
+ addListener<K extends keyof L>(name: K, listener: L[K]): this;
22
+ off<K extends keyof L>(name: K, listener: L[K]): this;
23
+ removeListener<K extends keyof L>(name: K, listener: L[K]): this;
24
+ removeAllListeners<K extends keyof L>(name?: K): this;
18
25
  emit<K extends keyof L>(name: K, ...args: Parameters<L[K]>): boolean;
26
+ get hasDebugger(): boolean;
19
27
  }
20
28
 
21
29
  interface CreateStreamOps {
@@ -322,6 +330,10 @@ interface ResourcePlayOptions {
322
330
  seek?: number;
323
331
  transitionMode?: boolean;
324
332
  }
333
+ interface SkipOptions {
334
+ reason: TrackSkipReason;
335
+ description: string;
336
+ }
325
337
  interface PlayerTimestamp {
326
338
  current: {
327
339
  label: string;
@@ -435,7 +447,7 @@ declare class GuildQueuePlayerNode<Meta = unknown> {
435
447
  /**
436
448
  * Skip current track
437
449
  */
438
- skip(): boolean;
450
+ skip(options?: SkipOptions): boolean;
439
451
  /**
440
452
  * Remove the given track from queue
441
453
  * @param track The track to remove
@@ -668,7 +680,7 @@ declare class AFilterGraph<Meta = unknown> {
668
680
  constructor(af: GuildQueueAudioFilters<Meta>);
669
681
  get ffmpeg(): (keyof QueueFilters)[];
670
682
  get equalizer(): EqualizerBand[];
671
- get biquad(): null;
683
+ get biquad(): "SinglePoleLowPassApprox" | "SinglePoleLowPass" | "LowPass" | "HighPass" | "BandPass" | "Notch" | "AllPass" | "LowShelf" | "HighShelf" | "PeakingEQ" | null;
672
684
  get filters(): ("8D" | "Tremolo" | "Vibrato")[];
673
685
  get volume(): _discord_player_equalizer.VolumeTransformer | null;
674
686
  get resampler(): _discord_player_equalizer.PCMResampler | null;
@@ -723,7 +735,6 @@ interface GuildNodeInit<Meta = unknown> {
723
735
  filterer: PCMFilters[] | boolean;
724
736
  ffmpegFilters: FiltersName[];
725
737
  disableHistory: boolean;
726
- skipOnNoStream: boolean;
727
738
  onBeforeCreateStream?: OnBeforeCreateStreamHandler;
728
739
  onAfterCreateStream?: OnAfterCreateStreamHandler;
729
740
  repeatMode?: QueueRepeatMode;
@@ -879,6 +890,14 @@ declare const GuildQueueEvent: {
879
890
  */
880
891
  readonly willAutoPlay: "willAutoPlay";
881
892
  };
893
+ declare enum TrackSkipReason {
894
+ NoStream = "ERR_NO_STREAM",
895
+ Manual = "MANUAL",
896
+ SEEK_OVER_THRESHOLD = "SEEK_OVER_THRESHOLD",
897
+ Jump = "JUMPED_TO_ANOTHER_TRACK",
898
+ SkipTo = "SKIP_TO_ANOTHER_TRACK",
899
+ HistoryNext = "HISTORY_NEXT_TRACK"
900
+ }
882
901
  interface GuildQueueEvents<Meta = any> {
883
902
  /**
884
903
  * Emitted when audio track is added to the queue
@@ -964,8 +983,10 @@ interface GuildQueueEvents<Meta = any> {
964
983
  * Emitted when the audio player skips current track
965
984
  * @param queue The queue where this event occurred
966
985
  * @param track The track that was skipped
986
+ * @param reason The reason for skipping
987
+ * @param description The description for skipping
967
988
  */
968
- playerSkip: (queue: GuildQueue<Meta>, track: Track) => unknown;
989
+ playerSkip: (queue: GuildQueue<Meta>, track: Track, reason: TrackSkipReason, description: string) => unknown;
969
990
  /**
970
991
  * Emitted when the audio player is triggered
971
992
  * @param queue The queue where this event occurred
@@ -1904,7 +1925,6 @@ declare class Player extends PlayerEventsEmitter<PlayerEvents> {
1904
1925
  * @param {PlayerInitOptions} [options] The player init options
1905
1926
  */
1906
1927
  constructor(client: Client, options?: PlayerInitOptions);
1907
- get hasDebugger(): boolean;
1908
1928
  /**
1909
1929
  * Override default voice state update handler
1910
1930
  * @param handler The handler callback
@@ -2064,7 +2084,6 @@ interface GuildNodeCreateOptions<T = unknown> {
2064
2084
  biquad?: BiquadFilters;
2065
2085
  resampler?: number;
2066
2086
  disableHistory?: boolean;
2067
- skipOnNoStream?: boolean;
2068
2087
  onBeforeCreateStream?: OnBeforeCreateStreamHandler;
2069
2088
  onAfterCreateStream?: OnAfterCreateStreamHandler;
2070
2089
  repeatMode?: QueueRepeatMode;
@@ -2615,6 +2634,10 @@ interface PlayerInitOptions {
2615
2634
  * Skip ffmpeg process when possible
2616
2635
  */
2617
2636
  skipFFmpeg?: boolean;
2637
+ /**
2638
+ * The probe timeout in milliseconds. Defaults to 5000.
2639
+ */
2640
+ probeTimeout?: number;
2618
2641
  }
2619
2642
 
2620
2643
  declare class AudioFilters {
@@ -2752,6 +2775,10 @@ declare class QueryResolver {
2752
2775
  soundcloudPlaylistRegex: RegExp;
2753
2776
  youtubePlaylistRegex: RegExp;
2754
2777
  };
2778
+ /**
2779
+ * Pre-resolve redirect urls
2780
+ */
2781
+ static preResolve(query: string, maxDepth?: number): Promise<string>;
2755
2782
  /**
2756
2783
  * Resolves the given search query
2757
2784
  * @param {string} query The query
@@ -2854,4 +2881,4 @@ declare function createHook<T extends HookDeclaration<(...args: any[]) => any>>(
2854
2881
 
2855
2882
  declare const version: string;
2856
2883
 
2857
- 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 };
2884
+ 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 };