get-summary-info

Use the interface to retrieve status and parameters of the Pro Convert device, including device information, Ethernet status, USB RNDIS status, and NDI status.

HTTP Request

GET http://ip/mwapi?method=get-summary-info
Parameter Description
method get-summary-info

Response Body

JSON structure is as follows:

{
 "status": 0,
 "device": {...},
 "ethernet": {...},
 "rndis": {...},
 "ndi": {...}
}
1. Request Body
"status": 0
Name Description
status 0 indicates a successful data acquisition. Refer to API Status Codes to find specific description for other values.
2. Basic Information (device {...})
"device": {
 "name": "Pro Convert",
  "model": "NDI to HDMI",
  "serial-no": "101",
  "hw-revision": "A",
  "fw-version": "1.1.157",
  "up-to-date": true,
  "output-state": "connected",
  "cpu-usage": 60.00,
  "memory-usage": 37.46,
  "core-temp": 69.23,
  "board-id": 0,
  "up-time": 19972,
  "sd-size": 0
}
Name Description
name Shows the family name of the Pro Convert unit.
model Shows the model name of the Pro Convert unit.
serial-no Shows the serial number of the Pro Convert unit.
hw-revision Shows the hardware version of the Pro Convert unit, the value ranges from A to Z.
fw-version Shows the current firmware version that’s installed in the Pro Convert unit.
up-to-date True indicates that the firmware is up to date, otherwise it shows false.
output-state Shows whether a loop-through device is connected to the Pro Convert device, including unconnected, unsupported, active.
cpu-usage Shows the current CPU usage (the load on the processor, shown as a percentage) of the Pro Convert device.
memory-usage Shows the current memory usage.
core-temp Shows the current temperature(℃) of the unit's processor.
board-id Shows the rotary switch number, from 0 to F.
up-time Shows the elapsed time since the Pro device’s last boot-up, in seconds.
sd-size Shows the SD memory in MB.
3. Ethernet Status (ethernet {...})
"ethernet": {
 "state": "disconnected",
 "mac-addr": "70:B3:D5:75:D2:41",
 "ip-addr": "0.0.0.0",
 "ip-mask": "0.0.0.0",
 "gw-addr": "0.0.0.0",
 "dns-addr": "0.0.0.0",
 "tx-speed-kbps": 0,
 "rx-speed-kbps": 0
}
Name Description
state Shows Ethernet connection status, including down, disconnected, 10m, 100m, 1000m, 2500m, 5000m, 10000m.
mac-addr Shows the MAC address.
ip-addr Shows the IP address.
ip-mask Shows the subnet mask address.
gw-addr Shows the gateway address.
dns-addr Shows the DNS server address.
tx-speed-kbps Shows the Ethernet send speed in Kbps.
rx-speed-kbps Shows the Ethernet receive speed in Kbps.
4. USB RNDIS Status (rndis {...})
"rndis": {
 "state": "high-speed",
 "ip-addr": "192.168.66.1",
 "tx-speed-kbps": 0,
 "rx-speed-kbps": 0
}
Name Description
state Shows Ethernet over USB connection status, including disconnected, full-speed, high-speed, super-speed-5g, super-speed-10g.
ip-addr Shows Ethernet over USB IP Address.
tx-speed-kbps Shows current Ethernet over USB send speed, in Kbps.
rx-speed-kbps Shows current Ethernet over USB receive speed, in Kbps.
5. NDI® Status (ndi {...})
"ndi": {
 "name": "#00 (B401180706020)",
 "connected": true,
 "tally-preview": false,
 "tally-program": false,
 "audio-drop-frames": 0,
 "video-drop-frames": 0,
 "video-bit-rate": 0,
 "audio-bit-rate": 0,
 "video-width": 0,
 "video-height": 0,
 "video-scan": "progressive",
 "video-field-rate": 0.00,
 "audio-num-channels": 0,
 "audio-sample-rate": 0,
 "audio-bit-count": 16
}
Name Description
name Shows NDI source name.
connected True indicates the NDI function is enabled, otherwise it is false.
tally-preview True indicates the NDI stream has been selected to the Preview bus by any client, otherwise it is false.
tally-program True indicates that the NDI stream has been selected to the Program bus by any client, otherwise it is false.
audio-drop-frames Shows dropped audio frames in the previous second.
audio-bit-rate Shows the audio bitrate for the previous second in Kbps.
audio-num-channels Shows the total number of NDI audio output channels.
audio-sample-rate Shows the sampling rate of the audio output, such as 32000, 44100, ...
audio-bit-count Shows the sampling bit depth of the audio output, including 16, 20, 24, ...
video-drop-frames Shows dropped video frames in the previous second.
video-bit-rate Shows the video bitrate for the previous second in kbps.
video-width Shows the total number of pixels, horizontally.
video-height Shows the total number of pixels, vertically.
video-scan Shows the video scan format, including progressive, interlaced, psf.
video-field-rate Shows the video frame, including 24, 25, 29.97, 30, 48, 50, 59.94, 60.

results matching ""

    No results matching ""

    results matching ""

      No results matching ""