docs(ci): Update generated docs - fe64620 [skip ci]

2024-08-30 18:12:16 +00:00 · 2022-01-01 02:06:35 +00:00 · 2022-01-01 02:06:35 +00:00 · 8f2d266dec
commit 8f2d266dec
parent fe64620731
2 changed files with 195 additions and 0 deletions
--- a/docs/generated/protocol.json
+++ b/docs/generated/protocol.json
@ -1472,6 +1472,48 @@
        }
      ]
    },
+    {
+      "description": "Gets the names of all special inputs.",
+      "requestType": "GetSpecialInputs",
+      "complexity": 2,
+      "rpcVersion": "1",
+      "deprecated": false,
+      "initialVersion": "5.0.0",
+      "category": "inputs",
+      "requestFields": [],
+      "responseFields": [
+        {
+          "valueName": "desktop1",
+          "valueType": "String",
+          "valueDescription": "Name of the Desktop Audio input"
+        },
+        {
+          "valueName": "desktop2",
+          "valueType": "String",
+          "valueDescription": "Name of the Desktop Audio 2 input"
+        },
+        {
+          "valueName": "mic1",
+          "valueType": "String",
+          "valueDescription": "Name of the Mic/Auxiliary Audio input"
+        },
+        {
+          "valueName": "mic2",
+          "valueType": "String",
+          "valueDescription": "Name of the Mic/Auxiliary Audio 2 input"
+        },
+        {
+          "valueName": "mic3",
+          "valueType": "String",
+          "valueDescription": "Name of the Mic/Auxiliary Audio 3 input"
+        },
+        {
+          "valueName": "mic4",
+          "valueType": "String",
+          "valueDescription": "Name of the Mic/Auxiliary Audio 4 input"
+        }
+      ]
+    },
    {
      "description": "Creates a new input, adding it as a scene item to the specified scene.",
      "requestType": "CreateInput",
@ -2814,6 +2856,76 @@
      ],
      "responseFields": []
    },
