From 36216c0e1a0c99e5200de97f08d054e278fd3f0f Mon Sep 17 00:00:00 2001 From: RanAS Date: Thu, 27 Apr 2023 15:29:27 -0300 Subject: [PATCH] docs: include StreamType enum description in new docs (#9457) --- packages/voice/src/audio/TransformerGraph.ts | 22 +++++++++++++------- 1 file changed, 15 insertions(+), 7 deletions(-) diff --git a/packages/voice/src/audio/TransformerGraph.ts b/packages/voice/src/audio/TransformerGraph.ts index fbb8d3252..8c3846567 100644 --- 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', }