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

docs(ci): Update generated docs - 0f6ee87 [skip ci]

Browse Source
This commit is contained in:
Github Actions
2021-12-15 10:42:02 +00:00
parent 0f6ee87f99
commit 24cd95bca7
1 changed files with 0 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
docs/generated/protocol.md
View File

@ -164,12 +164,10 @@ Authentication is not required
{
"rpcVersion": number,
"authentication": string(optional),
"ignoreInvalidMessages": bool(optional) = false,
"eventSubscriptions": number(optional) = (EventSubscription::All)
}
```
- `rpcVersion` is the version number that the client would like the obs-websocket server to use.
- When `ignoreInvalidMessages` is true, the socket will not be closed for `WebSocketCloseCode`: `MessageDecodeError`, `UnknownOpCode`, or `MissingDataKey`. Instead, the message will be logged and ignored.
- `eventSubscriptions` is a bitmask of `EventSubscriptions` items to subscribe to events and event categories at will. By default, all event categories are subscribed, except for events marked as high volume. High volume events must be explicitly subscribed to.
**Example Message:**
@ -219,7 +217,6 @@ Authentication is not required
**Data Keys:**
```
{
"ignoreInvalidMessages": bool(optional) = false,
"eventSubscriptions": number(optional) = (EventSubscription::All)
}
```