mirror of
https://github.com/Palakis/obs-websocket.git
synced 2024-08-30 18:12:16 +00:00
docs(ci): Update generated docs - 1dd57f6 [skip ci]
This commit is contained in:
Github Actions
parent
1dd57f6140
commit
ab743c2ee6
@ -2768,6 +2768,198 @@
|
|||||||
}
|
}
|
||||||
]
|
]
|
||||||
},
|
},
|
||||||
|
{
|
||||||
|
"description": "Gets the list of available outputs.",
|
||||||
|
"requestType": "GetOutputList",
|
||||||
|
"complexity": 4,
|
||||||
|
"rpcVersion": "1",
|
||||||
|
"deprecated": false,
|
||||||
|
"initialVersion": "5.0.0",
|
||||||
|
"category": "outputs",
|
||||||
|
"requestFields": [],
|
||||||
|
"responseFields": []
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"description": "Gets the status of an output.",
|
||||||
|
"requestType": "GetOutputStatus",
|
||||||
|
"complexity": 4,
|
||||||
|
"rpcVersion": "1",
|
||||||
|
"deprecated": false,
|
||||||
|
"initialVersion": "5.0.0",
|
||||||
|
"category": "outputs",
|
||||||
|
"requestFields": [
|
||||||
|
{
|
||||||
|
"valueName": "outputName",
|
||||||
|
"valueType": "String",
|
||||||
|
"valueDescription": "Output name",
|
||||||
|
"valueRestrictions": null,
|
||||||
|
"valueOptional": false,
|
||||||
|
"valueOptionalBehavior": null
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"responseFields": [
|
||||||
|
{
|
||||||
|
"valueName": "outputActive",
|
||||||
|
"valueType": "Boolean",
|
||||||
|
"valueDescription": "Whether the output is active"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"valueName": "outputReconnecting",
|
||||||
|
"valueType": "Boolean",
|
||||||
|
"valueDescription": "Whether the output is reconnecting"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"valueName": "outputTimecode",
|
||||||
|
"valueType": "String",
|
||||||
|
"valueDescription": "Current formatted timecode string for the output"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"valueName": "outputDuration",
|
||||||
|
"valueType": "Number",
|
||||||
|
"valueDescription": "Current duration in milliseconds for the output"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"valueName": "outputCongestion",
|
||||||
|
"valueType": "Number",
|
||||||
|
"valueDescription": "Congestion of the output"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"valueName": "outputBytes",
|
||||||
|
"valueType": "Number",
|
||||||
|
"valueDescription": "Number of bytes sent by the output"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"valueName": "outputSkippedFrames",
|
||||||
|
"valueType": "Number",
|
||||||
|
"valueDescription": "Number of frames skipped by the output's process"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"valueName": "outputTotalFrames",
|
||||||
|
"valueType": "Number",
|
||||||
|
"valueDescription": "Total number of frames delivered by the output's process"
|
||||||
|
}
|
||||||
|
]
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"description": "Toggles the status of an output.",
|
||||||
|
"requestType": "ToggleOutput",
|
||||||
|
"complexity": 4,
|
||||||
|
"rpcVersion": "1",
|
||||||
|
"deprecated": false,
|
||||||
|
"initialVersion": "5.0.0",
|
||||||
|
"category": "outputs",
|
||||||
|
"requestFields": [
|
||||||
|
{
|
||||||
|
"valueName": "outputName",
|
||||||
|
"valueType": "String",
|
||||||
|
"valueDescription": "Output name",
|
||||||
|
"valueRestrictions": null,
|
||||||
|
"valueOptional": false,
|
||||||
|
"valueOptionalBehavior": null
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"responseFields": [
|
||||||
|
{
|
||||||
|
"valueName": "outputActive",
|
||||||
|
"valueType": "Boolean",
|
||||||
|
"valueDescription": "Whether the output is active"
|
||||||
|
}
|
||||||
|
]
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"description": "Starts an output.",
|
||||||
|
"requestType": "StartOutput",
|
||||||
|
"complexity": 4,
|
||||||
|
"rpcVersion": "1",
|
||||||
|
"deprecated": false,
|
||||||
|
"initialVersion": "5.0.0",
|
||||||
|
"category": "outputs",
|
||||||
|
"requestFields": [
|
||||||
|
{
|
||||||
|
"valueName": "outputName",
|
||||||
|
"valueType": "String",
|
||||||
|
"valueDescription": "Output name",
|
||||||
|
"valueRestrictions": null,
|
||||||
|
"valueOptional": false,
|
||||||
|
"valueOptionalBehavior": null
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"responseFields": []
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"description": "Stops an output.",
|
||||||
|
"requestType": "StopOutput",
|
||||||
|
"complexity": 4,
|
||||||
|
"rpcVersion": "1",
|
||||||
|
"deprecated": false,
|
||||||
|
"initialVersion": "5.0.0",
|
||||||
|
"category": "outputs",
|
||||||
|
"requestFields": [
|
||||||
|
{
|
||||||
|
"valueName": "outputName",
|
||||||
|
"valueType": "String",
|
||||||
|
"valueDescription": "Output name",
|
||||||
|
"valueRestrictions": null,
|
||||||
|
"valueOptional": false,
|
||||||
|
"valueOptionalBehavior": null
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"responseFields": []
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"description": "Gets the settings of an output.",
|
||||||
|
"requestType": "GetOutputSettings",
|
||||||
|
"complexity": 4,
|
||||||
|
"rpcVersion": "1",
|
||||||
|
"deprecated": false,
|
||||||
|
"initialVersion": "5.0.0",
|
||||||
|
"category": "outputs",
|
||||||
|
"requestFields": [
|
||||||
|
{
|
||||||
|
"valueName": "outputName",
|
||||||
|
"valueType": "String",
|
||||||
|
"valueDescription": "Output name",
|
||||||
|
"valueRestrictions": null,
|
||||||
|
"valueOptional": false,
|
||||||
|
"valueOptionalBehavior": null
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"responseFields": [
|
||||||
|
{
|
||||||
|
"valueName": "outputSettings",
|
||||||
|
"valueType": "Object",
|
||||||
|
"valueDescription": "Output settings"
|
||||||
|
}
|
||||||
|
]
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"description": "Sets the settings of an output.",
|
||||||
|
"requestType": "SetOutputSettings",
|
||||||
|
"complexity": 4,
|
||||||
|
"rpcVersion": "1",
|
||||||
|
"deprecated": false,
|
||||||
|
"initialVersion": "5.0.0",
|
||||||
|
"category": "outputs",
|
||||||
|
"requestFields": [
|
||||||
|
{
|
||||||
|
"valueName": "outputName",
|
||||||
|
"valueType": "String",
|
||||||
|
"valueDescription": "Output name",
|
||||||
|
"valueRestrictions": null,
|
||||||
|
"valueOptional": false,
|
||||||
|
"valueOptionalBehavior": null
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"valueName": "outputSettings",
|
||||||
|
"valueType": "Object",
|
||||||
|
"valueDescription": "Output settings",
|
||||||
|
"valueRestrictions": null,
|
||||||
|
"valueOptional": false,
|
||||||
|
"valueOptionalBehavior": null
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"responseFields": []
|
||||||
|
},
|
||||||
{
|
{
|
||||||
"description": "Gets the status of the record output.",
|
"description": "Gets the status of the record output.",
|
||||||
"requestType": "GetRecordStatus",
|
"requestType": "GetRecordStatus",
|
||||||
@ -3871,6 +4063,11 @@
|
|||||||
"valueType": "Number",
|
"valueType": "Number",
|
||||||
"valueDescription": "Current duration in milliseconds for the output"
|
"valueDescription": "Current duration in milliseconds for the output"
|
||||||
},
|
},
|
||||||
|
{
|
||||||
|
"valueName": "outputCongestion",
|
||||||
|
"valueType": "Number",
|
||||||
|
"valueDescription": "Congestion of the output"
|
||||||
|
},
|
||||||
{
|
{
|
||||||
"valueName": "outputBytes",
|
"valueName": "outputBytes",
|
||||||
"valueType": "Number",
|
"valueType": "Number",
|
||||||
|
|||||||
@ -2383,6 +2383,13 @@ Studio mode has been enabled or disabled.
|
|||||||
- [StopReplayBuffer](#stopreplaybuffer)
|
- [StopReplayBuffer](#stopreplaybuffer)
|
||||||
- [SaveReplayBuffer](#savereplaybuffer)
|
- [SaveReplayBuffer](#savereplaybuffer)
|
||||||
- [GetLastReplayBufferReplay](#getlastreplaybufferreplay)
|
- [GetLastReplayBufferReplay](#getlastreplaybufferreplay)
|
||||||
|
- [GetOutputList](#getoutputlist)
|
||||||
|
- [GetOutputStatus](#getoutputstatus)
|
||||||
|
- [ToggleOutput](#toggleoutput)
|
||||||
|
- [StartOutput](#startoutput)
|
||||||
|
- [StopOutput](#stopoutput)
|
||||||
|
- [GetOutputSettings](#getoutputsettings)
|
||||||
|
- [SetOutputSettings](#setoutputsettings)
|
||||||
- [Stream Requests](#stream-requests)
|
- [Stream Requests](#stream-requests)
|
||||||
- [GetStreamStatus](#getstreamstatus)
|
- [GetStreamStatus](#getstreamstatus)
|
||||||
- [ToggleStream](#togglestream)
|
- [ToggleStream](#togglestream)
|
||||||
@ -4487,6 +4494,138 @@ Gets the filename of the last replay buffer save file.
|
|||||||
| ---- | :---: | ----------- |
|
| ---- | :---: | ----------- |
|
||||||
| savedReplayPath | String | File path |
|
| savedReplayPath | String | File path |
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### GetOutputList
|
||||||
|
|
||||||
|
Gets the list of available outputs.
|
||||||
|
|
||||||
|
- Complexity Rating: `4/5`
|
||||||
|
- Latest Supported RPC Version: `1`
|
||||||
|
- Added in v5.0.0
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### GetOutputStatus
|
||||||
|
|
||||||
|
Gets the status of an output.
|
||||||
|
|
||||||
|
- Complexity Rating: `4/5`
|
||||||
|
- Latest Supported RPC Version: `1`
|
||||||
|
- Added in v5.0.0
|
||||||
|
|
||||||
|
**Request Fields:**
|
||||||
|
|
||||||
|
| Name | Type | Description | Value Restrictions | ?Default Behavior |
|
||||||
|
| ---- | :---: | ----------- | :----------------: | ----------------- |
|
||||||
|
| outputName | String | Output name | None | N/A |
|
||||||
|
|
||||||
|
**Response Fields:**
|
||||||
|
|
||||||
|
| Name | Type | Description |
|
||||||
|
| ---- | :---: | ----------- |
|
||||||
|
| outputActive | Boolean | Whether the output is active |
|
||||||
|
| outputReconnecting | Boolean | Whether the output is reconnecting |
|
||||||
|
| outputTimecode | String | Current formatted timecode string for the output |
|
||||||
|
| outputDuration | Number | Current duration in milliseconds for the output |
|
||||||
|
| outputCongestion | Number | Congestion of the output |
|
||||||
|
| outputBytes | Number | Number of bytes sent by the output |
|
||||||
|
| outputSkippedFrames | Number | Number of frames skipped by the output's process |
|
||||||
|
| outputTotalFrames | Number | Total number of frames delivered by the output's process |
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### ToggleOutput
|
||||||
|
|
||||||
|
Toggles the status of an output.
|
||||||
|
|
||||||
|
- Complexity Rating: `4/5`
|
||||||
|
- Latest Supported RPC Version: `1`
|
||||||
|
- Added in v5.0.0
|
||||||
|
|
||||||
|
**Request Fields:**
|
||||||
|
|
||||||
|
| Name | Type | Description | Value Restrictions | ?Default Behavior |
|
||||||
|
| ---- | :---: | ----------- | :----------------: | ----------------- |
|
||||||
|
| outputName | String | Output name | None | N/A |
|
||||||
|
|
||||||
|
**Response Fields:**
|
||||||
|
|
||||||
|
| Name | Type | Description |
|
||||||
|
| ---- | :---: | ----------- |
|
||||||
|
| outputActive | Boolean | Whether the output is active |
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### StartOutput
|
||||||
|
|
||||||
|
Starts an output.
|
||||||
|
|
||||||
|
- Complexity Rating: `4/5`
|
||||||
|
- Latest Supported RPC Version: `1`
|
||||||
|
- Added in v5.0.0
|
||||||
|
|
||||||
|
**Request Fields:**
|
||||||
|
|
||||||
|
| Name | Type | Description | Value Restrictions | ?Default Behavior |
|
||||||
|
| ---- | :---: | ----------- | :----------------: | ----------------- |
|
||||||
|
| outputName | String | Output name | None | N/A |
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### StopOutput
|
||||||
|
|
||||||
|
Stops an output.
|
||||||
|
|
||||||
|
- Complexity Rating: `4/5`
|
||||||
|
- Latest Supported RPC Version: `1`
|
||||||
|
- Added in v5.0.0
|
||||||
|
|
||||||
|
**Request Fields:**
|
||||||
|
|
||||||
|
| Name | Type | Description | Value Restrictions | ?Default Behavior |
|
||||||
|
| ---- | :---: | ----------- | :----------------: | ----------------- |
|
||||||
|
| outputName | String | Output name | None | N/A |
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### GetOutputSettings
|
||||||
|
|
||||||
|
Gets the settings of an output.
|
||||||
|
|
||||||
|
- Complexity Rating: `4/5`
|
||||||
|
- Latest Supported RPC Version: `1`
|
||||||
|
- Added in v5.0.0
|
||||||
|
|
||||||
|
**Request Fields:**
|
||||||
|
|
||||||
|
| Name | Type | Description | Value Restrictions | ?Default Behavior |
|
||||||
|
| ---- | :---: | ----------- | :----------------: | ----------------- |
|
||||||
|
| outputName | String | Output name | None | N/A |
|
||||||
|
|
||||||
|
**Response Fields:**
|
||||||
|
|
||||||
|
| Name | Type | Description |
|
||||||
|
| ---- | :---: | ----------- |
|
||||||
|
| outputSettings | Object | Output settings |
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### SetOutputSettings
|
||||||
|
|
||||||
|
Sets the settings of an output.
|
||||||
|
|
||||||
|
- Complexity Rating: `4/5`
|
||||||
|
- Latest Supported RPC Version: `1`
|
||||||
|
- Added in v5.0.0
|
||||||
|
|
||||||
|
**Request Fields:**
|
||||||
|
|
||||||
|
| Name | Type | Description | Value Restrictions | ?Default Behavior |
|
||||||
|
| ---- | :---: | ----------- | :----------------: | ----------------- |
|
||||||
|
| outputName | String | Output name | None | N/A |
|
||||||
|
| outputSettings | Object | Output settings | None | N/A |
|
||||||
|
|
||||||
## Stream Requests
|
## Stream Requests
|
||||||
|
|
||||||
### GetStreamStatus
|
### GetStreamStatus
|
||||||
@ -4505,6 +4644,7 @@ Gets the status of the stream output.
|
|||||||
| outputReconnecting | Boolean | Whether the output is currently reconnecting |
|
| outputReconnecting | Boolean | Whether the output is currently reconnecting |
|
||||||
| outputTimecode | String | Current formatted timecode string for the output |
|
| outputTimecode | String | Current formatted timecode string for the output |
|
||||||
| outputDuration | Number | Current duration in milliseconds for the output |
|
| outputDuration | Number | Current duration in milliseconds for the output |
|
||||||
|
| outputCongestion | Number | Congestion of the output |
|
||||||
| outputBytes | Number | Number of bytes sent by the output |
|
| outputBytes | Number | Number of bytes sent by the output |
|
||||||
| outputSkippedFrames | Number | Number of frames skipped by the output's process |
|
| outputSkippedFrames | Number | Number of frames skipped by the output's process |
|
||||||
| outputTotalFrames | Number | Total number of frames delivered by the output's process |
|
| outputTotalFrames | Number | Total number of frames delivered by the output's process |
|
||||||
|
|||||||
Loading…
Reference in New Issue
Block a user