set-ndi-config

Use the interface to set NDI configurations.

HTTP Request

GET http://ip/mwapi?method=set-ndi-config&param1=value1&param2=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. Enable NDI

http://ip/mwapi?method=set-ndi-config&enable=true

Parameter	Description
method	set-ndi-config
enable	Indicates whether to enable NDI. If yes, it shows true; otherwise, it is false.

2. Set Source Video

http://ip/mwapi?method=set-ndi-config&source-name=%23%25board-id%25+(%25serial-no%25)+ab&group-name=public

Parameter	Description
method	set-ndi-config
source-name	Indicates the NDI source name used for the converter. %board-id% and %serial-no% are the only supported variables.
group-name	Indicates the group that the converter is multicasted to, separated by commas if there are multiple groups, including public,test, etc.

3. Set Transition Mode

http://ip/mwapi?method=set-ndi-config&enable-mcast=false&enable-tcp=false&enable-udp=false&enable-rudp=true&mcast-addr=239.255.0.0&mcast-mask=255.255.0.0&mcast-ttl=4

Parameter	Description
method	set-ndi-config
enable-mcast	Indicates whether the UDP (Multicast) is enabled. If yes, it shows true; otherwise, it is false.
enable-rudp	Indicates whether the RUDP (Unicast) is enabled. If yes, it shows true; otherwise, it is false.
enable-tcp	Indicates whether the TCP (Multi-connection) is enabled. If yes, it shows true; otherwise, it is false.
enable-udp	Indicates whether the UDP (Unicast) 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 value, that is, the number of hops that a packet travels before being discarded in the local network. The value rages from 1 to 255.

Only one of enable-mcast, enable-rudp, enable-tcp and enable-udp can be true. When all are false, it means that the transmission mode is TCP (Uni-connection).

4. Set Failover

You can obtain the backup channels through the get-ndi-sources interface.

http://ip/mwapi?method=set-ndi-config&enable-fail-over=true&fail-over-ndi-name=02-0+Pro+Capture+HDMI+4K&fail-over-ip-addr=192.168.1.102:5961

Parameter	Description
method	set-ndi-config
enable-fail-over	Indicates whether failover is enabled. If yes, when the source video fails, the backup device begins to provide a service, and 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.

5. Discovery Server

http://ip/mwapi?method=set-ndi-config&enable-discovery=true&discovery-server=192.168.1.115

Parameter	Description
method	set-ndi-config
enable-discovery	True indicates the discovery server is enabled, otherwise it is false.
discovery-server	Indicates the server IP address when discovery server is enabled. Multiple IP addresses should be separated with commas.

6. Audio Reference Level

http://ip/mwapi?method=set-ndi-config&reference-level=20

Parameter	Description
method	set-ndi-config
reference-level	Indicates the audio reference level value. Options are SMPTE: 20 EBU: 14

7. Set Receiver Control

http://ip/mwapi?method=set-ndi-config&enable-ptz-control=true&enable-web-control=false

Parameter	Description
method	set-ndi-config
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-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.

8. Set NDI Vendor

http://ip/mwapi?method=set-ndi-config&vendor-name=Magewell&vendor-id=01234567-0123-0123-0123456789AB

Parameter	Description
method	set-ndi-config
vendor-name	1 to 63 characters
vendor-id	1 to 31 characters

Magewell Pro Convert Encoder