接口功能介绍
本接口用于查询设备在云端的直播流。
接口约束
查询设备云端直播流确保设备和流在线。
请求参数说明：
String类型的参数，传""等同于不传。
Integer类型的参数，传0等同于不传。
Boolean类型的参数，传false等同于不传。
URI
GET /v2/devices/*/live/stream
路径参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| DeviceId | 是 | String | 设备ID。 | 32388487739092996 |
Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| OutNetwork | 否 | String | 播放网络类型，默认internet。取值：internet(互联网)，vpn(视频专网)。 | vpn | |
| StreamNum | 是 | Integer | 第几个码流，gb28181和rtmp设备仅支持主码流。取值：1(主码流)，2(子码流)，3(第三码流)。 | 1 |
请求参数
请求头header参数
无
请求体body参数
无
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 响应状态码。 | 200 | |
| error | String | 错误码，执行成功时，不返回该字段。 | VSS_0001 | |
| message | String | 响应信息。 | 请求成功 | |
| requestId | String | 请求ID。 | 362d4e78556b47129182d0881fade86b | |
| returnObj | Object | 响应数据，执行失败时，不返回该字段。 | returnObj |
表 returnObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| DeviceId | String | 设备ID。 | 719322608810442752 | |
| LiveStreams | Array of Objects | 流信息列表。 | LiveStream | |
| RequestId | String | 请求ID。 | ab109a44dce04c6a8670b4ddc9ca37d7 |
表 LiveStream
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| StreamNum | Long | 第几个码流。 | 1 | |
| Video | Object | 视频属性信息。 | Video | |
| PlayUrl | Object | 流的播放URL。 | PlayUrl |
表 Video
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| Codec | String | 编码格式。取值：h264，h265。 | h264 |
表 PlayUrl
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| FlvUrl | String | flv播放URL。 | xxx | |
| HlsUrl | String | hls播放URL。 | xxx | |
| WebrtcUrl | String | webcut播放URL。 | xxx | |
| RtspUrl | String | rtsp播放URL。 | xxx | |
| RtmpUrl | String | rtmp播放URL。 | xxx |
枚举参数
无
请求示例
请求url
GET '/v2/devices/719322608810442752/live/stream?StreamNum=1'
请求头header
无
请求体body
无
响应示例
{"statusCode": 200,"message": "请求成功","requestId": "ab109a44dce04c6a8670b4ddc9ca37d7","returnObj": {"DeviceId": "719322608810442752","LiveStreams": [{"StreamNum": 1,"Video": {"Codec": "h264"},"PlayUrl": {"RtmpUrl": "xxx","FlvUrl": "xxx","HlsUrl": "xxx","WebrtcUrl": "xxx","RtspUrl": "xxx"}}],"RequestId": "ab109a44dce04c6a8670b4ddc9ca37d7"}}
状态码
请参考 状态码
错误码
请参考 错误码
