Set volume
1. API Description
This API is used to set volume.
Request mode:
- V2.6.0 and above: POST [ip]/mwapi/V2.0/audio/set-volume-config
- V2.5.0 and below: POST [ip]/mwapi/set-volume-config
| Administrator Rights | Logged-in |
|---|---|
| No | Yes |
2. Input Parameters
| Name | Required | Type | Description |
|---|---|---|---|
| id | Yes | Int | The unique identifier of audio, serving as the target for setting volume, which can be obtained via Get volume |
| db | Yes | Int | The volume in dB, ranging from -70 to 0 |
| mute | Yes | Boolean | Whether to mute the audio true: Yes; false: No |
3. Output Parameters
| Name | Type | Description |
|---|---|---|
| status | Int | Status code |
4. Example
Setting the volume of mater to 0dB.
{
"id": 1,
"db": 0,
"mute": false
}
Output Example
{
"status": 0,
}
5. Error Code
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
| Status | Definition | Description |
|---|---|---|
| 7 | MW_STATUS_INVALID_ARG | Missing required parameters |