/api/ndi/receiver-info
Use the interface to obtain NDI RX information.
Request Mode
POST /api/ndi/receiver-info
Response Body
{
"status": 0,
"discovery-server": "",
"group": "",
"extra-ips": "",
"ndi": [
{
"uid": 1,
"enable": true,
"is-find": true,
"alias": "DESKTOP-KN2V7CQ (Intel UHD Graphics 630 1)",
"ndi-name": "DESKTOP-KN2V7CQ (Intel UHD Graphics 630 1)",
"url": "10.10.14.202:5961",
"audio-standard": 0,
"buffer-duration": 60,
"headroom-db": -20,
"format": {
"sample-rate": 48000,
"channel-num": 2,
"bit-depth": 32
},
"report": {
"audio-jitter": 22222,
"audio-kbps": 3000,
"is-connected": true,
"living-time-ms": 6442306,
"module-name": "mws_ndi_src_0",
"module-type": 33,
"video-jitter": 0,
"video-kbps": 0
}
}
]
}
| Name | Description |
|---|---|
| status | 0 indicates that the request was accepted successfully. Refer to API Status Codes. |
| discovery-server | Discovery Server. |
| group | NDI group. |
| extra-ips | IP address of extra sources. |
| ndi[i].uid | Unique ID, non-0 value. |
| ndi[i].enable | True: enable NDI. False: disable NDI. |
| ndi[i].is-find | True indicates NDI source is found via discovery server, otherwise it is false. |
| ndi[i].alias | Alias. |
| ndi[i].ndi-name | NDI name. |
| ndi[i].url | NDI device URL. |
| ndi[i].audio-standard | Audio-standard. 0: SMPTE 1: EBU |
| ndi[i].buffer-duration | Buffer time within [1,120], in milliseconds. |
| ndi[i].headroom-db | Headroom, in decibels |
| ndi[i].format.sample-rate | Sample rate. |
| ndi[i].format.channel-num | Number of channels. |
| ndi[i].format.bit-depth | Bit depth. |
| ndi[i].report | Running report. |