@discordjs/voice 0.6.0 → 0.7.0

package/dist/index.d.ts

@@ -1,5 +1,4 @@
-/// <reference types="node" />
-import { Readable, ReadableOptions } from 'stream';
+import { Readable, ReadableOptions } from 'node:stream';
 import { VolumeTransformer, opus } from 'prism-media';
 import { TypedEmitter } from 'tiny-typed-emitter';
 import { GatewayVoiceServerUpdateDispatchData, GatewayVoiceStateUpdateDispatchData } from 'discord-api-types/v9';
@@ -8,17 +7,13 @@ import WebSocket, { MessageEvent } from 'ws';
 declare type Awaited<T> = T | Promise<T>;
 
 /**
- * The different types of stream that can exist within the pipeline
+ * The different types of stream that can exist within the pipeline.
  *
  * @remarks
  * - `Arbitrary` - the type of the stream at this point is unknown.
- *
  * - `Raw` - the stream at this point is s16le PCM.
- *
  * - `OggOpus` - the stream at this point is Opus audio encoded in an Ogg wrapper.
- *
  * - `WebmOpus` - the stream at this point is Opus audio encoded in a WebM wrapper.
- *
  * - `Opus` - the stream at this point is Opus audio, and the stream is in object-mode. This is ready to play.
  */
 declare enum StreamType {
@@ -29,7 +24,7 @@ declare enum StreamType {
     Opus = "opus"
 }
 /**
- * The different types of transformers that can exist within the pipeline
+ * The different types of transformers that can exist within the pipeline.
  */
 declare enum TransformerType {
     FFmpegPCM = "ffmpeg pcm",
@@ -41,7 +36,7 @@ declare enum TransformerType {
     InlineVolume = "volume transformer"
 }
 /**
- * Represents a pathway from one stream type to another using a transformer
+ * Represents a pathway from one stream type to another using a transformer.
  */
 interface Edge {
     from: Node;
@@ -55,16 +50,16 @@ interface Edge {
  */
 declare class Node {
     /**
-     * The outbound edges from this node
+     * The outbound edges from this node.
      */
     readonly edges: Edge[];
     /**
-     * The type of stream for this node
+     * The type of stream for this node.
      */
     readonly type: StreamType;
     constructor(type: StreamType);
     /**
-     * Creates an outbound edge from this node
+     * Creates an outbound edge from this node.
      *
      * @param edge - The edge to create
      */
@@ -74,7 +69,7 @@ declare class Node {
 /**
  * Options that are set when creating a new audio resource.
  *
- * @template T - the type for the metadata (if any) of the audio resource.
+ * @template T - the type for the metadata (if any) of the audio resource
  */
 interface CreateAudioResourceOptions<T> {
     /**
@@ -82,7 +77,7 @@ interface CreateAudioResourceOptions<T> {
      */
     inputType?: StreamType;
     /**
-     * Optional metadata that can be attached to the resource (e.g. track title, random ID).
+     * Optional metadata that can be attached to the resource (e.g. track title, random id).
      * This is useful for identification purposes when the resource is passed around in events.
      * See {@link AudioResource.metadata}
      */
@@ -101,7 +96,7 @@ interface CreateAudioResourceOptions<T> {
 /**
  * Represents an audio resource that can be played by an audio player.
  *
- * @template T - the type for the metadata (if any) of the audio resource.
+ * @template T - the type for the metadata (if any) of the audio resource
  */
 declare class AudioResource<T = unknown> {
     /**
@@ -161,15 +156,47 @@ declare class AudioResource<T = unknown> {
     /**
      * Attempts to read an Opus packet from the audio resource. If a packet is available, the playbackDuration
      * is incremented.
-     * @internal
+     *
      * @remarks
      * It is advisable to check that the playStream is readable before calling this method. While no runtime
      * errors will be thrown, you should check that the resource is still available before attempting to
      * read from it.
+     *
+     * @internal
      */
     read(): Buffer | null;
 }
+/**
+ * Creates an audio resource that can be played by audio players.
+ *
+ * @remarks
+ * If the input is given as a string, then the inputType option will be overridden and FFmpeg will be used.
+ *
+ * If the input is not in the correct format, then a pipeline of transcoders and transformers will be created
+ * to ensure that the resultant stream is in the correct format for playback. This could involve using FFmpeg,
+ * Opus transcoders, and Ogg/WebM demuxers.
+ *
+ * @param input - The resource to play
+ * @param options - Configurable options for creating the resource
+ *
+ * @template T - the type for the metadata (if any) of the audio resource
+ */
 declare function createAudioResource<T>(input: string | Readable, options: CreateAudioResourceOptions<T> & Pick<T extends null | undefined ? CreateAudioResourceOptions<T> : Required<CreateAudioResourceOptions<T>>, 'metadata'>): AudioResource<T extends null | undefined ? null : T>;
+/**
+ * Creates an audio resource that can be played by audio players.
+ *
+ * @remarks
+ * If the input is given as a string, then the inputType option will be overridden and FFmpeg will be used.
+ *
+ * If the input is not in the correct format, then a pipeline of transcoders and transformers will be created
+ * to ensure that the resultant stream is in the correct format for playback. This could involve using FFmpeg,
+ * Opus transcoders, and Ogg/WebM demuxers.
+ *
+ * @param input - The resource to play
+ * @param options - Configurable options for creating the resource
+ *
+ * @template T - the type for the metadata (if any) of the audio resource
+ */
 declare function createAudioResource<T extends null | undefined>(input: string | Readable, options?: Omit<CreateAudioResourceOptions<T>, 'metadata'>): AudioResource<null>;
 
 /**
@@ -190,11 +217,11 @@ declare class AudioPlayerError extends Error {
  */
 declare class PlayerSubscription {
     /**
-     * The voice connection of this subscription
+     * The voice connection of this subscription.
      */
     readonly connection: VoiceConnection;
     /**
-     * The audio player of this subscription
+     * The audio player of this subscription.
      */
     readonly player: AudioPlayer;
     constructor(connection: VoiceConnection, player: AudioPlayer);
@@ -211,33 +238,33 @@ declare class PlayerSubscription {
  */
 declare enum NoSubscriberBehavior {
     /**
-     * Pauses playing the stream until a voice connection becomes available
+     * Pauses playing the stream until a voice connection becomes available.
      */
     Pause = "pause",
     /**
-     * Continues to play through the resource regardless
+     * Continues to play through the resource regardless.
      */
     Play = "play",
     /**
-     * The player stops and enters the Idle state
+     * The player stops and enters the Idle state.
      */
     Stop = "stop"
 }
 declare enum AudioPlayerStatus {
     /**
-     * When there is currently no resource for the player to be playing
+     * When there is currently no resource for the player to be playing.
      */
     Idle = "idle",
     /**
-     * When the player is waiting for an audio resource to become readable before transitioning to Playing
+     * When the player is waiting for an audio resource to become readable before transitioning to Playing.
      */
     Buffering = "buffering",
     /**
-     * When the player has been manually paused
+     * When the player has been manually paused.
      */
     Paused = "paused",
     /**
-     * When the player is actively playing an audio resource
+     * When the player is actively playing an audio resource.
      */
     Playing = "playing",
     /**
@@ -292,7 +319,7 @@ interface AudioPlayerPlayingState {
      */
     playbackDuration: number;
     /**
-     * The resource that is being played
+     * The resource that is being played.
      */
     resource: AudioResource;
     onStreamError: (error: Error) => void;
@@ -304,7 +331,7 @@ interface AudioPlayerPlayingState {
 interface AudioPlayerPausedState {
     status: AudioPlayerStatus.Paused | AudioPlayerStatus.AutoPaused;
     /**
-     * How many silence packets still need to be played to avoid audio interpolation due to the stream suddenly pausing
+     * How many silence packets still need to be played to avoid audio interpolation due to the stream suddenly pausing.
      */
     silencePacketsRemaining: number;
     /**
@@ -313,7 +340,7 @@ interface AudioPlayerPausedState {
      */
     playbackDuration: number;
     /**
-     * The current resource of the audio player
+     * The current resource of the audio player.
      */
     resource: AudioResource;
     onStreamError: (error: Error) => void;
@@ -345,7 +372,7 @@ declare type AudioPlayerEvents = {
  */
 declare class AudioPlayer extends TypedEmitter<AudioPlayerEvents> {
     /**
-     * The state that the AudioPlayer is in
+     * The state that the AudioPlayer is in.
      */
     private _state;
     /**
@@ -362,11 +389,11 @@ declare class AudioPlayer extends TypedEmitter<AudioPlayerEvents> {
      */
     private readonly debug;
     /**
-     * Creates a new AudioPlayer
+     * Creates a new AudioPlayer.
      */
     constructor(options?: CreateAudioPlayerOptions);
     /**
-     * A list of subscribed voice connections that can currently receive audio to play
+     * A list of subscribed voice connections that can currently receive audio to play.
      */
     get playable(): VoiceConnection[];
     /**
@@ -377,7 +404,8 @@ declare class AudioPlayer extends TypedEmitter<AudioPlayerEvents> {
      * This method should not be directly called. Instead, use VoiceConnection#subscribe.
      *
      * @param connection - The connection to subscribe
-     * @returns The new subscription if the voice connection is not yet subscribed, otherwise the existing subscription.
+     *
+     * @returns The new subscription if the voice connection is not yet subscribed, otherwise the existing subscription
      */
     private subscribe;
     /**
@@ -387,7 +415,8 @@ declare class AudioPlayer extends TypedEmitter<AudioPlayerEvents> {
      * This method should not be directly called. Instead, use PlayerSubscription#unsubscribe.
      *
      * @param subscription - The subscription to remove
-     * @returns Whether or not the subscription existed on the player and was removed.
+     *
+     * @returns Whether or not the subscription existed on the player and was removed
      */
     private unsubscribe;
     /**
@@ -410,34 +439,37 @@ declare class AudioPlayer extends TypedEmitter<AudioPlayerEvents> {
      * Idle state during the swap over.
      *
      * @param resource - The resource to play
-     * @throws Will throw if attempting to play an audio resource that has already ended, or is being played by another player.
+     *
+     * @throws Will throw if attempting to play an audio resource that has already ended, or is being played by another player
      */
     play<T>(resource: AudioResource<T>): void;
     /**
      * Pauses playback of the current resource, if any.
      *
-     * @param interpolateSilence - If true, the player will play 5 packets of silence after pausing to prevent audio glitches.
-     * @returns true if the player was successfully paused, otherwise false.
+     * @param interpolateSilence - If true, the player will play 5 packets of silence after pausing to prevent audio glitches
+     *
+     * @returns `true` if the player was successfully paused, otherwise `false`
      */
     pause(interpolateSilence?: boolean): boolean;
     /**
      * Unpauses playback of the current resource, if any.
      *
-     * @returns true if the player was successfully unpaused, otherwise false.
+     * @returns `true` if the player was successfully unpaused, otherwise `false`
      */
     unpause(): boolean;
     /**
      * Stops playback of the current resource and destroys the resource. The player will either transition to the Idle state,
      * or remain in its current state until the silence padding frames of the resource have been played.
      *
-     * @param force - If true, will force the player to enter the Idle state even if the resource has silence padding frames.
-     * @returns true if the player will come to a stop, otherwise false.
+     * @param force - If true, will force the player to enter the Idle state even if the resource has silence padding frames
+     *
+     * @returns `true` if the player will come to a stop, otherwise `false`
      */
     stop(force?: boolean): boolean;
     /**
-     * Checks whether the underlying resource (if any) is playable (readable).
+     * Checks whether the underlying resource (if any) is playable (readable)
      *
-     * @returns true if the resource is playable, false otherwise.
+     * @returns `true` if the resource is playable, otherwise `false`
      */
     checkPlayable(): boolean;
     /**
@@ -466,7 +498,7 @@ declare class AudioPlayer extends TypedEmitter<AudioPlayerEvents> {
     private _preparePacket;
 }
 /**
- * Creates a new AudioPlayer to be used
+ * Creates a new AudioPlayer to be used.
  */
 declare function createAudioPlayer(options?: CreateAudioPlayerOptions): AudioPlayer;
 
@@ -480,15 +512,32 @@ interface JoinConfig {
 /**
  * Retrieves the map of group names to maps of voice connections. By default, all voice connections
  * are created under the 'default' group.
+ *
  * @returns The group map
  */
 declare function getGroups(): Map<string, Map<string, VoiceConnection>>;
+/**
+ * Retrieves all the voice connections under the 'default' group.
+ *
+ * @param group - The group to look up
+ *
+ * @returns The map of voice connections
+ */
 declare function getVoiceConnections(group?: 'default'): Map<string, VoiceConnection>;
+/**
+ * Retrieves all the voice connections under the given group name.
+ *
+ * @param group - The group to look up
+ *
+ * @returns The map of voice connections
+ */
 declare function getVoiceConnections(group: string): Map<string, VoiceConnection> | undefined;
 /**
- * Finds a voice connection with the given guild ID and group. Defaults to the 'default' group.
- * @param guildId - The guild ID of the voice connection
+ * Finds a voice connection with the given guild id and group. Defaults to the 'default' group.
+ *
+ * @param guildId - The guild id of the voice connection
  * @param group - the group that the voice connection was registered with
+ *
  * @returns The voice connection, if it exists
  */
 declare function getVoiceConnection(guildId: string, group?: string): VoiceConnection | undefined;
@@ -523,7 +572,8 @@ interface DiscordGatewayAdapterImplementerMethods {
      * Implement this method such that the given payload is sent to the main Discord gateway connection.
      *
      * @param payload - The payload to send to the main Discord gateway connection
-     * @returns false if the payload definitely failed to send - in this case, the voice connection disconnects.
+     *
+     * @returns `false` if the payload definitely failed to send - in this case, the voice connection disconnects
      */
     sendPayload(payload: any): boolean;
     /**
@@ -563,7 +613,7 @@ declare class VoiceUDPSocket extends TypedEmitter<VoiceUDPSocketEvents> {
      */
     private readonly socket;
     /**
-     * The socket details for Discord (remote).
+     * The socket details for Discord (remote)
      */
     private readonly remote;
     /**
@@ -571,19 +621,19 @@ declare class VoiceUDPSocket extends TypedEmitter<VoiceUDPSocketEvents> {
      */
     private readonly keepAlives;
     /**
-     * The counter used in the keep alive mechanism
+     * The counter used in the keep alive mechanism.
      */
     private keepAliveCounter;
     /**
-     * The buffer used to write the keep alive counter into
+     * The buffer used to write the keep alive counter into.
      */
     private readonly keepAliveBuffer;
     /**
-     * The Node.js interval for the keep-alive mechanism
+     * The Node.js interval for the keep-alive mechanism.
      */
     private readonly keepAliveInterval;
     /**
-     * The time taken to receive a response to keep alive messages
+     * The time taken to receive a response to keep alive messages.
      */
     ping?: number;
     /**
@@ -597,12 +647,13 @@ declare class VoiceUDPSocket extends TypedEmitter<VoiceUDPSocketEvents> {
      */
     constructor(remote: SocketConfig, debug?: boolean);
     /**
-     * Called when a message is received on the UDP socket
+     * Called when a message is received on the UDP socket.
+     *
      * @param buffer The received buffer
      */
     private onMessage;
     /**
-     * Called at a regular interval to check whether we are still able to send datagrams to Discord
+     * Called at a regular interval to check whether we are still able to send datagrams to Discord.
      */
     private keepAlive;
     /**
@@ -631,7 +682,7 @@ declare class VoiceUDPSocket extends TypedEmitter<VoiceUDPSocketEvents> {
  */
 interface VoiceWebSocketEvents {
     error: (error: Error) => Awaited<void>;
-    open: (event: WebSocket.OpenEvent) => Awaited<void>;
+    open: (event: WebSocket.Event) => Awaited<void>;
     close: (event: WebSocket.CloseEvent) => Awaited<void>;
     debug: (message: string) => Awaited<void>;
     packet: (packet: any) => Awaited<void>;
@@ -642,7 +693,7 @@ interface VoiceWebSocketEvents {
  */
 declare class VoiceWebSocket extends TypedEmitter<VoiceWebSocketEvents> {
     /**
-     * The current heartbeat interval, if any
+     * The current heartbeat interval, if any.
      */
     private heartbeatInterval?;
     /**
@@ -668,11 +719,11 @@ declare class VoiceWebSocket extends TypedEmitter<VoiceWebSocketEvents> {
      */
     private readonly debug;
     /**
-     * The underlying WebSocket of this wrapper
+     * The underlying WebSocket of this wrapper.
      */
     private readonly ws;
     /**
-     * Creates a new VoiceWebSocket
+     * Creates a new VoiceWebSocket.
      *
      * @param address - The address to connect to
      */
@@ -689,19 +740,19 @@ declare class VoiceWebSocket extends TypedEmitter<VoiceWebSocketEvents> {
      */
     onMessage(event: MessageEvent): void;
     /**
-     * Sends a JSON-stringifiable packet over the WebSocket
+     * Sends a JSON-stringifiable packet over the WebSocket.
      *
      * @param packet - The packet to send
      */
     sendPacket(packet: any): void;
     /**
-     * Sends a heartbeat over the WebSocket
+     * Sends a heartbeat over the WebSocket.
      */
     private sendHeartbeat;
     /**
-     * Sets/clears an interval to send heartbeats over the WebSocket
+     * Sets/clears an interval to send heartbeats over the WebSocket.
      *
-     * @param ms - The interval in milliseconds. If negative, the interval will be unset.
+     * @param ms - The interval in milliseconds. If negative, the interval will be unset
      */
     setHeartbeatInterval(ms: number): void;
 }
@@ -878,11 +929,12 @@ declare class Networking extends TypedEmitter<NetworkingEvents> {
      */
     private onWsClose;
     /**
-     * Called when the UDP socket has closed itself if it has stopped receiving replies from Discord
+     * Called when the UDP socket has closed itself if it has stopped receiving replies from Discord.
      */
     private onUdpClose;
     /**
-     * Called when a packet is received on the connection's WebSocket
+     * Called when a packet is received on the connection's WebSocket.
+     *
      * @param packet - The received packet
      */
     private onWsPacket;
@@ -900,7 +952,7 @@ declare class Networking extends TypedEmitter<NetworkingEvents> {
     private onUdpDebug;
     /**
      * Prepares an Opus packet for playback. This includes attaching metadata to it and encrypting it.
-     * It will be stored within the instance, and can be played by dispatchAudio().
+     * It will be stored within the instance, and can be played by dispatchAudio()
      *
      * @remarks
      * Calling this method while there is already a prepared audio packet that has not yet been dispatched
@@ -908,7 +960,7 @@ declare class Networking extends TypedEmitter<NetworkingEvents> {
      *
      * @param opusPacket - The Opus packet to encrypt
      *
-     * @returns The audio packet that was prepared.
+     * @returns The audio packet that was prepared
      */
     prepareAudioPacket(opusPacket: Buffer): Buffer | undefined;
     /**
@@ -990,7 +1042,7 @@ declare class AudioReceiveStream extends Readable {
 }
 
 /**
- * The events that a SpeakingMap can emit
+ * The events that a SpeakingMap can emit.
  */
 interface SpeakingMapEvents {
     /**
@@ -1021,20 +1073,20 @@ declare class SpeakingMap extends TypedEmitter<SpeakingMapEvents> {
 }
 
 /**
- * The known data for a user in a Discord voice connection
+ * The known data for a user in a Discord voice connection.
  */
 interface VoiceUserData {
     /**
-     * The SSRC of the user's audio stream
+     * The SSRC of the user's audio stream.
      */
     audioSSRC: number;
     /**
-     * The SSRC of the user's video stream (if one exists).
+     * The SSRC of the user's video stream (if one exists)
      * Cannot be 0. If undefined, the user has no video stream.
      */
     videoSSRC?: number;
     /**
-     * The Discord user ID of the user
+     * The Discord user id of the user.
      */
     userId: string;
 }
@@ -1051,7 +1103,7 @@ interface SSRCMapEvents {
  */
 declare class SSRCMap extends TypedEmitter<SSRCMapEvents> {
     /**
-     * The underlying map
+     * The underlying map.
      */
     private readonly map;
     constructor();
@@ -1064,13 +1116,14 @@ declare class SSRCMap extends TypedEmitter<SSRCMapEvents> {
     /**
      * Gets the stored voice data of a user.
      *
-     * @param target The target, either their user ID or audio SSRC
+     * @param target The target, either their user id or audio SSRC
      */
     get(target: number | string): VoiceUserData | undefined;
     /**
      * Deletes the stored voice data about a user.
      *
-     * @param target The target of the delete operation, either their audio SSRC or user ID
+     * @param target The target of the delete operation, either their audio SSRC or user id
+     *
      * @returns The data that was deleted, if any
      */
     delete(target: number | string): VoiceUserData | undefined;
@@ -1088,7 +1141,7 @@ declare class VoiceReceiver {
      */
     readonly voiceConnection: VoiceConnection;
     /**
-     * Maps SSRCs to Discord user IDs.
+     * Maps SSRCs to Discord user ids.
      */
     readonly ssrcMap: SSRCMap;
     /**
@@ -1097,6 +1150,7 @@ declare class VoiceReceiver {
     readonly subscriptions: Map<string, AudioReceiveStream>;
     /**
      * The connection data of the receiver.
+     *
      * @internal
      */
     connectionData: Partial<ConnectionData>;
@@ -1109,6 +1163,7 @@ declare class VoiceReceiver {
      * Called when a packet is received on the attached connection's WebSocket.
      *
      * @param packet The received packet
+     *
      * @internal
      */
     onWsPacket(packet: any): void;
@@ -1120,6 +1175,7 @@ declare class VoiceReceiver {
      * @param mode The encryption mode
      * @param nonce The nonce buffer used by the connection for encryption
      * @param secretKey The secret key used by the connection for encryption
+     *
      * @returns The parsed Opus packet
      */
     private parsePacket;
@@ -1127,13 +1183,15 @@ declare class VoiceReceiver {
      * Called when the UDP socket of the attached connection receives a message.
      *
      * @param msg The received message
+     *
      * @internal
      */
     onUdpMessage(msg: Buffer): void;
     /**
-     * Creates a subscription for the given user ID.
+     * Creates a subscription for the given user id.
+     *
+     * @param target The id of the user to subscribe to
      *
-     * @param target The ID of the user to subscribe to
      * @returns A readable stream of Opus packets received from the target
      */
     subscribe(userId: string, options?: Partial<AudioReceiveStreamOptions>): AudioReceiveStream;
@@ -1152,7 +1210,7 @@ declare enum VoiceConnectionStatus {
      */
     Connecting = "connecting",
     /**
-     * A voice connection has been established, and is ready to be used
+     * A voice connection has been established, and is ready to be used.
      */
     Ready = "ready",
     /**
@@ -1277,11 +1335,12 @@ declare class VoiceConnection extends TypedEmitter<VoiceConnectionEvents> {
      */
     rejoinAttempts: number;
     /**
-     * The state of the voice connection
+     * The state of the voice connection.
      */
     private _state;
     /**
      * A configuration storing all the data needed to reconnect to a Guild's voice server.
+     *
      * @internal
      */
     readonly joinConfig: JoinConfig;
@@ -1307,7 +1366,7 @@ declare class VoiceConnection extends TypedEmitter<VoiceConnectionEvents> {
      */
     constructor(joinConfig: JoinConfig, { debug, adapterCreator }: CreateVoiceConnectionOptions);
     /**
-     * The current state of the voice connection
+     * The current state of the voice connection.
      */
     get state(): VoiceConnectionState;
     /**
@@ -1322,7 +1381,7 @@ declare class VoiceConnection extends TypedEmitter<VoiceConnectionEvents> {
      */
     private addServerPacket;
     /**
-     * Registers a `VOICE_STATE_UPDATE` packet to the voice connection. Most importantly, it stores the ID of the
+     * Registers a `VOICE_STATE_UPDATE` packet to the voice connection. Most importantly, it stores the id of the
      * channel that the client is connected to.
      *
      * @param packet - The received `VOICE_STATE_UPDATE` packet
@@ -1380,7 +1439,7 @@ declare class VoiceConnection extends TypedEmitter<VoiceConnectionEvents> {
      */
     private onNetworkingDebug;
     /**
-     * Prepares an audio packet for dispatch
+     * Prepares an audio packet for dispatch.
      *
      * @param buffer - The Opus packet to prepare
      */
@@ -1390,7 +1449,7 @@ declare class VoiceConnection extends TypedEmitter<VoiceConnectionEvents> {
      */
     dispatchAudio(): boolean | undefined;
     /**
-     * Prepares an audio packet and dispatches it immediately
+     * Prepares an audio packet and dispatches it immediately.
      *
      * @param buffer - The Opus packet to play
      */
@@ -1399,12 +1458,14 @@ declare class VoiceConnection extends TypedEmitter<VoiceConnectionEvents> {
      * Destroys the VoiceConnection, preventing it from connecting to voice again.
      * This method should be called when you no longer require the VoiceConnection to
      * prevent memory leaks.
+     *
      * @param adapterAvailable - Whether the adapter can be used
      */
     destroy(adapterAvailable?: boolean): void;
     /**
      * Disconnects the VoiceConnection, allowing the possibility of rejoining later on.
-     * @returns - true if the connection was successfully disconnected.
+     *
+     * @returns `true` if the connection was successfully disconnected
      */
     disconnect(): boolean;
     /**
@@ -1424,11 +1485,12 @@ declare class VoiceConnection extends TypedEmitter<VoiceConnectionEvents> {
      *
      * @param enabled - Whether or not to show as speaking
      */
-    setSpeaking(enabled: boolean): false | undefined;
+    setSpeaking(enabled: boolean): false | void;
     /**
      * Subscribes to an audio player, allowing the player to play audio on this voice connection.
      *
      * @param player - The audio player to subscribe to
+     *
      * @returns The created subscription
      */
     subscribe(player: AudioPlayer): PlayerSubscription | undefined;
@@ -1468,11 +1530,11 @@ interface CreateVoiceConnectionOptions {
  */
 interface JoinVoiceChannelOptions {
     /**
-     * The ID of the Discord voice channel to join
+     * The id of the Discord voice channel to join.
      */
     channelId: string;
     /**
-     * The ID of the guild that the voice channel belongs to
+     * The id of the guild that the voice channel belongs to.
      */
     guildId: string;
     /**
@@ -1484,7 +1546,7 @@ interface JoinVoiceChannelOptions {
      */
     selfMute?: boolean;
     /**
-     * An optional group identifier for the voice connection
+     * An optional group identifier for the voice connection.
      */
     group?: string;
 }
@@ -1521,8 +1583,10 @@ declare function entersState(target: AudioPlayer, status: AudioPlayerStatus, tim
 
 /**
  * Takes an Opus Head, and verifies whether the associated Opus audio is suitable to play in a Discord voice channel.
+ *
  * @param opusHead The Opus Head to validate
- * @returns true if suitable to play in a Discord voice channel, false otherwise
+ *
+ * @returns `true` if suitable to play in a Discord voice channel, otherwise `false`
  */
 declare function validateDiscordOpusHead(opusHead: Buffer): boolean;
 /**
@@ -1535,17 +1599,19 @@ interface ProbeInfo {
      */
     stream: Readable;
     /**
-     * The recommended stream type for this audio stream
+     * The recommended stream type for this audio stream.
      */
     type: StreamType;
 }
 /**
  * Attempt to probe a readable stream to figure out whether it can be demuxed using an Ogg or WebM Opus demuxer.
+ *
  * @param stream The readable stream to probe
  * @param probeSize The number of bytes to attempt to read before giving up on the probe
  * @param validator The Opus Head validator function
+ *
  * @experimental
  */
 declare function demuxProbe(stream: Readable, probeSize?: number, validator?: typeof validateDiscordOpusHead): Promise<ProbeInfo>;
 
-export { AudioPlayer, AudioPlayerBufferingState, AudioPlayerError, AudioPlayerEvents, AudioPlayerIdleState, AudioPlayerPausedState, AudioPlayerPlayingState, AudioPlayerState, AudioPlayerStatus, AudioReceiveStream, AudioReceiveStreamOptions, AudioResource, CreateAudioPlayerOptions, CreateVoiceConnectionOptions, DiscordGatewayAdapterCreator, DiscordGatewayAdapterImplementerMethods, DiscordGatewayAdapterLibraryMethods, EndBehavior, EndBehaviorType, JoinVoiceChannelOptions, NoSubscriberBehavior, PlayerSubscription, ProbeInfo, SSRCMap, SSRCMapEvents, StreamType, VoiceConnection, VoiceConnectionConnectingState, VoiceConnectionDestroyedState, VoiceConnectionDisconnectReason, VoiceConnectionDisconnectedBaseState, VoiceConnectionDisconnectedOtherState, VoiceConnectionDisconnectedState, VoiceConnectionDisconnectedWebSocketState, VoiceConnectionEvents, VoiceConnectionReadyState, VoiceConnectionSignallingState, VoiceConnectionState, VoiceConnectionStatus, VoiceReceiver, VoiceUserData, createAudioPlayer, createAudioResource, createDefaultAudioReceiveStreamOptions, demuxProbe, entersState, generateDependencyReport, getGroups, getVoiceConnection, getVoiceConnections, joinVoiceChannel, validateDiscordOpusHead };
+export { AudioPlayer, AudioPlayerBufferingState, AudioPlayerError, AudioPlayerEvents, AudioPlayerIdleState, AudioPlayerPausedState, AudioPlayerPlayingState, AudioPlayerState, AudioPlayerStatus, AudioReceiveStream, AudioReceiveStreamOptions, AudioResource, CreateAudioPlayerOptions, CreateAudioResourceOptions, CreateVoiceConnectionOptions, DiscordGatewayAdapterCreator, DiscordGatewayAdapterImplementerMethods, DiscordGatewayAdapterLibraryMethods, EndBehavior, EndBehaviorType, JoinConfig, JoinVoiceChannelOptions, NoSubscriberBehavior, PlayerSubscription, ProbeInfo, SSRCMap, SSRCMapEvents, SpeakingMap, SpeakingMapEvents, StreamType, VoiceConnection, VoiceConnectionConnectingState, VoiceConnectionDestroyedState, VoiceConnectionDisconnectReason, VoiceConnectionDisconnectedBaseState, VoiceConnectionDisconnectedOtherState, VoiceConnectionDisconnectedState, VoiceConnectionDisconnectedWebSocketState, VoiceConnectionEvents, VoiceConnectionReadyState, VoiceConnectionSignallingState, VoiceConnectionState, VoiceConnectionStatus, VoiceReceiver, VoiceUserData, createAudioPlayer, createAudioResource, createDefaultAudioReceiveStreamOptions, demuxProbe, entersState, generateDependencyReport, getGroups, getVoiceConnection, getVoiceConnections, joinVoiceChannel, validateDiscordOpusHead };