discord-player 6.6.0 → 6.6.1

package/README.md

@@ -121,7 +121,7 @@ Let's move on to the command part. You can define the command as per your requir
 
 ```js
 async function execute(interaction) {
-    const channel = interaction.message.member.voice.channel;
+    const channel = interaction.member.voice.channel;
     if (!channel) return interaction.reply('You are not connected to a voice channel!'); // make sure we have a voice channel
     const query = interaction.options.getString('query', true); // we need input/query to play
 

package/dist/index.d.ts

@@ -9,6 +9,7 @@ import { StreamType, AudioPlayerError, AudioResource, VoiceConnection, AudioPlay
 export { AudioPlayer, CreateAudioPlayerOptions, createAudioPlayer } from '@discordjs/voice';
 import { RequestOptions } from 'http';
 import { downloadOptions } from 'ytdl-core';
+import { BridgeProvider } from '@discord-player/extractor';
 export * from '@discord-player/ffmpeg';
 
 declare class PlayerEventsEmitter<L extends ListenerSignature<L> = DefaultListener> extends EventEmitter<L> {
@@ -251,11 +252,13 @@ interface AsyncQueueAcquisitionOptions {
      */
     signal?: AbortSignal;
 }
+type AsyncQueueExceptionHandler = (exception: Error) => void;
 declare class AsyncQueue {
     /**
      * The queued entries
      */
     entries: Array<AsyncQueueEntry>;
+    exceptionHandler?: AsyncQueueExceptionHandler;
     /**
      * Clear entries queue
      * @param consume Whether or not to consume all entries before clearing
@@ -268,8 +271,7 @@ declare class AsyncQueue {
     /**
      * Acquire an entry.
      *
-     * ```typescript
-     * // lock the queue
+     * @example // lock the queue
      * const entry = asyncQueue.acquire();
      * // wait until previous task is completed
      * await entry.getTask();
