Get Video Configuration
1. API Description
Get video configuration information.
Request mode: GET [ip]/api/video/config/get
| Administrator Rights | Login Authentication |
|---|---|
| No | Yes |
2. Input Parameters
None
3. Output Parameters
| Parameter | Type | Description |
|---|---|---|
| status | Int | Status code |
| enable-follow-input | Boolean | Whether the output resolution can be configured to match the input |
| follow-input | Boolean | Whether the output resolution matches the input |
| show-title | Boolean | Whether to display source name and resolution |
| enable-webrtc | Boolean | Whether to enable webrtc preview |
| screen-debug | Boolean | Whether to enable on-screen debugging information |
| ident-mode | Int | Identifier Display Mode |
| ident-text | String | Identifier text |
| show-tally | Boolean | Whether to display NDI status tags (preview or program). |
| show-vu-meter | Boolean | Whether to display volume bars |
| vu-meter-mode | Int | Volume meter mode, 0: hide, 1: post dbvu (or dbu), 2: post-dbfs |
| show-center-cross | Boolean | Whether to display center lines. |
| safe-area | Int | 0: none, 1: 4:3, 2: 80% center view, 3: square |
| h-flip | Boolean | Whether to flip horizontally |
| v-flip | Boolean | Whether to flip vertically |
| deinterlace-mode | Int | Deinterlace mode: 0: bob, 1: weave, 2: blend |
| force-deint | Boolean | Boolean value, force deinterlace (even if output is interlaced) |
| ar-convert | Int | 0: Letterbox/Pillarbox, 1: Zoom/Crop, 2: Full Screen |
| hdr-enabled | Boolean | Read-only, whether HDR can be configured |
| hdr-output | Boolean | Enable HDR output (requires monitor support) |
| screen-mode | Int | View Mode |
| color-format | String | Color format, values: rgb, yuv444, yuv422 |
| quant-range | String | Quant range, values: limited, full |
| switch-mode | Int | Set screen display after signal loss: 0 for no signal image, 1 for black screen, 2 for last frame, 3 for turn off output (output turns off 30 seconds after signal loss) |
| in-color-fmt | Int | Set the color space of the signal source: 0 for automatic, 1 for bt601, 2 for bt709, 3 for bt2020 |
4. Example
Output Example
{
"ar-convert": 0,
"color-format": "rgb",
"deinterlace-mode": 0,
"enable-follow-input": false,
"enable-webrtc": true,
"follow-input": false,
"force-deint": false,
"h-flip": false,
"hdr-output": false,
"ident-mode": 2,
"ident-text": "2K HDMI 85",
"in-color-fmt": 2,
"quant-range": "limited",
"safe-area": 0,
"screen-debug": true,
"screen-mode": 1,
"show-center-cross": false,
"show-tally": true,
"show-title": true,
"show-vu-meter": true,
"status": 0,
"switch-mode": 0,
"v-flip": false,
"vu-meter-mode": 1
}