Nomchy/discord.js
1
0
Fork 0
mirror of https://github.com/discordjs/discord.js.git synced 2026-03-15 11:03:30 +01:00
Code Issues Packages Projects Releases Wiki Activity

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

Browse Source
This commit is contained in:
RanAS
2023-04-27 15:29:27 -03:00
committed by GitHub
parent 6212bffa30
commit 36216c0e1a
1 changed files with 15 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
packages/voice/src/audio/TransformerGraph.ts
View File

@@ -24,19 +24,27 @@ const FFMPEG_OPUS_ARGUMENTS = [
/** /**
* 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.
*/ */
export enum StreamType { export enum StreamType {
/**
* The type of the stream at this point is unknown.
*/
Arbitrary = 'arbitrary', Arbitrary = 'arbitrary',
/**
* The stream at this point is Opus audio encoded in an Ogg wrapper.
*/
OggOpus = 'ogg/opus', 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', Opus = 'opus',
/**
* The stream at this point is s16le PCM.
*/
Raw = 'raw', Raw = 'raw',
/**
* The stream at this point is Opus audio encoded in a WebM wrapper.
*/
WebmOpus = 'webm/opus', WebmOpus = 'webm/opus',
} }