get-ndi-config

Use the interface to obtain NDI configurations.

HTTP Request

GET http://ip/mwapi?method=get-ndi-config
Parameter Description
method get-ndi-config

Response Body

{
 "status": 0,
 "enable": true,
 "source-name": "#%board-id% (%serial-no%)",
 "group-name": "public",
 "enable-web-control": true,
 "enable-ptz-control": false,
 "enable-fail-over": true,
 "fail-over-ndi-name": "",
 "fail-over-ip-addr": "",
 "enable-mcast": false,
 "mcast-addr": "239.255.0.0",
 "mcast-mask": "255.255.0.0",
 "mcast-ttl": 4
}
Name Description
status 0 indicates that the request was accepted successfully. Refer to API Status Codes to find specific description for other values.
enable Indicates whether NDI is enabled. If enabled, it shows true; otherwise, it is false.
source-name Indicates the NDI source name. The %string% is used as variable name and is replace with the board-id and serial-no when displaying.
board-id indicates the unit's rotary switch number. You can change the board-id by operating rotary switch in the unit.
serial-no indicates the unit's serial number (as shown on the barcode label on its surface).
%board-id% and %serial-no% are the only supported variables.
group-name Indicates the NDI group name to which the converter is multicasted.
enable-web-control Indicates whether you can open the Web UI by clicking the gear icon in the NDI Studio Monitor. If yes, it shows true; otherwise, it is false.
enable-ptz-control Indicates whether you can control a connected PTZ camera through the NDI Studio Monitor. If yes, it shows true; otherwise, it is false.
enable-fail-over indicate whether failover function is enabled, which is used to provide a backup device service when the source video failed. If yes, it shows true; otherwise, it is false.
fail-over-ndi-name Indicates the backup NDI channel name.
fail-over-ip-addr Indicates the IP Address of the backup NDI channel.
enable-mcast Indicates whether the multicast is enabled. If yes, it shows true; otherwise, it is false.
mcast-addr Indicates the multicast address.
mcast-mask Indicates the subnet mask for multicast address.
mcast-ttl Indicates the multicast time-to-live, which limits the lifespan or lifetime of data in your network.

results matching ""

    No results matching ""

    results matching ""

      No results matching ""