Mirrored_Repos/obs-websocket
1
0
Fork 0
mirror of https://github.com/Palakis/obs-websocket.git synced 2024-08-30 18:12:16 +00:00
Code Issues Packages Projects Releases Wiki Activity

Doc update

Browse Source
This commit is contained in:
Stéphane Lepin 2016-11-11 21:23:48 +01:00
parent 4e5f7d1e50
commit 5f7061c586
1 changed files with 12 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
PROTOCOL.md
View File

@ -54,6 +54,18 @@ Recording is stopping but isn't completely stopped yet.
*New in OBS Studio*
Recording has been stopped successfully.
#### "StreamStatus"
Sent every second with those additional fields :
- **streaming** (bool) : streaming state
- **recording** (bool) : recording state
- **preview-only** (bool) : always false.
- **bytes-per-sec** (integer) : during streaming, amount of data (in bytes) transmitted by the stream encoder
- **strain** (double) : i have no idea what this is
- **total-stream-time** (integer) : total time since the beginning of streaming
- **num-total-frames** (integer) : total number of frames transmitted since the beginning
- **num-dropped-frames** (integer) : number of frames dropped by the encoder for the current streaming session
- **fps** (double) : current framerate
#### "Exiting"
*New in OBS Studio*
OBS is exiting.