set-video-config
Use the interface to modify the video settings.
HTTP Request
GET http://ip/mwapi?method=set-video-config¶m1=value1¶m2=value2...
Response Body
{
"status": 0
}
| Name | Description |
|---|---|
| status | 0 indicates that the request was accepted successfully. Refer to API Status Codes to find specific description for other values. |
Example
1. Set OSD
http://ip/mwapi?method=set-video-config&show-title=true&show-tally=true&show-vu-meter=true&vu-meter-mode=dbu&safe-area-mode=4:3&show-center-cross=true
| Parameter | Description |
|---|---|
| method | set-video-config |
| show-title | True indicates to overlay the name and resolution of the video source on the output, otherwise it is false. |
| show-tally | True indicates to overlay the Tally light status of selected NDI stream on the output, otherwise it is false. |
| show-vu-meter | True indicates to overlay the VU meter, a volume bar, on the output, otherwise it is false. |
| vu-meter-mode | Specify the measurement of the volume, including none, dbu, dbvu, dbfs, if audio gain is set, the post-gain-dbu, post-gain-dbvu, and post-gain-dbfs will show the gain effect. |
| show-vu-meter | True indicates to show the VU meter, otherwise it is false. |
| vu-meter-mode | Specify the measurement of the volume, including none, db, post-gain-db, post-gain-dbfs. |
| show-center-cross | True indicates to overlay a center cross on the output which determines the center position of the entire image, otherwise it is false. |
| safe-area-mode | Specify the dimension of a rectangular to mark the most important part of the picture which can be seen by the majority presentation device, including none, 4:3, 80%, and square. |
| ident-mode | Set to show/hide the device name or ident text that overlays the output, including none, ident-text, device-name. |
| ident-text | Specify digital label 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. |
2. Set video process
http://ip/mwapi?method=set-video-config&h-flip=false&v-flip=false&deinterlace-mode=weave&ar-convert-mode=full&alpha-disp-mode=alpha-blend-checkerboard
| Parameter | Description |
|---|---|
| method | set-video-config |
| h-flip | True indicates to set a mirror effect, otherwise it is false. |
| v-flip | True indicates to reverse the active image vertically, otherwise it is false. |
| deinterlace-mode | Convert interlaced video into a progressive form using bob or weave method. |
| ar-convert-mode | Specify the method to convert the aspect ratio of the decoded video. Options are windowbox, full and zoom. |
| alpha-disp-mode | Specify the background for the alpha channel display. Options are alpha-only, alpha-blend-white, alpha-blend-black, alpha-blend-checkerboard. |
3. Set video source
http://ip/mwapi?method=set-video-config&in-auto-color-fmt=false&in-color-fmt=bt.709&switch-mode=blank
| Parameter | Description |
|---|---|
| method | set-video-config |
| 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 | Specify the color space to bt.601 or bt.709. |
| switch-mode | Specify the image to either black screen(blank) or the last picture of the previous video(keep-last) when the NDI source is changed. |
4. Set whether to keep the output resolution consistent with that of the input source
http://ip/mwapi?method=set-video-config&follow-input-mode=false
| Name | Description |
|---|---|
| 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. |