From b806a0cfb18a3dd13a5ddfe1972f15e3f7f5efdb Mon Sep 17 00:00:00 2001 From: Github Actions <> Date: Fri, 19 Jan 2024 00:02:16 +0000 Subject: [PATCH] docs(ci): Update generated docs - 1d0db34 [skip ci] --- docs/generated/protocol.json | 34 ++++++++++++++++++++++++++++++++++ docs/generated/protocol.md | 24 ++++++++++++++++++++++++ 2 files changed, 58 insertions(+) diff --git a/docs/generated/protocol.json b/docs/generated/protocol.json index 92746875..8d1779b0 100644 --- a/docs/generated/protocol.json +++ b/docs/generated/protocol.json @@ -3305,6 +3305,40 @@ } ] }, + { + "description": "Gets the source name of a scene item.", + "requestType": "GetSceneItemSourceName", + "complexity": 3, + "rpcVersion": "1", + "deprecated": false, + "initialVersion": "5.4.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": "sourceName", + "valueType": "String", + "valueDescription": "Name of the source associated with the scene item" + } + ] + }, { "description": "Creates a new scene item using a source.\n\nScenes only", "requestType": "CreateSceneItem", diff --git a/docs/generated/protocol.md b/docs/generated/protocol.md index 43f14910..fd920bb6 100644 --- a/docs/generated/protocol.md +++ b/docs/generated/protocol.md @@ -2649,6 +2649,7 @@ communication is desired. - [GetSceneItemList](#getsceneitemlist) - [GetGroupSceneItemList](#getgroupsceneitemlist) - [GetSceneItemId](#getsceneitemid) + - [GetSceneItemSourceName](#getsceneitemsourcename) - [CreateSceneItem](#createsceneitem) - [RemoveSceneItem](#removesceneitem) - [DuplicateSceneItem](#duplicatesceneitem) @@ -4399,6 +4400,29 @@ Scenes and Groups --- +### GetSceneItemSourceName + +Gets the source name of a scene item. + +- Complexity Rating: `3/5` +- Latest Supported RPC Version: `1` +- Added in v5.4.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 | +| ---- | :---: | ----------- | +| sourceName | String | Name of the source associated with the scene item | + +--- + ### CreateSceneItem Creates a new scene item using a source.