mirror of
https://github.com/Palakis/obs-websocket.git
synced 2024-08-30 18:12:16 +00:00
docs(ci): Update generated docs - 9d89937
[skip ci]
This commit is contained in:
@ -1443,6 +1443,42 @@
|
|||||||
],
|
],
|
||||||
"responseFields": []
|
"responseFields": []
|
||||||
},
|
},
|
||||||
|
{
|
||||||
|
"description": "Sets the enable state of a source filter.",
|
||||||
|
"requestType": "SetSourceFilterEnabled",
|
||||||
|
"complexity": 3,
|
||||||
|
"rpcVersion": "1",
|
||||||
|
"deprecated": false,
|
||||||
|
"initialVersion": "5.0.0",
|
||||||
|
"category": "filters",
|
||||||
|
"requestFields": [
|
||||||
|
{
|
||||||
|
"valueName": "sourceName",
|
||||||
|
"valueType": "String",
|
||||||
|
"valueDescription": "Name of the source the filter is on",
|
||||||
|
"valueRestrictions": null,
|
||||||
|
"valueOptional": false,
|
||||||
|
"valueOptionalBehavior": null
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"valueName": "filterName",
|
||||||
|
"valueType": "String",
|
||||||
|
"valueDescription": "Name of the filter",
|
||||||
|
"valueRestrictions": null,
|
||||||
|
"valueOptional": false,
|
||||||
|
"valueOptionalBehavior": null
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"valueName": "filterEnabled",
|
||||||
|
"valueType": "Boolean",
|
||||||
|
"valueDescription": "New enable state of the filter",
|
||||||
|
"valueRestrictions": null,
|
||||||
|
"valueOptional": false,
|
||||||
|
"valueOptionalBehavior": null
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"responseFields": []
|
||||||
|
},
|
||||||
{
|
{
|
||||||
"description": "Gets data about the current plugin and RPC version.",
|
"description": "Gets data about the current plugin and RPC version.",
|
||||||
"requestType": "GetVersion",
|
"requestType": "GetVersion",
|
||||||
@ -2891,6 +2927,14 @@
|
|||||||
"valueRestrictions": null,
|
"valueRestrictions": null,
|
||||||
"valueOptional": false,
|
"valueOptional": false,
|
||||||
"valueOptionalBehavior": null
|
"valueOptionalBehavior": null
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"valueName": "searchOffset",
|
||||||
|
"valueType": "Number",
|
||||||
|
"valueDescription": "Number of matches to skip during search. >= 0 means first forward. -1 means last (top) item",
|
||||||
|
"valueRestrictions": ">= -1",
|
||||||
|
"valueOptional": true,
|
||||||
|
"valueOptionalBehavior": "0"
|
||||||
}
|
}
|
||||||
],
|
],
|
||||||
"responseFields": [
|
"responseFields": [
|
||||||
|
@ -2346,6 +2346,7 @@ Studio mode has been enabled or disabled.
|
|||||||
- [GetSourceFilter](#getsourcefilter)
|
- [GetSourceFilter](#getsourcefilter)
|
||||||
- [SetSourceFilterIndex](#setsourcefilterindex)
|
- [SetSourceFilterIndex](#setsourcefilterindex)
|
||||||
- [SetSourceFilterSettings](#setsourcefiltersettings)
|
- [SetSourceFilterSettings](#setsourcefiltersettings)
|
||||||
|
- [SetSourceFilterEnabled](#setsourcefilterenabled)
|
||||||
- [Scene Items](#scene-items-1)
|
- [Scene Items](#scene-items-1)
|
||||||
- [GetSceneItemList](#getsceneitemlist)
|
- [GetSceneItemList](#getsceneitemlist)
|
||||||
- [GetGroupItemList](#getgroupitemlist)
|
- [GetGroupItemList](#getgroupitemlist)
|
||||||
@ -4049,6 +4050,25 @@ Sets the settings of a source filter.
|
|||||||
| filterSettings | Object | Object of settings to apply | None | N/A |
|
| filterSettings | Object | Object of settings to apply | None | N/A |
|
||||||
| ?overlay | Boolean | True == apply the settings on top of existing ones, False == reset the input to its defaults, then apply settings. | None | true |
|
| ?overlay | Boolean | True == apply the settings on top of existing ones, False == reset the input to its defaults, then apply settings. | None | true |
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### SetSourceFilterEnabled
|
||||||
|
|
||||||
|
Sets the enable state of a source filter.
|
||||||
|
|
||||||
|
- Complexity Rating: `3/5`
|
||||||
|
- Latest Supported RPC Version: `1`
|
||||||
|
- Added in v5.0.0
|
||||||
|
|
||||||
|
|
||||||
|
**Request Fields:**
|
||||||
|
|
||||||
|
| Name | Type | Description | Value Restrictions | ?Default Behavior |
|
||||||
|
| ---- | :---: | ----------- | :----------------: | ----------------- |
|
||||||
|
| sourceName | String | Name of the source the filter is on | None | N/A |
|
||||||
|
| filterName | String | Name of the filter | None | N/A |
|
||||||
|
| filterEnabled | Boolean | New enable state of the filter | None | N/A |
|
||||||
|
|
||||||
|
|
||||||
## Scene Items
|
## Scene Items
|
||||||
|
|
||||||
@ -4123,6 +4143,7 @@ Scenes and Groups
|
|||||||
| ---- | :---: | ----------- | :----------------: | ----------------- |
|
| ---- | :---: | ----------- | :----------------: | ----------------- |
|
||||||
| sceneName | String | Name of the scene or group to search in | None | N/A |
|
| sceneName | String | Name of the scene or group to search in | None | N/A |
|
||||||
| sourceName | String | Name of the source to find | None | N/A |
|
| sourceName | String | Name of the source to find | None | N/A |
|
||||||
|
| ?searchOffset | Number | Number of matches to skip during search. >= 0 means first forward. -1 means last (top) item | >= -1 | 0 |
|
||||||
|
|
||||||
|
|
||||||
**Response Fields:**
|
**Response Fields:**
|
||||||
|
Reference in New Issue
Block a user