Get configuration of HDMI video source
1. API Description
This API is used to get the configuration information of the HDMI video source.
Request mode:
- V2.6.0 and above: POST [ip]/mwapi/V2.0/input/get-video-config
- V2.5.0 and below: POST [ip]/mwapi/get-video-config
Administrator Rights | Logged-in |
---|---|
No | Yes |
2. Input Parameters
Name | Required | Type | Description |
---|---|---|---|
source-id | Yes | Int | Source ID 0: HDMI 1; 1: HDMI 2 |
3. Output Parameters
Name | Type | Description |
---|---|---|
status | Int | Status code |
in-auto-color-fmt | Boolean | Whether to obtain the color space of input signal automatically true: Yes; false: No |
in-color-fmt | String | The color space value of input signal, including rgb, bt.601, bt.709 and bt.2020 |
in-auto-quant-range | Boolean | Whether to obtain the quantization range of input signal automatically true: Yes; false: No |
in-quant-range | String | The quantization range of input signal, including full and limited |
brightness | Int | Brightness, ranging from -100 to +100 |
contrast | Int | Contrast, ranging from 50 to 200 |
hue | Int | Hue, ranging from -90 to 90 |
saturation | Int | Saturation, ranging from 0 to 200 |
deinterlace | String | Deinterlacing option, including none, bob, motion_adaptive and motion_compensated |
out-mirror | Boolean | Whether the mirror effect is enabled true: Yes; false: No |
4. Example
Getting the configuration information of HDMI 2 video source.
Input Example
{
"source-id": 1
}
Output Example
{
"status": 0,
"in-auto-color-fmt": true,
"in-color-fmt": "rgb",
"in-auto-quant-range": true,
"in-quant-range": "full",
"brightness": 0,
"contrast": 100,
"hue": 0,
"saturation": 100,
"deinterlace": "none",
"out-mirror": false,
}
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 |
49 | MW_STATUS_INVALID_DATA | Incorrect parameter |