docs(ci): Update protocol.md - 83e23c9 [skip ci]

This commit is contained in:
Azure CI 2021-01-28 23:26:40 +00:00
parent 83e23c9c41
commit cb7c77d29e
2 changed files with 82 additions and 0 deletions

View File

@ -7255,6 +7255,63 @@
"type": "class",
"examples": []
},
{
"subheads": [],
"description": "Get the default settings for a given source type.",
"param": "{String} `sourceKind` Source kind. Also called \"source id\" in libobs terminology.",
"return": [
"{String} `sourceKind` Source kind. Same value as the `sourceKind` parameter.",
"{Object} `defaultSettings` Settings object for source."
],
"api": "requests",
"name": "GetSourceDefaultSettings",
"category": "sources",
"since": "4.9.0",
"returns": [
{
"type": "String",
"name": "sourceKind",
"description": "Source kind. Same value as the `sourceKind` parameter."
},
{
"type": "Object",
"name": "defaultSettings",
"description": "Settings object for source."
}
],
"params": [
{
"type": "String",
"name": "sourceKind",
"description": "Source kind. Also called \"source id\" in libobs terminology."
}
],
"names": [
{
"name": "",
"description": "GetSourceDefaultSettings"
}
],
"categories": [
{
"name": "",
"description": "sources"
}
],
"sinces": [
{
"name": "",
"description": "4.9.0"
}
],
"heading": {
"level": 2,
"text": "GetSourceDefaultSettings"
},
"lead": "",
"type": "class",
"examples": []
},
{
"subheads": [],
"description": "\n\nAt least `embedPictureFormat` or `saveToFilePath` must be specified.\n\nClients can specify `width` and `height` parameters to receive scaled pictures. Aspect ratio is\npreserved if only one of these two parameters is specified.",

View File

@ -183,6 +183,7 @@ You can also refer to any of the client libraries listed on the [README](README.
+ [SetSourceFilterVisibility](#setsourcefiltervisibility)
+ [GetAudioMonitorType](#getaudiomonitortype)
+ [SetAudioMonitorType](#setaudiomonitortype)
+ [GetSourceDefaultSettings](#getsourcedefaultsettings)
+ [TakeSourceScreenshot](#takesourcescreenshot)
* [Outputs](#outputs)
+ [ListOutputs](#listoutputs)
@ -2810,6 +2811,30 @@ Set the audio monitoring type of the specified source.
_No additional response items._
---
### GetSourceDefaultSettings
- Added in v4.9.0
Get the default settings for a given source type.
**Request Fields:**
| Name | Type | Description |
| ---- | :---: | ------------|
| `sourceKind` | _String_ | Source kind. Also called "source id" in libobs terminology. |
**Response Items:**
| Name | Type | Description |
| ---- | :---: | ------------|
| `sourceKind` | _String_ | Source kind. Same value as the `sourceKind` parameter. |
| `defaultSettings` | _Object_ | Settings object for source. |
---
### TakeSourceScreenshot