获取摘要信息
1.接口描述
获取设备摘要信息。
请求方式:GET [ip]/api/system/summary
| 管理员权限 | 登录认证 |
|---|---|
| 否 | 是 |
2.输入参数
无
3.输出参数
| 参数 | 类型 | 描述 |
|---|---|---|
| status | Int | 状态码 |
| mode | Int | 配置模式 |
| ptz | Struct | PTZ状态 |
| profile | Struct | 当前profile信息 |
| device-name | String | 设备名称 |
| product-id | String | 设备ID |
| product-name | String | 产品系列名称 |
| hardware-rev | String | 硬件版本 |
| serial-number | String | 设备序列号 |
| firmware-ver | String | 设备固件版本 |
| firmware-name | String | 设备固件名称 |
| core-temp | Float | 温度,单位摄氏度 |
| hdmi-state | Int | hdmi口连接状态,0为未连接,1为正常工作,10为不支持 |
| fan-speed | Int | 风扇转速 |
| uptime | Int | 开机时长,单位:s |
| cpu | Struct | CPU信息 |
| mem | Struct | 内存信息 |
| preview | Struct | 预览信息 |
| net | Array | 数组类型,成员数据结构为网卡信息 |
| ndi-out | Struct | NDI输出流状态,当解码器为注解解码器型号才存在 |
| voltage | Int | 风扇转速,0则代表没有风扇 |
CPU信息
| 参数 | 类型 | 描述 |
|---|---|---|
| total | Int | CPU 总时间 |
| idle | Int | CPU 空闲时间 |
| usage | Int | CPU 使用率 x 100 |
内存信息
| 参数 | 类型 | 描述 |
|---|---|---|
| total | Int | 系统总内存,单位:KB |
| avail | Int | 系统可用内存,单位:KB |
预览信息
| 参数 | 类型 | 描述 |
|---|---|---|
| enable-webrtc | Boolean | 设备是否启用了webrtc预览 |
| image-key | String | 静态图预览地址 |
| webrtc-key | String | webrtc预览key |
网卡信息
| 参数 | 类型 | 描述 |
|---|---|---|
| enable | Boolean | 网卡服务是否开启 true:是;false:否 |
| prio | Int | 网卡优先级 0:没有优先级,一般指USB,ETH CONSOLE; 正常 1 ~ 99 |
| iface | String | 网卡名称 |
| type | Int | 网卡类型 0:以太网 1:无线网卡(Wi-Fi/AP) 2:USB Sharing 3:USB NET 4:内置4G/5G 5:bridge |
| use-dhcp | Boolean | 是否启用DHCP true:是;false:否 |
| ipaddr | String | IP 地址 |
| netmask | String | 子网掩码 |
| gateway | String | 网关地址 |
| mac | String | MAC 地址 |
| link-speed | Int | 速率 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 | 连接状态 0:网口异常 1:未连接 2:已连接 |
| tx-speed-kbps | Int | 发送速度 (Kbps) |
| rx-speed-kbps | Int | 接收速度 (Kbps) |
PTZ
| 参数 | 类型 | 描述 |
|---|---|---|
| enabled | Boolean | 是否支持ptz控制 |
NDI输出流状态
| 参数 | 类型 | 描述 |
|---|---|---|
| name | String | NDI输出流的名称 |
| num-clients | Int | 连接数量(仅作参考,一个NDI客户端可能有多个连接 |
| video-kbps | Int | 视频编码码率(非网络发送总码率) |
| audio-kbps | Int | 音频编码码率(非网络发送总码率) |
profile
| 参数 | 类型 | 描述 |
|---|---|---|
| name | String | profile名称,如果配置模式为简单模式,可以忽略该字段 |
| mode | Int | 视图模式 |
| id | Int | profile id |
| audio-idx | Int | 当前选择的音频流 |
| streams | Array | 数组类型,成员数据结构为流信息,如果是简单模式或者profile模式的单屏,列表中只有一个对象,如果是画中画,第二个对象是小画面,如果是4分屏,按照顺序分别是左上,右上,左下,右下 |
流信息
| 参数 | 类型 | 描述 |
|---|---|---|
| name | String | 流名称 |
| state | Int | 连接状态 |
| protocol | String | 协议类型 |
| buffer-ms | Int | 源缓冲时间 |
| id | Int | 源ID |
| index | Int | 分屏索引 |
| uptime | Int | 已连接时间,单位秒 |
| re-conn | Int | 重连次数 |
| audio | Struct | 音频状态 |
| video | Struct | 视频状态 |
| extra | Struct | 协议特有状态,根据协议类型而定 |
音频状态
| 参数 | 类型 | 描述 |
|---|---|---|
| codec | String | 编码类型 |
| drops | Int | 当前丢帧数量 |
| kbps | Int | 比特率 |
| jitter | Int | 抖动,单位百纳秒 |
| num-channels | Int | 声道数量 |
| sample-rate | Int | 音频采样率 |
| bit-count | Int | 音频位宽 |
视频状态
| 参数 | 类型 | 描述 |
|---|---|---|
| codec | String | 视频编码类型 |
| color-depth | Int | 色深 |
| quant-range | String | 量化范围,有效值:limited,full |
| frame-struct | String | 帧结构,有效值:2d,3d-left-right,3d-top-bottom,3d-left-right-half,3d-top-bottom-half |
| aspect-ratio | String | 显示宽高比,包括 16:9,4:3 等 |
| color-format | String | 色彩空间,如:rgb,bt.601,bt.709,bt.2020 |
| sampling | String | 采样方式,包括 420,422,444,4444 |
| drops | Int | 当前丢帧数量 |
| kbps | Int | 比特率 |
| jitter | Int | 抖动,单位百纳秒 |
| field-rate | String | 帧率 |
| width | Int | 宽 |
| height | Int | 高 |
| scan-mode | String | 扫描方式:progressive、interlaced、psf |
协议特有状态
NDI
| 参数 | 类型 | 描述 |
|---|---|---|
| tally-preview | Boolean | 预览状态 |
| tally-program | Boolean | 播出状态 |
SRT
| 参数 | 类型 | 描述 |
|---|---|---|
| pkt-lost | Int | 丢包数量 |
| rtt-ms | Int | 网络数据往返时间(Round-trip time),单位毫秒 |
连接状态
| 值 | 描述 |
|---|---|
| 0 | waiting 等待连接 |
| 1 | connecting 连接中 |
| 2 | connected 已连接 |
| 3 | connect-failed 连接失败 |
| 4 | failed-broken 连接中断 |
| 5 | failed-reject 连接被拒绝 |
| 6 | failed-dns-resolve dns解析失败 |
| 7 | failed-tcp-connect 传输层连接失败 |
| 8 | failed-handshake 握手失败 |
| 9 | failed-connect-stream 连接流失败 |
| 10 | failed-auth 认证失败 |
| 11 | create-failed 创建对象失败 |
| 12 | bind-failed 绑定端口失败 |
4.示例
输出示例
{
"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
}