Skip to content

Commit

Permalink
Document playStream options, specify where to change streamer options
Browse files Browse the repository at this point in the history
  • Loading branch information
longnguyen2004 committed Feb 4, 2025
1 parent 9bb33ba commit b3a3eb3
Showing 1 changed file with 38 additions and 1 deletion.
39 changes: 38 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -176,9 +176,46 @@ h26xPreset?: 'ultrafast' | 'superfast' | 'veryfast' | 'faster' | 'fast' | 'mediu
minimizeLatency?: boolean;
```

## `playStream` options available

```typescript
/**
* Set stream type as "Go Live" or camera stream
*/
type: "go-live" | "camera",

/**
* Override video width sent to Discord.
*
* DO NOT SPECIFY UNLESS YOU KNOW WHAT YOU'RE DOING!
*/
width: number,

/**
* Override video height sent to Discord.
*
* DO NOT SPECIFY UNLESS YOU KNOW WHAT YOU'RE DOING!
*/
height: number,

/**
* Override video frame rate sent to Discord.
*
* DO NOT SPECIFY UNLESS YOU KNOW WHAT YOU'RE DOING!
*/
frameRate: number,

/**
* Same as ffmpeg's `readrate_initial_burst` command line flag
*
* See https://ffmpeg.org/ffmpeg.html#:~:text=%2Dreadrate_initial_burst
*/
readrateInitialBurst: number | undefined,
```

## Streamer options available

These control internal operations of the library, so you probably shouldn't change it without a good reason
These control internal operations of the library, and can be changed through the `opts` property on the `Streamer` class. You probably shouldn't change it without a good reason

```typescript
/**
Expand Down

0 comments on commit b3a3eb3

Please sign in to comment.