discord-player 6.7.0 → 6.8.0-dev.0

package/README.md

@@ -25,6 +25,9 @@ Discord Player is a robust framework for developing Discord Music bots using Jav
 -   Out-of-the-box voice states handling
 -   IP Rotation support
 -   Easy serialization and deserialization
+-   Limited support for [Eris](https://npmjs.com/eris)
+
+> Eris compat mode does not support `VoiceStateUpdate` handler. You need to handle it manually.
 
 ## Installation
 
@@ -85,6 +88,10 @@ $ npm install --save ffmpeg-binaries
 
 #### Streaming Library
 
+**The following method is deprecated and will be removed in the future. Please switch to [discord-player-youtubei](https://npmjs.com/discord-player-youtubei).**
+
+**Not recommended**:
+
 YouTube streaming is not supported without installing one of the following package. If you want to add support for YouTube playback, you need to install a streaming library. This step is not needed if you do not plan on using youtube source.
 
 ```bash
@@ -99,8 +106,6 @@ $ npm install --save yt-stream
 $ npm install --save ytdl-core
 ```
 
-We recommend using `youtube-ext` for better performance.
-
 Once you have completed these installations, let's proceed with writing a simple music bot.
 
 ### Setup
@@ -132,6 +137,16 @@ player.events.on('playerStart', (queue, track) => {
 });
 ```
 
+## Eris Setup
+
+Discord Player has limited support for Eris. You can use the following code to set up Discord Player with Eris:
+
+```js index.js
+const { Player, createErisCompat } = require('discord-player');
+
+const player = new Player(createErisCompat(client));
+```
+
 Let's move on to the command part. You can define the command as per your requirements. We will only focus on the command part:
 
 ```js play.js

package/dist/index.d.ts

@@ -1,12 +1,13 @@
-import { ListenerSignature, DefaultListener, EventEmitter, Queue, QueueStrategy, Collection } from '@discord-player/utils';
 import * as discord_js from 'discord.js';
-import { VoiceChannel, StageChannel, UserResolvable, Guild, VoiceState, VoiceBasedChannel, GuildVoiceChannelResolvable, User, Snowflake, Client, GuildResolvable } from 'discord.js';
+import { Client, VoiceChannel, StageChannel, UserResolvable, Guild, VoiceState, VoiceBasedChannel, GuildVoiceChannelResolvable, User, Snowflake, GuildResolvable } from 'discord.js';
+import Eris from 'eris';
+import { ListenerSignature, DefaultListener, EventEmitter, Queue, QueueStrategy, Collection } from '@discord-player/utils';
 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 { Readable as Readable$1 } from 'node:stream';
 import { StreamType, AudioPlayerError, AudioResource, VoiceConnection, AudioPlayer, AudioPlayerStatus, EndBehaviorType } from 'discord-voip';
-export { AudioPlayer, CreateAudioPlayerOptions, createAudioPlayer } from 'discord-voip';
+export { AudioPlayer, CreateAudioPlayerOptions, createAudioPlayer, getVoiceConnection, getVoiceConnections } from 'discord-voip';
 import * as stream from 'stream';
 import { Readable, Duplex } from 'stream';
 import * as _discord_player_extractor from '@discord-player/extractor';
@@ -17,6 +18,14 @@ import { FFmpeg } from '@discord-player/ffmpeg';
 export * from '@discord-player/ffmpeg';
 import { downloadOptions } from 'ytdl-core';
 
+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.
+ * @returns The Eris client with discord-player compatibility.
+ */
+declare function createErisCompat(client: Eris.Client): Client;
+
 declare class PlayerEventsEmitter<L extends ListenerSignature<L> = DefaultListener> extends EventEmitter<L> {
     #private;
     requiredEvents: Array<keyof L>;
@@ -1590,12 +1599,13 @@ declare class Track<T = unknown> {
     requestedBy: User | null;
     playlist?: Playlist;
     queryType: SearchQueryType | null | undefined;
-    raw: RawTrackData;
+    raw: any;
     extractor: BaseExtractor | null;
     readonly id: string;
     private __metadata;
     private __reqMetadataFn;
     cleanTitle: string;
+    live: boolean;
     /**
      * Track constructor
      * @param player The player that instantiated this Track
@@ -1633,7 +1643,7 @@ declare class Track<T = unknown> {
     /**
      * Returns source of this track
      */
-    get source(): TrackSource;
+    get source(): any;
     /**
      * String representation of this track
      */
@@ -1654,7 +1664,7 @@ declare class Track<T = unknown> {
         duration: string;
         views: number;
         requested_by: {} | null;
-        source: TrackSource;
+        source: any;
         live: boolean;
         query_type: SearchQueryType | null | undefined;
         extractor: string | null;
@@ -1725,16 +1735,12 @@ declare class Playlist {
             title: string;
             description: string;
             author: 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
-             */
+            url: string;
             thumbnail: any;
             duration: string;
             views: number;
             requested_by: {} | null;
-            source: TrackSource;
+            source: any;
             live: boolean;
             query_type: SearchQueryType | null | undefined;
             extractor: string | null;
@@ -2495,6 +2501,10 @@ declare class Player extends PlayerEventsEmitter<PlayerEvents> {
         queryCacheEnabled: boolean;
         queues: GuildQueueStatisticsMetadata[];
     };
+    /**
+     * Whether the player is in compatibility mode. Compatibility mode is enabled when non-discord.js client is used.
+     */
+    isCompatMode(): boolean;
     /**
      * Destroy every single queues managed by this master player instance
      * @example ```typescript
@@ -3149,6 +3159,10 @@ interface PlayerInitOptions {
      * The probe timeout in milliseconds. Defaults to 5000.
      */
     probeTimeout?: number;
+    /**
+     * Configure ffmpeg path
+     */
+    ffmpegPath?: string;
 }
 
 declare class AudioFilters {
@@ -3329,4 +3343,4 @@ declare class QueryResolver {
 
 declare const version: string;
 
-export { AFilterGraph, AsyncQueue, AsyncQueueAcquisitionOptions, AsyncQueueEntry, AsyncQueueExceptionHandler, AudioFilters, BaseExtractor, Context, ContextReceiver, CreateStreamOps, DiscordPlayerQueryResultCache, Encodable, EqualizerConfigurationPreset, ExtractorExecutionContext, ExtractorExecutionEvents, ExtractorExecutionFN, ExtractorExecutionResult, ExtractorInfo, ExtractorLoaderOptionDict, ExtractorResolvable, 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, LrcGetParams, LrcGetResult, LrcLib, LrcSearchParams, LrcSearchResult, MetadataDispatch, 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, RequestEntity, ResolvedQuery, ResourcePlayOptions, Runtime, RuntimeType, SearchOptions, SearchQueryType, SearchResult, SearchResultData, SequentialBucket, SerializedPlaylist, SerializedTrack, SerializedType, SetterFN$1 as SetterFN, SkipOptions, StreamConfig, StreamDispatcher, TimeData, TimelineDispatcherOptions, Track, TrackJSON, TrackLike, TrackResolvable, TrackSkipReason, TrackSource, TypeUtil, Util, VALIDATE_QUEUE_CAP, VoiceConnectConfig, VoiceEvents, VoiceReceiverNode, VoiceReceiverOptions, VoiceStateHandler, VoiceUtils, WithMetadata, createContext, createFFmpegStream, createHook, decode, deserialize, encode, onAfterCreateStream, onBeforeCreateStream, serialize, tryIntoThumbnailString, useContext, useHistory, useMainPlayer, useMasterPlayer, useMetadata, usePlayer, useQueue, useTimeline, useVolume, version };
+export { AFilterGraph, AsyncQueue, AsyncQueueAcquisitionOptions, AsyncQueueEntry, AsyncQueueExceptionHandler, AudioFilters, BaseExtractor, Context, ContextReceiver, CreateStreamOps, DiscordPlayerQueryResultCache, Encodable, EqualizerConfigurationPreset, ExtractorExecutionContext, ExtractorExecutionEvents, ExtractorExecutionFN, ExtractorExecutionResult, ExtractorInfo, ExtractorLoaderOptionDict, ExtractorResolvable, 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, LrcGetParams, LrcGetResult, LrcLib, LrcSearchParams, LrcSearchResult, MetadataDispatch, 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, RequestEntity, ResolvedQuery, ResourcePlayOptions, Runtime, RuntimeType, SearchOptions, SearchQueryType, SearchResult, SearchResultData, SequentialBucket, SerializedPlaylist, SerializedTrack, SerializedType, SetterFN$1 as SetterFN, SkipOptions, StreamConfig, StreamDispatcher, TimeData, TimelineDispatcherOptions, Track, TrackJSON, TrackLike, TrackResolvable, TrackSkipReason, TrackSource, TypeUtil, Util, VALIDATE_QUEUE_CAP, VoiceConnectConfig, VoiceEvents, VoiceReceiverNode, VoiceReceiverOptions, VoiceStateHandler, VoiceUtils, WithMetadata, createContext, createErisCompat, createFFmpegStream, createHook, decode, deserialize, encode, isErisProxy, onAfterCreateStream, onBeforeCreateStream, serialize, tryIntoThumbnailString, useContext, useHistory, useMainPlayer, useMasterPlayer, useMetadata, usePlayer, useQueue, useTimeline, useVolume, version };