获取实时视频地址
接口描述
获取设备视频的实时直播地址,目前支持FLV、RTSP,要能够成功访问此接口并得到播放地址有几下几个条件:
- 该设备已经被绑定到你的账号下
- 设备支持此功能(请与臻识销售咨询您的设备是否支持)
请求说明
接口ID | 协议 | 方法 | PATH |
---|---|---|---|
11 | HTTPS | GET | /openapi/v1/stp/user/devices/vurl |
PATH参数
无
URL参数
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
accesskey_id | string | 是 | 参见签名认证 |
expires | int | 是 | 参见签名认证 |
signature | string | 是 | 参见签名认证 |
sn | string | 是 | 设备序列号 |
type | string | 是 | 播放地址类型,可选值有 auto 、 rtsp 、flv 、mjpeg 、webrtc |
proto | string | 否 | 视频协议,设置返回flv的协议,可选值有http 、ws ,若不传此参数,那么设备支持http-flv则返回http-flv,否则返回ws-flv |
channel | string | 否 | 通道号,获取国标设备时是必填的(国标设备通道号使用20位通道编号) |
stream | string | 否 | 码流号,0:主码流;1:子码流(默认) |
webrtc | bool | 否 | 当为true时,若设备支持webrtc,则会在返回的结果里包含webrtc的取流地址 |
auth | string | 否 | 认证信息,默认为admin:admin 的Base64编码 |
user_tag | string | 否 | 用户标识,可以用于管理取流,1到16位的数字和字母组合 |
注1:建议在浏览器、移动端播放时使用flv
,在PC客户端使用rtsp
。
注2: 若在浏览器、移动端播放时建议使用auto
类型,此类型会自动判断所访问设备所支持的流类型,若设备支持flv
,则返回flv
的播放地址,否则返回mjpeg
的播放地址(注意此类型不会返回rtsp
的播放地址)
注3:不建议使用mjpeg
,此类型的支持只是为了保证从旧臻云到新臻云的过渡,新臻云后期会禁用此类型
注4:如果type
为flv
且设备端开启了认证,那么需要传入auth
信息才能成功播放视频,如下图:
auth
认证信息是设备登录名和密码的username:password
的Base64编码,若不传,臻云会使用臻云控制台配置的登录名和密码,如下图:
如果臻云控制台没有配置设备的登录名和密码,臻云会默认使用admin:admin
作为认证信息。
注5:同一台的设备的用户标识必须唯一,否则新的用户标识会取代旧的用户标识
请求示例
GET https://open.vzicloud.com/openapi/v1/stp/user/devices/vurl?sn=6593d05e-34c85fbd&type=auto&accesskey_id=7eQ8kIcf1125fDVz4dnBJhMh7n9tSGGy&expires=1600763374&signature=mGZdL636IzUyw5zpBppYSinwAOc%3D HTTP/1.1
Host: open.vzicloud.com
注意:您无法将请求示例的链接地址贴入浏览器直接运行,此示例仅展示URL格式,由于AccessKey具备有效期,您访问时此链接已过期。
返回说明
返回参数
参数 | 类型 | 说明 |
---|---|---|
type | string | 播放地址类型,可选值有 rtsp 、flv 、mjpeg |
url | string | 播放地址 |
id | string | 流ID |
webrtc | object | 若请求时指定了webrtc参数,且设备支持webrtc,则会返回此内容 |
+id | string | webrtc流ID |
+url | string | webrtc流地址 |
注意:接口返回的url包含有效期,请千万不要将返回的url存储长期使用,否则有效期过了将无法播放视频。
返回示例
{
"type": "flv",
"proto": "http",
"url": "https://video2.vzicloud.com/6593d05e-34c85fbd/0_1/live.flv?id=96d96b40-1455-11f0-91b1-4cedfb687489"
}