mirror of
https://github.com/Palakis/obs-websocket.git
synced 2024-08-30 18:12:16 +00:00
docs(ci): Update generated docs - e2f60b0 [skip ci]
This commit is contained in:
parent
e2f60b002e
commit
851a6f8c5a
@ -1323,43 +1323,6 @@
|
|||||||
],
|
],
|
||||||
"responseFields": []
|
"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`.",
|
"description": "Sleeps for a time duration or number of frames. Only available in request batches with types `SERIAL_REALTIME` or `SERIAL_FRAME`.",
|
||||||
"requestType": "Sleep",
|
"requestType": "Sleep",
|
||||||
@ -2843,6 +2806,43 @@
|
|||||||
"category": "stream",
|
"category": "stream",
|
||||||
"requestFields": [],
|
"requestFields": [],
|
||||||
"responseFields": []
|
"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": [
|
"events": [
|
||||||
|
@ -1407,8 +1407,6 @@ The profile list has changed.
|
|||||||
- [GetHotkeyList](#gethotkeylist)
|
- [GetHotkeyList](#gethotkeylist)
|
||||||
- [TriggerHotkeyByName](#triggerhotkeybyname)
|
- [TriggerHotkeyByName](#triggerhotkeybyname)
|
||||||
- [TriggerHotkeyByKeySequence](#triggerhotkeybykeysequence)
|
- [TriggerHotkeyByKeySequence](#triggerhotkeybykeysequence)
|
||||||
- [GetStudioModeEnabled](#getstudiomodeenabled)
|
|
||||||
- [SetStudioModeEnabled](#setstudiomodeenabled)
|
|
||||||
- [Sleep](#sleep)
|
- [Sleep](#sleep)
|
||||||
- [Config](#config-1)
|
- [Config](#config-1)
|
||||||
- [GetPersistentData](#getpersistentdata)
|
- [GetPersistentData](#getpersistentdata)
|
||||||
@ -1479,6 +1477,9 @@ The profile list has changed.
|
|||||||
- [ToggleStream](#togglestream)
|
- [ToggleStream](#togglestream)
|
||||||
- [StartStream](#startstream)
|
- [StartStream](#startstream)
|
||||||
- [StopStream](#stopstream)
|
- [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
|
### Sleep
|
||||||
|
|
||||||
Sleeps for a time duration or number of frames. Only available in request batches with types `SERIAL_REALTIME` or `SERIAL_FRAME`.
|
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
|
- 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 |
|
||||||
|
|
||||||
|
|
||||||
|
Loading…
x
Reference in New Issue
Block a user