设备信息
针对待审核设备,可以进行以下操作:
针对已拒绝申请的设备,可以进行以下操作:
针对通过审核的设备,可以通过ControlHub远程管理:
设备连接全局配置信息
| 参数 | 描述 | |
|---|---|---|
| input | 输入设备的全局默认配置 | |
| protocol | 默认协议,参考协议类型定义 | |
| latency | 当协议为srt时生效,用于配置srt的延迟 | |
| stream-index | 主辅流选择 | |
| output | 输出设备的全局默认配置 | |
| protocol | 默认协议,参考协议类型定义 | |
| latency | 当协议为srt时生效,用于配置srt的延迟 | |
| buffer-ms | 设备的缓存时间,单位毫秒 |
device
| 参数 | 描述 |
|---|---|
| id | 对象全局唯一id。 |
| name | 名称。 |
| apply-date | 申请/通过审核时间。 |
| catalog-id | 设备分组ID |
| config | 设备的配置信息,如果不存在代表采用全局配置,参考设备连接配置 |
| dev-warns | 取值大于0,表示异常设备。参考异常设备状态掩码 |
| dir | 设备的节点流方向 |
| firmware-ver | 固件版本。 |
| group-mask | 可见用户组掩码集合,当选择所有可见时,将该值配置为0xFFFFFFFF(4294967295)。 |
| hardware-ver | 硬件版本。 |
| is-favorite | 收藏用户的id,判断该设备是否被当前用户收藏,需要用该值和用户ID做二进制与的操作 |
| is-inherit | 是否继承可见性配置,数值,如果非0,表示用户组和用户的掩码配置为继承值 |
| module | 产品族编号 |
| api-class | 是否为magewell产品 |
| module-name | 设备型号名称,可通过product-id字段在产品型号中找到对应名称 |
| online-date | 设备在线时间。大于0:设备在线,小于等于0:设备离线。 |
| owner-i | 作为input时所属channel,数组类型,存放所属channel的名称,非固定字段 |
| owner-o | 作为output时所属channel,字符串类型,存放所属channel的名称,非固定字段 |
| preview_id | 预览图片ID,该字段只会在支持预览的设备上存在 |
| pro-feature | 不同类型设备的特定信息,数据结构根据module而定,参考设备特定信息。 |
| product-id | 设备型号ID |
| reg-state | 注册状态,参考注册状态 |
| sn | 序列号。 |
| status | 设备的状态信息。 |
| type | 节点类型。 |
| usr-mask | 可见用户掩码集合。 |
| warns | 取值大于0,表示设备在ControlHub上存在问题,参考ControlHub平台设备异常定义 |
ControlHub平台设备异常定义
MH_DEV_WARN_UNSUPPORTED_VER = 0x01, // 不支持的设备固件版本
MH_DEV_WARN_VER_TOO_LOW = 0x02, // 设备版本太旧
config
| 参数 | 描述 |
|---|---|
| input | 作为输入时的配置,如果不存在代表采用全局配置,参考输入设备连接配置 |
| output | 作为输出时的配置,如果不存在代表采用全局配置,参考输出设备连接配置 |
status
| 参数 | 描述 |
|---|---|
| name | 设备名称。 |
| cur-status | 设备状态掩码,不同设备不同处理,值的定义需要查找相关的设备的接口文档。 |
| eth | 如果存在,则表示以太网IP |
| firmware-ver | 固件版本。 |
| hardware-ver | 硬件版本。 |
| is-online | 布尔类型,是否在线。 |
| module-name | 设备型号名称。 |
| rndis | 如果存在,则表示USB RNDIS IP。 |
| up-time | 设备上电时间,单位:秒。 |
| wifi | 如果存在,则表示WI-FI IP。 |
| upgrade-status | 设备升级状态 |
设备升级状态
| 参数 | 描述 |
|---|---|
| step | 当前阶段,参考设备升级阶段 |
| percent | 当前阶段的进度 |
| ret | 如果失败,可以在这里获取到失败的错误码 |
设备升级阶段
| 参数 | 描述 |
|---|---|
| -1 | 失败 |
| 0 | 无升级任务。 |
| 1 | 排队等待升级。 |
| 2 | 正在上传文件 |
| 3 | 安装中 |
| 4 | 重启中 |
设备特定信息
UltraStream
| 参数 | 描述 |
|---|---|
| input | 输入信号 1920x1080p, 60.00 Hz |
| rec-sec | 录制时间(ms) |
| live-sec | 直播时间(ms) |
| usb-option | 0:未启用; 即U盘录制关闭 |
| usb-status | U盘状态 |
| usb-used | 使用size |
| usb-total | 总size |
| sd-status | sd状态 |
| sd-used | 使用size |
| sd-total | 总size |
UltraEncoder
| 参数 | 描述 |
|---|---|
| input | 输入信号 |
ProConvertEncoder
| 参数 | 描述 |
|---|---|
| input | 输入信号,如:1920x1080p, 60.00 Hz |
| output | 输出信号 (产品0x405、0x406没有Output) |
| ndi-enabled | NDI开启状态 |
| ndi-video-width | 视频 宽 |
| ndi-video-height | 视频 高 |
| ndi-video-scan | 视频 扫描方式 |
| ndi-video-field-rate | 视频 场频率 |
| ndi-audio-channels | 音频 通道数 |
| ndi-audio-sample-rate | 音频 采样率 |
| ndi-audio-bit-count | 音频比特率,包括 16、20、24 等。 |
ProConvertDecoder
| 参数 | 描述 |
|---|---|
| ndi-name | 信号源 |
| ndi-connected | 是否连接, true: 连接 |
| ndi-video-width | 视频 宽 |
| ndi-video-height | 视频 高 |
| ndi-video-scan | 视频 扫描方式 |
| ndi-video-field-rate | 视频 场频率 |
| ndi-audio-channels | 音频 通道数 |
| ndi-audio-sample-rate | 音频 采样率 |
| ndi-audio-bit-count | 音频比特率,包括 16、20、24 等。 |