mirror of
https://github.com/Palakis/obs-websocket.git
synced 2024-08-30 18:12:16 +00:00
docs(ci): Update generated docs - 2042692
[skip ci]
This commit is contained in:
parent
20426924cd
commit
612a50efbb
@ -1084,26 +1084,6 @@
|
|||||||
}
|
}
|
||||||
]
|
]
|
||||||
},
|
},
|
||||||
{
|
|
||||||
"description": "Broadcasts a `CustomEvent` to all WebSocket clients. Receivers are clients which are identified and subscribed.",
|
|
||||||
"requestType": "BroadcastCustomEvent",
|
|
||||||
"complexity": 1,
|
|
||||||
"rpcVersion": "1",
|
|
||||||
"deprecated": false,
|
|
||||||
"initialVersion": "5.0.0",
|
|
||||||
"category": "general",
|
|
||||||
"requestFields": [
|
|
||||||
{
|
|
||||||
"valueName": "eventData",
|
|
||||||
"valueType": "Object",
|
|
||||||
"valueDescription": "Data payload to emit to all receivers",
|
|
||||||
"valueRestrictions": null,
|
|
||||||
"valueOptional": false,
|
|
||||||
"valueOptionalBehavior": null
|
|
||||||
}
|
|
||||||
],
|
|
||||||
"responseFields": []
|
|
||||||
},
|
|
||||||
{
|
{
|
||||||
"description": "Gets statistics about OBS, obs-websocket, and the current session.",
|
"description": "Gets statistics about OBS, obs-websocket, and the current session.",
|
||||||
"requestType": "GetStats",
|
"requestType": "GetStats",
|
||||||
@ -1171,6 +1151,26 @@
|
|||||||
}
|
}
|
||||||
]
|
]
|
||||||
},
|
},
|
||||||
|
{
|
||||||
|
"description": "Broadcasts a `CustomEvent` to all WebSocket clients. Receivers are clients which are identified and subscribed.",
|
||||||
|
"requestType": "BroadcastCustomEvent",
|
||||||
|
"complexity": 1,
|
||||||
|
"rpcVersion": "1",
|
||||||
|
"deprecated": false,
|
||||||
|
"initialVersion": "5.0.0",
|
||||||
|
"category": "general",
|
||||||
|
"requestFields": [
|
||||||
|
{
|
||||||
|
"valueName": "eventData",
|
||||||
|
"valueType": "Object",
|
||||||
|
"valueDescription": "Data payload to emit to all receivers",
|
||||||
|
"valueRestrictions": null,
|
||||||
|
"valueOptional": false,
|
||||||
|
"valueOptionalBehavior": null
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"responseFields": []
|
||||||
|
},
|
||||||
{
|
{
|
||||||
"description": "Gets an array of all hotkey names in OBS",
|
"description": "Gets an array of all hotkey names in OBS",
|
||||||
"requestType": "GetHotkeyList",
|
"requestType": "GetHotkeyList",
|
||||||
|
@ -1368,8 +1368,8 @@ The profile list has changed.
|
|||||||
### Requests Table of Contents
|
### Requests Table of Contents
|
||||||
- [General](#general-1)
|
- [General](#general-1)
|
||||||
- [GetVersion](#getversion)
|
- [GetVersion](#getversion)
|
||||||
- [BroadcastCustomEvent](#broadcastcustomevent)
|
|
||||||
- [GetStats](#getstats)
|
- [GetStats](#getstats)
|
||||||
|
- [BroadcastCustomEvent](#broadcastcustomevent)
|
||||||
- [GetHotkeyList](#gethotkeylist)
|
- [GetHotkeyList](#gethotkeylist)
|
||||||
- [TriggerHotkeyByName](#triggerhotkeybyname)
|
- [TriggerHotkeyByName](#triggerhotkeybyname)
|
||||||
- [TriggerHotkeyByKeySequence](#triggerhotkeybykeysequence)
|
- [TriggerHotkeyByKeySequence](#triggerhotkeybykeysequence)
|
||||||
@ -1450,23 +1450,6 @@ Gets data about the current plugin and RPC version.
|
|||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
### BroadcastCustomEvent
|
|
||||||
|
|
||||||
Broadcasts a `CustomEvent` to all WebSocket clients. Receivers are clients which are identified and subscribed.
|
|
||||||
|
|
||||||
- Complexity Rating: `1/5`
|
|
||||||
- Latest Supported RPC Version: `1`
|
|
||||||
- Added in v5.0.0
|
|
||||||
|
|
||||||
|
|
||||||
**Request Fields:**
|
|
||||||
|
|
||||||
| Name | Type | Description | Value Restrictions | ?Default Behavior |
|
|
||||||
| ---- | :---: | ----------- | :----------------: | ----------------- |
|
|
||||||
| eventData | Object | Data payload to emit to all receivers | None | N/A |
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
### GetStats
|
### GetStats
|
||||||
|
|
||||||
Gets statistics about OBS, obs-websocket, and the current session.
|
Gets statistics about OBS, obs-websocket, and the current session.
|
||||||
@ -1494,6 +1477,23 @@ Gets statistics about OBS, obs-websocket, and the current session.
|
|||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
|
### BroadcastCustomEvent
|
||||||
|
|
||||||
|
Broadcasts a `CustomEvent` to all WebSocket clients. Receivers are clients which are identified and subscribed.
|
||||||
|
|
||||||
|
- Complexity Rating: `1/5`
|
||||||
|
- Latest Supported RPC Version: `1`
|
||||||
|
- Added in v5.0.0
|
||||||
|
|
||||||
|
|
||||||
|
**Request Fields:**
|
||||||
|
|
||||||
|
| Name | Type | Description | Value Restrictions | ?Default Behavior |
|
||||||
|
| ---- | :---: | ----------- | :----------------: | ----------------- |
|
||||||
|
| eventData | Object | Data payload to emit to all receivers | None | N/A |
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
### GetHotkeyList
|
### GetHotkeyList
|
||||||
|
|
||||||
Gets an array of all hotkey names in OBS
|
Gets an array of all hotkey names in OBS
|
||||||
|
Loading…
Reference in New Issue
Block a user