NDI HX Plugin 1.x API documentation

The Plugin utilizes the NDI® HX2 protocol to display the camera in the network, livestream both in HQ and LQ, and control the tally light as well as PTZ positions.

Sample API requests to Postman can be downloaded here

How to get and change the whole configuration of the application

The application has eight parameters.

ndiNameThis is the name of the NDI source to create. It is a NULL-terminated UTF-8 string. This will be the name of the NDI source on the network. For instance, if your network machine name is called “MyMachine” and you specify this parameter as “My Video”, the NDI source on the network would be “MyMachine (My Video)”.
ndiGroups This parameter represents the groups that this NDI sender should place itself into. Groups are sets of NDI sources. Any source can be part of any number of groups, and groups are comma-separated. For instance "cameras, studio 1,10am show" would place a source in the three groups named. On the finding side, you can specify which groups to look for and look in multiple groups. If the group is NULL then the system default groups will be used.
channel number of the camera channel (View Area or Sensor), starts from number 1
width width of the required video
height height of the required video
fps number of frames per second
gop number of frames after which is the key frame sent
audioEnabled parameter to turn audio off and on

Get configuration

Complete settings of the application in JSON format can be obtained with GET call below.

http://USER:PASS@IPADDR[:PORT]/local/ndihxplugin/settings.cgi?action=get

where

USER is an user name. E.g. root
PASS is a password . E.g. pass
IPADDR[:PORT] is an IP address:port of the camera. E.g. 192.168.1.5

Example of what you get:

{
"ndiName": "P1375",
"ndiGroups": "",
"channel": 2,
"width": 1920,
"height": 1080,
"fps": 50,
"gop": 101,
"audioEnabled": false
}

Set the configuration

If you want to update your settings, you must use POST call.

http://USER:PASS@IPADDR[:PORT]/local/ndihxplugin/settings.cgi?action=set

where

USER is an user name. E.g. root
PASS is a password . E.g. pass
IPADDR[:PORT] is an IP address:port of the camera. E.g. 192.168.1.5