discord-player 6.6.9-dev.1 → 6.6.10

package/README.md

@@ -24,6 +24,7 @@ Discord Player is a robust framework for developing Discord Music bots using Jav
 -   Offers easy debugging methods
 -   Out-of-the-box voice states handling
 -   IP Rotation support
+-   Easy serialization and deserialization
 
 ## Installation
 
@@ -117,7 +118,7 @@ const client = new Discord.Client({
 // this is the entrypoint for discord-player based application
 const player = new Player(client);
 
-// Now, lets load all the default extractors, except 'YouTubeExtractor'. You can remove the filter if you want to load all the extractors.
+// Now, lets load all the default extractors, except 'YouTubeExtractor'. You can remove the filter if you want to include youtube.
 await player.extractors.loadDefault((ext) => ext !== 'YouTubeExtractor');
 ```
 
@@ -127,7 +128,7 @@ Discord Player is mostly events based. It emits different events based on the co
 // this event is emitted whenever discord-player starts to play a track
 player.events.on('playerStart', (queue, track) => {
     // we will later define queue.metadata object while creating the queue
-    queue.metadata.channel.send(`Started playing **${track.title}**!`);
+    queue.metadata.channel.send(`Started playing **${track.cleanTitle}**!`);
 });
 ```
 
@@ -153,7 +154,7 @@ export async function execute(interaction) {
             }
         });
 
