docs(ci): Update protocol.md - 481b26d [skip ci]

This commit is contained in:
Azure CI 2020-05-26 11:58:51 +00:00
parent 481b26d09d
commit ed29ec528d
2 changed files with 73 additions and 0 deletions

View File

@ -5919,6 +5919,55 @@
"type": "class",
"examples": []
},
{
"subheads": [],
"description": "\n\nNote: If the new name already exists as a source, OBS will automatically modify the name to not interfere.",
"param": [
"{String} `sourceName` Source name.",
"{String} `newName` New source name."
],
"api": "requests",
"name": "SetSourceName",
"category": "sources",
"since": "4.8.0",
"params": [
{
"type": "String",
"name": "sourceName",
"description": "Source name."
},
{
"type": "String",
"name": "newName",
"description": "New source name."
}
],
"names": [
{
"name": "",
"description": "SetSourceName"
}
],
"categories": [
{
"name": "",
"description": "sources"
}
],
"sinces": [
{
"name": "",
"description": "4.8.0"
}
],
"heading": {
"level": 2,
"text": "SetSourceName"
},
"lead": "Sets (aka rename) the name of a source. Also works with scenes since scenes are technically sources in OBS.",
"type": "class",
"examples": []
},
{
"subheads": [],
"description": "Set the audio sync offset of a specified source.",

View File

@ -172,6 +172,7 @@ auth_response = base64_encode(auth_response_hash)
+ [GetMute](#getmute)
+ [SetMute](#setmute)
+ [ToggleMute](#togglemute)
+ [SetSourceName](#setsourcename)
+ [SetSyncOffset](#setsyncoffset)
+ [GetSyncOffset](#getsyncoffset)
+ [GetSourceSettings](#getsourcesettings)
@ -2372,6 +2373,29 @@ Inverts the mute status of a specified source.
| `source` | _String_ | Source name. |
**Response Items:**
_No additional response items._
---
### SetSourceName
- Added in v4.8.0
Note: If the new name already exists as a source, OBS will automatically modify the name to not interfere.
**Request Fields:**
| Name | Type | Description |
| ---- | :---: | ------------|
| `sourceName` | _String_ | Source name. |
| `newName` | _String_ | New source name. |
**Response Items:**
_No additional response items._