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 generated docs - e2f60b0 [skip ci]

Browse Source
This commit is contained in:
Github Actions 2021-12-29 00:58:51 +00:00
parent e2f60b002e
commit 851a6f8c5a
2 changed files with 75 additions and 73 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

74
docs/generated/protocol.json
View File

@ -1323,43 +1323,6 @@
],
"responseFields": []
},
{
"description": "Gets whether studio is enabled.",
"requestType": "GetStudioModeEnabled",
"complexity": 1,
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"category": "general",
"requestFields": [],
"responseFields": [
{
"valueName": "studioModeEnabled",
"valueType": "Boolean",
"valueDescription": "Whether studio mode is enabled"
}
]
},
{
"description": "Enables or disables studio mode",
"requestType": "SetStudioModeEnabled",
"complexity": 1,
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"category": "general",
"requestFields": [
{
"valueName": "studioModeEnabled",
"valueType": "Boolean",
"valueDescription": "True == Enabled, False == Disabled",
"valueRestrictions": null,
"valueOptional": false,
"valueOptionalBehavior": null
}
],
"responseFields": []
},
{
"description": "Sleeps for a time duration or number of frames. Only available in request batches with types `SERIAL_REALTIME` or `SERIAL_FRAME`.",
"requestType": "Sleep",
@ -2843,6 +2806,43 @@
"category": "stream",
"requestFields": [],
"responseFields": []
},
{
"description": "Gets whether studio is enabled.",
"requestType": "GetStudioModeEnabled",
"complexity": 1,
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"category": "ui",
"requestFields": [],
"responseFields": [
{
"valueName": "studioModeEnabled",
"valueType": "Boolean",
"valueDescription": "Whether studio mode is enabled"
}
]
},
{
"description": "Enables or disables studio mode",
"requestType": "SetStudioModeEnabled",
"complexity": 1,
"rpcVersion": "1",
"deprecated": false,
"initialVersion": "5.0.0",
"category": "ui",
"requestFields": [
{
"valueName": "studioModeEnabled",
"valueType": "Boolean",
"valueDescription": "True == Enabled, False == Disabled",
"valueRestrictions": null,
"valueOptional": false,
"valueOptionalBehavior": null
}
],
"responseFields": []
}
],
"events": [

74
docs/generated/protocol.md
View File

@ -1407,8 +1407,6 @@ The profile list has changed.
- [GetHotkeyList](#gethotkeylist)
- [TriggerHotkeyByName](#triggerhotkeybyname)
- [TriggerHotkeyByKeySequence](#triggerhotkeybykeysequence)
- [GetStudioModeEnabled](#getstudiomodeenabled)
- [SetStudioModeEnabled](#setstudiomodeenabled)
- [Sleep](#sleep)
- [Config](#config-1)
- [GetPersistentData](#getpersistentdata)
@ -1479,6 +1477,9 @@ The profile list has changed.
- [ToggleStream](#togglestream)
- [StartStream](#startstream)
- [StopStream](#stopstream)
- [Ui](#ui)
- [GetStudioModeEnabled](#getstudiomodeenabled)
- [SetStudioModeEnabled](#setstudiomodeenabled)
@ -1635,40 +1636,6 @@ Triggers a hotkey using a sequence of keys.
---
### GetStudioModeEnabled
Gets whether studio is enabled.
- Complexity Rating: `1/5`
- Latest Supported RPC Version: `1`
- Added in v5.0.0
**Response Fields:**
| Name | Type | Description |
| ---- | :---: | ----------- |
| studioModeEnabled | Boolean | Whether studio mode is enabled |
---
### SetStudioModeEnabled
Enables or disables studio mode
- Complexity Rating: `1/5`
- Latest Supported RPC Version: `1`
- Added in v5.0.0
**Request Fields:**
| Name | Type | Description | Value Restrictions | ?Default Behavior |
| ---- | :---: | ----------- | :----------------: | ----------------- |
| studioModeEnabled | Boolean | True == Enabled, False == Disabled | None | N/A |
---
### Sleep
Sleeps for a time duration or number of frames. Only available in request batches with types `SERIAL_REALTIME` or `SERIAL_FRAME`.
@ -3069,3 +3036,38 @@ Stops the stream output.
- Added in v5.0.0
## Ui
### GetStudioModeEnabled
Gets whether studio is enabled.
- Complexity Rating: `1/5`
- Latest Supported RPC Version: `1`
- Added in v5.0.0
**Response Fields:**
| Name | Type | Description |
| ---- | :---: | ----------- |
| studioModeEnabled | Boolean | Whether studio mode is enabled |
---
### SetStudioModeEnabled
Enables or disables studio mode
- Complexity Rating: `1/5`
- Latest Supported RPC Version: `1`
- Added in v5.0.0
**Request Fields:**
| Name | Type | Description | Value Restrictions | ?Default Behavior |
| ---- | :---: | ----------- | :----------------: | ----------------- |
| studioModeEnabled | Boolean | True == Enabled, False == Disabled | None | N/A |