Get volume
1. API Description
This API is used to get volume.
Request mode:
- V2.6.0 and above: POST [ip]/mwapi/V2.0/audio/get-volume-config
- V2.5.0 and below: POST [ip]/mwapi/get-volume-config
| Administrator Rights | Logged-in |
|---|---|
| No | Yes |
2. Input Parameters
Null
3. Output Parameters
| Name | Type | Description |
|---|---|---|
| status | Int | Status code |
| output | Array of OutputData | Array of output volume data |
| input | Array of InputData | Array of input volume data |
OutputData
| Name | Type | Description |
|---|---|---|
| id | Int | The unique identifier of audio 1: Master |
| db | Int | Volume, in dB |
| mute | Boolean | Whether it is muted. true: Yes; false: No |
InputData
| Name | Type | Description |
|---|---|---|
| id | Int | The unique identifier of audio 11: Mic; 12: HDMI 1; 13: HDMI 2; 14: BGM; 15: Video in Layer 1; 16: Video in Layer 2; 17: USB-C; 18: Line in; 19: USB Camera; 20: Cast; 21: Web page |
| db | Int | The volume in dB, ranging from -70 to 0 |
| mute | Boolean | Whether it is muted. true: Yes; false: No |
4. Example
Getting the volume.
Input Example
None
Output Example
{
"status": 0,
"output": [
{
"id": 1,
"db": 0,
"mute": false
}
],
"input": [
{
"id": 11,
"db": 0,
"mute": false
},
{
"id": 14,
"db": 0,
"mute": false
},
{
"id": 17,
"db": 0,
"mute": false
},
{
"id": 18,
"db": 0,
"mute": false
},
{
"id": 12,
"db": 0,
"mute": false
},
{
"id": 13,
"db": 0,
"mute": false
},
{
"id": 19,
"db": 0,
"mute": false
},
{
"id": 21,
"db": 0,
"mute": false
}
]
}
5. Error Code
No error code related to the API business logic. For other error codes, see Common Error Codes.