-        return interaction.followUp(`**${track.title}** enqueued!`);
+        return interaction.followUp(`**${track.cleanTitle}** enqueued!`);
     } catch (e) {
         // let's return error if something failed
         return interaction.followUp(`Something went wrong: ${e}`);

package/dist/index.d.ts

@@ -585,7 +585,7 @@ declare class FFmpegFilterer<Meta = unknown> {
      * Set ffmpeg filters
      * @param filters The filters
      */
-    setFilters(filters: Filters[] | Record<Filters, boolean> | boolean): Promise<boolean>;
+    setFilters(filters: Filters[] | Record<Filters, boolean> | string[] | boolean): Promise<boolean>;
     /**
      * Currently active ffmpeg filters
      */
@@ -969,119 +969,149 @@ declare const GuildQueueEvent: {
      * Emitted when audio track is added to the queue
      */
     readonly audioTrackAdd: "audioTrackAdd";
+    readonly AudioTrackAdd: "audioTrackAdd";
     /**
      * Emitted when audio tracks were added to the queue
      */
     readonly audioTracksAdd: "audioTracksAdd";
+    readonly AudioTracksAdd: "audioTracksAdd";
     /**
      * Emitted when audio track is removed from the queue
      */
     readonly audioTrackRemove: "audioTrackRemove";
+    readonly AudioTrackRemove: "audioTrackRemove";
     /**
      * Emitted when audio tracks are removed from the queue
      */
     readonly audioTracksRemove: "audioTracksRemove";
+    readonly AudioTracksRemove: "audioTracksRemove";
     /**
      * Emitted when a connection is created
      */
     readonly connection: "connection";
+    readonly Connection: "connection";
     /**
      * Emitted when a voice connection is destroyed
      */
     readonly connectionDestroyed: "connectionDestroyed";
+    readonly ConnectionDestroyed: "connectionDestroyed";
     /**
      * Emitted when the bot is disconnected from the channel
      */
     readonly disconnect: "disconnect";
+    readonly Disconnect: "disconnect";
     /**
      * Emitted when the queue sends a debug info
      */
     readonly debug: "debug";
+    readonly Debug: "debug";
     /**
      * Emitted when the queue encounters error
      */
     readonly error: "error";
+    readonly Error: "error";
     /**
      * Emitted when the voice channel is empty
      */
     readonly emptyChannel: "emptyChannel";
+    readonly EmptyChannel: "emptyChannel";
     /**
      * Emitted when the queue is empty
      */
     readonly emptyQueue: "emptyQueue";
+    readonly EmptyQueue: "emptyQueue";
     /**
      * Emitted when the audio player starts streaming audio track
      */
     readonly playerStart: "playerStart";
+    readonly PlayerStart: "playerStart";
     /**
      * Emitted when the audio player errors while streaming audio track
      */
     readonly playerError: "playerError";
+    readonly PlayerError: "playerError";
     /**
      * Emitted when the audio player finishes streaming audio track
      */
     readonly playerFinish: "playerFinish";
+    readonly PlayerFinish: "playerFinish";
     /**
      * Emitted when the audio player skips current track
      */
     readonly playerSkip: "playerSkip";
+    readonly PlayerSkip: "playerSkip";
     /**
      * Emitted when the audio player is triggered
      */
     readonly playerTrigger: "playerTrigger";
+    readonly PlayerTrigger: "playerTrigger";
     /**
      * Emitted when the voice state is updated. Consuming this event may disable default voice state update handler if `Player.isVoiceStateHandlerLocked()` returns `false`.
      */
     readonly voiceStateUpdate: "voiceStateUpdate";
+    readonly VoiceStateUpdate: "voiceStateUpdate";
     /**
      * Emitted when volume is updated
      */
     readonly volumeChange: "volumeChange";
+    readonly VolumeChange: "volumeChange";
     /**
      * Emitted when player is paused
      */
     readonly playerPause: "playerPause";
+    readonly PlayerPause: "playerPause";
     /**
      * Emitted when player is resumed
      */
     readonly playerResume: "playerResume";
+    readonly PlayerResume: "playerResume";
     /**
      * Biquad Filters Update
      */
     readonly biquadFiltersUpdate: "biquadFiltersUpdate";
+    readonly BiquadFiltersUpdate: "biquadFiltersUpdate";
     /**
      * Equalizer Update
      */
     readonly equalizerUpdate: "equalizerUpdate";
+    readonly EqualizerUpdate: "equalizerUpdate";
     /**
      * DSP update
      */
     readonly dspUpdate: "dspUpdate";
+    readonly DSPUpdate: "dspUpdate";
     /**
      * Audio Filters Update
      */
     readonly audioFiltersUpdate: "audioFiltersUpdate";
+    readonly AudioFiltersUpdate: "audioFiltersUpdate";
     /**
      * Audio player will play next track
      */
     readonly willPlayTrack: "willPlayTrack";
+    readonly WillPlayTrack: "willPlayTrack";
     /**
      * Emitted when a voice channel is repopulated
      */
     readonly channelPopulate: "channelPopulate";
+    readonly ChannelPopulate: "channelPopulate";
     /**
      * Emitted when a queue is successfully created
      */
     readonly queueCreate: "queueCreate";
+    readonly QueueCreate: "queueCreate";
     /**
      * Emitted when a queue is deleted
      */
     readonly queueDelete: "queueDelete";
+    readonly QueueDelete: "queueDelete";
     /**
      * Emitted when a queue is trying to add similar track for autoplay
      */
     readonly willAutoPlay: "willAutoPlay";
+    readonly WillAutoPlay: "willAutoPlay";
 };
+type GuildQueueEvent = (typeof GuildQueueEvent)[keyof typeof GuildQueueEvent];
 declare enum TrackSkipReason {
     NoStream = "ERR_NO_STREAM",
     Manual = "MANUAL",
@@ -1096,81 +1126,81 @@ interface GuildQueueEvents<Meta = any> {
      * @param queue The queue where this event occurred
      * @param track The track
      */
-    audioTrackAdd: (queue: GuildQueue<Meta>, track: Track) => unknown;
+    [GuildQueueEvent.AudioTrackAdd]: (queue: GuildQueue<Meta>, track: Track) => unknown;
     /**
      * Emitted when audio tracks were added to the queue
      * @param queue The queue where this event occurred
      * @param tracks The tracks array
      */
-    audioTracksAdd: (queue: GuildQueue<Meta>, track: Track[]) => unknown;
+    [GuildQueueEvent.AudioTracksAdd]: (queue: GuildQueue<Meta>, track: Track[]) => unknown;
     /**
      * Emitted when audio track is removed from the queue
      * @param queue The queue where this event occurred
      * @param track The track
      */
-    audioTrackRemove: (queue: GuildQueue<Meta>, track: Track) => unknown;
+    [GuildQueueEvent.AudioTrackRemove]: (queue: GuildQueue<Meta>, track: Track) => unknown;
     /**
      * Emitted when audio tracks are removed from the queue
      * @param queue The queue where this event occurred
      * @param track The track
      */
-    audioTracksRemove: (queue: GuildQueue<Meta>, track: Track[]) => unknown;
+    [GuildQueueEvent.AudioTracksRemove]: (queue: GuildQueue<Meta>, track: Track[]) => unknown;
     /**
      * Emitted when a connection is created
      * @param queue The queue where this event occurred
      */
-    connection: (queue: GuildQueue<Meta>) => unknown;
+    [GuildQueueEvent.Connection]: (queue: GuildQueue<Meta>) => unknown;
     /**
      * Emitted when a connection is destroyed
      * @param queue The queue where this event occurred
      */
-    connectionDestroyed: (queue: GuildQueue<Meta>) => unknown;
+    [GuildQueueEvent.ConnectionDestroyed]: (queue: GuildQueue<Meta>) => unknown;
     /**
      * Emitted when the bot is disconnected from the channel
      * @param queue The queue where this event occurred
      */
-    disconnect: (queue: GuildQueue<Meta>) => unknown;
+    [GuildQueueEvent.Disconnect]: (queue: GuildQueue<Meta>) => unknown;
     /**
      * Emitted when the queue sends a debug info
      * @param queue The queue where this event occurred
      * @param message The debug message
      */
-    debug: (queue: GuildQueue<Meta>, message: string) => unknown;
+    [GuildQueueEvent.Debug]: (queue: GuildQueue<Meta>, message: string) => unknown;
     /**
      * Emitted when the queue encounters error
      * @param queue The queue where this event occurred
      * @param error The error
      */
-    error: (queue: GuildQueue<Meta>, error: Error) => unknown;
+    [GuildQueueEvent.Error]: (queue: GuildQueue<Meta>, error: Error) => unknown;
     /**
      * Emitted when the voice channel is empty
      * @param queue The queue where this event occurred
      */
-    emptyChannel: (queue: GuildQueue<Meta>) => unknown;
+    [GuildQueueEvent.EmptyChannel]: (queue: GuildQueue<Meta>) => unknown;
     /**
      * Emitted when the queue is empty
      * @param queue The queue where this event occurred
      */
-    emptyQueue: (queue: GuildQueue<Meta>) => unknown;
+    [GuildQueueEvent.EmptyQueue]: (queue: GuildQueue<Meta>) => unknown;
     /**
      * Emitted when the audio player starts streaming audio track
      * @param queue The queue where this event occurred
      * @param track The track that is being streamed
      */
-    playerStart: (queue: GuildQueue<Meta>, track: Track) => unknown;
+    [GuildQueueEvent.PlayerStart]: (queue: GuildQueue<Meta>, track: Track) => unknown;
     /**
      * Emitted when the audio player errors while streaming audio track
      * @param queue The queue where this event occurred
      * @param error The error
      * @param track The track that is being streamed
      */
-    playerError: (queue: GuildQueue<Meta>, error: Error, track: Track) => unknown;
+    [GuildQueueEvent.PlayerError]: (queue: GuildQueue<Meta>, error: Error, track: Track) => unknown;
     /**
      * Emitted when the audio player finishes streaming audio track
      * @param queue The queue where this event occurred
      * @param track The track that was being streamed
      */
-    playerFinish: (queue: GuildQueue<Meta>, track: Track) => unknown;
+    [GuildQueueEvent.PlayerFinish]: (queue: GuildQueue<Meta>, track: Track) => unknown;
     /**
      * Emitted when the audio player skips current track
      * @param queue The queue where this event occurred
@@ -1178,65 +1208,65 @@ interface GuildQueueEvents<Meta = any> {
      * @param reason The reason for skipping
      * @param description The description for skipping
      */
-    playerSkip: (queue: GuildQueue<Meta>, track: Track, reason: TrackSkipReason, description: string) => unknown;
+    [GuildQueueEvent.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
      * @param track The track which was played in this event
      */
-    playerTrigger: (queue: GuildQueue<Meta>, track: Track, reason: PlayerTriggeredReason) => unknown;
+    [GuildQueueEvent.PlayerTrigger]: (queue: GuildQueue<Meta>, track: Track, reason: PlayerTriggeredReason) => unknown;
     /**
      * Emitted when the voice state is updated. Consuming this event may disable default voice state update handler if `Player.isVoiceStateHandlerLocked()` returns `false`.
      * @param queue The queue where this event occurred
      * @param oldState The old voice state
      * @param newState The new voice state
      */
-    voiceStateUpdate: (queue: GuildQueue<Meta>, oldState: VoiceState, newState: VoiceState) => unknown;
+    [GuildQueueEvent.VoiceStateUpdate]: (queue: GuildQueue<Meta>, oldState: VoiceState, newState: VoiceState) => unknown;
     /**
      * Emitted when audio player is paused
      * @param queue The queue where this event occurred
      */
-    playerPause: (queue: GuildQueue<Meta>) => unknown;
+    [GuildQueueEvent.PlayerPause]: (queue: GuildQueue<Meta>) => unknown;
     /**
      * Emitted when audio player is resumed
      * @param queue The queue where this event occurred
      */
-    playerResume: (queue: GuildQueue<Meta>) => unknown;
+    [GuildQueueEvent.PlayerResume]: (queue: GuildQueue<Meta>) => unknown;
     /**
      * Emitted when audio player's volume is changed
      * @param queue The queue where this event occurred
      * @param oldVolume The old volume
      * @param newVolume The updated volume
      */
-    volumeChange: (queue: GuildQueue<Meta>, oldVolume: number, newVolume: number) => unknown;
+    [GuildQueueEvent.VolumeChange]: (queue: GuildQueue<Meta>, oldVolume: number, newVolume: number) => unknown;
     /**
      * Emitted when equalizer config is updated
      * @param queue The queue where this event occurred
      * @param oldFilters Old filters
      * @param newFilters New filters
      */
-    equalizerUpdate: (queue: GuildQueue<Meta>, oldFilters: EqualizerBand[], newFilters: EqualizerBand[]) => unknown;
+    [GuildQueueEvent.EqualizerUpdate]: (queue: GuildQueue<Meta>, oldFilters: EqualizerBand[], newFilters: EqualizerBand[]) => unknown;
     /**
      * Emitted when biquad filters is updated
      * @param queue The queue where this event occurred
      * @param oldFilters Old filters
      * @param newFilters New filters
      */
-    biquadFiltersUpdate: (queue: GuildQueue<Meta>, oldFilters: BiquadFilters | null, newFilters: BiquadFilters | null) => unknown;
+    [GuildQueueEvent.BiquadFiltersUpdate]: (queue: GuildQueue<Meta>, oldFilters: BiquadFilters | null, newFilters: BiquadFilters | null) => unknown;
     /**
      * Emitted when dsp filters is updated
      * @param queue The queue where this event occurred
      * @param oldFilters Old filters
      * @param newFilters New filters
      */
-    dspUpdate: (queue: GuildQueue<Meta>, oldFilters: PCMFilters[], newFilters: PCMFilters[]) => unknown;
+    [GuildQueueEvent.DSPUpdate]: (queue: GuildQueue<Meta>, oldFilters: PCMFilters[], newFilters: PCMFilters[]) => unknown;
     /**
      * Emitted when ffmpeg audio filters is updated
      * @param queue The queue where this event occurred
      * @param oldFilters Old filters
      * @param newFilters New filters
      */
-    audioFiltersUpdate: (queue: GuildQueue<Meta>, oldFilters: FiltersName[], newFilters: FiltersName[]) => unknown;
+    [GuildQueueEvent.AudioFiltersUpdate]: (queue: GuildQueue<Meta>, oldFilters: FiltersName[], newFilters: FiltersName[]) => unknown;
     /**
      * Emitted before streaming an audio track. This event can be used to modify stream config before playing a track.
      * Listening to this event will pause the execution of audio player until `done()` is invoked.
@@ -1245,29 +1275,29 @@ interface GuildQueueEvents<Meta = any> {
      * @param config Configurations for streaming
      * @param done Done callback
      */
-    willPlayTrack: (queue: GuildQueue<Meta>, track: Track<unknown>, config: StreamConfig, done: () => void) => unknown;
+    [GuildQueueEvent.WillPlayTrack]: (queue: GuildQueue<Meta>, track: Track<unknown>, config: StreamConfig, done: () => void) => unknown;
     /**
      * Emitted when a voice channel is populated
      * @param queue The queue where this event occurred
      */
-    channelPopulate: (queue: GuildQueue<Meta>) => unknown;
+    [GuildQueueEvent.ChannelPopulate]: (queue: GuildQueue<Meta>) => unknown;
     /**
      * Emitted when a queue is successfully created
      * @param queue The queue where this event occurred
      */
-    queueCreate: (queue: GuildQueue<Meta>) => unknown;
+    [GuildQueueEvent.QueueCreate]: (queue: GuildQueue<Meta>) => unknown;
     /**
      * Emitted when a queue is successfully deleted
      * @param queue The queue where this event occurred
      */
-    queueDelete: (queue: GuildQueue<Meta>) => unknown;
+    [GuildQueueEvent.QueueDelete]: (queue: GuildQueue<Meta>) => unknown;
     /**
      * Emitted when a queue is trying to add similar track for autoplay
      * @param queue The queue where this event occurred
      * @param tracks The similar tracks that were found
      * @param done Done callback
      */
-    willAutoPlay: (queue: GuildQueue<Meta>, tracks: Track[], done: (track: Track | null) => void) => unknown;
+    [GuildQueueEvent.WillAutoPlay]: (queue: GuildQueue<Meta>, tracks: Track[], done: (track: Track | null) => void) => unknown;
 }
 declare class GuildQueue<Meta = unknown> {
     #private;
@@ -1561,6 +1591,7 @@ declare class Track<T = unknown> {
     readonly id: string;
     private __metadata;
     private __reqMetadataFn;
+    cleanTitle: string;
     /**
      * Track constructor
      * @param player The player that instantiated this Track
@@ -1690,13 +1721,13 @@ declare class Playlist {
             title: string;
             description: string;
             author: string;
-            url: string;
-            thumbnail: any;
-            duration: string; /**
+            url: string; /**
              * 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
              */
+            thumbnail: any;
+            duration: string;
             views: number;
             requested_by: {} | null;
             source: TrackSource;
@@ -2707,6 +2738,10 @@ interface RawTrackData {
      * The query type
      */
     queryType?: SearchQueryType;
+    /**
+     * The seralised title
+     */
+    cleanTitle?: string;
 }
 interface TimeData {
     /**
@@ -2815,11 +2850,15 @@ interface PlayerEvents {
     error: (error: Error) => any;
     voiceStateUpdate: (queue: GuildQueue, oldState: VoiceState, newState: VoiceState) => any;
 }
-declare enum PlayerEvent {
-    debug = "debug",
-    error = "error",
-    voiceStateUpdate = "voiceStateUpdate"
-}
+declare const PlayerEvent: {
+    readonly debug: "debug";
+    readonly Debug: "debug";
+    readonly error: "error";
+    readonly Error: "error";
+    readonly voiceStateUpdate: "voiceStateUpdate";
+    readonly VoiceStateUpdate: "voiceStateUpdate";
+};
+type PlayerEvent = (typeof PlayerEvent)[keyof typeof PlayerEvent];
 interface PlayOptions {
     /**
      * If this play was triggered for filters update
@@ -3106,7 +3145,7 @@ declare class AudioFilters {
      * @param filter The filter name
      * @returns
      */
-    static create<K extends FiltersName>(filters?: K[]): string;
+    static create<K extends FiltersName>(filters?: (K | string)[]): string;
     /**
      * Defines audio filter
      * @param filterName The name of the filter
@@ -3155,6 +3194,11 @@ declare class Util {
      * @returns {string}
      */
     static buildTimeCode(duration: TimeData): string;
+    /**
+     * Formats duration
+     * @param {number} duration The duration in ms
+     */
+    static formatDuration(duration: number): string;
     /**
      * Picks last item of the given array
      * @param {any[]} arr The array
@@ -3167,6 +3211,13 @@ declare class Util {
      * @returns {boolean}
      */
     static isVoiceEmpty(channel: VoiceChannel | StageChannel): boolean;
+    /**
+     * Cleans the track title
+     * @param title The title
+     * @param source The source
+     * @returns Cleaned title
+     */
+    static cleanTitle(title: string, source: TrackSource): string;
     /**
      * Safer require
      * @param {string} id Node require id