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 - 8a8ea92 [skip ci]

Browse Source
This commit is contained in:
Azure CI 2020-12-20 06:20:47 +00:00
parent 8a8ea92140
commit d77e4ab10d
2 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
docs/generated/comments.json
View File

@ -5059,7 +5059,7 @@
], ],
"return": [ "return": [
"{String} `name` Source name.", "{String} `name` Source name.",
"{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).", "{double} `volume` Volume of the source. Between `0.0` and `20.0` if using mul, under `26.0` if using dB.",
"{boolean} `muted` Indicates whether the source is muted." "{boolean} `muted` Indicates whether the source is muted."
], ],
"api": "requests", "api": "requests",
@ -5075,7 +5075,7 @@
{ {
"type": "double", "type": "double",
"name": "volume", "name": "volume",
"description": "Volume of the source. Between `0.0` and `1.0` if using mul, under `0.0` if using dB (since it is attenuating)." "description": "Volume of the source. Between `0.0` and `20.0` if using mul, under `26.0` if using dB."
}, },
{ {
"type": "boolean", "type": "boolean",
@ -5126,7 +5126,7 @@
"description": "Set the volume of the specified source. Default request format uses mul, NOT SLIDER PERCENTAGE.", "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` for mul, and under 0.0 for dB. Note: OBS will interpret dB values under -100.0 as Inf.", "{double} `volume` Desired volume. Must be between `0.0` and `20.0` for mul, and under 26.0 for dB. OBS will interpret dB values under -100.0 as Inf. Note: The OBS volume sliders only reach a maximum of 1.0mul/0.0dB, however OBS actually supports larger values.",
"{boolean (optional)} `useDecibel` Interperet `volume` data as decibels instead of amplitude/mul." "{boolean (optional)} `useDecibel` Interperet `volume` data as decibels instead of amplitude/mul."
], ],
"api": "requests", "api": "requests",
@ -5142,7 +5142,7 @@
{ {
"type": "double", "type": "double",
"name": "volume", "name": "volume",
"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." "description": "Desired volume. Must be between `0.0` and `20.0` for mul, and under 26.0 for dB. OBS will interpret dB values under -100.0 as Inf. Note: The OBS volume sliders only reach a maximum of 1.0mul/0.0dB, however OBS actually supports larger values."
}, },
{ {
"type": "boolean (optional)", "type": "boolean (optional)",

4
docs/generated/protocol.md
View File

@ -2083,7 +2083,7 @@ Get the volume of the specified source. Default response uses mul format, NOT SL
| 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` if using mul, under `0.0` if using dB (since it is attenuating). | | `volume` | _double_ | Volume of the source. Between `0.0` and `20.0` if using mul, under `26.0` if using dB. |
| `muted` | _boolean_ | Indicates whether the source is muted. | | `muted` | _boolean_ | Indicates whether the source is muted. |
@ -2101,7 +2101,7 @@ Set the volume of the specified source. Default request format uses mul, NOT SLI
| 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` for mul, and under 0.0 for dB. Note: OBS will interpret dB values under -100.0 as Inf. | | `volume` | _double_ | Desired volume. Must be between `0.0` and `20.0` for mul, and under 26.0 for dB. OBS will interpret dB values under -100.0 as Inf. Note: The OBS volume sliders only reach a maximum of 1.0mul/0.0dB, however OBS actually supports larger values. |
| `useDecibel` | _boolean (optional)_ | Interperet `volume` data as decibels instead of amplitude/mul. | | `useDecibel` | _boolean (optional)_ | Interperet `volume` data as decibels instead of amplitude/mul. |