obs-websocket/docs/partials/introduction.md

# obs-websocket 5.0.0 protocol reference


## General Introduction
obs-websocket provides a feature-rich RPC communication protocol, giving access to much of OBS's feature set. This document contains everything you should know in order to make a connection and use obs-websocket's functionality to the fullest.


## 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)
- [Requests](#requests)
- [Events](#events)


## Connecting to obs-websocket
Here's info on how to connect to obs-websocket

### Connection steps
- Step 1

### Creating an authentication string
- Start by


## 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
- Sent from: obs-websocket
- Sent to: Freshly connected websocket client
- Description:

### Identify
- Sent from: Freshly connected websocket client
- Sent to: obs-websocket
- Description: 

### Identified
- Sent from: obs-websocket
- Sent to: Freshly identified client
- Description: 

### Reidentify
- Sent from: Identified client
- Sent to: obs-websocket
- Description:

### Event
- Sent from: obs-websocket
- Sent to: All subscribed and identified clients
- Description: 

### Request
- Sent from: Identified client
- Sent to: obs-websocket
- Description: 

### RequestResponse
- Sent from: obs-websocket
- Sent to: Identified client which made the request
- Description: 

### RequestBatch
- Sent from: Identified client
- Sent to: obs-websocket
- Description: 

### RequestBatchResponse
- Sent from: obs-websocket
- Sent to: Identified client which made the request
- Description:
docs: Lots of changes 2021-04-26 16:55:50 +00:00			`# obs-websocket 5.0.0 protocol reference`
Initial commit for attempted rewrite 2021-03-08 11:56:43 +00:00

docs: Lots of changes 2021-04-26 16:55:50 +00:00			`## General Introduction`
			`obs-websocket provides a feature-rich RPC communication protocol, giving access to much of OBS's feature set. This document contains everything you should know in order to make a connection and use obs-websocket's functionality to the fullest.`
Initial commit for attempted rewrite 2021-03-08 11:56:43 +00:00

docs: Lots of changes 2021-04-26 16:55:50 +00:00			`## 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)`
			`- [Requests](#requests)`
			`- [Events](#events)`
Initial commit for attempted rewrite 2021-03-08 11:56:43 +00:00

docs: Apparently github doesnt support custom header ids 2021-04-26 16:59:26 +00:00			`## Connecting to obs-websocket`
docs: Lots of changes 2021-04-26 16:55:50 +00:00			`Here's info on how to connect to obs-websocket`
Initial commit for attempted rewrite 2021-03-08 11:56:43 +00:00
docs: Apparently github doesnt support custom header ids 2021-04-26 16:59:26 +00:00			`### Connection steps`
docs: Lots of changes 2021-04-26 16:55:50 +00:00			`- Step 1`
Initial commit for attempted rewrite 2021-03-08 11:56:43 +00:00
docs: Apparently github doesnt support custom header ids 2021-04-26 16:59:26 +00:00			`### Creating an authentication string`
docs: Lots of changes 2021-04-26 16:55:50 +00:00			`- Start by`
Initial commit for attempted rewrite 2021-03-08 11:56:43 +00:00
docs: Lots of changes 2021-04-26 16:55:50 +00:00
docs: Apparently github doesnt support custom header ids 2021-04-26 16:59:26 +00:00			`## Message Types`
docs: Lots of changes 2021-04-26 16:55:50 +00:00			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`.

docs: Apparently github doesnt support custom header ids 2021-04-26 16:59:26 +00:00			`### Hello`
docs: Lots of changes 2021-04-26 16:55:50 +00:00			`- Sent from: obs-websocket`
			`- Sent to: Freshly connected websocket client`
			`- Description:`

docs: Apparently github doesnt support custom header ids 2021-04-26 16:59:26 +00:00			`### Identify`
docs: Lots of changes 2021-04-26 16:55:50 +00:00			`- Sent from: Freshly connected websocket client`
			`- Sent to: obs-websocket`
			`- Description:`

docs: Apparently github doesnt support custom header ids 2021-04-26 16:59:26 +00:00			`### Identified`
docs: Lots of changes 2021-04-26 16:55:50 +00:00			`- Sent from: obs-websocket`
			`- Sent to: Freshly identified client`
			`- Description:`

docs: Apparently github doesnt support custom header ids 2021-04-26 16:59:26 +00:00			`### Reidentify`
docs: Lots of changes 2021-04-26 16:55:50 +00:00			`- Sent from: Identified client`
			`- Sent to: obs-websocket`
			`- Description:`

docs: Apparently github doesnt support custom header ids 2021-04-26 16:59:26 +00:00			`### Event`
docs: Lots of changes 2021-04-26 16:55:50 +00:00			`- Sent from: obs-websocket`
			`- Sent to: All subscribed and identified clients`
			`- Description:`

docs: Apparently github doesnt support custom header ids 2021-04-26 16:59:26 +00:00			`### Request`
docs: Lots of changes 2021-04-26 16:55:50 +00:00			`- Sent from: Identified client`
			`- Sent to: obs-websocket`
			`- Description:`

docs: Apparently github doesnt support custom header ids 2021-04-26 16:59:26 +00:00			`### RequestResponse`
docs: Lots of changes 2021-04-26 16:55:50 +00:00			`- Sent from: obs-websocket`
			`- Sent to: Identified client which made the request`
			`- Description:`

docs: Apparently github doesnt support custom header ids 2021-04-26 16:59:26 +00:00			`### RequestBatch`
docs: Lots of changes 2021-04-26 16:55:50 +00:00			`- Sent from: Identified client`
			`- Sent to: obs-websocket`
			`- Description:`

docs: Apparently github doesnt support custom header ids 2021-04-26 16:59:26 +00:00			`### RequestBatchResponse`
docs: Lots of changes 2021-04-26 16:55:50 +00:00			`- Sent from: obs-websocket`
			`- Sent to: Identified client which made the request`
			`- Description:`