Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: include StreamType enum description in new docs #9457

Merged
merged 2 commits into from
Apr 27, 2023
Merged

docs: include StreamType enum description in new docs #9457

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
cba15a4
docs: include StreamType enum description in new docs
RanAwaySuccessfully Apr 25, 2023
806e49a
Update TransformerGraph.ts
RanAwaySuccessfully Apr 27, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 17 additions & 9 deletions packages/voice/src/audio/TransformerGraph.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,20 +24,28 @@ 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',
OggOpus = 'ogg/opus',
Opus = 'opus',
/**
* The stream at this point is s16le PCM.
*/
Raw = 'raw',
/**
* The stream at this point is Opus audio encoded in an Ogg wrapper.
*/
OggOpus = 'ogg/opus',
/**
* The stream at this point is Opus audio encoded in a WebM wrapper.
*/
WebmOpus = 'webm/opus',
/**
* The stream at this point is Opus audio, and the stream is in object-mode. This is ready to play.
*/
Opus = 'opus',
}

/**
Expand Down