# 查询设备码流能力和码流列表 #### 功能介绍 查询设备码流能力和码流列表，目前仅支持好望设备 #### URI GET /v1/{user_id}/devices/{device_id}/channels/{channel_id}/stream-ability 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | channel_id | 是 | String | 通道ID校验：目前只支持好望设备，取值范围\[-1,999\] | | device_id | 是 | String | 设备ID： 好望设备：大小写字母、数字组成，长度范围\[8,32\]，可在设备外壳或者设备web页面上获取 | | user_id | 是 | String | 用户ID：由数字组成，长度范围\[15,25\]，获取方式参考[获取user ID与下载AK/SK](https://support.huaweicloud.com/api-ivm/ivm_03_0005.html#ZH-CN_TOPIC_0000001710465704__section1213543912215) | #### 请求参数 表2请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | Access-Token | 是 | String | 用户认证AccessToken：从[获取用户北向接口认证AccessToken](https://support.huaweicloud.com/api-ivm/ivm_03_0002.html)中获取 | #### 响应参数 **状态码： 200** 表3响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | abilities | Array of [StreamAbilityItem] objects | 码流能力列表 | | channel_no | Integer | 视频通道ID | | is_support_corridor_mode | Boolean | 是否支持走廊模式 | | is_support_water_mark | Boolean | 是否支持水印，取值范围：true -- 支持；false -- 不支持 | | mirror_mode | [MirrorMode] object | 镜像模式 | | variable_bit_rate | [VariableBitRate] object | 动态码率 | | variable_frame | [VariableFrame] object | 动态帧率 | | h264_info | [EncodeInfo] object | H264编码信息 | | h265_info | [EncodeInfo] object | H265编码信息 | | mjpeg_info | [EncodeInfo] object | MJPEG编码信息 | | digital_zoom_info | [DigitalZoomInfo] object | 数字变倍信息 | | roi_info | [ROIInfo] object | ROI（感兴趣区域）信息 | | vo_info | [VOInfo] object | VO模拟输出能力 | | osd_info | [OSDInfo] object | OSD信息 | | is_hide_sub_stream_for_main_mjpeg | Boolean | 主码流MJPEG开启时是否隐藏子码流 | 表4StreamAbilityItem | 参数 | 参数类型 | 描述 | |:---|:---|:---| | stream_count | Integer | 码流数量 | | max_frame_rate | Integer | 最大帧率 | | stream_info | Array of [StreamInfo](https://support.huaweicloud.com/api-ivm/ivm_03_0130.html) objects | 码流信息 | 表5StreamInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | stream_type | Integer | 码流类型：枚举类型 枚举值： - **0** 主码流， - **1** 子码流1 - **2** 子码流2 | | encode_mode | Array of [EncodeMode] objects | 编码信息列表 | | support_crop | Boolean | 是否支持裁剪：枚举类型 枚举值： - **false**不支持 - **true**支持 | | support_eptz | Boolean | 是否支持电子云台：枚举类型 枚举值： - **false**不支持 - **true**支持 | 表6EncodeMode | 参数 | 参数类型 | 描述 | |:---|:---|:---| | type | String | 编码类型：枚举类型 枚举值： - **H.264** - **H.265** - **MJPEG** | | resolution | Array of [Resolution] objects | 分辨率列表 | 表7Resolution | 参数 | 参数类型 | 描述 | |:---|:---|:---| | type | String | 分辨率长和宽为数字，通过\*分隔 | | frame_rate | Array of integers | 帧率列表 | | bit_rate | [BitRate] object | 该分辨率对应的码率信息 | 表8BitRate | 参数 | 参数类型 | 描述 | |:---|:---|:---| | support | Boolean | 该分辨率对应的是否支持码率配置\* | | begin | Integer | 该分辨率对应的码率最小值\* | | end | Integer | 该分辨率对应的码率最大值\* | | default | Integer | 该分辨率对应的码率默认值\* | 表9MirrorMode | 参数 | 参数类型 | 描述 | |:---|:---|:---| | support | Boolean | 是否支持镜像模式：枚举类型 枚举值： - **false**关闭 - **true**开启 | | type | Array of integers | 镜像类型：枚举类型 枚举值： - **0** 不开启镜像 - **1** 水平镜像 - **2** 垂直镜像 - **3** 水平垂直镜像 | 表10VariableBitRate | 参数 | 参数类型 | 描述 | |:---|:---|:---| | support | Boolean | 是否支持动态码率：枚举类型 枚举值： - **false**关闭 - **true**开启 | 表11VariableFrame | 参数 | 参数类型 | 描述 | |:---|:---|:---| | support | Boolean | 是否支持动态帧率：枚举类型 枚举值： - **false**关闭 - **true**开启 | 表12EncodeInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | intelligence | [Intelligence] object | 智能编码信息 | | is_support_slice | Boolean | 是否支持多Slice编码 | | is_support_layered_encoding | Boolean | 是否支持分层编码 | | profile_list | [ProfileList] object | 编码复杂度类型 | | i_frame_interval | [IFrameInterval] object | I帧间隔 | | bit_rate_info | [BitRateInfo] object | 码率信息 | | jpeg_quality | [JpegQuality] object | jpeg质量 | 表13Intelligence | 参数 | 参数类型 | 描述 | |:---|:---|:---| | support | Boolean | 是否支持智能编：枚举类型 枚举值： - **false**关闭 - **true**开启 | | type | Array of integers | 支持智能编码类型 | 表14ProfileList | 参数 | 参数类型 | 描述 | |:---|:---|:---| | support | Boolean | 是否支持编码复杂度类型：枚举类型 枚举值： - **false**关闭 - **true**开启 | | type | Array of integers | 枚举类型 H264编码枚举值： - **0** High profile， - **1** Main profile - **2** Base profile H264编码枚举值： - **0** Main profile | 表15IFrameInterval | 参数 | 参数类型 | 描述 | |:---|:---|:---| | support | Boolean | 是否支持I帧间隔：枚举类型 枚举值： - **false**关闭 - **true**开启 | | begin | Integer | I帧间隔最小值 | | end | Integer | I帧间隔最大值 | 表16BitRateInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | support | Boolean | 是否支持：枚举类型 枚举值： - **false**关闭 - **true**开启 | | bit_rate_type | Array of [BitRateType] objects | 码率类型：枚举类型 枚举值： - **0**定码率 - **1**变码率 | 表17JpegQuality | 参数 | 参数类型 | 描述 | |:---|:---|:---| | begin | Integer | jpeg质量最小值：1 | | end | Integer | jpeg质量最大值：99 | 表18BitRateType | 参数 | 参数类型 | 描述 | |:---|:---|:---| | type | Integer | 码率类型 | | bit_rate_mode | Array of integers | 定码率类型：枚举类型 枚举值： - **1** 帧率优先 - **2** 图像质量优先 | | pic_quality | Array of integers | 变码率图像质量：枚举类型 枚举值： - **1** 最好 - **2** 次好 - **3** 较好 - **4** 一般 - **5** 较差 - **6** 差 | 表19DigitalZoomInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | max_zoom | Integer | 数字变倍支持的最大倍率 | | support | Boolean | 是否支持数字变倍 | 表20ROIInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | support | Boolean | 是否支持感兴趣区域编码：枚举类型 枚举值： - **false**关闭 - **true**开启 | | roi_quality | [ROIQuality] object | 感兴趣区域编码质量能力对象 | 表21ROIQuality | 参数 | 参数类型 | 描述 | |:---|:---|:---| | begin | Integer | 最小值 | | end | Integer | 最大值 | 表22VOInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | param | [VOInfoParam] object | 参数 | | support | Boolean | 是否支持模拟输出能力：枚举类型 枚举值： - **false**关闭 - **true**开启 | 表23VOInfoParam | 参数 | 参数类型 | 描述 | |:---|:---|:---| | channel_no | String | 通道号 | 表24OSDInfo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | support | Boolean | 是否支持OSD：枚举类型 枚举值： - **false**关闭 - **true**开启 | #### 请求示例 查询设备码流能力和码流列表 ``` GET/v1/2562572829***/devices/952352LWXT***/channels/1/stream-ability ``` #### 响应示例 **状态码： 200** OK ``` { "channel_no": 101, "is_support_corridor_mode": false, "is_hide_sub_stream_for_main_mjpeg": false, "is_support_water_mark": true, "mirror_mode": { "support": true, "type": [0,1,2,3 ] }, "variable_bit_rate": { "support": true }, "variable_frame": { "support": true }, "h264_info": { "intelligence": { "support": true, "type": [3,1,2,4,5] }, "is_support_slice": true, "is_support_layered_encoding": true, "profile_list": { "support": true, "type": [0,1,2] }, "i_frame_interval": { "support": true, "begin": 1, "end": 500 }, "bit_rate_info": { "support": true, "bit_rate_type": [ { "type": 0, "bit_rate_mode": [0,1], "pic_quality": null }, { "type": 1, "bit_rate_mode": null, "pic_quality": [ 0,1,2,3,4,5] } ] }, "jpeg_quality": { "begin": 1, "end": 99 } }, "h265_info": { "intelligence": { "support": true, "type": [3,1,2,4,5] }, "is_support_slice": false, "is_support_layered_encoding": true, "profile_list": { "support": true, "type": [0] }, "i_frame_interval": { "support": true, "begin": 1, "end": 500 }, "bit_rate_info": { "support": true, "bit_rate_type": [ { "type": 0, "bit_rate_mode": [ 0, 1 ], "pic_quality": null }, { "type": 1, "bit_rate_mode": null, "pic_quality": [0,1,2,3,4,5 ] } ] }, "jpeg_quality": { "begin": 1, "end": 99 } }, "mjpeg_info": { "intelligence": { "support": false, "type": [3,1,2,4,5] }, "is_support_slice": false, "is_support_layered_encoding": false, "profile_list": { "support": false, "type": [0] }, "i_frame_interval": { "support": false, "begin": 0, "end": 0 }, "bit_rate_info": { "support": false, "bit_rate_type": [ { "type": 0, "bit_rate_mode": [0,1], "pic_quality": null }, { "type": 1, "bit_rate_mode": null, "pic_quality": [0,1,2,3,4,5] } ] }, "jpeg_quality": { "begin": 1, "end": 99 } }, "digital_zoom_info": { "support": false, "max_zoom": 16 }, "roi_info": { "support": true, "roi_quality": { "begin": 1, "end": 10 } }, "vo_info": { "support": true, "param": { "channel_no": "101" } }, "osd_info": { "support": true }, "abilities": [ { "stream_count": 3, "max_frame_rate": 25, "stream_info": [ { "stream_type": 0, "encode_mode": [ { "type": "H.264", "resolution": [ { "type": "1920*1080", "frame_rate": ["25","20","19","18","17","16","15","14","13","12","11","10","9","8","7","6","5","4","3","2","1"], "bit_rate": { "support": true, "begin": 512, "end": 8192, "default": 2048 } }, { "type": "1280*720", "frame_rate": ["25","20","19","18","17","16","15","14","13","12","11","10","9","8","7","6","5","4","3","2","1"], "bit_rate": { "support": true, "begin": 384, "end": 4096, "default": 1024 } } ] } ], "support_crop": false, "support_eptz": false } ] } ] } ``` #### 状态码 请参见[状态码](https://support.huaweicloud.com/api-ivm/ivm_03_0136.html) #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-ivm/ivm_03_0137.html)