discord-player 6.8.0-dev.1 → 7.0.0-dev.1

package/dist/index.d.ts

@@ -1,22 +1,20 @@
 import * as discord_js from 'discord.js';
-import { Client, VoiceChannel, StageChannel, UserResolvable, Guild, VoiceState, VoiceBasedChannel, GuildVoiceChannelResolvable, User, Snowflake, GuildResolvable } from 'discord.js';
+import { Client, VoiceChannel, StageChannel, Guild, VoiceState, VoiceBasedChannel, GuildVoiceChannelResolvable, User, Snowflake, GuildResolvable, UserResolvable } 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, getVoiceConnection, getVoiceConnections } from 'discord-voip';
 import * as stream from 'stream';
 import { Readable, Duplex } from 'stream';
 import * as _discord_player_extractor from '@discord-player/extractor';
 import { BridgeProvider } from '@discord-player/extractor';
 import { RequestOptions } from 'http';
-import * as _discord_player_ffmpeg from '@discord-player/ffmpeg';
-import { FFmpeg } from '@discord-player/ffmpeg';
-export * from '@discord-player/ffmpeg';
+import { StreamType, AudioPlayerError, AudioResource, VoiceConnection, AudioPlayer, AudioPlayerStatus } from 'discord-voip';
+export { AudioPlayer, CreateAudioPlayerOptions, JoinConfig, JoinVoiceChannelOptions, createAudioPlayer, getVoiceConnection, getVoiceConnections, joinVoiceChannel } from 'discord-voip';
 import { downloadOptions } from 'ytdl-core';
