mirror of
https://github.com/Palakis/obs-websocket.git
synced 2024-08-30 18:12:16 +00:00
docs(ci): Update generated docs - 7b52d7e [skip ci]
This commit is contained in:
Github Actions
parent
7b52d7e015
commit
0b294734a2
@ -1129,6 +1129,23 @@
|
||||
],
|
||||
"responseFields": []
|
||||
},
|
||||
{
|
||||
"description": "Gets the current directory that the record output is set to.",
|
||||
"requestType": "GetRecordDirectory",
|
||||
"complexity": 1,
|
||||
"rpcVersion": "1",
|
||||
"deprecated": false,
|
||||
"initialVersion": "5.0.0",
|
||||
"category": "rconfig",
|
||||
"requestFields": [],
|
||||
"responseFields": [
|
||||
{
|
||||
"valueName": "recordDirectory",
|
||||
"valueType": "String",
|
||||
"valueDescription": "Output directory"
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"description": "Gets the info for a specific source filter.",
|
||||
"requestType": "GetSourceFilter",
|
||||
@ -2550,23 +2567,6 @@
|
||||
"requestFields": [],
|
||||
"responseFields": []
|
||||
},
|
||||
{
|
||||
"description": "Gets the current directory that the record output is set to.",
|
||||
"requestType": "GetRecordDirectory",
|
||||
"complexity": 1,
|
||||
"rpcVersion": "1",
|
||||
"deprecated": false,
|
||||
"initialVersion": "5.0.0",
|
||||
"category": "record",
|
||||
"requestFields": [],
|
||||
"responseFields": [
|
||||
{
|
||||
"valueName": "recordDirectory",
|
||||
"valueType": "String",
|
||||
"valueDescription": "Output directory"
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"description": "Gets a list of all scene items in a scene.\n\nScenes only",
|
||||
"requestType": "GetSceneItemList",
|
||||
@ -3301,6 +3301,73 @@
|
||||
],
|
||||
"responseFields": []
|
||||
},
|
||||
{
|
||||
"description": "Gets the scene transition overridden for a scene.",
|
||||
"requestType": "GetSceneSceneTransitionOverride",
|
||||
"complexity": 2,
|
||||
"rpcVersion": "1",
|
||||
"deprecated": false,
|
||||
"initialVersion": "5.0.0",
|
||||
"category": "scenes",
|
||||
"requestFields": [
|
||||
{
|
||||
"valueName": "sceneName",
|
||||
"valueType": "String",
|
||||
"valueDescription": "Name of the scene",
|
||||
"valueRestrictions": null,
|
||||
"valueOptional": false,
|
||||
"valueOptionalBehavior": null
|
||||
}
|
||||
],
|
||||
"responseFields": [
|
||||
{
|
||||
"valueName": "transitionName",
|
||||
"valueType": "String",
|
||||
"valueDescription": "Name of the overridden scene transition, else `null`"
|
||||
},
|
||||
{
|
||||
"valueName": "transitionDuration",
|
||||
"valueType": "Number",
|
||||
"valueDescription": "Duration of the overridden scene transition, else `null`"
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"description": "Gets the scene transition overridden for a scene.",
|
||||
"requestType": "SetSceneSceneTransitionOverride",
|
||||
"complexity": 2,
|
||||
"rpcVersion": "1",
|
||||
"deprecated": false,
|
||||
"initialVersion": "5.0.0",
|
||||
"category": "scenes",
|
||||
"requestFields": [
|
||||
{
|
||||
"valueName": "sceneName",
|
||||
"valueType": "String",
|
||||
"valueDescription": "Name of the scene",
|
||||
"valueRestrictions": null,
|
||||
"valueOptional": false,
|
||||
"valueOptionalBehavior": null
|
||||
},
|
||||
{
|
||||
"valueName": "transitionName",
|
||||
"valueType": "String",
|
||||
"valueDescription": "Name of the scene transition to use as override. Specify `null` to remove",
|
||||
"valueRestrictions": null,
|
||||
"valueOptional": true,
|
||||
"valueOptionalBehavior": "Unchanged"
|
||||
},
|
||||
{
|
||||
"valueName": "transitionDuration",
|
||||
"valueType": "Number",
|
||||
"valueDescription": "Duration to use for any overridden transition. Specify `null` to remove",
|
||||
"valueRestrictions": ">= 50, <= 20000",
|
||||
"valueOptional": true,
|
||||
"valueOptionalBehavior": "Unchanged"
|
||||
}
|
||||
],
|
||||
"responseFields": []
|
||||
},
|
||||
{
|
||||
"description": "Gets the active and show state of a source.\n\n**Compatible with inputs and scenes.**",
|
||||
"requestType": "GetSourceActive",
|
||||
@ -3716,6 +3783,23 @@
|
||||
],
|
||||
"responseFields": []
|
||||
},
|
||||
{
|
||||
"description": "Gets the cursor position of the current scene transition.\n\nNote: `transitionCursor` will return 1.0 when the transition is inactive.",
|
||||
"requestType": "GetCurrentSceneTransitionCursor",
|
||||
"complexity": 2,
|
||||
"rpcVersion": "1",
|
||||
"deprecated": false,
|
||||
"initialVersion": "5.0.0",
|
||||
"category": "transitions",
|
||||
"requestFields": [],
|
||||
"responseFields": [
|
||||
{
|
||||
"valueName": "transitionCursor",
|
||||
"valueType": "Number",
|
||||
"valueDescription": "Cursor position, between 0.0 and 1.0"
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"description": "Triggers the current scene transition. Same functionality as the `Transition` button in studio mode.",
|
||||
"requestType": "TriggerStudioModeTransition",
|
||||
@ -3727,6 +3811,34 @@
|
||||
"requestFields": [],
|
||||
"responseFields": []
|
||||
},
|
||||
{
|
||||
"description": "Sets the position of the TBar.\n\n**Very important note**: This will be deprecated and replaced in a future version of obs-websocket.",
|
||||
"requestType": "SetTBarPosition",
|
||||
"complexity": 3,
|
||||
"rpcVersion": "1",
|
||||
"deprecated": false,
|
||||
"initialVersion": "5.0.0",
|
||||
"category": "transitions",
|
||||
"requestFields": [
|
||||
{
|
||||
"valueName": "position",
|
||||
"valueType": "Number",
|
||||
"valueDescription": "New position",
|
||||
"valueRestrictions": ">= 0.0, <= 1.0",
|
||||
"valueOptional": false,
|
||||
"valueOptionalBehavior": null
|
||||
},
|
||||
{
|
||||
"valueName": "release",
|
||||
"valueType": "Boolean",
|
||||
"valueDescription": "Whether to release the TBar. Only set `false` if you know that you will be sending another position update",
|
||||
"valueRestrictions": null,
|
||||
"valueOptional": true,
|
||||
"valueOptionalBehavior": "`true`"
|
||||
}
|
||||
],
|
||||
"responseFields": []
|
||||
},
|
||||
{
|
||||
"description": "Gets whether studio is enabled.",
|
||||
"requestType": "GetStudioModeEnabled",
|
||||
|
||||
@ -2127,6 +2127,8 @@ Studio mode has been enabled or disabled.
|
||||
- [CreateScene](#createscene)
|
||||
- [RemoveScene](#removescene)
|
||||
- [SetSceneName](#setscenename)
|
||||
- [GetSceneSceneTransitionOverride](#getscenescenetransitionoverride)
|
||||
- [SetSceneSceneTransitionOverride](#setscenescenetransitionoverride)
|
||||
- [Inputs](#inputs-1)
|
||||
- [GetInputList](#getinputlist)
|
||||
- [GetInputKindList](#getinputkindlist)
|
||||
@ -2159,7 +2161,9 @@ Studio mode has been enabled or disabled.
|
||||
- [SetCurrentSceneTransition](#setcurrentscenetransition)
|
||||
- [SetCurrentSceneTransitionDuration](#setcurrentscenetransitionduration)
|
||||
- [SetCurrentSceneTransitionSettings](#setcurrentscenetransitionsettings)
|
||||
- [GetCurrentSceneTransitionCursor](#getcurrentscenetransitioncursor)
|
||||
- [TriggerStudioModeTransition](#triggerstudiomodetransition)
|
||||
- [SetTBarPosition](#settbarposition)
|
||||
- [Filters](#filters)
|
||||
- [GetSourceFilter](#getsourcefilter)
|
||||
- [Scene Items](#scene-items-1)
|
||||
@ -2204,7 +2208,6 @@ Studio mode has been enabled or disabled.
|
||||
- [ToggleRecordPause](#togglerecordpause)
|
||||
- [PauseRecord](#pauserecord)
|
||||
- [ResumeRecord](#resumerecord)
|
||||
- [GetRecordDirectory](#getrecorddirectory)
|
||||
- [Media Inputs](#media-inputs-1)
|
||||
- [GetMediaInputStatus](#getmediainputstatus)
|
||||
- [SetMediaInputCursor](#setmediainputcursor)
|
||||
@ -2947,6 +2950,50 @@ Sets the name of a scene (rename).
|
||||
| sceneName | String | Name of the scene to be renamed | None | N/A |
|
||||
| newSceneName | String | New name for the scene | None | N/A |
|
||||
|
||||
---
|
||||
|
||||
### GetSceneSceneTransitionOverride
|
||||
|
||||
Gets the scene transition overridden for a scene.
|
||||
|
||||
- Complexity Rating: `2/5`
|
||||
- Latest Supported RPC Version: `1`
|
||||
- Added in v5.0.0
|
||||
|
||||
|
||||
**Request Fields:**
|
||||
|
||||
| Name | Type | Description | Value Restrictions | ?Default Behavior |
|
||||
| ---- | :---: | ----------- | :----------------: | ----------------- |
|
||||
| sceneName | String | Name of the scene | None | N/A |
|
||||
|
||||
|
||||
**Response Fields:**
|
||||
|
||||
| Name | Type | Description |
|
||||
| ---- | :---: | ----------- |
|
||||
| transitionName | String | Name of the overridden scene transition, else `null` |
|
||||
| transitionDuration | Number | Duration of the overridden scene transition, else `null` |
|
||||
|
||||
---
|
||||
|
||||
### SetSceneSceneTransitionOverride
|
||||
|
||||
Gets the scene transition overridden for a scene.
|
||||
|
||||
- Complexity Rating: `2/5`
|
||||
- Latest Supported RPC Version: `1`
|
||||
- Added in v5.0.0
|
||||
|
||||
|
||||
**Request Fields:**
|
||||
|
||||
| Name | Type | Description | Value Restrictions | ?Default Behavior |
|
||||
| ---- | :---: | ----------- | :----------------: | ----------------- |
|
||||
| sceneName | String | Name of the scene | None | N/A |
|
||||
| ?transitionName | String | Name of the scene transition to use as override. Specify `null` to remove | None | Unchanged |
|
||||
| ?transitionDuration | Number | Duration to use for any overridden transition. Specify `null` to remove | >= 50, <= 20000 | Unchanged |
|
||||
|
||||
|
||||
## Inputs
|
||||
|
||||
@ -3602,6 +3649,25 @@ Sets the settings of the current scene transition.
|
||||
|
||||
---
|
||||
|
||||
### GetCurrentSceneTransitionCursor
|
||||
|
||||
Gets the cursor position of the current scene transition.
|
||||
|
||||
Note: `transitionCursor` will return 1.0 when the transition is inactive.
|
||||
|
||||
- Complexity Rating: `2/5`
|
||||
- Latest Supported RPC Version: `1`
|
||||
- Added in v5.0.0
|
||||
|
||||
|
||||
**Response Fields:**
|
||||
|
||||
| Name | Type | Description |
|
||||
| ---- | :---: | ----------- |
|
||||
| transitionCursor | Number | Cursor position, between 0.0 and 1.0 |
|
||||
|
||||
---
|
||||
|
||||
### TriggerStudioModeTransition
|
||||
|
||||
Triggers the current scene transition. Same functionality as the `Transition` button in studio mode.
|
||||
@ -3610,6 +3676,26 @@ Triggers the current scene transition. Same functionality as the `Transition` bu
|
||||
- Latest Supported RPC Version: `1`
|
||||
- Added in v5.0.0
|
||||
|
||||
---
|
||||
|
||||
### SetTBarPosition
|
||||
|
||||
Sets the position of the TBar.
|
||||
|
||||
**Very important note**: This will be deprecated and replaced in a future version of obs-websocket.
|
||||
|
||||
- Complexity Rating: `3/5`
|
||||
- Latest Supported RPC Version: `1`
|
||||
- Added in v5.0.0
|
||||
|
||||
|
||||
**Request Fields:**
|
||||
|
||||
| Name | Type | Description | Value Restrictions | ?Default Behavior |
|
||||
| ---- | :---: | ----------- | :----------------: | ----------------- |
|
||||
| position | Number | New position | >= 0.0, <= 1.0 | N/A |
|
||||
| ?release | Boolean | Whether to release the TBar. Only set `false` if you know that you will be sending another position update | None | `true` |
|
||||
|
||||
|
||||
## Filters
|
||||
|
||||
@ -4343,23 +4429,6 @@ Resumes the record output.
|
||||
- Latest Supported RPC Version: `1`
|
||||
- Added in v5.0.0
|
||||
|
||||
---
|
||||
|
||||
### GetRecordDirectory
|
||||
|
||||
Gets the current directory that the record output is set to.
|
||||
|
||||
- Complexity Rating: `1/5`
|
||||
- Latest Supported RPC Version: `1`
|
||||
- Added in v5.0.0
|
||||
|
||||
|
||||
**Response Fields:**
|
||||
|
||||
| Name | Type | Description |
|
||||
| ---- | :---: | ----------- |
|
||||
| recordDirectory | String | Output directory |
|
||||
|
||||
|
||||
## Media Inputs
|
||||
|
||||
|
||||
Loading…
Reference in New Issue
Block a user