discord-player 6.6.0-dev → 6.6.0-dev.0

package/README.md

@@ -1,87 +1,89 @@
 # Discord Player
 
-Discord Player is a powerful framework for JavaScript and TypeScript, built on top of **[@discordjs/voice](https://npm.im/@discordjs/voice)** library.
-It provides easy set of customizable tools to develop Discord Music bots.
+Discord Player is a robust framework for developing Discord Music bots using JavaScript and TypeScript. It is built on top of the [@discordjs/voice](https://npm.im/@discordjs/voice) library and offers a comprehensive set of customizable tools, making it one of the most feature enrich framework in town.
 
 [![downloadsBadge](https://img.shields.io/npm/dt/discord-player?style=for-the-badge)](https://npmjs.com/discord-player)
 [![versionBadge](https://img.shields.io/npm/v/discord-player?style=for-the-badge)](https://npmjs.com/discord-player)
 [![discordBadge](https://img.shields.io/discord/558328638911545423?style=for-the-badge&color=7289da)](https://androz2091.fr/discord)
 
-# Why Discord Player?
+# Why Choose Discord Player?
 
--   Beginner friendly, easy to understand
+-   Beginner-friendly with easy-to-understand features
 -   TypeScript support
+-   Offers hackable APIs.
 -   Supports audio player sharing
--   Quick and easy to set up
+-   Quick and easy setup process
 -   Wide range of player management features
--   64+ built-in audio filter presets
--   Highly customizable
+-   Offers 64+ built-in audio filter presets
+-   Highly customizable according to your needs
 -   Automatic queue management
 -   Query caching support
--   Wide range of extendable sources via Extractors API
--   Object oriented
--   Built in stats tracker
+-   Extensible sources through the Extractors API
+-   Object-oriented design
+-   Built-in stats tracker
+-   Offers easy debugging methods
+-   Out-of-the-box voice states handling
 
 ## Installation
 
 ### Before you start
 
-Discord Player requires Discord.js 14.0 or higher. PLease make sure you have a compatible version using `npm list discord.js` in your terminal. If you're using an earlier version please update it. The [Discord.JS Guide](https://discordjs.guide/) has resources to help with that.
+Discord Player requires Discord.js 14.0 or higher. Please ensure that you have a compatible version by running `npm list discord.js` in your terminal. If you're using an earlier version, please update it. The [discord.js Guide](https://discordjs.guide) provides resources to assist you with the update process.
 
 #### Main Library
 
 ```bash
-$ yarn add discord-player # main library
-$ yarn add @discord-player/extractor # extractors provider
+$ npm install --save discord-player # main library
+$ npm install --save @discord-player/extractor # extractors provider
 ```
 
-> Discord Player recognizes `@discord-player/extractor` and loads it automatically by default.
+> Discord Player recognizes `@discord-player/extractor` and loads it automatically by default. Just invoke `await player.extractors.loadDefault()`.
 
 #### Opus Library
 
-Discord Player is a high level framework for Discord VoIP. Discord only accepts opus packets, thus you need to install opus library. You can install any of these:
+Since Discord only accepts opus packets, you need to install the opus library. Choose one of the following options:
 
 ```bash
-$ yarn add @discordjs/opus
+$ npm install --save @discordjs/opus
 # or
-$ yarn add opusscript
+$ npm install --save opusscript
 ```
 
 #### FFmpeg or Avconv
 
-FFmpeg or Avconv is required for media transcoding. You can get it from [https://ffmpeg.org](https://www.ffmpeg.org/download.html) or by installing it from npm (ffmpeg-static or other binaries are not recommended):
+FFmpeg or Avconv is required for media transcoding. You can obtain it from [https://ffmpeg.org](https://ffmpeg.org) or install it via npm (we recommend against using ffmpeg-static or other binaries):
 
 ```bash
-$ yarn add ffmpeg-static
+$ npm install --save ffmpeg-static
 # or
-$ yarn add @ffmpeg-installer/ffmpeg
+$ npm install --save @ffmpeg-installer/ffmpeg
 # or
-$ yarn add @node-ffmpeg/node-ffmpeg-installer
+$ npm install --save @node-ffmpeg/node-ffmpeg-installer
 # or
-$ yarn add ffmpeg-binaries
+$ npm install --save ffmpeg-binaries
 ```
 
 > Use `FFMPEG_PATH` environment variable to load ffmpeg from custom path.
 
 #### Streaming Library
 
-You also need to install streaming library if you want to add support for youtube playback. You can install one of these libraries:
+If you want to add support for YouTube playback, you need to install a streaming library. Choose one of the following options:
 
 ```bash
-$ yarn add ytdl-core
+$ npm install --save ytdl-core
 # or
-$ yarn add play-dl
+$ npm install --save play-dl
 # or
-$ yarn add @distube/ytdl-core
+$ npm install --save @distube/ytdl-core
 # or
-$ yarn add yt-stream
+$ npm install --save yt-stream
 ```
 
-Done with all these? Let's write a simple music bot then.
+Once you have completed these installations, let's proceed with writing a simple music bot.
 
 ### Setup
 
-Let's create a master player instance.
+Let's create a main player instance. This instance handles and keeps track of all the queues and its components.
 
 ```js
 const { Player } = require('discord-player');
@@ -94,7 +96,6 @@ const client = new Discord.Client({
     intents: ['GuildVoiceStates' /* Other intents */]
 });
 
-
 // this is the entrypoint for discord-player based application
 const player = new Player(client);
 
@@ -106,9 +107,7 @@ await player.extractors.register(SpotifyExtractor, {});
 await player.extractors.register(SoundCloudExtractor, {});
 ```
 
-> **Did You Know?** _Discord Player is by default a singleton._
-
-Now, let's add some event listeners:
+Discord Player is mostly events based. It emits different events based on the context and actions. Let's add a basic event listener to notify the user when a track starts to play:
 
 ```js
 // this event is emitted whenever discord-player starts to play a track
@@ -118,7 +117,7 @@ player.events.on('playerStart', (queue, track) => {
 });
 ```
 
-Let's write the command part. You can define the command as you desire. We will only check the command handler part:
+Let's move on to the command part. You can define the command as per your requirements. We will only focus on the command handler part:
 
 ```js
 async function execute(interaction) {
@@ -145,11 +144,8 @@ async function execute(interaction) {
 }
 ```
 
-That's all it takes to build your own music bot.
-
-#### Check out the [Documentation](https://discord-player.js.org) for more info.
+That's all it takes to build your own music bot. Please check out the [Documentation](https://discord-player.js.org) for more features/functionalities.
 
 ## Community Resources
 
-A curated list of resources (such as open source music bots, extractors, etc.) built by Discord Player community.
-[https://discord-player.js.org/docs/guides/community-resources](https://discord-player.js.org/docs/guides/community-resources)
+Explore a curated list of resources built by the Discord Player community, including open-source music bots and extractors. Visit [https://discord-player.js.org/docs/guides/community-resources](https://discord-player.js.org/docs/guides/community-resources) for more information.

package/dist/index.d.ts

@@ -6,7 +6,6 @@ import { RequestOptions } from 'http';
 import * as _discord_player_equalizer from '@discord-player/equalizer';
 import { EqualizerBand, BiquadFilters, PCMFilters, 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 * as _discordjs_voice from '@discordjs/voice';
 import { StreamType, AudioPlayerError, AudioResource, VoiceConnection, AudioPlayer, AudioPlayerStatus, EndBehaviorType } from '@discordjs/voice';
 export { AudioPlayer, CreateAudioPlayerOptions, createAudioPlayer } from '@discordjs/voice';
 import { downloadOptions } from 'ytdl-core';
@@ -335,6 +334,7 @@ interface VoiceEvents {
     sampleRate: (filters: number) => any;
     biquad: (filters: BiquadFilters) => any;
     volume: (volume: number) => any;
+    destroyed: () => any;
 }
 declare class StreamDispatcher extends EventEmitter<VoiceEvents> {
     queue: GuildQueue;
@@ -414,6 +414,10 @@ declare class StreamDispatcher extends EventEmitter<VoiceEvents> {
      * @returns {void}
      */
     disconnect(): void;
+    /**
+     * Destroys this dispatcher
+     */
+    destroy(): void;
     /**
      * Stops the player
      * @returns {void}
@@ -1014,6 +1018,7 @@ interface GuildNodeInit<Meta = unknown> {
 interface VoiceConnectConfig {
     deaf?: boolean;
     timeout?: number;
+    group?: string;
     audioPlayer?: AudioPlayer;
 }
 interface PostProcessedResult {
@@ -1367,7 +1372,7 @@ declare class GuildQueue<Meta = unknown> {
     /**
      * The voice connection of this queue
      */
-    get connection(): _discordjs_voice.VoiceConnection | null;
+    get connection(): VoiceConnection | null;
     /**
      * The guild this queue belongs to
      */
@@ -1478,6 +1483,11 @@ declare class GuildQueue<Meta = unknown> {
      * @param dest The second track to swap
      */
     swapTracks(src: TrackResolvable, dest: TrackResolvable): void;
+    /**
+     * Create stream dispatcher from the given connection
+     * @param connection The connection to use
+     */
+    createDispatcher(connection: VoiceConnection, options?: Pick<VoiceConnectConfig, 'audioPlayer' | 'timeout'>): void;
     /**
      * Connect to a voice channel
      * @param channelResolvable The voice channel to connect to
@@ -1521,6 +1531,7 @@ declare class GuildQueue<Meta = unknown> {
      * @param args The args for the event
      */
     emit<K extends keyof GuildQueueEvents<Meta>>(event: K, ...args: Parameters<GuildQueueEvents<Meta>[K]>): boolean;
+    get hasDebugger(): boolean;
 }
 
 interface GuildQueueStatisticsMetadata {
@@ -1643,6 +1654,7 @@ declare class VoiceUtils {
         maxTime?: number;
         queue: GuildQueue;
         audioPlayer?: AudioPlayer;
+        group?: string;
     }): Promise<StreamDispatcher>;
     /**
      * Joins a voice channel
@@ -1653,6 +1665,7 @@ declare class VoiceUtils {
     join(channel: VoiceChannel | StageChannel, options?: {
         deaf?: boolean;
         maxTime?: number;
+        group?: string;
     }): Promise<VoiceConnection>;
     /**
      * Disconnects voice connection
@@ -1665,7 +1678,7 @@ declare class VoiceUtils {
      * @param {Snowflake} guild The guild id
      * @returns {StreamDispatcher}
      */
-    getConnection(guild: Snowflake): StreamDispatcher | VoiceConnection | undefined;
+    getConnection(guild: Snowflake, group?: string): StreamDispatcher | VoiceConnection | undefined;
 }
 
 interface QueryCacheOptions {
@@ -1727,6 +1740,7 @@ 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