docs(ci): Update protocol.md - 1c6e8fd [skip ci]

This commit is contained in:
Azure CI 2021-04-26 10:01:25 -07:00
parent 1c6e8fdf86
commit d2e8971245

View File

@ -8,77 +8,77 @@ obs-websocket provides a feature-rich RPC communication protocol, giving access
## Table of Contents
- [Connecting to obs-websocket](#connecting_to_obs-websocket)
- [Connection steps](#connecting_steps)
- [Creating an authentication string](#connecting_authentication_string)
- [Base message types](#message_types)
- [Hello](#basemessage_hello)
- [Identify](#basemessage_identify)
- [Identified](#basemessage_identified)
- [Reidentify](#basemessage_reidentify)
- [Event](#basemessage_event)
- [Request](#basemessage_request)
- [RequestResponse](#basemessage_requestresponse)
- [RequestBatch](#basemessage_requestbatch)
- [RequestBatchResponse](#basemessage_requestbatchresponse)
- [Connecting to obs-websocket](#connecting-to-obs-websocket)
- [Connection steps](#connection-steps)
- [Creating an authentication string](#creating-an-authentication-string)
- [Base message types](#message-types)
- [Hello](#hello)
- [Identify](#identify)
- [Identified](#identified)
- [Reidentify](#reidentify)
- [Event](#event)
- [Request](#request)
- [RequestResponse](#requestresponse)
- [RequestBatch](#requestbatch)
- [RequestBatchResponse](#requestbatchresponse)
- [Requests](#requests)
- [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: