mirror of
https://github.com/Palakis/obs-websocket.git
synced 2024-08-30 18:12:16 +00:00
docs(ci): Update protocol.md - e9c17c9 [skip ci]
This commit is contained in:
parent
e9c17c9a1d
commit
590943ed95
@ -7624,6 +7624,104 @@
|
|||||||
"type": "class",
|
"type": "class",
|
||||||
"examples": []
|
"examples": []
|
||||||
},
|
},
|
||||||
|
{
|
||||||
|
"subheads": [],
|
||||||
|
"description": "Get the audio monitoring type of the specified source.",
|
||||||
|
"param": "{String} `sourceName` Source name.",
|
||||||
|
"return": "{String} `monitorType` The monitor type in use. Options: `none`, `monitorOnly`, `monitorAndOutput`.",
|
||||||
|
"api": "requests",
|
||||||
|
"name": "GetAudioMonitorType",
|
||||||
|
"category": "sources",
|
||||||
|
"since": "4.8.0",
|
||||||
|
"returns": [
|
||||||
|
{
|
||||||
|
"type": "String",
|
||||||
|
"name": "monitorType",
|
||||||
|
"description": "The monitor type in use. Options: `none`, `monitorOnly`, `monitorAndOutput`."
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"params": [
|
||||||
|
{
|
||||||
|
"type": "String",
|
||||||
|
"name": "sourceName",
|
||||||
|
"description": "Source name."
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"names": [
|
||||||
|
{
|
||||||
|
"name": "",
|
||||||
|
"description": "GetAudioMonitorType"
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"categories": [
|
||||||
|
{
|
||||||
|
"name": "",
|
||||||
|
"description": "sources"
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"sinces": [
|
||||||
|
{
|
||||||
|
"name": "",
|
||||||
|
"description": "4.8.0"
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"heading": {
|
||||||
|
"level": 2,
|
||||||
|
"text": "GetAudioMonitorType"
|
||||||
|
},
|
||||||
|
"lead": "",
|
||||||
|
"type": "class",
|
||||||
|
"examples": []
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"subheads": [],
|
||||||
|
"description": "Set the audio monitoring type of the specified source.",
|
||||||
|
"param": [
|
||||||
|
"{String} `sourceName` Source name.",
|
||||||
|
"{String} `monitorType` The monitor type to use. Options: `none`, `monitorOnly`, `monitorAndOutput`."
|
||||||
|
],
|
||||||
|
"api": "requests",
|
||||||
|
"name": "SetAudioMonitorType",
|
||||||
|
"category": "sources",
|
||||||
|
"since": "4.8.0",
|
||||||
|
"params": [
|
||||||
|
{
|
||||||
|
"type": "String",
|
||||||
|
"name": "sourceName",
|
||||||
|
"description": "Source name."
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"type": "String",
|
||||||
|
"name": "monitorType",
|
||||||
|
"description": "The monitor type to use. Options: `none`, `monitorOnly`, `monitorAndOutput`."
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"names": [
|
||||||
|
{
|
||||||
|
"name": "",
|
||||||
|
"description": "SetAudioMonitorType"
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"categories": [
|
||||||
|
{
|
||||||
|
"name": "",
|
||||||
|
"description": "sources"
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"sinces": [
|
||||||
|
{
|
||||||
|
"name": "",
|
||||||
|
"description": "4.8.0"
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"heading": {
|
||||||
|
"level": 2,
|
||||||
|
"text": "SetAudioMonitorType"
|
||||||
|
},
|
||||||
|
"lead": "",
|
||||||
|
"type": "class",
|
||||||
|
"examples": []
|
||||||
|
},
|
||||||
{
|
{
|
||||||
"subheads": [],
|
"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.",
|
"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.",
|
||||||
|
@ -191,6 +191,8 @@ auth_response = base64_encode(auth_response_hash)
|
|||||||
+ [MoveSourceFilter](#movesourcefilter)
|
+ [MoveSourceFilter](#movesourcefilter)
|
||||||
+ [SetSourceFilterSettings](#setsourcefiltersettings)
|
+ [SetSourceFilterSettings](#setsourcefiltersettings)
|
||||||
+ [SetSourceFilterVisibility](#setsourcefiltervisibility)
|
+ [SetSourceFilterVisibility](#setsourcefiltervisibility)
|
||||||
|
+ [GetAudioMonitorType](#getaudiomonitortype)
|
||||||
|
+ [SetAudioMonitorType](#setaudiomonitortype)
|
||||||
+ [TakeSourceScreenshot](#takesourcescreenshot)
|
+ [TakeSourceScreenshot](#takesourcescreenshot)
|
||||||
* [Streaming](#streaming-1)
|
* [Streaming](#streaming-1)
|
||||||
+ [GetStreamingStatus](#getstreamingstatus)
|
+ [GetStreamingStatus](#getstreamingstatus)
|
||||||
@ -2910,6 +2912,50 @@ Change the visibility/enabled state of a filter
|
|||||||
| `filterEnabled` | _Boolean_ | New filter state |
|
| `filterEnabled` | _Boolean_ | New filter state |
|
||||||
|
|
||||||
|
|
||||||
|
**Response Items:**
|
||||||
|
|
||||||
|
_No additional response items._
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### GetAudioMonitorType
|
||||||
|
|
||||||
|
|
||||||
|
- Added in v4.8.0
|
||||||
|
|
||||||
|
Get the audio monitoring type of the specified source.
|
||||||
|
|
||||||
|
**Request Fields:**
|
||||||
|
|
||||||
|
| Name | Type | Description |
|
||||||
|
| ---- | :---: | ------------|
|
||||||
|
| `sourceName` | _String_ | Source name. |
|
||||||
|
|
||||||
|
|
||||||
|
**Response Items:**
|
||||||
|
|
||||||
|
| Name | Type | Description |
|
||||||
|
| ---- | :---: | ------------|
|
||||||
|
| `monitorType` | _String_ | The monitor type in use. Options: `none`, `monitorOnly`, `monitorAndOutput`. |
|
||||||
|
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### SetAudioMonitorType
|
||||||
|
|
||||||
|
|
||||||
|
- Added in v4.8.0
|
||||||
|
|
||||||
|
Set the audio monitoring type of the specified source.
|
||||||
|
|
||||||
|
**Request Fields:**
|
||||||
|
|
||||||
|
| Name | Type | Description |
|
||||||
|
| ---- | :---: | ------------|
|
||||||
|
| `sourceName` | _String_ | Source name. |
|
||||||
|
| `monitorType` | _String_ | The monitor type to use. Options: `none`, `monitorOnly`, `monitorAndOutput`. |
|
||||||
|
|
||||||
|
|
||||||
**Response Items:**
|
**Response Items:**
|
||||||
|
|
||||||
_No additional response items._
|
_No additional response items._
|
||||||
|
Loading…
x
Reference in New Issue
Block a user