mirror of
https://github.com/Palakis/obs-websocket.git
synced 2024-08-30 18:12:16 +00:00
docs(ci): Update protocol.md - 1c6e8fd [skip ci]
This commit is contained in:
parent
1c6e8fdf86
commit
d2e8971245
@ -8,77 +8,77 @@ obs-websocket provides a feature-rich RPC communication protocol, giving access
|
|||||||
|
|
||||||
|
|
||||||
## Table of Contents
|
## Table of Contents
|
||||||
- [Connecting to obs-websocket](#connecting_to_obs-websocket)
|
- [Connecting to obs-websocket](#connecting-to-obs-websocket)
|
||||||
- [Connection steps](#connecting_steps)
|
- [Connection steps](#connection-steps)
|
||||||
- [Creating an authentication string](#connecting_authentication_string)
|
- [Creating an authentication string](#creating-an-authentication-string)
|
||||||
- [Base message types](#message_types)
|
- [Base message types](#message-types)
|
||||||
- [Hello](#basemessage_hello)
|
- [Hello](#hello)
|
||||||
- [Identify](#basemessage_identify)
|
- [Identify](#identify)
|
||||||
- [Identified](#basemessage_identified)
|
- [Identified](#identified)
|
||||||
- [Reidentify](#basemessage_reidentify)
|
- [Reidentify](#reidentify)
|
||||||
- [Event](#basemessage_event)
|
- [Event](#event)
|
||||||
- [Request](#basemessage_request)
|
- [Request](#request)
|
||||||
- [RequestResponse](#basemessage_requestresponse)
|
- [RequestResponse](#requestresponse)
|
||||||
- [RequestBatch](#basemessage_requestbatch)
|
- [RequestBatch](#requestbatch)
|
||||||
- [RequestBatchResponse](#basemessage_requestbatchresponse)
|
- [RequestBatchResponse](#requestbatchresponse)
|
||||||
- [Requests](#requests)
|
- [Requests](#requests)
|
||||||
- [Events](#events)
|
- [Events](#events)
|
||||||
|
|
||||||
|
|
||||||
## Connecting to obs-websocket {#connecting_to_obs-websocket}
|
## Connecting to obs-websocket
|
||||||
Here's info on how to connect to obs-websocket
|
Here's info on how to connect to obs-websocket
|
||||||
|
|
||||||
### Connection steps {#connecting_steps}
|
### Connection steps
|
||||||
- Step 1
|
- Step 1
|
||||||
|
|
||||||
### Creating an authentication string {#connecting_authentication_string}
|
### Creating an authentication string
|
||||||
- Start by
|
- 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`.
|
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 from: obs-websocket
|
||||||
- Sent to: Freshly connected websocket client
|
- Sent to: Freshly connected websocket client
|
||||||
- Description:
|
- Description:
|
||||||
|
|
||||||
### Identify {#basemessage_identify}
|
### Identify
|
||||||
- Sent from: Freshly connected websocket client
|
- Sent from: Freshly connected websocket client
|
||||||
- Sent to: obs-websocket
|
- Sent to: obs-websocket
|
||||||
- Description:
|
- Description:
|
||||||
|
|
||||||
### Identified {#basemessage_event}
|
### Identified
|
||||||
- Sent from: obs-websocket
|
- Sent from: obs-websocket
|
||||||
- Sent to: Freshly identified client
|
- Sent to: Freshly identified client
|
||||||
- Description:
|
- Description:
|
||||||
|
|
||||||
### Reidentify {#basemessage_reidentify}
|
### Reidentify
|
||||||
- Sent from: Identified client
|
- Sent from: Identified client
|
||||||
- Sent to: obs-websocket
|
- Sent to: obs-websocket
|
||||||
- Description:
|
- Description:
|
||||||
|
|
||||||
### Event {#basemessage_event}
|
### Event
|
||||||
- Sent from: obs-websocket
|
- Sent from: obs-websocket
|
||||||
- Sent to: All subscribed and identified clients
|
- Sent to: All subscribed and identified clients
|
||||||
- Description:
|
- Description:
|
||||||
|
|
||||||
### Request {#basemessage_request}
|
### Request
|
||||||
- Sent from: Identified client
|
- Sent from: Identified client
|
||||||
- Sent to: obs-websocket
|
- Sent to: obs-websocket
|
||||||
- Description:
|
- Description:
|
||||||
|
|
||||||
### RequestResponse {#basemessage_requestresponse}
|
### RequestResponse
|
||||||
- Sent from: obs-websocket
|
- Sent from: obs-websocket
|
||||||
- Sent to: Identified client which made the request
|
- Sent to: Identified client which made the request
|
||||||
- Description:
|
- Description:
|
||||||
|
|
||||||
### RequestBatch {#basemessage_requestbatch}
|
### RequestBatch
|
||||||
- Sent from: Identified client
|
- Sent from: Identified client
|
||||||
- Sent to: obs-websocket
|
- Sent to: obs-websocket
|
||||||
- Description:
|
- Description:
|
||||||
|
|
||||||
### RequestBatchResponse {#basemessage_requestbatchresponse}
|
### RequestBatchResponse
|
||||||
- Sent from: obs-websocket
|
- Sent from: obs-websocket
|
||||||
- Sent to: Identified client which made the request
|
- Sent to: Identified client which made the request
|
||||||
- Description:
|
- Description:
|
||||||
|
Loading…
x
Reference in New Issue
Block a user