diff --git a/docs/partials/introduction.md b/docs/partials/introduction.md index 6947ad4e..776fb6da 100644 --- a/docs/partials/introduction.md +++ b/docs/partials/introduction.md @@ -23,60 +23,60 @@ obs-websocket provides a feature-rich RPC communication protocol, giving access - [Events](#events) -## Connecting to obs-websocket {#connecting_to_obs-websocket} +## Connecting to obs-websocket Here's info on how to connect to obs-websocket -### Connection steps {#connecting_steps} +### Connection steps - Step 1 -### Creating an authentication string {#connecting_authentication_string} +### Creating an authentication string - Start by -## Message Types {#message_types} +## Message Types The following message types (`messageType`) are the base message types which may be sent to and from obs-websocket. Sending a message with a `messageType` that is not recognized to the obs-websocket server will result in your connection being closed with `WebsocketCloseCode::UnknownMessageType`. -### Hello {#basemessage_hello} +### Hello - Sent from: obs-websocket - Sent to: Freshly connected websocket client - Description: -### Identify {#basemessage_identify} +### Identify - Sent from: Freshly connected websocket client - Sent to: obs-websocket - Description: -### Identified {#basemessage_event} +### Identified - Sent from: obs-websocket - Sent to: Freshly identified client - Description: -### Reidentify {#basemessage_reidentify} +### Reidentify - Sent from: Identified client - Sent to: obs-websocket - Description: -### Event {#basemessage_event} +### Event - Sent from: obs-websocket - Sent to: All subscribed and identified clients - Description: -### Request {#basemessage_request} +### Request - Sent from: Identified client - Sent to: obs-websocket - Description: -### RequestResponse {#basemessage_requestresponse} +### RequestResponse - Sent from: obs-websocket - Sent to: Identified client which made the request - Description: -### RequestBatch {#basemessage_requestbatch} +### RequestBatch - Sent from: Identified client - Sent to: obs-websocket - Description: -### RequestBatchResponse {#basemessage_requestbatchresponse} +### RequestBatchResponse - Sent from: obs-websocket - Sent to: Identified client which made the request - Description: \ No newline at end of file