获取 HDMI 输入信号状态信息
1.接口描述
接口说明:获取 HDMI 输入信号状态信息。
请求方式:
- 固件版本 V2.6.0 及以上:POST [ip]/mwapi/V2.0/input/get-signal-info
- 固件版本 V2.5.0 及以下:POST [ip]/mwapi/get-signal-info
管理员权限 | 登录认证 |
---|---|
否 | 是 |
2.输入参数
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
source-id | 是 | Int | 输入源ID 0:HDMI 1;1:HDMI 2 |
3.输出参数
参数名称 | 类型 | 描述 |
---|---|---|
status | Int | 状态码 |
signal-info-types | Array of String | 信号类型,包括 video-info、audio-info、hdmi-info、info-frames |
video-info | VideoInfoData | 视频信号状态 |
audio-info | AudioInfoData | 音频信号状态 |
hdmi-info | HdmiInfoData | HDMI 信号状态 |
info-frames | Array of InfoFrameData | 信息帧列表 |
VideoInfoData
参数名称 | 类型 | 描述 |
---|---|---|
width | Int | 视频宽度,像素数。 |
height | Int | 视频高度,像素数。 |
scan | String | 视频扫描方式 progressive:逐行扫描; interlaced:隔行扫描 |
field-rate | Int | 视频帧率(fps X 100) |
color-depth | Int | 色深,有效值:8、10、12。 |
color-format | String | 色彩空间,有效值:rgb、bt.601、bt.709、bt.2020。 |
aspect-ratio | String | 显示宽高比 |
sampling | String | 采样方式,包括 4:2:0、4:2:2、4:4:4、4:4:4:4。 |
quant-range | String | 量化范围 full:全范围;limited:有限范围 |
sat-range | String | 饱和范围, limited:有限范围;extended:扩展范围;full:全范围 |
frame-struct | String | 帧结构, 2d:2D;3d:3D |
AudioInfoData
参数名称 | 类型 | 描述 |
---|---|---|
codec | String | 音频编码方式 |
num-channels | Int | 检测到的输入音频通道数 |
sample-rate | Int | 音频采样率(Hz) |
bit-count | Int | 音频比特率(bit) |
HdmiInfoData
参数名称 | 类型 | 描述 |
---|---|---|
mode | String | 模式,显示输入信号类型 |
hdcp | String | HDCP 是否加密, none:不加密;encrypted:加密 |
vic | Int | 视频标识码,显示符合 CEA 标准定义的相关数值。 |
it-content | Boolean | IT 内容标志,显示传输报文是否为内容。 true:是;false:否 |
pixel-rate | Floot | 像素率,每秒向本地存储器写入的最大像素数 |
timing-h-total | Int | 时序 - 水平总宽度,水平方向的总像素数。 |
timing-h-active | Int | 时序 - 水平有效宽度,水平方向的有效像素数 |
timing-h-front-porch | Int | 时序 - 水平同步前沿宽度,水平方向同步前沿像素数 |
timing-h-sync-width | Int | 时序 - 水平同步宽度,水平方向同步宽度像素数 |
timing-h-back-porch | Int | 时序 - 水平同步后沿宽度,水平方向同步后沿像素数 |
timing-v-total | Int | 时序 - 垂直总宽度,垂直方向的总行数 |
timing-v-active | Int | 时序 - 垂直有效宽度,垂直方向的有效行数 |
timing-v-front-porch | Int | 时序 - 垂直同步前沿宽度,垂直方向同步前沿行数 |
timing-v-sync-width | Int | 时序 - 垂直同步宽度,同步宽度行数 |
timing-v-back-porch | Int | 时序 - 垂直同步后沿宽度,同步后沿行数 |
InfoFrameData
参数名称 | 类型 | 描述 |
---|---|---|
id | Sting | 信息帧名称,包括 AVI、Audio等 |
type | Int | 报文类型 |
version | Int | 报文版本 |
checksum | Int | 报文的校验和 |
length | Int | 帧信息的负载长度 |
data | Sting | 帧信息的负载数据,base64 编码数据,转换成 16 进制显示 |
4.示例
获取 HDMI 1 输入信号状态信息。
输入示例
{
"source-id": 0
}
输出示例
{
"status": 0,
"signal-info-types": [
"video-info",
"audio-info",
"hdmi-info",
"info-frames"
],
"video-info": {
"width": 1920,
"height": 1080,
"scan": "progressive",
"field-rate": 6000,
"color-depth": 8,
"color-format": "bt.709",
"aspect-ratio": "16:9",
"sampling": "4:4:4",
"quant-range": "limited",
"sat-range": "limited",
"frame-struct": "2d"
},
"audio-info": {
"codec": "lpcm",
"num-channels": 2,
"sample-rate": 48000,
"bit-count": 16
},
"hdmi-info": {
"mode": "HDMI",
"hdcp": "none",
"vic": 16,
"it-content": false,
"pixel-rate": 148.00,
"timing-h-total": 2200,
"timing-h-active": 1920,
"timing-h-front-porch": 88,
"timing-h-sync-width": 44,
"timing-h-back-porch": 148,
"timing-v-total": 1125,
"timing-v-active": 1080,
"timing-v-front-porch": 4,
"timing-v-sync-width": 5,
"timing-v-back-porch": 36
},
"info-frames": [
{
"id": "AVI",
"type": 130,
"version": 2,
"checksum": 103,
"length": 13,
"data": "UKgAEAAAAAAAAAAAAA=="
},
{
"id": "Audio",
"type": 132,
"version": 1,
"checksum": 112,
"length": 10,
"data": "AQAAAAAAAAAAAA=="
}
]
}
5.错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 定义 | 说明 |
---|---|---|
7 | MW_STATUS_INVALID_ARG | 参数缺失或错误 |