mirror of
https://github.com/Palakis/obs-websocket.git
synced 2024-08-30 18:12:16 +00:00
docs(travis): Update protocol.md - 047e6e1 [skip ci]
This commit is contained in:
parent
047e6e11bf
commit
661fd4efa8
@ -3278,6 +3278,83 @@
|
||||
"lead": "",
|
||||
"type": "class",
|
||||
"examples": []
|
||||
},
|
||||
{
|
||||
"subheads": [],
|
||||
"description": "Set settings of the specified source.",
|
||||
"param": [
|
||||
"{String} `sourceName` Name of the source item.",
|
||||
"{String (optional)} `sourceType` Type of the specified source. Useful for type-checking to avoid settings a set of settings incompatible with the actual source's type.",
|
||||
"{Object} `sourceSettings` Source settings. Varying between source types."
|
||||
],
|
||||
"return": [
|
||||
"{String} `sourceName` Source name",
|
||||
"{String} `sourceType` Type of the specified source",
|
||||
"{Object} `sourceSettings` Source settings. Varying between source types."
|
||||
],
|
||||
"api": "requests",
|
||||
"name": "GetSourcesList",
|
||||
"category": "sources",
|
||||
"since": "unreleased",
|
||||
"returns": [
|
||||
{
|
||||
"type": "String",
|
||||
"name": "sourceName",
|
||||
"description": "Source name"
|
||||
},
|
||||
{
|
||||
"type": "String",
|
||||
"name": "sourceType",
|
||||
"description": "Type of the specified source"
|
||||
},
|
||||
{
|
||||
"type": "Object",
|
||||
"name": "sourceSettings",
|
||||
"description": "Source settings. Varying between source types."
|
||||
}
|
||||
],
|
||||
"params": [
|
||||
{
|
||||
"type": "String",
|
||||
"name": "sourceName",
|
||||
"description": "Name of the source item."
|
||||
},
|
||||
{
|
||||
"type": "String (optional)",
|
||||
"name": "sourceType",
|
||||
"description": "Type of the specified source. Useful for type-checking to avoid settings a set of settings incompatible with the actual source's type."
|
||||
},
|
||||
{
|
||||
"type": "Object",
|
||||
"name": "sourceSettings",
|
||||
"description": "Source settings. Varying between source types."
|
||||
}
|
||||
],
|
||||
"names": [
|
||||
{
|
||||
"name": "",
|
||||
"description": "GetSourcesList"
|
||||
}
|
||||
],
|
||||
"categories": [
|
||||
{
|
||||
"name": "",
|
||||
"description": "sources"
|
||||
}
|
||||
],
|
||||
"sinces": [
|
||||
{
|
||||
"name": "",
|
||||
"description": "unreleased"
|
||||
}
|
||||
],
|
||||
"heading": {
|
||||
"level": 2,
|
||||
"text": "GetSourcesList"
|
||||
},
|
||||
"lead": "",
|
||||
"type": "class",
|
||||
"examples": []
|
||||
}
|
||||
],
|
||||
"streaming": [
|
||||
@ -3609,14 +3686,14 @@
|
||||
{
|
||||
"subheads": [],
|
||||
"description": "Change the current recording folder.",
|
||||
"param": "{Stsring} `rec-folder` Path of the recording folder.",
|
||||
"param": "{String} `rec-folder` Path of the recording folder.",
|
||||
"api": "requests",
|
||||
"name": "SetRecordingFolder",
|
||||
"category": "recording",
|
||||
"since": "4.1.0",
|
||||
"params": [
|
||||
{
|
||||
"type": "Stsring",
|
||||
"type": "String",
|
||||
"name": "rec-folder",
|
||||
"description": "Path of the recording folder."
|
||||
}
|
||||
|
@ -119,6 +119,7 @@ auth_response = base64_encode(auth_response_hash)
|
||||
+ [GetBrowserSourceProperties](#getbrowsersourceproperties)
|
||||
+ [SetBrowserSourceProperties](#setbrowsersourceproperties)
|
||||
+ [ResetSceneItem](#resetsceneitem)
|
||||
+ [GetSourcesList](#getsourceslist)
|
||||
* [Streaming](#streaming-1)
|
||||
+ [GetStreamingStatus](#getstreamingstatus)
|
||||
+ [StartStopStreaming](#startstopstreaming)
|
||||
@ -1348,6 +1349,33 @@ Reset a source item.
|
||||
|
||||
_No additional response items._
|
||||
|
||||
---
|
||||
|
||||
### GetSourcesList
|
||||
|
||||
|
||||
- Unreleased
|
||||
|
||||
Set settings of the specified source.
|
||||
|
||||
**Request Fields:**
|
||||
|
||||
| Name | Type | Description |
|
||||
| ---- | :---: | ------------|
|
||||
| `sourceName` | _String_ | Name of the source item. |
|
||||
| `sourceType` | _String (optional)_ | Type of the specified source. Useful for type-checking to avoid settings a set of settings incompatible with the actual source's type. |
|
||||
| `sourceSettings` | _Object_ | Source settings. Varying between source types. |
|
||||
|
||||
|
||||
**Response Items:**
|
||||
|
||||
| Name | Type | Description |
|
||||
| ---- | :---: | ------------|
|
||||
| `sourceName` | _String_ | Source name |
|
||||
| `sourceType` | _String_ | Type of the specified source |
|
||||
| `sourceSettings` | _Object_ | Source settings. Varying between source types. |
|
||||
|
||||
|
||||
---
|
||||
|
||||
## Streaming
|
||||
@ -1506,7 +1534,7 @@ Change the current recording folder.
|
||||
|
||||
| Name | Type | Description |
|
||||
| ---- | :---: | ------------|
|
||||
| `rec-folder` | _Stsring_ | Path of the recording folder. |
|
||||
| `rec-folder` | _String_ | Path of the recording folder. |
|
||||
|
||||
|
||||
**Response Items:**
|
||||
|
Loading…
x
Reference in New Issue
Block a user