查询视频流URL
最近更新时间：2025-02-21 02:50:54
1. 接口描述
接口请求域名: vssapi.ctyun.cn
默认接口请求频率限制：500次/秒。
查询流URL信息。
2. 请求参数
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| Action | String | 是 | DescribeStreamURL | 操作接口名，系统规定参数。 |
| InProtocol | String | 是 | gb28181 | 使用的接入协议。 取值: gb28181, rtmp, rtsp, onvif,ehome，vgroup |
| DeviceId | String | 是 | 32388487739092997 | 设备ID。 |
| OutProtocol | String | 是 | webrtc | 流播放协议，多值用逗号分隔。 取值: rtmp, hls, flv, webrtc |
| Type | String | 是 | live | 流类型，默认live。 取值：live（直播流）、vod（点播流，例如NVR上的历史流） |
| StartTime | Long | 否 | 1571639499 | 开始时间，适用于vod流类型。 unix时间戳，单位秒。 |
| EndTime | Long | 否 | 1571639999 | 结束时间，适用于vod流类型 unix时间戳，单位秒。点播流时，开始时间和结束时间间隔不大于7200秒 |
| ChannelNum | Long | 否 | 44142100001310000001 | 通道号，适用于ehome协议点播流。 |
| StreamName | String | 否 | 323884892996 | 流名称，适用于ehome协议点播流。 |
| StreamNum | Long | 否 | 1 | 第几个码流，适用于EHOME和RTSP协议直播流。取值: 1: 主码流 2: 子码流 3: 第三码流 |
| FileName | String | 否 | 123xxx | 文件名，适用于ehome协议点播流。 |
| SeekType | Long | 否 | 10 | 搜索类型，默认10，适用于ehome协议点播流。 |
| FileOffset | Long | 否 | 10 | file offset，默认10，适用于ehome协议点播流。 |
| RealGroupId | String | 否 | 1 | 组ID，适用于vgroup虚拟业务组。 |
| OutNetwork | String | 是 | internet | 播放网络类型，默认internet 取值： internet：互联网； vpn：视频专网 |
| Expires | Long | 否 | 86400 | 播放URL的过期时长，单位秒。 |
3. 返回参数
| 参数 | 类型 | 描述 |
|---|---|---|
| Video | Video{} | 视频流属性信息。 |
| PushUrl | PushUrl{} | 推流URL。 可选项，RTMP或RTSP设备有效。 |
| PlayUrl | PlayUrl{} | 流的播放URL。 |
| RequestId | String | 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
| DeviceId | String | 设备ID。 可选项，ehome协议有效。 |
| CreatedTime | String | 生成时间。 可选项，ehome协议有效。 |
| UpdatedTime | String | 更新时间。 可选项，ehome协议有效。 |
| AudioInfo | String | 音频信息 |
| VideoInfo | String | 视频信息 |
Video
| 参数 | 类型 | 描述 |
|---|---|---|
| Codec | String | 取值: h264, h265 |
PushUrl
| 参数 | 类型 | 描述 |
|---|---|---|
| RtmpUrl | String[] | rtmp播放url |
PlayUrl
| 参数 | 类型 | 描述 |
|---|---|---|
| RtmpUrl | String | rtmp播放url |
| FlvUrl | String | flv播放url |
| HlsUrl | String | hls播放url |
| WebrtcUrl | String | webrtc播放url |
4. 示例
4.1 请求示例
https://vssapi.ctyun.cn/
?Action=DescribeStreamURL
&InProtocol=gb28181
&DeviceId=29941970440815198
&OutProtocol=webrtc
&Type=live
&OutNetwork=internet
&Version=2020-06-12
&AccessKeyId=O0G0BPBI2T9YUD3U****
&Signature=M7rcepN979hy2YlT375NlOcnb7M%3D
&SignatureMethod=HMAC-SHA1
&SignatureNonce=635429707
&SignatureVersion=1.0
&Timestamp=1599095835
4.2 返回示例
{
"PlayUrl":
{
"RtmpUrl":"rtmp://127.0.0.1/live/29941970440815198",
"FlvUrl":"http://127.0.0.1:8080/live/29941970440815198.flv",
"HlsUrl":"http://127.0.0.1:8080/live/29941970440815198/hls.m3u8",
"WebrtcUrl":"webrtc://127.0.0.1:8080/live/29941970440815198"
},
"Video":{"Codec":"h264"},
"RequestId":"888467ffd25346d8907143a1faf2777e",
"deviceId":"",
"createdTime":"",
"updatedTime":"",
"VideoInfo":"{\"Bitrate\":2126,\"Codec\":\"h264\",\"Fps\":29,\"Lossrate\":0,\"Width\":540,\"Height\":960}",
"AudioInfo":"{\"Codec\":\"g711a\",\"SampleBit\":16,\"SampleRate\":8000}"
}
本页目录：