docs(ci): Update generated docs - 9cdfa41 [skip ci]

2024-08-30 18:12:16 +00:00 · 2022-07-02 15:26:00 +00:00 · 2022-07-02 15:26:00 +00:00 · 798eebf638
commit 798eebf638
parent 9cdfa41113
2 changed files with 119 additions and 0 deletions
--- a/docs/generated/protocol.json
+++ b/docs/generated/protocol.json
@ -4270,6 +4270,78 @@
          "valueDescription": "a list of detected monitors with some information"
        }
      ]
+    },
+    {
+      "description": "Opens a projector for a specific output video mix.\n\nMix types:\n- `OBS_WEBSOCKET_VIDEO_MIX_TYPE_PREVIEW`\n- `OBS_WEBSOCKET_VIDEO_MIX_TYPE_PROGRAM`\n- `OBS_WEBSOCKET_VIDEO_MIX_TYPE_MULTIVIEW`\n\nNote: This request serves to provide feature parity with 4.x. It is very likely to be changed/deprecated in a future release.",
+      "requestType": "OpenVideoMixProjector",
+      "complexity": 3,
+      "rpcVersion": "1",
+      "deprecated": false,
+      "initialVersion": "5.0.0",
+      "category": "ui",
+      "requestFields": [
+        {
+          "valueName": "videoMixType",
+          "valueType": "String",
+          "valueDescription": "Type of mix to open",
+          "valueRestrictions": null,
+          "valueOptional": false,
+          "valueOptionalBehavior": null
+        },
+        {
+          "valueName": "monitorIndex",
+          "valueType": "Number",
+          "valueDescription": "Monitor index, use `GetMonitorList` to obtain index",
+          "valueRestrictions": null,
+          "valueOptional": true,
+          "valueOptionalBehavior": "-1: Opens projector in windowed mode"
+        },
+        {
+          "valueName": "projectorGeometry",
+          "valueType": "String",
+          "valueDescription": "Size/Position data for a windowed projector, in Qt Base64 encoded format. Mutually exclusive with `monitorIndex`",
+          "valueRestrictions": null,
+          "valueOptional": true,
+          "valueOptionalBehavior": "N/A"
+        }
+      ],
+      "responseFields": []
+    },
+    {
+      "description": "Opens a projector for a source.\n\nNote: This request serves to provide feature parity with 4.x. It is very likely to be changed/deprecated in a future release.",
+      "requestType": "OpenSourceProjector",
+      "complexity": 3,
+      "rpcVersion": "1",
+      "deprecated": false,
+      "initialVersion": "5.0.0",
+      "category": "ui",
+      "requestFields": [
+        {
+          "valueName": "sourceName",
+          "valueType": "String",
+          "valueDescription": "Name of the source to open a projector for",
+          "valueRestrictions": null,
+          "valueOptional": false,
+          "valueOptionalBehavior": null
+        },
+        {
+          "valueName": "monitorIndex",
+          "valueType": "Number",
+          "valueDescription": "Monitor index, use `GetMonitorList` to obtain index",
+          "valueRestrictions": null,
+          "valueOptional": true,
+          "valueOptionalBehavior": "-1: Opens projector in windowed mode"
+        },
+        {
+          "valueName": "projectorGeometry",
+          "valueType": "String",
+          "valueDescription": "Size/Position data for a windowed projector, in Qt Base64 encoded format. Mutually exclusive with `monitorIndex`",
+          "valueRestrictions": null,
+          "valueOptional": true,
+          "valueOptionalBehavior": "N/A"
+        }
+      ],
+      "responseFields": []
    }
  ],
  "events": [
--- a/docs/generated/protocol.md
+++ b/docs/generated/protocol.md
@ -2409,6 +2409,8 @@ Studio mode has been enabled or disabled.
  - [OpenInputFiltersDialog](#openinputfiltersdialog)
  - [OpenInputInteractDialog](#openinputinteractdialog)
  - [GetMonitorList](#getmonitorlist)
+  - [OpenVideoMixProjector](#openvideomixprojector)
+  - [OpenSourceProjector](#opensourceprojector)

 ## General Requests

@ -4830,3 +4832,48 @@ Gets a list of connected monitors and information about them.
 | Name | Type  | Description |
 | ---- | :---: | ----------- |
 | monitors | Array&lt;Object&gt; | a list of detected monitors with some information |
+
+---
+
+### OpenVideoMixProjector
+
+Opens a projector for a specific output video mix.
+
+Mix types:
+- `OBS_WEBSOCKET_VIDEO_MIX_TYPE_PREVIEW`
+- `OBS_WEBSOCKET_VIDEO_MIX_TYPE_PROGRAM`
+- `OBS_WEBSOCKET_VIDEO_MIX_TYPE_MULTIVIEW`
+
+Note: This request serves to provide feature parity with 4.x. It is very likely to be changed/deprecated in a future release.
+
+- Complexity Rating: `3/5`
+- Latest Supported RPC Version: `1`
+- Added in v5.0.0
+
+**Request Fields:**
+
+| Name | Type  | Description | Value Restrictions | ?Default Behavior |
+| ---- | :---: | ----------- | :----------------: | ----------------- |
+| videoMixType | String | Type of mix to open | None | N/A |
+| ?monitorIndex | Number | Monitor index, use `GetMonitorList` to obtain index | None | -1: Opens projector in windowed mode |
+| ?projectorGeometry | String | Size/Position data for a windowed projector, in Qt Base64 encoded format. Mutually exclusive with `monitorIndex` | None | N/A |
+
+---
+
+### OpenSourceProjector
+
+Opens a projector for a source.
+
+Note: This request serves to provide feature parity with 4.x. It is very likely to be changed/deprecated in a future release.
+
+- 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 to open a projector for | None | N/A |
+| ?monitorIndex | Number | Monitor index, use `GetMonitorList` to obtain index | None | -1: Opens projector in windowed mode |
+| ?projectorGeometry | String | Size/Position data for a windowed projector, in Qt Base64 encoded format. Mutually exclusive with `monitorIndex` | None | N/A |