Skip to content

Commit

Permalink
docs(ci): Update generated docs - 1d0db34 [skip ci]
Browse files Browse the repository at this point in the history
  • Loading branch information
Github Actions committed Jan 19, 2024
1 parent 1d0db34 commit b806a0c
Show file tree
Hide file tree
Showing 2 changed files with 58 additions and 0 deletions.
34 changes: 34 additions & 0 deletions docs/generated/protocol.json
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down
24 changes: 24 additions & 0 deletions docs/generated/protocol.md
Original file line number Diff line number Diff line change
Expand Up @@ -2649,6 +2649,7 @@ communication is desired.
- [GetSceneItemList](#getsceneitemlist)
- [GetGroupSceneItemList](#getgroupsceneitemlist)
- [GetSceneItemId](#getsceneitemid)
- [GetSceneItemSourceName](#getsceneitemsourcename)
- [CreateSceneItem](#createsceneitem)
- [RemoveSceneItem](#removesceneitem)
- [DuplicateSceneItem](#duplicatesceneitem)
Expand Down Expand Up @@ -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.
Expand Down

0 comments on commit b806a0c

Please sign in to comment.