docs: include StreamType enum description in new docs (#9457)

discordjs · Apr 27, 2023 · 36216c0 · 36216c0
1 parent 6212bff
commit 36216c0
Showing 1 changed file with 15 additions and 7 deletions.
diff --git a/packages/voice/src/audio/TransformerGraph.ts b/packages/voice/src/audio/TransformerGraph.ts
@@ -24,19 +24,27 @@ const FFMPEG_OPUS_ARGUMENTS = [
 
 /**
  * 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.
  */
 export enum StreamType {
+	/**
+	 * The type of the stream at this point is unknown.
+	 */
 	Arbitrary = 'arbitrary',
+	/**
+	 * The stream at this point is Opus audio encoded in an Ogg wrapper.
+	 */
 	OggOpus = 'ogg/opus',
+	/**
+	 * The stream at this point is Opus audio, and the stream is in object-mode. This is ready to play.
+	 */
 	Opus = 'opus',
+	/**
+	 * The stream at this point is s16le PCM.
+	 */
 	Raw = 'raw',
+	/**
+	 * The stream at this point is Opus audio encoded in a WebM wrapper.
+	 */
 	WebmOpus = 'webm/opus',
 }