mirror of
https://github.com/Palakis/obs-websocket.git
synced 2024-08-30 18:12:16 +00:00
docs(ci): Update generated docs - 1d0db34 [skip ci]
This commit is contained in:
parent
1d0db34bb2
commit
b806a0cfb1
@ -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",
|
"description": "Creates a new scene item using a source.\n\nScenes only",
|
||||||
"requestType": "CreateSceneItem",
|
"requestType": "CreateSceneItem",
|
||||||
|
@ -2649,6 +2649,7 @@ communication is desired.
|
|||||||
- [GetSceneItemList](#getsceneitemlist)
|
- [GetSceneItemList](#getsceneitemlist)
|
||||||
- [GetGroupSceneItemList](#getgroupsceneitemlist)
|
- [GetGroupSceneItemList](#getgroupsceneitemlist)
|
||||||
- [GetSceneItemId](#getsceneitemid)
|
- [GetSceneItemId](#getsceneitemid)
|
||||||
|
- [GetSceneItemSourceName](#getsceneitemsourcename)
|
||||||
- [CreateSceneItem](#createsceneitem)
|
- [CreateSceneItem](#createsceneitem)
|
||||||
- [RemoveSceneItem](#removesceneitem)
|
- [RemoveSceneItem](#removesceneitem)
|
||||||
- [DuplicateSceneItem](#duplicatesceneitem)
|
- [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
|
### CreateSceneItem
|
||||||
|
|
||||||
Creates a new scene item using a source.
|
Creates a new scene item using a source.
|
||||||
|
Loading…
x
Reference in New Issue
Block a user