Mirrored_Repos/obs-websocket
1
0
Fork 0
mirror of https://github.com/Palakis/obs-websocket.git synced 2024-08-30 18:12:16 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs(ci): Update protocol.md - 33b080b [skip ci]

Browse Source
This commit is contained in:
Azure CI 2020-05-14 20:48:16 +00:00
parent 33b080b3b8
commit 344f5bda69
2 changed files with 27 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
docs/generated/comments.json
View File

@ -5642,11 +5642,14 @@
}, },
{ {
"subheads": [], "subheads": [],
"description": "Get the volume of the specified source.", "description": "Get the volume of the specified source. Default response uses mul format, NOT SLIDER PERCENTAGE.",
"param": "{String} `source` Source name.", "param": [
"{String} `source` Source name.",
"{boolean (optional)} `useDecibel` Output volume in decibels of attenuation instead of amplitude/mul."
],
"return": [ "return": [
"{String} `name` Source name.", "{String} `name` Source name.",
"{double} `volume` Volume of the source. Between `0.0` and `1.0`.", "{double} `volume` Volume of the source. Between `0.0` and `1.0` if using mul, under `0.0` if using dB (since it is attenuating).",
"{boolean} `muted` Indicates whether the source is muted." "{boolean} `muted` Indicates whether the source is muted."
], ],
"api": "requests", "api": "requests",
@ -5662,7 +5665,7 @@
{ {
"type": "double", "type": "double",
"name": "volume", "name": "volume",
"description": "Volume of the source. Between `0.0` and `1.0`." "description": "Volume of the source. Between `0.0` and `1.0` if using mul, under `0.0` if using dB (since it is attenuating)."
}, },
{ {
"type": "boolean", "type": "boolean",
@ -5675,6 +5678,11 @@
"type": "String", "type": "String",
"name": "source", "name": "source",
"description": "Source name." "description": "Source name."
},
{
"type": "boolean (optional)",
"name": "useDecibel",
"description": "Output volume in decibels of attenuation instead of amplitude/mul."
} }
], ],
"names": [ "names": [
@ -5705,10 +5713,11 @@
}, },
{ {
"subheads": [], "subheads": [],
"description": "Set the volume of the specified source.", "description": "Set the volume of the specified source. Default request format uses mul, NOT SLIDER PERCENTAGE.",
"param": [ "param": [
"{String} `source` Source name.", "{String} `source` Source name.",
"{double} `volume` Desired volume. Must be between `0.0` and `1.0`." "{double} `volume` Desired volume. Must be between `0.0` and `1.0` for mul, and under 0.0 for dB. Note: OBS will interpret dB values under -100.0 as Inf.",
"{boolean (optional)} `useDecibel` Interperet `volume` data as decibels instead of amplitude/mul."
], ],
"api": "requests", "api": "requests",
"name": "SetVolume", "name": "SetVolume",
@ -5723,7 +5732,12 @@
{ {
"type": "double", "type": "double",
"name": "volume", "name": "volume",
"description": "Desired volume. Must be between `0.0` and `1.0`." "description": "Desired volume. Must be between `0.0` and `1.0` for mul, and under 0.0 for dB. Note: OBS will interpret dB values under -100.0 as Inf."
},
{
"type": "boolean (optional)",
"name": "useDecibel",
"description": "Interperet `volume` data as decibels instead of amplitude/mul."
} }
], ],
"names": [ "names": [

10
docs/generated/protocol.md
View File

@ -2267,13 +2267,14 @@ _No specified parameters._
- Added in v4.0.0 - Added in v4.0.0
Get the volume of the specified source. Get the volume of the specified source. Default response uses mul format, NOT SLIDER PERCENTAGE.
**Request Fields:** **Request Fields:**
| Name | Type | Description | | Name | Type | Description |
| ---- | :---: | ------------| | ---- | :---: | ------------|
| `source` | _String_ | Source name. | | `source` | _String_ | Source name. |
| `useDecibel` | _boolean (optional)_ | Output volume in decibels of attenuation instead of amplitude/mul. |
**Response Items:** **Response Items:**
@ -2281,7 +2282,7 @@ Get the volume of the specified source.
| Name | Type | Description | | Name | Type | Description |
| ---- | :---: | ------------| | ---- | :---: | ------------|
| `name` | _String_ | Source name. | | `name` | _String_ | Source name. |
| `volume` | _double_ | Volume of the source. Between `0.0` and `1.0`. | | `volume` | _double_ | Volume of the source. Between `0.0` and `1.0` if using mul, under `0.0` if using dB (since it is attenuating). |
| `muted` | _boolean_ | Indicates whether the source is muted. | | `muted` | _boolean_ | Indicates whether the source is muted. |
@ -2292,14 +2293,15 @@ Get the volume of the specified source.
- Added in v4.0.0 - Added in v4.0.0
Set the volume of the specified source. Set the volume of the specified source. Default request format uses mul, NOT SLIDER PERCENTAGE.
**Request Fields:** **Request Fields:**
| Name | Type | Description | | Name | Type | Description |
| ---- | :---: | ------------| | ---- | :---: | ------------|
| `source` | _String_ | Source name. | | `source` | _String_ | Source name. |
| `volume` | _double_ | Desired volume. Must be between `0.0` and `1.0`. | | `volume` | _double_ | Desired volume. Must be between `0.0` and `1.0` for mul, and under 0.0 for dB. Note: OBS will interpret dB values under -100.0 as Inf. |
| `useDecibel` | _boolean (optional)_ | Interperet `volume` data as decibels instead of amplitude/mul. |
**Response Items:** **Response Items:**