Get System Summary
1. API Description
Get device summary information.
Request mode: GET [ip]/api/system/summary
| Administrator Rights | Login Authentication |
|---|---|
| No | Yes |
2. Input Parameters
None
3. Output Parameters
| Parameter | Type | Description |
|---|---|---|
| status | Int | Status code |
| mode | Int | Configuration Mode |
| ptz | Struct | PTZ status |
| profile | Struct | Current profile information |
| device-name | String | Device name |
| product-id | String | Product ID |
| product-name | String | Product series name |
| hardware-rev | String | Hardware revision |
| serial-number | String | Device serial number |
| firmware-ver | String | Firmware version |
| firmware-name | String | Firmware name |
| core-temp | Float | Temperature in degrees Celsius |
| hdmi-state | Int | HDMI port connection status: 0=Disconnected, 1=Working normally, 10=Not supported |
| fan-speed | Int | Fan speed |
| uptime | Int | Device uptime in seconds |
| cpu | Struct | CPU Information |
| mem | Struct | Memory Information |
| preview | Struct | Preview Information |
| net | Array | Array of Network Card Information |
| ndi-out | Struct | NDI Output Stream Status (only for annotation decoder models) |
| voltage | Int | Fan speed, 0 means no fan installed |
CPU Information
| Parameter | Type | Description |
|---|---|---|
| total | Int | Total CPU time |
| idle | Int | CPU idle time |
| usage | Int | CPU usage rate x 100 |
Memory Information
| Parameter | Type | Description |
|---|---|---|
| total | Int | Total system memory in KB |
| avail | Int | Available system memory in KB |
Preview Information
| Parameter | Type | Description |
|---|---|---|
| enable-webrtc | Boolean | Whether WebRTC preview is enabled |
| image-key | String | Static image preview key |
| webrtc-key | String | WebRTC preview key |
Network Card Information
| Parameter | Type | Description |
|---|---|---|
| enable | Boolean | Whether the network card is enabled true: Yes; false: No |
| prio | Int | Network card priority 0: No priority, typically for USB, ETH CONSOLE; Normal range: 1 ~ 99 |
| iface | String | Network card name |
| type | Int | Network card type 0: Ethernet 1: Wireless (Wi-Fi/AP) 2: USB Sharing 3: USB NET 4: Built-in 4G/5G 5: bridge |
| use-dhcp | Boolean | Whether DHCP is enabled true: Yes; false: No |
| ipaddr | String | IP address |
| netmask | String | Subnet mask |
| gateway | String | Gateway address |
| mac | String | MAC address |
| link-speed | Int | Speed 10: 10Mbps 100: 100Mbps 1000: 1Gbps 2500: 2.5Gbps 10000: 10Gbps 12: full-speed 480: high-speed 5000: super-speed-5g 10000: super-speed-10g |
| link-state | Int | Connection status 0: Network port abnormal 1: Disconnected 2: Connected |
| tx-speed-kbps | Int | Transmission speed (Kbps) |
| rx-speed-kbps | Int | Reception speed (Kbps) |
PTZ
| Parameter | Type | Description |
|---|---|---|
| enabled | Boolean | Whether PTZ control is supported |
NDI Output Stream Status
| Parameter | Type | Description |
|---|---|---|
| name | String | NDI output stream name |
| num-clients | Int | Number of connections (for reference only, one NDI client may have multiple connections) |
| video-kbps | Int | Video encoding bitrate (not total network transmission bitrate) |
| audio-kbps | Int | Audio encoding bitrate (not total network transmission bitrate) |
Profile
| Parameter | Type | Description |
|---|---|---|
| name | String | Profile name (can be ignored if configuration mode is simple mode) |
| mode | Int | View Mode |
| id | Int | Profile ID |
| audio-idx | Int | Currently selected audio stream |
| streams | Array | Array of Stream Information. For simple mode or single-screen profile mode, the list contains only one object. For picture-in-picture, the second object is the small screen. For 4-split screen, the order is: top-left, top-right, bottom-left, bottom-right |
Stream Information
| Parameter | Type | Description |
|---|---|---|
| name | String | Stream name |
| state | Int | Connection Status |
| protocol | String | Protocol type |
| buffer-ms | Int | Source buffer time in milliseconds |
| id | Int | Source ID |
| index | Int | Split screen index |
| uptime | Int | Connection duration in seconds |
| re-conn | Int | Number of reconnections |
| audio | Struct | Audio Status |
| video | Struct | Video Status |
| extra | Struct | Protocol-specific Status (varies by protocol type) |
Audio Status
| Parameter | Type | Description |
|---|---|---|
| codec | String | Encoding type |
| drops | Int | Current drop count |
| kbps | Int | Bitrate |
| jitter | Int | Jitter in hundreds of nanoseconds |
| num-channels | Int | Number of channels |
| sample-rate | Int | Audio sampling rate |
| bit-count | Int | Audio bit width |
Video Status
| Parameter | Type | Description |
|---|---|---|
| codec | String | Video encoding type |
| color-depth | Int | Color depth |
| quant-range | String | Quantization range, valid values: limited, full |
| frame-struct | String | Frame structure, valid values: 2d, 3d-left-right, 3d-top-bottom, 3d-left-right-half, 3d-top-bottom-half |
| aspect-ratio | String | Display aspect ratio, including 16:9, 4:3, etc. |
| color-format | String | Color space, e.g., rgb, bt.601, bt.709, bt.2020 |
| sampling | String | Sampling method, including 420, 422, 444, 4444 |
| drops | Int | Current drop count |
| kbps | Int | Bitrate |
| jitter | Int | Jitter in hundreds of nanoseconds |
| field-rate | String | Frame rate |
| width | Int | Width |
| height | Int | Height |
| scan-mode | String | Scan mode: progressive, interlaced, psf |
Protocol-specific Status
NDI
| Parameter | Type | Description |
|---|---|---|
| tally-preview | Boolean | Preview status |
| tally-program | Boolean | Program status |
SRT
| Parameter | Type | Description |
|---|---|---|
| pkt-lost | Int | Number of lost packets |
| rtt-ms | Int | Round-trip time in milliseconds |
Connection Status
| Value | Description |
|---|---|
| 0 | waiting |
| 1 | connecting |
| 2 | connected |
| 3 | connect-failed |
| 4 | failed-broken |
| 5 | failed-reject |
| 6 | failed-dns-resolve |
| 7 | failed-tcp-connect |
| 8 | failed-handshake |
| 9 | failed-connect-stream |
| 10 | failed-auth |
| 11 | create-failed |
| 12 | bind-failed |
4. Example
Output Example
{
"core-temp": 52.5,
"cpu": {
"idle": 77380008,
"total": 90378675,
"usage": 2074
},
"device-name": "Test 2K HDMI A",
"engine-type": 2,
"fan-speed": 0,
"firmware-ver": "1.1.369",
"hardware-rev": "A",
"hdmi-state": 1,
"mem": {
"avail": 602872,
"total": 2021584
},
"mode": 1,
"model": "",
"net": [
{
"enable": true,
"gateway": "10.10.32.1",
"iface": "eth0",
"ipaddr": "10.10.35.85",
"link-speed": 1000,
"link-state": 2,
"mac": "d0:c8:57:82:51:11",
"netmask": "255.255.252.0",
"prio": 34,
"rx-speed-kbps": 5116,
"support-enable": false,
"tx-speed-kbps": 2441,
"type": 0,
"use-dhcp": true
},
{
"enable": true,
"gateway": "192.168.67.1",
"iface": "usb0",
"ipaddr": "192.168.67.1",
"link-speed": 0,
"link-state": 1,
"mac": "8e:40:6a:d5:aa:55",
"netmask": "255.255.255.0",
"prio": 0,
"rx-speed-kbps": 0,
"support-enable": false,
"tx-speed-kbps": 0,
"type": 3,
"use-dhcp": true
}
],
"preview": {
"enable-webrtc": true,
"image-key": "main",
"webrtc-key": "server"
},
"product-id": "0x443",
"product-name": "Pro Convert IP to HDMI",
"profile": {
"audio-idx": 0,
"id": 0,
"mode": 1,
"name": "Default",
"streams": [
{
"audio": {
"bit-count": 0,
"cache": 0,
"channels": 8,
"codec": "AAC",
"drops": 0,
"jitter": 220319,
"kbps": 260,
"num-channels": 8,
"overflow": 0,
"sample-rate": 48000,
"underflow": 0,
"volume": 0
},
"buffer-ms": 500,
"extra": {
"tally-preview": false,
"tally-program": false
},
"id": 10017,
"index": 0,
"kbps": 0,
"name": "ULTRA ENCODE (C315230423002-2)",
"protocol": "ndi",
"re-conn": 0,
"state": 2,
"uptime": 1144,
"video": {
"aspect-ratio": "16:9",
"cache": 0,
"codec": "H264",
"color-depth": 8,
"color-format": "bt.709",
"drops": 0,
"field-rate": "59.94",
"frame-struct": "2d",
"height": 1080,
"jitter": 291635,
"kbps": 6430,
"quant-range": "limited",
"sampling": "420",
"scan-mode": "progressive",
"underflow": 0,
"width": 1920
}
}
],
"version": 0
},
"ptz": {
"enabled": false
},
"serial-number": "A443250103001",
"status": 0,
"system": {
"date": 1762736194
},
"uptime": 231941,
"voltage": 0
}