mirror of
https://github.com/Palakis/obs-websocket.git
synced 2024-08-30 18:12:16 +00:00
docs(ci): Update generated docs - aa13828
[skip ci]
This commit is contained in:
parent
aa13828cf5
commit
e0057b05db
@ -1180,6 +1180,32 @@
|
|||||||
}
|
}
|
||||||
]
|
]
|
||||||
},
|
},
|
||||||
|
{
|
||||||
|
"description": "Gets the default settings for a filter kind.",
|
||||||
|
"requestType": "GetSourceFilterDefaultSettings",
|
||||||
|
"complexity": 3,
|
||||||
|
"rpcVersion": "1",
|
||||||
|
"deprecated": false,
|
||||||
|
"initialVersion": "5.0.0",
|
||||||
|
"category": "filters",
|
||||||
|
"requestFields": [
|
||||||
|
{
|
||||||
|
"valueName": "filterKind",
|
||||||
|
"valueType": "String",
|
||||||
|
"valueDescription": "Filter kind to get the default settings for",
|
||||||
|
"valueRestrictions": null,
|
||||||
|
"valueOptional": false,
|
||||||
|
"valueOptionalBehavior": null
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"responseFields": [
|
||||||
|
{
|
||||||
|
"valueName": "defaultFilterSettings",
|
||||||
|
"valueType": "Object",
|
||||||
|
"valueDescription": "Object of default settings for the filter kind"
|
||||||
|
}
|
||||||
|
]
|
||||||
|
},
|
||||||
{
|
{
|
||||||
"description": "Creates a new filter, adding it to the specified source.",
|
"description": "Creates a new filter, adding it to the specified source.",
|
||||||
"requestType": "CreateSourceFilter",
|
"requestType": "CreateSourceFilter",
|
||||||
@ -1253,30 +1279,40 @@
|
|||||||
"responseFields": []
|
"responseFields": []
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"description": "Gets the default settings for a filter kind.",
|
"description": "Sets the name of a source filter (rename).",
|
||||||
"requestType": "GetSourceFilterDefaultSettings",
|
"requestType": "SetSourceFilterName",
|
||||||
"complexity": 3,
|
"complexity": 2,
|
||||||
"rpcVersion": "1",
|
"rpcVersion": "1",
|
||||||
"deprecated": false,
|
"deprecated": false,
|
||||||
"initialVersion": "5.0.0",
|
"initialVersion": "5.0.0",
|
||||||
"category": "filters",
|
"category": "filters",
|
||||||
"requestFields": [
|
"requestFields": [
|
||||||
{
|
{
|
||||||
"valueName": "filterKind",
|
"valueName": "sourceName",
|
||||||
"valueType": "String",
|
"valueType": "String",
|
||||||
"valueDescription": "Filter kind to get the default settings for",
|
"valueDescription": "Name of the source the filter is on",
|
||||||
|
"valueRestrictions": null,
|
||||||
|
"valueOptional": false,
|
||||||
|
"valueOptionalBehavior": null
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"valueName": "filterName",
|
||||||
|
"valueType": "String",
|
||||||
|
"valueDescription": "Current name of the filter",
|
||||||
|
"valueRestrictions": null,
|
||||||
|
"valueOptional": false,
|
||||||
|
"valueOptionalBehavior": null
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"valueName": "newFilterName",
|
||||||
|
"valueType": "String",
|
||||||
|
"valueDescription": "New name for the filter",
|
||||||
"valueRestrictions": null,
|
"valueRestrictions": null,
|
||||||
"valueOptional": false,
|
"valueOptional": false,
|
||||||
"valueOptionalBehavior": null
|
"valueOptionalBehavior": null
|
||||||
}
|
}
|
||||||
],
|
],
|
||||||
"responseFields": [
|
"responseFields": []
|
||||||
{
|
|
||||||
"valueName": "defaultFilterSettings",
|
|
||||||
"valueType": "Object",
|
|
||||||
"valueDescription": "Object of default settings for the filter kind"
|
|
||||||
}
|
|
||||||
]
|
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"description": "Gets the info for a specific source filter.",
|
"description": "Gets the info for a specific source filter.",
|
||||||
|
@ -2278,9 +2278,10 @@ Studio mode has been enabled or disabled.
|
|||||||
- [SetTBarPosition](#settbarposition)
|
- [SetTBarPosition](#settbarposition)
|
||||||
- [Filters](#filters-1)
|
- [Filters](#filters-1)
|
||||||
- [GetSourceFilterList](#getsourcefilterlist)
|
- [GetSourceFilterList](#getsourcefilterlist)
|
||||||
|
- [GetSourceFilterDefaultSettings](#getsourcefilterdefaultsettings)
|
||||||
- [CreateSourceFilter](#createsourcefilter)
|
- [CreateSourceFilter](#createsourcefilter)
|
||||||
- [RemoveSourceFilter](#removesourcefilter)
|
- [RemoveSourceFilter](#removesourcefilter)
|
||||||
- [GetSourceFilterDefaultSettings](#getsourcefilterdefaultsettings)
|
- [SetSourceFilterName](#setsourcefiltername)
|
||||||
- [GetSourceFilter](#getsourcefilter)
|
- [GetSourceFilter](#getsourcefilter)
|
||||||
- [SetSourceFilterIndex](#setsourcefilterindex)
|
- [SetSourceFilterIndex](#setsourcefilterindex)
|
||||||
- [SetSourceFilterSettings](#setsourcefiltersettings)
|
- [SetSourceFilterSettings](#setsourcefiltersettings)
|
||||||
@ -3841,6 +3842,30 @@ Gets an array of all of a source's filters.
|
|||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
|
### GetSourceFilterDefaultSettings
|
||||||
|
|
||||||
|
Gets the default settings for a filter kind.
|
||||||
|
|
||||||
|
- Complexity Rating: `3/5`
|
||||||
|
- Latest Supported RPC Version: `1`
|
||||||
|
- Added in v5.0.0
|
||||||
|
|
||||||
|
|
||||||
|
**Request Fields:**
|
||||||
|
|
||||||
|
| Name | Type | Description | Value Restrictions | ?Default Behavior |
|
||||||
|
| ---- | :---: | ----------- | :----------------: | ----------------- |
|
||||||
|
| filterKind | String | Filter kind to get the default settings for | None | N/A |
|
||||||
|
|
||||||
|
|
||||||
|
**Response Fields:**
|
||||||
|
|
||||||
|
| Name | Type | Description |
|
||||||
|
| ---- | :---: | ----------- |
|
||||||
|
| defaultFilterSettings | Object | Object of default settings for the filter kind |
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
### CreateSourceFilter
|
### CreateSourceFilter
|
||||||
|
|
||||||
Creates a new filter, adding it to the specified source.
|
Creates a new filter, adding it to the specified source.
|
||||||
@ -3879,11 +3904,11 @@ Removes a filter from a source.
|
|||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
### GetSourceFilterDefaultSettings
|
### SetSourceFilterName
|
||||||
|
|
||||||
Gets the default settings for a filter kind.
|
Sets the name of a source filter (rename).
|
||||||
|
|
||||||
- Complexity Rating: `3/5`
|
- Complexity Rating: `2/5`
|
||||||
- Latest Supported RPC Version: `1`
|
- Latest Supported RPC Version: `1`
|
||||||
- Added in v5.0.0
|
- Added in v5.0.0
|
||||||
|
|
||||||
@ -3892,14 +3917,9 @@ Gets the default settings for a filter kind.
|
|||||||
|
|
||||||
| Name | Type | Description | Value Restrictions | ?Default Behavior |
|
| Name | Type | Description | Value Restrictions | ?Default Behavior |
|
||||||
| ---- | :---: | ----------- | :----------------: | ----------------- |
|
| ---- | :---: | ----------- | :----------------: | ----------------- |
|
||||||
| filterKind | String | Filter kind to get the default settings for | None | N/A |
|
| sourceName | String | Name of the source the filter is on | None | N/A |
|
||||||
|
| filterName | String | Current name of the filter | None | N/A |
|
||||||
|
| newFilterName | String | New name for the filter | None | N/A |
|
||||||
**Response Fields:**
|
|
||||||
|
|
||||||
| Name | Type | Description |
|
|
||||||
| ---- | :---: | ----------- |
|
|
||||||
| defaultFilterSettings | Object | Object of default settings for the filter kind |
|
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
|
Loading…
Reference in New Issue
Block a user