@@ -277,7 +279,7 @@ declare class AsyncQueue {
      * await performSomethingExpensive();
      * // make sure to release the lock once done
      * asyncQueue.release();
-     * ```
+     *
      */
     acquire(options?: AsyncQueueAcquisitionOptions): AsyncQueueEntry;
     /**
@@ -1318,7 +1320,7 @@ declare class ExtractorExecutionContext extends PlayerEventsEmitter<ExtractorExe
      * @param _extractor The extractor to register
      * @param options Options supplied to the extractor
      */
-    register<O extends object, T extends typeof BaseExtractor<O>>(_extractor: T, options: ConstructorParameters<T>['1']): Promise<void>;
+    register<O extends object, T extends typeof BaseExtractor<O>>(_extractor: T, options: ConstructorParameters<T>['1']): Promise<InstanceType<T> | null>;
     /**
      * Unregister single extractor
      * @param _extractor The extractor to unregister
@@ -1484,6 +1486,10 @@ declare class Track<T = unknown> {
      * The track duration in millisecond
      */
     get durationMS(): number;
+    /**
+     * Discord hyperlink representation of this track
+     */
+    toHyperlink(): string;
     /**
      * Returns source of this track
      */
@@ -1544,6 +1550,12 @@ declare class Playlist {
      * @returns {PlaylistJSON}
      */
     toJSON(withTracks?: boolean): PlaylistJSON;
+    /**
+     * Play this playlist to the given voice channel. If queue exists and another track is being played, this playlist will be added to the queue.
+     * @param channel Voice channel on which this playlist shall be played
+     * @param options Node initialization options
+     */
+    play<T = unknown>(channel: GuildVoiceChannelResolvable, options?: PlayerNodeInitializerOptions<T>): Promise<PlayerNodeInitializationResult<T>>;
 }
 
 interface SearchResultData {
@@ -1619,10 +1631,15 @@ declare class SearchResult {
 
 declare class VoiceUtils {
     player: Player;
+    /**
+     * Voice connection cache to store voice connections of the Player components.
+     * This property is deprecated and will be removed in the future.
+     * It only exists for compatibility reasons.
+     * @deprecated
+     */
     cache: Collection<Snowflake, StreamDispatcher>;
     /**
-     * The voice utils
-     * @private
+     * The voice utils constructor
      */
     constructor(player: Player);
     /**
@@ -1660,7 +1677,7 @@ declare class VoiceUtils {
      * @param {Snowflake} guild The guild id
      * @returns {StreamDispatcher}
      */
-    getConnection(guild: Snowflake, group?: string): StreamDispatcher | VoiceConnection | undefined;
+    getConnection(guild: Snowflake, group?: string): VoiceConnection | undefined;
 }
 
 interface QueryCacheOptions {
@@ -1702,6 +1719,7 @@ interface PlayerNodeInitializerOptions<T> extends SearchOptions {
     nodeOptions?: GuildNodeCreateOptions<T>;
     connectionOptions?: VoiceConnectConfig;
     audioPlayerOptions?: ResourcePlayOptions;
+    signal?: AbortSignal;
     afterSearch?: (result: SearchResult) => Promise<SearchResult>;
 }
 type VoiceStateHandler = (player: Player, queue: GuildQueue, oldVoiceState: VoiceState, newVoiceState: VoiceState) => Awaited<void>;
@@ -2038,13 +2056,17 @@ interface TimeData {
  * @property {boolean} [timecodes] If it should render time codes
  * @property {boolean} [queue] If it should create progress bar for the whole queue
  * @property {number} [length] The bar length
- * @property {string} [line] The bar track
+ * @property {string} [leftChar] The elapsed time track
+ * @property {string} [rightChar] The remaining time track
+ * @property {string} [separator] The separation between timestamp and line
  * @property {string} [indicator] The indicator
  */
 interface PlayerProgressbarOptions {
     timecodes?: boolean;
     length?: number;
-    line?: string;
+    leftChar?: string;
+    rightChar?: string;
+    separator?: string;
     indicator?: string;
     queue?: boolean;
 }
@@ -2250,6 +2272,7 @@ interface PlaylistJSON {
  * @property {QueryCache | null} [queryCache] Query cache provider
  * @property {boolean} [ignoreInstance] Ignore player instance
  * @property {boolean} [useLegacyFFmpeg] Use legacy version of ffmpeg
+ * @property {BridgeProvider} [bridgeProvider] Set bridge provider
  */
 interface PlayerInitOptions {
     ytdlOptions?: downloadOptions;
@@ -2261,6 +2284,7 @@ interface PlayerInitOptions {
     queryCache?: QueryCache | null;
     ignoreInstance?: boolean;
     useLegacyFFmpeg?: boolean;
+    bridgeProvider?: BridgeProvider;
 }
 
 declare class AudioFilters {
@@ -2496,4 +2520,4 @@ declare function createHook<T extends HookDeclaration<(...args: any[]) => any>>(
 
 declare const version: string;
 
-export { AFilterGraph, AsyncQueue, AsyncQueueAcquisitionOptions, AsyncQueueEntry, AudioFilters, BaseExtractor, CreateStreamOps, DiscordPlayerQueryResultCache, EqualizerConfigurationPreset, ExtractorExecutionContext, ExtractorExecutionEvents, ExtractorExecutionFN, ExtractorExecutionResult, ExtractorInfo, ExtractorSearchContext, 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, NextFunction, NodeResolvable, OnAfterCreateStreamHandler, OnBeforeCreateStreamHandler, PlayOptions, Player, PlayerEvent, PlayerEvents, PlayerEventsEmitter, PlayerInitOptions, PlayerNodeInitializationResult, PlayerNodeInitializerOptions, PlayerProgressbarOptions, PlayerSearchResult, PlayerTimestamp, PlayerTriggeredReason, Playlist, PlaylistInitData, PlaylistJSON, PostProcessedResult, QueryCache, QueryCacheOptions, QueryCacheResolverContext, QueryExtractorSearch, QueryResolver, QueryType, QueueFilters, QueueRepeatMode, RawTrackData, RawTrackInit, ResourcePlayOptions, SearchOptions, SearchQueryType, SearchResult, SearchResultData, StreamConfig, StreamDispatcher, TimeData, TimelineDispatcherOptions, Track, TrackJSON, TrackLike, TrackResolvable, TrackSource, TypeUtil, Util, VALIDATE_QUEUE_CAP, VoiceConnectConfig, VoiceEvents, VoiceReceiverNode, VoiceReceiverOptions, VoiceStateHandler, VoiceUtils, WithMetadata, createFFmpegStream, createHook, onAfterCreateStream, onBeforeCreateStream, useHistory, useMainPlayer, useMasterPlayer, useMetadata, usePlayer, useQueue, useTimeline, useVolume, version };
+export { AFilterGraph, AsyncQueue, AsyncQueueAcquisitionOptions, AsyncQueueEntry, AsyncQueueExceptionHandler, AudioFilters, BaseExtractor, CreateStreamOps, DiscordPlayerQueryResultCache, EqualizerConfigurationPreset, ExtractorExecutionContext, ExtractorExecutionEvents, ExtractorExecutionFN, ExtractorExecutionResult, ExtractorInfo, ExtractorSearchContext, 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, NextFunction, NodeResolvable, OnAfterCreateStreamHandler, OnBeforeCreateStreamHandler, PlayOptions, Player, PlayerEvent, PlayerEvents, PlayerEventsEmitter, PlayerInitOptions, PlayerNodeInitializationResult, PlayerNodeInitializerOptions, PlayerProgressbarOptions, PlayerSearchResult, PlayerTimestamp, PlayerTriggeredReason, Playlist, PlaylistInitData, PlaylistJSON, PostProcessedResult, QueryCache, QueryCacheOptions, QueryCacheResolverContext, QueryExtractorSearch, QueryResolver, QueryType, QueueFilters, QueueRepeatMode, RawTrackData, RawTrackInit, ResourcePlayOptions, SearchOptions, SearchQueryType, SearchResult, SearchResultData, StreamConfig, StreamDispatcher, TimeData, TimelineDispatcherOptions, Track, TrackJSON, TrackLike, TrackResolvable, TrackSource, TypeUtil, Util, VALIDATE_QUEUE_CAP, VoiceConnectConfig, VoiceEvents, VoiceReceiverNode, VoiceReceiverOptions, VoiceStateHandler, VoiceUtils, WithMetadata, createFFmpegStream, createHook, onAfterCreateStream, onBeforeCreateStream, useHistory, useMainPlayer, useMasterPlayer, useMetadata, usePlayer, useQueue, useTimeline, useVolume, version };