From ed29ec528d7169ea68695652183292fa83a9fe99 Mon Sep 17 00:00:00 2001 From: Azure CI <> Date: Tue, 26 May 2020 11:58:51 +0000 Subject: [PATCH] docs(ci): Update protocol.md - 481b26d [skip ci] --- docs/generated/comments.json | 49 ++++++++++++++++++++++++++++++++++++ docs/generated/protocol.md | 24 ++++++++++++++++++ 2 files changed, 73 insertions(+) diff --git a/docs/generated/comments.json b/docs/generated/comments.json index 5c74beb4..104a2167 100644 --- a/docs/generated/comments.json +++ b/docs/generated/comments.json @@ -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.", diff --git a/docs/generated/protocol.md b/docs/generated/protocol.md index 5ea71f45..deefbb4c 100644 --- a/docs/generated/protocol.md +++ b/docs/generated/protocol.md @@ -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._