From 3770b75a789a43a0a304166b23cb3993ac9128b7 Mon Sep 17 00:00:00 2001 From: Travis CI <> Date: Mon, 11 Nov 2019 13:41:29 +0000 Subject: [PATCH] docs(travis): Update protocol.md - 5d81b61 [skip ci] --- docs/generated/comments.json | 193 +++++++++++++++++++++++++++++++++++ docs/generated/protocol.md | 71 +++++++++++++ 2 files changed, 264 insertions(+) diff --git a/docs/generated/comments.json b/docs/generated/comments.json index 791fd993..b81131a3 100644 --- a/docs/generated/comments.json +++ b/docs/generated/comments.json @@ -2212,6 +2212,61 @@ "type": "class", "examples": [] }, + { + "subheads": [], + "description": "The visibility/enabled state of a filter changed", + "return": [ + "{String} `sourceName` Source name", + "{String} `filterName` Filter name", + "{Boolean} `filterEnabled` New filter state" + ], + "api": "events", + "name": "SourceFilterVisibilityChanged", + "category": "sources", + "since": "4.7.0", + "returns": [ + { + "type": "String", + "name": "sourceName", + "description": "Source name" + }, + { + "type": "String", + "name": "filterName", + "description": "Filter name" + }, + { + "type": "Boolean", + "name": "filterEnabled", + "description": "New filter state" + } + ], + "names": [ + { + "name": "", + "description": "SourceFilterVisibilityChanged" + } + ], + "categories": [ + { + "name": "", + "description": "sources" + } + ], + "sinces": [ + { + "name": "", + "description": "4.7.0" + } + ], + "heading": { + "level": 2, + "text": "SourceFilterVisibilityChanged" + }, + "lead": "", + "type": "class", + "examples": [] + }, { "subheads": [], "description": "Filters in a source have been reordered.", @@ -6739,6 +6794,7 @@ "param": "{String} `sourceName` Source name", "return": [ "{Array} `filters` List of filters for the specified source", + "{Boolean} `filters.*.enabled` Filter status (enabled or not)", "{String} `filters.*.type` Filter type", "{String} `filters.*.name` Filter name", "{Object} `filters.*.settings` Filter settings" @@ -6753,6 +6809,11 @@ "name": "filters", "description": "List of filters for the specified source" }, + { + "type": "Boolean", + "name": "filters.*.enabled", + "description": "Filter status (enabled or not)" + }, { "type": "String", "name": "filters.*.type", @@ -6802,6 +6863,83 @@ "type": "class", "examples": [] }, + { + "subheads": [], + "description": "List filters applied to a source", + "param": [ + "{String} `sourceName` Source name", + "{String} `filterName` Source filter name" + ], + "return": [ + "{Boolean} `enabled` Filter status (enabled or not)", + "{String} `type` Filter type", + "{String} `name` Filter name", + "{Object} `settings` Filter settings" + ], + "api": "requests", + "name": "GetSourceFilterInfo", + "category": "sources", + "since": "4.7.0", + "returns": [ + { + "type": "Boolean", + "name": "enabled", + "description": "Filter status (enabled or not)" + }, + { + "type": "String", + "name": "type", + "description": "Filter type" + }, + { + "type": "String", + "name": "name", + "description": "Filter name" + }, + { + "type": "Object", + "name": "settings", + "description": "Filter settings" + } + ], + "params": [ + { + "type": "String", + "name": "sourceName", + "description": "Source name" + }, + { + "type": "String", + "name": "filterName", + "description": "Source filter name" + } + ], + "names": [ + { + "name": "", + "description": "GetSourceFilterInfo" + } + ], + "categories": [ + { + "name": "", + "description": "sources" + } + ], + "sinces": [ + { + "name": "", + "description": "4.7.0" + } + ], + "heading": { + "level": 2, + "text": "GetSourceFilterInfo" + }, + "lead": "", + "type": "class", + "examples": [] + }, { "subheads": [], "description": "Add a new filter to a source. Available source types along with their settings properties are available from `GetSourceTypesList`.", @@ -7077,6 +7215,61 @@ "type": "class", "examples": [] }, + { + "subheads": [], + "description": "Change the visibility/enabled state of a filter", + "param": [ + "{String} `sourceName` Source name", + "{String} `filterName` Source filter name", + "{String} `filterEnabled` New filter state" + ], + "api": "requests", + "name": "EnableSourceFilter", + "category": "sources", + "since": "4.7.0", + "params": [ + { + "type": "String", + "name": "sourceName", + "description": "Source name" + }, + { + "type": "String", + "name": "filterName", + "description": "Source filter name" + }, + { + "type": "String", + "name": "filterEnabled", + "description": "New filter state" + } + ], + "names": [ + { + "name": "", + "description": "EnableSourceFilter" + } + ], + "categories": [ + { + "name": "", + "description": "sources" + } + ], + "sinces": [ + { + "name": "", + "description": "4.7.0" + } + ], + "heading": { + "level": 2, + "text": "EnableSourceFilter" + }, + "lead": "", + "type": "class", + "examples": [] + }, { "subheads": [], "description": "\n\nAt least `embedPictureFormat` or `saveToFilePath` must be specified.\n\nClients can specify `width` and `height` parameters to receive scaled pictures. Aspect ratio is\npreserved if only one of these two parameters is specified.", diff --git a/docs/generated/protocol.md b/docs/generated/protocol.md index 370dd76a..6eb13529 100644 --- a/docs/generated/protocol.md +++ b/docs/generated/protocol.md @@ -95,6 +95,7 @@ auth_response = base64_encode(auth_response_hash) + [SourceRenamed](#sourcerenamed) + [SourceFilterAdded](#sourcefilteradded) + [SourceFilterRemoved](#sourcefilterremoved) + + [SourceFilterVisibilityChanged](#sourcefiltervisibilitychanged) + [SourceFiltersReordered](#sourcefiltersreordered) + [SourceOrderChanged](#sourceorderchanged) + [SceneItemAdded](#sceneitemadded) @@ -178,11 +179,13 @@ auth_response = base64_encode(auth_response_hash) + [SetBrowserSourceProperties](#setbrowsersourceproperties) + [GetSpecialSources](#getspecialsources) + [GetSourceFilters](#getsourcefilters) + + [GetSourceFilterInfo](#getsourcefilterinfo) + [AddFilterToSource](#addfiltertosource) + [RemoveFilterFromSource](#removefilterfromsource) + [ReorderSourceFilter](#reordersourcefilter) + [MoveSourceFilter](#movesourcefilter) + [SetSourceFilterSettings](#setsourcefiltersettings) + + [EnableSourceFilter](#enablesourcefilter) + [TakeSourceScreenshot](#takesourcescreenshot) * [Streaming](#streaming-1) + [GetStreamingStatus](#getstreamingstatus) @@ -915,6 +918,24 @@ A filter was removed from a source. | `filterType` | _String_ | Filter type | +--- + +### SourceFilterVisibilityChanged + + +- Added in v4.7.0 + +The visibility/enabled state of a filter changed + +**Response Items:** + +| Name | Type | Description | +| ---- | :---: | ------------| +| `sourceName` | _String_ | Source name | +| `filterName` | _String_ | Filter name | +| `filterEnabled` | _Boolean_ | New filter state | + + --- ### SourceFiltersReordered @@ -2619,11 +2640,39 @@ List filters applied to a source | Name | Type | Description | | ---- | :---: | ------------| | `filters` | _Array<Object>_ | List of filters for the specified source | +| `filters.*.enabled` | _Boolean_ | Filter status (enabled or not) | | `filters.*.type` | _String_ | Filter type | | `filters.*.name` | _String_ | Filter name | | `filters.*.settings` | _Object_ | Filter settings | +--- + +### GetSourceFilterInfo + + +- Added in v4.7.0 + +List filters applied to a source + +**Request Fields:** + +| Name | Type | Description | +| ---- | :---: | ------------| +| `sourceName` | _String_ | Source name | +| `filterName` | _String_ | Source filter name | + + +**Response Items:** + +| Name | Type | Description | +| ---- | :---: | ------------| +| `enabled` | _Boolean_ | Filter status (enabled or not) | +| `type` | _String_ | Filter type | +| `name` | _String_ | Filter name | +| `settings` | _Object_ | Filter settings | + + --- ### AddFilterToSource @@ -2730,6 +2779,28 @@ Update settings of a filter | `filterSettings` | _Object_ | New settings. These will be merged to the current filter settings. | +**Response Items:** + +_No additional response items._ + +--- + +### EnableSourceFilter + + +- Added in v4.7.0 + +Change the visibility/enabled state of a filter + +**Request Fields:** + +| Name | Type | Description | +| ---- | :---: | ------------| +| `sourceName` | _String_ | Source name | +| `filterName` | _String_ | Source filter name | +| `filterEnabled` | _String_ | New filter state | + + **Response Items:** _No additional response items._