查詢設備云端直播流
更新時間 2024-09-11 16:11:27
最近更新時間: 2024-09-11 16:11:27
分享文章
接口功能介紹
本接口用于查詢設備在云端的直播流。
接口約束
查詢設備云端直播流確保設備和流在線。
請求參數說明：
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"}}
狀態碼
請參考
錯誤碼
請參考
