mirror of
https://github.com/Palakis/obs-websocket.git
synced 2024-08-30 18:12:16 +00:00
docs(ci): Update protocol.md - 9edc3ea [skip ci]
This commit is contained in:
parent
9edc3eafa3
commit
569e9681e5
@ -4775,6 +4775,81 @@
|
|||||||
"type": "class",
|
"type": "class",
|
||||||
"examples": []
|
"examples": []
|
||||||
},
|
},
|
||||||
|
{
|
||||||
|
"subheads": [],
|
||||||
|
"description": "Create a source and add it as a sceneitem to a scene.",
|
||||||
|
"param": [
|
||||||
|
"{String} `sourceName` Source name.",
|
||||||
|
"{String} `sourceKind` Source kind, Eg. `vlc_source`.",
|
||||||
|
"{String} `sceneName` Scene to add the new source to.",
|
||||||
|
"{Object (optional)} `sourceSettings` Source settings data.",
|
||||||
|
"{boolean (optional)} `setVisible` Set the created SceneItem as visible or not. Defaults to true"
|
||||||
|
],
|
||||||
|
"return": "{int} `itemId` ID of the SceneItem in the scene.",
|
||||||
|
"api": "requests",
|
||||||
|
"name": "CreateSource",
|
||||||
|
"category": "sources",
|
||||||
|
"since": "unreleased",
|
||||||
|
"returns": [
|
||||||
|
{
|
||||||
|
"type": "int",
|
||||||
|
"name": "itemId",
|
||||||
|
"description": "ID of the SceneItem in the scene."
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"params": [
|
||||||
|
{
|
||||||
|
"type": "String",
|
||||||
|
"name": "sourceName",
|
||||||
|
"description": "Source name."
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"type": "String",
|
||||||
|
"name": "sourceKind",
|
||||||
|
"description": "Source kind, Eg. `vlc_source`."
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"type": "String",
|
||||||
|
"name": "sceneName",
|
||||||
|
"description": "Scene to add the new source to."
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"type": "Object (optional)",
|
||||||
|
"name": "sourceSettings",
|
||||||
|
"description": "Source settings data."
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"type": "boolean (optional)",
|
||||||
|
"name": "setVisible",
|
||||||
|
"description": "Set the created SceneItem as visible or not. Defaults to true"
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"names": [
|
||||||
|
{
|
||||||
|
"name": "",
|
||||||
|
"description": "CreateSource"
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"categories": [
|
||||||
|
{
|
||||||
|
"name": "",
|
||||||
|
"description": "sources"
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"sinces": [
|
||||||
|
{
|
||||||
|
"name": "",
|
||||||
|
"description": "unreleased"
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"heading": {
|
||||||
|
"level": 2,
|
||||||
|
"text": "CreateSource"
|
||||||
|
},
|
||||||
|
"lead": "",
|
||||||
|
"type": "class",
|
||||||
|
"examples": []
|
||||||
|
},
|
||||||
{
|
{
|
||||||
"subheads": [],
|
"subheads": [],
|
||||||
"description": "List all sources available in the running OBS instance",
|
"description": "List all sources available in the running OBS instance",
|
||||||
|
@ -151,6 +151,7 @@ You can also refer to any of the client libraries listed on the [README](README.
|
|||||||
+ [GetMediaState](#getmediastate)
|
+ [GetMediaState](#getmediastate)
|
||||||
* [Sources](#sources-1)
|
* [Sources](#sources-1)
|
||||||
+ [GetMediaSourcesList](#getmediasourceslist)
|
+ [GetMediaSourcesList](#getmediasourceslist)
|
||||||
|
+ [CreateSource](#createsource)
|
||||||
+ [GetSourcesList](#getsourceslist)
|
+ [GetSourcesList](#getsourceslist)
|
||||||
+ [GetSourceTypesList](#getsourcetypeslist)
|
+ [GetSourceTypesList](#getsourcetypeslist)
|
||||||
+ [GetVolume](#getvolume)
|
+ [GetVolume](#getvolume)
|
||||||
@ -1966,6 +1967,33 @@ _No specified parameters._
|
|||||||
| `mediaSources.*.mediaState` | _String_ | The current state of media for that source. States: `none`, `playing`, `opening`, `buffering`, `paused`, `stopped`, `ended`, `error`, `unknown` |
|
| `mediaSources.*.mediaState` | _String_ | The current state of media for that source. States: `none`, `playing`, `opening`, `buffering`, `paused`, `stopped`, `ended`, `error`, `unknown` |
|
||||||
|
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### CreateSource
|
||||||
|
|
||||||
|
|
||||||
|
- Unreleased
|
||||||
|
|
||||||
|
Create a source and add it as a sceneitem to a scene.
|
||||||
|
|
||||||
|
**Request Fields:**
|
||||||
|
|
||||||
|
| Name | Type | Description |
|
||||||
|
| ---- | :---: | ------------|
|
||||||
|
| `sourceName` | _String_ | Source name. |
|
||||||
|
| `sourceKind` | _String_ | Source kind, Eg. `vlc_source`. |
|
||||||
|
| `sceneName` | _String_ | Scene to add the new source to. |
|
||||||
|
| `sourceSettings` | _Object (optional)_ | Source settings data. |
|
||||||
|
| `setVisible` | _boolean (optional)_ | Set the created SceneItem as visible or not. Defaults to true |
|
||||||
|
|
||||||
|
|
||||||
|
**Response Items:**
|
||||||
|
|
||||||
|
| Name | Type | Description |
|
||||||
|
| ---- | :---: | ------------|
|
||||||
|
| `itemId` | _int_ | ID of the SceneItem in the scene. |
|
||||||
|
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
### GetSourcesList
|
### GetSourcesList
|
||||||
|
Loading…
x
Reference in New Issue
Block a user