+import { FFmpegLib } from '@discord-player/ffmpeg';
+export * from '@discord-player/ffmpeg';
 
 declare function isErisProxy(client: any): client is Eris.Client;
 /**
@@ -72,7 +70,6 @@ declare class StreamDispatcher extends EventEmitter<VoiceEvents> {
     readonly connectionTimeout: number;
     voiceConnection: VoiceConnection;
     audioPlayer: AudioPlayer;
-    receiver: VoiceReceiverNode;
     channel: VoiceChannel | StageChannel;
     audioResource?: AudioResource<Track> | null;
     dsp: FiltersChain;
@@ -190,30 +187,6 @@ declare class StreamDispatcher extends EventEmitter<VoiceEvents> {
     get streamTime(): number;
 }
 
-interface VoiceReceiverOptions {
-    mode?: 'opus' | 'pcm';
-    end?: EndBehaviorType;
-    silenceDuration?: number;
-    crc?: boolean;
-}
-type RawTrackInit = Partial<Omit<RawTrackData, 'author' | 'playlist' | 'source' | 'engine' | 'raw' | 'queryType' | 'description' | 'views'>>;
-declare class VoiceReceiverNode {
-    dispatcher: StreamDispatcher;
-    constructor(dispatcher: StreamDispatcher);
-    createRawTrack(stream: Readable$1, data?: RawTrackInit): Track<unknown>;
-    /**
-     * Merge multiple streams together
-     * @param streams The array of streams to merge
-     */
-    mergeRecordings(streams: Readable$1[]): void;
-    /**
-     * Record a user in voice channel
-     * @param user The user to record
-     * @param options Recording options
-     */
-    recordUser(user: UserResolvable, options?: VoiceReceiverOptions): Readable$1;
-}
-
 declare class GuildQueueHistory<Meta = unknown> {
     queue: GuildQueue<Meta>;
     tracks: Queue<Track<unknown>>;
@@ -540,7 +513,7 @@ declare function FFMPEG_ARGS_PIPED(fmt?: string): string[];
  * @param stream The source stream
  * @param options FFmpeg stream options
  */
-declare function createFFmpegStream(stream: Readable | Duplex | string, options?: FFmpegStreamOptions): Readable | Duplex | FFmpeg;
+declare function createFFmpegStream(stream: Readable | Duplex | string, options?: FFmpegStreamOptions): Readable | Duplex;
 
 type Filters = keyof typeof AudioFilters.filters;
 type EQPreset = {
@@ -593,7 +566,7 @@ declare class FFmpegFilterer<Meta = unknown> {
      * @param source The stream source
      * @param options The stream options
      */
-    createStream(source: string | Readable, options: FFmpegStreamOptions): Readable | stream.Duplex | _discord_player_ffmpeg.FFmpeg;
+    createStream(source: string | Readable, options: FFmpegStreamOptions): Readable | stream.Duplex;
     /**
      * Set ffmpeg filters
      * @param filters The filters
@@ -1339,10 +1312,6 @@ declare class GuildQueue<Meta = unknown> {
      * Formatted duration of this queue
      */
     get durationFormatted(): string;
-    /**
-     * The voice receiver for this queue
-     */
-    get voiceReceiver(): VoiceReceiverNode | null;
     /**
      * The sync lyrics provider for this queue.
      * @example const lyrics = await player.lyrics.search({ q: 'Alan Walker Faded' });
@@ -1754,7 +1723,7 @@ declare class Playlist {
         title: string;
         description: string;
         thumbnail: any;
-        type: "playlist" | "album";
+        type: "album" | "playlist";
         source: TrackSource;
         author: {
             name: string;
@@ -3359,6 +3328,67 @@ declare class QueryResolver {
     static validateURL(q: string): boolean;
 }
 
+interface PackageJSON {
+    name: string;
+    version: string;
+}
+type MaybeNull<T> = T | null;
+interface DependenciesReport {
+    core: {
+        'discord-player': string;
+        'discord-voip': string;
+    };
+    libopus: {
+        mediaplex: MaybeNull<string>;
+        '@discordjs/opus': MaybeNull<string>;
+        '@evan/opus': MaybeNull<string>;
+        opusscript: MaybeNull<string>;
+        'node-opus': MaybeNull<string>;
+    };
+    libsodium: {
+        'sodium-native': MaybeNull<string>;
+        sodium: MaybeNull<string>;
+        'libsodium-wrappers': MaybeNull<string>;
+        'sodium-javascript': MaybeNull<string>;
+        '@stablelib/xchacha20poly1305': MaybeNull<string>;
+    };
+    ffmpeg: FFmpegReport;
+}
+type FFmpegReport = Record<FFmpegLib, MaybeNull<{
+    version: string;
+    hasLibopus: boolean;
+}>>;
+/**
+ * A utility to generate a report of the dependencies used by the discord-player module.
+ */
+declare const DependencyReportGenerator: {
+    /**
+     * Finds the package.json file of a package.
+     * @param dir - The directory to start searching from
+     * @param packageName - The name of the package to find
+     * @param depth - The maximum depth to search
+     * @returns The package.json file, or null if not found
+     */
+    findPackageJSON(dir: string, packageName: string, depth: number): PackageJSON | null;
+    /**
+     * Tries to find the version of a dependency.
+     * @param name - The package to find the version of
+     * @param maxLookupDepth - The maximum depth to search for the package.json file
+     * @returns The version of the package, or null if not found
+     */
+    version(name: string, maxLookupDepth?: number): string | null;
+    /**
+     * Generates a report of the dependencies used by the discord-player module.
+     * @returns The report object
+     */
+    generate(): DependenciesReport;
+    /**
+     * Generates a string representation of the dependencies report.
+     * @returns The string representation
+     */
+    generateString(): string;
+};
+
 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, ExtractorSession, 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 };
+export { AFilterGraph, AsyncQueue, AsyncQueueAcquisitionOptions, AsyncQueueEntry, AsyncQueueExceptionHandler, AudioFilters, BaseExtractor, Context, ContextReceiver, CreateStreamOps, DependenciesReport, DependencyReportGenerator, DiscordPlayerQueryResultCache, Encodable, EqualizerConfigurationPreset, ExtractorExecutionContext, ExtractorExecutionEvents, ExtractorExecutionFN, ExtractorExecutionResult, ExtractorInfo, ExtractorLoaderOptionDict, ExtractorResolvable, ExtractorSearchContext, ExtractorSession, ExtractorStreamable, FFMPEG_ARGS_PIPED, FFMPEG_ARGS_STRING, FFMPEG_SRATE_REGEX, FFmpegFilterer, FFmpegReport, 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, MaybeNull, MetadataDispatch, NextFunction, NodeResolvable, OnAfterCreateStreamHandler, OnBeforeCreateStreamHandler, PackageJSON, 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, 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, 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 };