docs: Add separators

This commit is contained in:
tt2468 2021-04-26 18:42:08 -07:00
parent 10fdb8a4f0
commit 41306511c9

View File

@ -69,6 +69,8 @@ These steps should be followed precisely. Failure to connect to the server as in
- If the server's version is newer than the client's, the client sends its highest supported version in its `Identify` in hopes that the server is backwards compatible to that version.
- If the `Hello` does not contain an `authentication` object, the resulting `Identify` object sent to the server does not need to have an `authentication` string.
---
### Creating an authentication string
obs-websocket uses SHA256 to transmit authentication credentials. The server starts by sending an object in the `authentication` field of its `Hello`. The client processes the authentication challenge and responds via the `authentication` string in `Identify`.
@ -90,6 +92,8 @@ To generate the authentication string, follow these steps:
For more info on how to create the `authentication` string, refer to the obs-websocket client libraries listed on the [README](README.md).
---
### Status and Close Codes
These are the enumeration definitions for various codes used by obs-websocket.
@ -290,6 +294,8 @@ Authentication is not required
}
```
---
### Identify
- Sent from: Freshly connected websocket client
- Sent to: obs-websocket
@ -323,6 +329,8 @@ Authentication is not required
}
```
---
### Identified
- Sent from: obs-websocket
- Sent to: Freshly identified client
@ -344,6 +352,8 @@ Authentication is not required
}
```
---
### Reidentify
- Sent from: Identified client
- Sent to: obs-websocket
@ -360,6 +370,8 @@ Authentication is not required
```
- Only the listed parameters may be changed by `Reidentify` after initial identification. To change a parameter not listed, you must reconnect to the obs-websocket server.
---
### Event
- Sent from: obs-websocket
- Sent to: All subscribed and identified clients
@ -373,6 +385,8 @@ Authentication is not required
}
```
---
### Request
- Sent from: Identified client
- Sent to: obs-websocket
@ -400,6 +414,8 @@ Authentication is not required
}
```
---
### RequestResponse
- Sent from: obs-websocket
- Sent to: Identified client which made the request
@ -456,11 +472,15 @@ Failure Response
}
```
---
### RequestBatch
- Sent from: Identified client
- Sent to: obs-websocket
- Description:
---
### RequestBatchResponse
- Sent from: obs-websocket
- Sent to: Identified client which made the request