Skip to content

Commit 36216c0

Browse files
docs: include StreamType enum description in new docs (#9457)
1 parent 6212bff commit 36216c0

File tree

1 file changed

+15
-7
lines changed

1 file changed

+15
-7
lines changed

packages/voice/src/audio/TransformerGraph.ts

Lines changed: 15 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -24,19 +24,27 @@ const FFMPEG_OPUS_ARGUMENTS = [
2424

2525
/**
2626
* The different types of stream that can exist within the pipeline.
27-
*
28-
* @remarks
29-
* - `Arbitrary` - the type of the stream at this point is unknown.
30-
* - `Raw` - the stream at this point is s16le PCM.
31-
* - `OggOpus` - the stream at this point is Opus audio encoded in an Ogg wrapper.
32-
* - `WebmOpus` - the stream at this point is Opus audio encoded in a WebM wrapper.
33-
* - `Opus` - the stream at this point is Opus audio, and the stream is in object-mode. This is ready to play.
3427
*/
3528
export enum StreamType {
29+
/**
30+
* The type of the stream at this point is unknown.
31+
*/
3632
Arbitrary = 'arbitrary',
33+
/**
34+
* The stream at this point is Opus audio encoded in an Ogg wrapper.
35+
*/
3736
OggOpus = 'ogg/opus',
37+
/**
38+
* The stream at this point is Opus audio, and the stream is in object-mode. This is ready to play.
39+
*/
3840
Opus = 'opus',
41+
/**
42+
* The stream at this point is s16le PCM.
43+
*/
3944
Raw = 'raw',
45+
/**
46+
* The stream at this point is Opus audio encoded in a WebM wrapper.
47+
*/
4048
WebmOpus = 'webm/opus',
4149
}
4250

0 commit comments

Comments
 (0)