From 389cbd854cbfa32a68635df3909b5ff988dcda20 Mon Sep 17 00:00:00 2001 From: Github Actions <> Date: Wed, 29 Dec 2021 08:54:22 +0000 Subject: [PATCH] docs(ci): Update generated docs - 707ac3f [skip ci] --- docs/generated/protocol.json | 46 ++++++++++++++++++------------- docs/generated/protocol.md | 53 ++++++++++++++++++++++-------------- 2 files changed, 59 insertions(+), 40 deletions(-) diff --git a/docs/generated/protocol.json b/docs/generated/protocol.json index 7a04a6de..ce6c1fd7 100644 --- a/docs/generated/protocol.json +++ b/docs/generated/protocol.json @@ -91,6 +91,14 @@ "initialVersion": "5.0.0", "enumValue": "(1 << 9)" }, + { + "description": "Subscription value to receive events in the `Ui` category.", + "enumIdentifier": "Ui", + "rpcVersion": "1", + "deprecated": false, + "initialVersion": "5.0.0", + "enumValue": "(1 << 10)" + }, { "description": "Helper to receive all non-high-volume events.", "enumIdentifier": "All", @@ -897,7 +905,7 @@ { "description": "Gets a parameter from the current profile's configuration.", "requestType": "GetProfileParameter", - "complexity": 3, + "complexity": 4, "rpcVersion": "1", "deprecated": false, "initialVersion": "5.0.0", @@ -936,7 +944,7 @@ { "description": "Sets the value of a parameter in the current profile's configuration.", "requestType": "SetProfileParameter", - "complexity": 3, + "complexity": 4, "rpcVersion": "1", "deprecated": false, "initialVersion": "5.0.0", @@ -3425,23 +3433,6 @@ "category": "general", "dataFields": [] }, - { - "description": "Studio mode has been enabled or disabled.", - "eventType": "StudioModeStateChanged", - "eventSubscription": "General", - "complexity": 1, - "rpcVersion": "1", - "deprecated": false, - "initialVersion": "5.0.0", - "category": "general", - "dataFields": [ - { - "valueName": "studioModeEnabled", - "valueType": "Boolean", - "valueDescription": "True == Enabled, False == Disabled" - } - ] - }, { "description": "An input has been created.", "eventType": "InputCreated", @@ -4134,6 +4125,23 @@ } ] }, + { + "description": "Studio mode has been enabled or disabled.", + "eventType": "StudioModeStateChanged", + "eventSubscription": "Ui", + "complexity": 1, + "rpcVersion": "1", + "deprecated": false, + "initialVersion": "5.0.0", + "category": "ui", + "dataFields": [ + { + "valueName": "studioModeEnabled", + "valueType": "Boolean", + "valueDescription": "True == Enabled, False == Disabled" + } + ] + }, { "description": "An event has been emitted from a vendor.\n\nA vendor is a unique name registered by a third-party plugin or script, which allows for custom requests and events to be added to obs-websocket.\nIf a plugin or script implements vendor requests or events, documentation is expected to be provided with them.", "eventType": "VendorEvent", diff --git a/docs/generated/protocol.md b/docs/generated/protocol.md index 58e9632e..ac8d03ac 100644 --- a/docs/generated/protocol.md +++ b/docs/generated/protocol.md @@ -459,6 +459,7 @@ These are enumeration declarations, which are referenced throughout obs-websocke - [EventSubscription::SceneItems](#eventsubscriptionsceneitems) - [EventSubscription::MediaInputs](#eventsubscriptionmediainputs) - [EventSubscription::Vendors](#eventsubscriptionvendors) + - [EventSubscription::Ui](#eventsubscriptionui) - [EventSubscription::All](#eventsubscriptionall) - [EventSubscription::InputVolumeMeters](#eventsubscriptioninputvolumemeters) - [EventSubscription::InputActiveStateChanged](#eventsubscriptioninputactivestatechanged) @@ -1175,6 +1176,16 @@ Subscription value to receive the `VendorEvent` event. --- +### EventSubscription::Ui + +Subscription value to receive events in the `Ui` category. + +- Identifier Value: `(1 << 10)` +- Latest Supported RPC Version: `1` +- Added in v5.0.0 + +--- + ### EventSubscription::All Helper to receive all non-high-volume events. @@ -1229,7 +1240,6 @@ Subscription value to receive the `SceneItemTransformChanged` high-volume event. ### Events Table of Contents - [General](#general) - [ExitStarted](#exitstarted) - - [StudioModeStateChanged](#studiomodestatechanged) - [VendorEvent](#vendorevent) - [Config](#config) - [CurrentSceneCollectionChanging](#currentscenecollectionchanging) @@ -1274,6 +1284,8 @@ Subscription value to receive the `SceneItemTransformChanged` high-volume event. - [MediaInputPlaybackStarted](#mediainputplaybackstarted) - [MediaInputPlaybackEnded](#mediainputplaybackended) - [MediaInputActionTriggered](#mediainputactiontriggered) +- [Ui](#ui) + - [StudioModeStateChanged](#studiomodestatechanged) ## General @@ -1288,23 +1300,6 @@ OBS has begun the shutdown process. --- -### StudioModeStateChanged - -Studio mode has been enabled or disabled. - -- Complexity Rating: `1/5` -- Latest Supported RPC Version: `1` -- Added in v5.0.0 - - -**Data Fields:** - -| Name | Type | Description | -| ---- | :---: | ----------- | -| studioModeEnabled | Boolean | True == Enabled, False == Disabled | - ---- - ### VendorEvent An event has been emitted from a vendor. @@ -1998,6 +1993,22 @@ An action has been performed on an input. | ---- | :---: | ----------- | | inputName | String | Name of the input | | mediaAction | String | Action performed on the input. See `ObsMediaInputAction` enum | +## Ui + +### StudioModeStateChanged + +Studio mode has been enabled or disabled. + +- Complexity Rating: `1/5` +- Latest Supported RPC Version: `1` +- Added in v5.0.0 + + +**Data Fields:** + +| Name | Type | Description | +| ---- | :---: | ----------- | +| studioModeEnabled | Boolean | True == Enabled, False == Disabled | # Requests @@ -2103,7 +2114,7 @@ An action has been performed on an input. - [SetMediaInputCursor](#setmediainputcursor) - [OffsetMediaInputCursor](#offsetmediainputcursor) - [TriggerMediaInputAction](#triggermediainputaction) -- [Ui](#ui) +- [Ui](#ui-1) - [GetStudioModeEnabled](#getstudiomodeenabled) - [SetStudioModeEnabled](#setstudiomodeenabled) @@ -2454,7 +2465,7 @@ Removes a profile. If the current profile is chosen, it will change to a differe Gets a parameter from the current profile's configuration. -- Complexity Rating: `3/5` +- Complexity Rating: `4/5` - Latest Supported RPC Version: `1` - Added in v5.0.0 @@ -2480,7 +2491,7 @@ Gets a parameter from the current profile's configuration. Sets the value of a parameter in the current profile's configuration. -- Complexity Rating: `3/5` +- Complexity Rating: `4/5` - Latest Supported RPC Version: `1` - Added in v5.0.0