/api/tx/live-info
Use the interface to get information of all TX streams.
Request Mode
POST /api/tx/live-info
Response Body
{
"stream-no-max": 2,
"streaming-count-max": 16,
"streaming-count": 3,
"streaming": [
{
"uid": 3,
"enable": true,
"name": "RTSP Server",
"stream-no": "Stream1",
"type": "rtsp",
"rtsp": {
"bind-port": 554,
"max-client-num": 8,
"key": "aud",
"enable-auth": false,
"username": "",
"password": ""
},
"aac-bitrate-kbps": "128",
"report": {
"clients-status": [
{
"audio-lost-percent": 5847.757058208435,
"audio-lost-total": 16777215,
"bitrate-kbps": 125,
"living-time-ms": 65359,
"name": "10.10.14.202",
"peer-audio-port": 63398,
"peer-rtsp-port": 56881,
"peer-video-port": 0,
"transport": "udp",
"video-lost-percent": 0.0,
"video-lost-total": 0
}
],
"living-time-ms": 143812,
"module-name": "mws_rtsp_sink_0",
"module-type": 98,
"num-clients": 1
}
},
{
"uid": 11,
"enable": true,
"name": "NDI",
"stream-no": "Stream1",
"type": "ndi",
"ndi": {
"source-name": "test11",
"group-name": "public",
"enable-full": true,
"audio-standard": "SMPTE",
"enable-discovery": false,
"discovery-server": "",
"transport-mode": "tcp-unicast",
"mcast-addr": "",
"mcast-mask": "",
"mcast-ttl": 4,
"enable-fail-over": false,
"fail-over-ndi-name": "",
"fail-over-ip-addr": "",
"enable-web-control": true
},
"aac-bitrate-kbps": "128",
"report": {
"module-name": "mws_ndi_sink_0",
"module-type": 34,
"ndi-name": "PRO-CONVERT-AES67 (test11)",
"num-clients": 0
}
},
{
"uid": 9,
"enable": false,
"name": "TS over SRT",
"stream-no": "Stream2",
"type": "srt",
"srt": {
"mode": "listener",
"dst-ip": "",
"dst-port": 8000,
"bind-port": 10000,
"stream-id": "12/12",
"connect-timeout": 3000,
"retry-duration": 3000,
"latency": 120,
"bandwidth": 25,
"mtu": 1500,
"enc": "disable",
"passphrase": "",
"enable-logo": false
},
"aac-bitrate-kbps": "128",
"report": {
"mode": "listener",
"module-name": "mws_srt_sink_0",
"module-type": 114
}
}
],
"discovery": [
{
"is-ndi": true,
"ndi-name": "DESKTOP-KN2V7CQ (Intel UHD Graphics 630 1)",
"ndi-url": "192.168.65.2:5961"
}
],
"status": 0
}
| Name | Description |
|---|---|
| status | 0 indicates that the request was accepted successfully. Refer to API Status Codes. |
| stream-no-max | Concurrency streams. |
| streaming-count-max | Maximum number of concurrency streams. |
| streaming-count | Number of streams. |
| streaming[i].uid | Unique ID, must be greater than 0. |
| streaming[i].enable | True: enable the stream. False: disable the stream. |
| streaming[i].name | Stream name, the length of which should be within [1, 1023]. |
| streaming[i].stream-no | The chosen stream includes Stream1, Stream2. |
| streaming[i].type | Streaming protocols include rtsp, srt, ndi. |
| streaming[i].rtsp.bind-port | Port for RTSP. |
| streaming[i].rtsp.max-client-num | Maximum number of RTSP connections. |
| streaming[i].rtsp.key | RTSP main stream key, the string length of which should be within [1, 63]. |
| streaming[i].rtsp.enable-auth | True: enable RTSP authentication. False: disable RTSP authentication. |
| streaming[i].rtsp.username | Username for RTSP Authentication, the string length of which should be within [0, 63]. |
| streaming[i].rtsp.password | Password for RTSP Authentication, the string length of which should be within [0, 63]. |
| streaming[i].rtsp.report | Report of RTSP main stream . |
| streaming[i].srt.mode | Connection mode, Caller and listener. |
| streaming[i].srt.dst-ip | Destination IP address for TS over caller. |
| streaming[i].srt.dst-port | Destination port for TS over SRT caller, within [1,65535]. |
| streaming[i].srt.bind-port | Binding port for TS over SRT listener, within [1,65535]. |
| streaming[i].srt.stream-id | TS over SRT Stream ID, the string length of which should be within [0,63]. |
| streaming[i].srt.connect-timeout | Connection timeout for TS over SRT, in milliseconds. |
| streaming[i].srt.retry-duration | Retry time for TS over SRT, in milliseconds. |
| streaming[i].srt.latency | Latency for TS over SRT, in milliseconds. |
| streaming[i].srt.bandwidth | Bandwidth for TS over SRT, in percents. |
| streaming[i].srt.mtu | MTU for TS over SRT within [228, 1500]. |
| streaming[i].srt.enc | Encryption algorithms include 0: unencrypted, 16: aes-128, 24: aes-192, 32: aes-256. |
| streaming[i].srt.passphrase | Encryption passphrase, the string length should be within [1,79]. |
| streaming[i].srt.enable-logo | True: display logo image. False: not to display logo image. |
| streaming[i].ndi.source-name | Source name, default value is device serial number. |
| streaming[i].ndi.group-name | NDI group name, default value is public. |
| streaming[i].ndi.enable-full | True: enable NDI FULL. False: disable NDI FULL. |
| streaming[i].ndi.audio-standard | Audio standards include SMPTE and EBU. |
| streaming[i].ndi.enable-discovery | True: enable discovery server. False: disable discovery server. |
| streaming[i].ndi.discovery-server | IP address of discovery server, the string length should be within [1,63]. |
| streaming[i].ndi.transport-mode | Transmit modes include udp-unicast, udp-multicast, rudp-unicast, tcp-unicast, and tcp-multi. |
| streaming[i].ndi.mcast-addr | Multicast address. |
| streaming[i].ndi.mcast-mask | Multicast mask. |
| streaming[i].ndi.mcast-ttl | TTL within [1, 255]. |
| streaming[i].ndi.enable-fail-over | True: enable failover; false: disable failover. |
| streaming[i].ndi.fail-over-ndi-name | Name of the chosen NDI TX for failover, the string length should be within [1,63]. |
| streaming[i].ndi.fail-over-ip-addr | IP address of the chosen NDI TX for failover, the length should be within [1,63]. |
| streaming[i].ndi.enable-web-control | True: enable web control. False: disable web control. |
| streaming[i].aac-bitrate-kbps | AAC bit rate of TX stream. Options are 128, 192, and 256. |
| discovery[i].is-ndi | True: enable auto-discovery NDI, false: disable auto-discovery NDI. |
| discovery[i].ndi-name | Auto-discovery NDI name. |
| discovery[i].ndi-url | Auto-discovery NDI address. |