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 protocol.md - fcd7d07 [skip ci]

Browse Source
This commit is contained in:
Azure CI 2021-04-26 09:57:24 -07:00
parent fcd7d07001
commit 579cc99fef
2 changed files with 26 additions and 26 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
docs/generated/protocol.md
View File

@ -25,60 +25,60 @@ obs-websocket provides a feature-rich RPC communication protocol, giving access
- [Events](#events) - [Events](#events)
## Connecting to obs-websocket {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 {#connecting_steps}
- Step 1 - Step 1
### Creating an authentication string {connecting_authentication_string} ### Creating an authentication string {#connecting_authentication_string}
- Start by - Start by
## Message Types {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 {#basemessage_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 {#basemessage_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 {#basemessage_event}
- Sent from: obs-websocket - Sent from: obs-websocket
- Sent to: Freshly identified client - Sent to: Freshly identified client
- Description: - Description:
### Reidentify {basemessage_reidentify} ### Reidentify {#basemessage_reidentify}
- Sent from: Identified client - Sent from: Identified client
- Sent to: obs-websocket - Sent to: obs-websocket
- Description: - Description:
### Event {basemessage_event} ### Event {#basemessage_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 {#basemessage_request}
- Sent from: Identified client - Sent from: Identified client
- Sent to: obs-websocket - Sent to: obs-websocket
- Description: - Description:
### RequestResponse {basemessage_requestresponse} ### RequestResponse {#basemessage_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 {#basemessage_requestbatch}
- Sent from: Identified client - Sent from: Identified client
- Sent to: obs-websocket - Sent to: obs-websocket
- Description: - Description:
### RequestBatchResponse {basemessage_requestbatchresponse} ### RequestBatchResponse {#basemessage_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:

26
docs/partials/introduction.md
View File

@ -23,60 +23,60 @@ obs-websocket provides a feature-rich RPC communication protocol, giving access
- [Events](#events) - [Events](#events)
## Connecting to obs-websocket {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 {#connecting_steps}
- Step 1 - Step 1
### Creating an authentication string {connecting_authentication_string} ### Creating an authentication string {#connecting_authentication_string}
- Start by - Start by
## Message Types {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 {#basemessage_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 {#basemessage_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 {#basemessage_event}
- Sent from: obs-websocket - Sent from: obs-websocket
- Sent to: Freshly identified client - Sent to: Freshly identified client
- Description: - Description:
### Reidentify {basemessage_reidentify} ### Reidentify {#basemessage_reidentify}
- Sent from: Identified client - Sent from: Identified client
- Sent to: obs-websocket - Sent to: obs-websocket
- Description: - Description:
### Event {basemessage_event} ### Event {#basemessage_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 {#basemessage_request}
- Sent from: Identified client - Sent from: Identified client
- Sent to: obs-websocket - Sent to: obs-websocket
- Description: - Description:
### RequestResponse {basemessage_requestresponse} ### RequestResponse {#basemessage_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 {#basemessage_requestbatch}
- Sent from: Identified client - Sent from: Identified client
- Sent to: obs-websocket - Sent to: obs-websocket
- Description: - Description:
### RequestBatchResponse {basemessage_requestbatchresponse} ### RequestBatchResponse {#basemessage_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: