Get audio level
1. API Description
This API is used to get the real-time audio level of current scene.
Request mode:
- V2.6.0 and above: POST [ip]/mwapi/V2.0/audio/get-vumeter-info
- V2.5.0 and below: POST [ip]/mwapi/get-vumeter-info
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 audio |
input | Array of InputData | Array of input audio |
OutputData
Name | Type | Description |
---|---|---|
id | Int | The unique identifier of audio 1: Master |
vu_left | Int | Left channel audio level |
vu_right | Int | Right channel audio level |
inCurrentScene | Boolean | Whether it is mixed into the current scene 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 |
vu_left | Int | Left channel audio level |
vu_right | Int | Right channel audio level |
inCurrentScene | Boolean | Whether it is mixed into the current scene true: Yes; false: No |
4. Example
Getting the real-time audio level of current scene.
Input Example
None
Output Example
{
"status": 0,
"output": [
{
"id": 1,
"vu_left": -100,
"vu_right": -100,
"inCurrentScene": true
}
],
"input": [
{
"id": 11,
"vu_left": -100,
"vu_right": -100,
"inCurrentScene": true
},
{
"id": 14,
"vu_left": -100,
"vu_right": -100,
"inCurrentScene": true
},
{
"id": 17,
"vu_left": -100,
"vu_right": -100,
"inCurrentScene": true
},
{
"id": 18,
"vu_left": -100,
"vu_right": -100,
"inCurrentScene": true
},
{
"id": 21,
"vu_left": -100,
"vu_right": -100,
"inCurrentScene": true
},
{
"id": 12,
"vu_left": -100,
"vu_right": -100,
"inCurrentScene": false
},
{
"id": 13,
"vu_left": -100,
"vu_right": -100,
"inCurrentScene": false
},
{
"id": 19,
"vu_left": -100,
"vu_right": -100,
"inCurrentScene": false
},
{
"id": 20,
"vu_left": -100,
"vu_right": -100,
"inCurrentScene": false
}
]
}
5. Error Code
No error code related to the API business logic. For other error codes, see Common Error Codes.