+    {
+      "description": "Gets the blend mode of a scene item.\n\nBlend modes:\n\n- `OBS_BLEND_NORMAL`\n- `OBS_BLEND_ADDITIVE`\n- `OBS_BLEND_SUBTRACT`\n- `OBS_BLEND_SCREEN`\n- `OBS_BLEND_MULTIPLY`\n- `OBS_BLEND_LIGHTEN`\n- `OBS_BLEND_DARKEN`\n\nScenes and Groups",
+      "requestType": "GetSceneItemBlendMode",
+      "complexity": 2,
+      "rpcVersion": "1",
+      "deprecated": false,
+      "initialVersion": "5.0.0",
+      "category": "scene items",
+      "requestFields": [
+        {
+          "valueName": "sceneName",
+          "valueType": "String",
+          "valueDescription": "Name of the scene the item is in",
+          "valueRestrictions": null,
+          "valueOptional": false,
+          "valueOptionalBehavior": null
+        },
+        {
+          "valueName": "sceneItemId",
+          "valueType": "Number",
+          "valueDescription": "Numeric ID of the scene item",
+          "valueRestrictions": ">= 0",
+          "valueOptional": false,
+          "valueOptionalBehavior": null
+        }
+      ],
+      "responseFields": [
+        {
+          "valueName": "sceneItemBlendMode",
+          "valueType": "String",
+          "valueDescription": "Current blend mode"
+        }
+      ]
+    },
+    {
+      "description": "Sets the blend mode of a scene item.\n\nScenes and Groups",
+      "requestType": "SetSceneItemBlendMode",
+      "complexity": 2,
+      "rpcVersion": "1",
+      "deprecated": false,
+      "initialVersion": "5.0.0",
+      "category": "scene items",
+      "requestFields": [
+        {
+          "valueName": "sceneName",
+          "valueType": "String",
+          "valueDescription": "Name of the scene the item is in",
+          "valueRestrictions": null,
+          "valueOptional": false,
+          "valueOptionalBehavior": null
+        },
+        {
+          "valueName": "sceneItemId",
+          "valueType": "Number",
+          "valueDescription": "Numeric ID of the scene item",
+          "valueRestrictions": ">= 0",
+          "valueOptional": false,
+          "valueOptionalBehavior": null
+        },
+        {
+          "valueName": "sceneItemBlendMode",
+          "valueType": "String",
+          "valueDescription": "New blend mode",
+          "valueRestrictions": null,
+          "valueOptional": false,
+          "valueOptionalBehavior": null
+        }
+      ],
+      "responseFields": []
+    },
    {
      "description": "Gets an array of all scenes in OBS.",
      "requestType": "GetSceneList",
--- a/docs/generated/protocol.md
+++ b/docs/generated/protocol.md
@ -2075,6 +2075,7 @@ Studio mode has been enabled or disabled.
 - [Inputs](#inputs-1)
  - [GetInputList](#getinputlist)
  - [GetInputKindList](#getinputkindlist)
+  - [GetSpecialInputs](#getspecialinputs)
  - [CreateInput](#createinput)
  - [RemoveInput](#removeinput)
  - [SetInputName](#setinputname)
@ -2119,6 +2120,8 @@ Studio mode has been enabled or disabled.
  - [SetSceneItemLocked](#setsceneitemlocked)
  - [GetSceneItemIndex](#getsceneitemindex)
  - [SetSceneItemIndex](#setsceneitemindex)
+  - [GetSceneItemBlendMode](#getsceneitemblendmode)
+  - [SetSceneItemBlendMode](#setsceneitemblendmode)
 - [Stream](#stream)
  - [GetStreamStatus](#getstreamstatus)
  - [ToggleStream](#togglestream)
@ -2926,6 +2929,28 @@ Gets an array of all available input kinds in OBS.

 ---

+### GetSpecialInputs
+
+Gets the names of all special inputs.
+
+- Complexity Rating: `2/5`
+- Latest Supported RPC Version: `1`
+- Added in v5.0.0
+
+
+**Response Fields:**
+
+| Name | Type  | Description |
+| ---- | :---: | ----------- |
+| desktop1 | String | Name of the Desktop Audio input |
+| desktop2 | String | Name of the Desktop Audio 2 input |
+| mic1 | String | Name of the Mic/Auxiliary Audio input |
+| mic2 | String | Name of the Mic/Auxiliary Audio 2 input |
+| mic3 | String | Name of the Mic/Auxiliary Audio 3 input |
+| mic4 | String | Name of the Mic/Auxiliary Audio 4 input |
+
+---
+
 ### CreateInput

 Creates a new input, adding it as a scene item to the specified scene.
@ -3866,6 +3891,64 @@ Scenes and Groups
 | sceneItemId | Number | Numeric ID of the scene item | >= 0 | N/A |
 | sceneItemIndex | Number | New index position of the scene item | >= 0 | N/A |

+---
+
+### GetSceneItemBlendMode
+
+Gets the blend mode of a scene item.
+
+Blend modes:
+
+- `OBS_BLEND_NORMAL`
+- `OBS_BLEND_ADDITIVE`
+- `OBS_BLEND_SUBTRACT`
+- `OBS_BLEND_SCREEN`
+- `OBS_BLEND_MULTIPLY`
+- `OBS_BLEND_LIGHTEN`
+- `OBS_BLEND_DARKEN`
+
+Scenes and Groups
+
+- 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 the item is in | None | N/A |
+| sceneItemId | Number | Numeric ID of the scene item | >= 0 | N/A |
+
+
+**Response Fields:**
+
+| Name | Type  | Description |
+| ---- | :---: | ----------- |
+| sceneItemBlendMode | String | Current blend mode |
+
+---
+
+### SetSceneItemBlendMode
+
+Sets the blend mode of a scene item.
+
+Scenes and Groups
+
+- 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 the item is in | None | N/A |
+| sceneItemId | Number | Numeric ID of the scene item | >= 0 | N/A |
+| sceneItemBlendMode | String | New blend mode | None | N/A |
+

 ## Stream