diff --git a/docs/generated/protocol.json b/docs/generated/protocol.json index 8139e7c7..e02d88b3 100644 --- a/docs/generated/protocol.json +++ b/docs/generated/protocol.json @@ -1129,6 +1129,55 @@ ], "responseFields": [] }, + { + "description": "Gets the info for a specific source filter.", + "requestType": "GetSourceFilter", + "complexity": 2, + "rpcVersion": "1", + "deprecated": false, + "initialVersion": "5.0.0", + "category": "filters", + "requestFields": [ + { + "valueName": "sourceName", + "valueType": "String", + "valueDescription": "Name of the source", + "valueRestrictions": null, + "valueOptional": false, + "valueOptionalBehavior": null + }, + { + "valueName": "filterName", + "valueType": "String", + "valueDescription": "Name of the filter", + "valueRestrictions": null, + "valueOptional": false, + "valueOptionalBehavior": null + } + ], + "responseFields": [ + { + "valueName": "filterEnabled", + "valueType": "Boolean", + "valueDescription": "Whether the filter is enabled" + }, + { + "valueName": "filterIndex", + "valueType": "Number", + "valueDescription": "Index of the filter in the list, beginning at 0" + }, + { + "valueName": "filterKind", + "valueType": "String", + "valueDescription": "The kind of filter" + }, + { + "valueName": "filterSettings", + "valueType": "Object", + "valueDescription": "Settings object associated with the filter" + } + ] + }, { "description": "Gets data about the current plugin and RPC version.", "requestType": "GetVersion", diff --git a/docs/generated/protocol.md b/docs/generated/protocol.md index 273e2364..af13f0c4 100644 --- a/docs/generated/protocol.md +++ b/docs/generated/protocol.md @@ -2105,6 +2105,8 @@ Studio mode has been enabled or disabled. - [SetCurrentSceneTransitionDuration](#setcurrentscenetransitionduration) - [SetCurrentSceneTransitionSettings](#setcurrentscenetransitionsettings) - [TriggerStudioModeTransition](#triggerstudiomodetransition) +- [Filters](#filters) + - [GetSourceFilter](#getsourcefilter) - [Scene Items](#scene-items-1) - [GetSceneItemList](#getsceneitemlist) - [GetGroupItemList](#getgroupitemlist) @@ -3542,6 +3544,35 @@ Triggers the current scene transition. Same functionality as the `Transition` bu - Added in v5.0.0 +## Filters + +### GetSourceFilter + +Gets the info for a specific source filter. + +- Complexity Rating: `2/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 | None | N/A | +| filterName | String | Name of the filter | None | N/A | + + +**Response Fields:** + +| Name | Type | Description | +| ---- | :---: | ----------- | +| filterEnabled | Boolean | Whether the filter is enabled | +| filterIndex | Number | Index of the filter in the list, beginning at 0 | +| filterKind | String | The kind of filter | +| filterSettings | Object | Settings object associated with the filter | + + ## Scene Items ### GetSceneItemList