docs(ci): Update protocol.md - 77f6335 [skip ci]

This commit is contained in:
Azure CI 2021-03-19 05:03:26 +00:00
parent 77f63359f6
commit 2be20a9179
2 changed files with 196 additions and 1 deletions

View File

@ -2118,7 +2118,8 @@
"description": "The volume of a source has changed.",
"return": [
"{String} `sourceName` Source name",
"{float} `volume` Source volume"
"{float} `volume` Source volume",
"{float} `volumeDb` Source volume in Decibel"
],
"api": "events",
"name": "SourceVolumeChanged",
@ -2134,6 +2135,11 @@
"type": "float",
"name": "volume",
"description": "Source volume"
},
{
"type": "float",
"name": "volumeDb",
"description": "Source volume in Decibel"
}
],
"names": [
@ -5337,6 +5343,142 @@
"type": "class",
"examples": []
},
{
"subheads": [],
"description": "Changes whether an audio track is active for a source.",
"param": [
"{String} `sourceName` Source name.",
"{int} `track` Audio tracks 1-6.",
"{boolean} `active` Whether audio track is active or not."
],
"api": "requests",
"name": "SetTracks",
"category": "sources",
"since": "unreleased",
"params": [
{
"type": "String",
"name": "sourceName",
"description": "Source name."
},
{
"type": "int",
"name": "track",
"description": "Audio tracks 1-6."
},
{
"type": "boolean",
"name": "active",
"description": "Whether audio track is active or not."
}
],
"names": [
{
"name": "",
"description": "SetTracks"
}
],
"categories": [
{
"name": "",
"description": "sources"
}
],
"sinces": [
{
"name": "",
"description": "unreleased"
}
],
"heading": {
"level": 2,
"text": "SetTracks"
},
"lead": "",
"type": "class",
"examples": []
},
{
"subheads": [],
"description": "Gets whether an audio track is active for a source.",
"param": "{String} `sourceName` Source name.",
"return": [
"{boolean} `track1`",
"{boolean} `track2`",
"{boolean} `track3`",
"{boolean} `track4`",
"{boolean} `track5`",
"{boolean} `track6`"
],
"api": "requests",
"name": "GetTracks",
"category": "sources",
"since": "unreleased",
"returns": [
{
"type": "boolean",
"name": "track1",
"description": ""
},
{
"type": "boolean",
"name": "track2",
"description": ""
},
{
"type": "boolean",
"name": "track3",
"description": ""
},
{
"type": "boolean",
"name": "track4",
"description": ""
},
{
"type": "boolean",
"name": "track5",
"description": ""
},
{
"type": "boolean",
"name": "track6",
"description": ""
}
],
"params": [
{
"type": "String",
"name": "sourceName",
"description": "Source name."
}
],
"names": [
{
"name": "",
"description": "GetTracks"
}
],
"categories": [
{
"name": "",
"description": "sources"
}
],
"sinces": [
{
"name": "",
"description": "unreleased"
}
],
"heading": {
"level": 2,
"text": "GetTracks"
},
"lead": "",
"type": "class",
"examples": []
},
{
"subheads": [],
"description": "Get the mute status of a specified source.",

View File

@ -161,6 +161,8 @@ You can also refer to any of the client libraries listed on the [README](README.
+ [GetSourceTypesList](#getsourcetypeslist)
+ [GetVolume](#getvolume)
+ [SetVolume](#setvolume)
+ [SetTracks](#settracks)
+ [GetTracks](#gettracks)
+ [GetMute](#getmute)
+ [SetMute](#setmute)
+ [ToggleMute](#togglemute)
@ -947,6 +949,7 @@ The volume of a source has changed.
| ---- | :---: | ------------|
| `sourceName` | _String_ | Source name |
| `volume` | _float_ | Source volume |
| `volumeDb` | _float_ | Source volume in Decibel |
---
@ -2171,6 +2174,56 @@ Set the volume of the specified source. Default request format uses mul, NOT SLI
_No additional response items._
---
### SetTracks
- Unreleased
Changes whether an audio track is active for a source.
**Request Fields:**
| Name | Type | Description |
| ---- | :---: | ------------|
| `sourceName` | _String_ | Source name. |
| `track` | _int_ | Audio tracks 1-6. |
| `active` | _boolean_ | Whether audio track is active or not. |
**Response Items:**
_No additional response items._
---
### GetTracks
- Unreleased
Gets whether an audio track is active for a source.
**Request Fields:**
| Name | Type | Description |
| ---- | :---: | ------------|
| `sourceName` | _String_ | Source name. |
**Response Items:**
| Name | Type | Description |
| ---- | :---: | ------------|
| `track1` | _boolean_ | |
| `track2` | _boolean_ | |
| `track3` | _boolean_ | |
| `track4` | _boolean_ | |
| `track5` | _boolean_ | |
| `track6` | _boolean_ | |
---
### GetMute