get-video-config
Use the interface to retrieve the video settings.
HTTP Request
GET http://ip/mwapi?method=get-video-config
| Parameter | Description |
|---|---|
| method | get-video-config |
Response Body
{
"status": 0,
"show-title": false,
"show-tally": false,
"show-vu-meter": true,
"vu-meter-mode": "none",
"show-center-cross": false,
"safe-area-mode": "none",
"ident-mode": "none",
"ident-text": "",
"h-flip": false,
"v-flip": false,
"switch-mode": "blank",
"deinterlace-mode": "bob",
"in-auto-color-fmt": true,
"in-color-fmt": "bt.709",
"ar-convert-mode": "full",
"alpha-disp-mode": "alpha-blend-checkerboard",
"follow-input-mode": true
}
| Name | Description |
|---|---|
| status | 0 indicates that the request was accepted successfully. Refer to API Status Codes to find specific description for other values. |
| show-title | True indicates to show the name and resolution of the source video, otherwise it is false. |
| show-tally | True indicates to show the Tally light status of selected NDI stream on the connected presentation and delivery applications, otherwise it is false. |
| show-vu-meter | True indicates to show the VU meter, otherwise it is false. |
| vu-meter-mode | Shows the measurement of the volume, including none, db, post-gain-db, post-gain-dbfs. |
| show-center-cross | True indicates to show a center cross on the connected presentation and delivery applications which determines the center position of the entire image, otherwise it is false. |
| safe-area-mode | Shows the safe area dimension including none, 4:3, 80%, and square. |
| ident-mode | Indicates to show or hide the device name or ident text that overlays the output, including none, ident-text, device-name. |
| ident-text | Shows the digital label text overlaid on the output. The label text ranges from 1 to 32 characters which contains A to Z, a to z, 0 to 9, and special characters including spaces, dash(_), minus(-) and plus(+) sign. |
| h-flip | True indicates to set a mirror effect for the video, otherwise it is false. |
| v-flip | True indicates to reverse the active image vertically, otherwise it is false. |
| switch-mode | Shows the image, either Black screen(blank) or the last picture of the previous video(keep-last), when the NDI source is changed. |
| deinterlace-mode | Shows the method to convert interlaced video into a progressive form including bob, weave. |
| in-auto-color-fmt | True indicates to auto-set color space, which means the color space will be BT.601 for SD and BT.709 for HD according to the source, otherwise it is false. |
| in-color-fmt | Shows the color space including bt.601 and bt.709. |
| ar-convert-mode | Shows the method to convert the aspect ratio of the decoded video. Options are windowbox, full and zoom. |
| alpha-disp-mode | Shows the background for the alpha channel display. Options are alpha-only, alpha-blend-white, alpha-blend-black, alpha-blend-checkerboard. |
| follow-input-mode | True indicates the output resolution keeps consistent with that of the input source, otherwise it is false. It only applies to NDI to AIO, NDI to HDMI and NDI to SDI. |