获取实时预览播放地址_标准协议

接口调用说明

请求地址 : /v1/api/device/video/get_realtime_url_standard
请求方式 : POST

请求头

参数名 参数值 是否必须
Content-Type application/json
X-Token 实际accessToken

请求报文体

名称 类型 是否必须 备注
deviceSn String 设备序列号
channelId int 视频通道号
streamId int 码流 0<=streamId < streamCount(设备详情接口有返回) ; 0为主码流 非0值为次码流
streamUUID String 流UUID(字母,数字,下划线),最长 42 位,可以为一个随机数,断流时候使用,如果不传,后台会自动生成一个
protocolType String 协议字段 取值: http_flv, wss, rtmp, https_flv, hls
userIp String 终端用户公网ip,用于就近选择策略
maxPlayDuration number 拉流时长限定 单位(s) 1<=maxPlayDuration<=2592000;服务端根据输入maxPlayDuration值会通知客户端进行断流操作,如客户端未主动断开,服务端会在maxPlayDuration值后延迟10s被动断开,具体可参考SDK错误码
针对标准协议,建议设置的maxPlayDuration不宜过低,过低可能会出现还未出图就断开连接的情况
针对hls协议,播放时长达到maxPlayDuration后,URL就会失效,无法继续使用,需重新获取URL
extensions String 协议拓展字段, 可以传递用户自定义参数, 长度限制300字符
//示例数据
{
    "deviceSn": "12421SSXXXX",
    "channelId": 0,
    "streamId": 0,
    "streamUUID":"1234567890956789uytrewqwerty23",
    "protocolType":"wss",
    "userIp":"1.1.1.1",
    "maxPlayDuration": 120,
    "extensions":"e4e36ab460f24e64af6c13747794d094"
}

响应报文

名称 类型 是否必须 备注
code int 状态码
msg String 状态码解释信息
data Object 返回内容(详情见下表)

data内容如下:

名称 类型 是否必须 备注
url string 流url,有效期180S,超时后无法拉流,需要重新获取播放地址
streamUUID string UUID
//示例数据
{
    "code": 1000,
    "msg": "OK",
    "data": {
        "url": "wss://xxx.xx.x.xxx:7070/live/12421SSBxxxx?token=xxxxxxxxxxxxxxxxx.xxxxxxxxxxxxxxxx.xxxxxxxxxxxxxxxxxxxxxx",
        "streamUUID": "1234567890956789uytrewqwerty23"
    }
}

错误码

状态码 状态描述
1000 成功
1001 参数错误
1002 请求异常
1006 AccessToken异常
2002 设备不在线
2008 设备不存在
2009 视频通道号不合法
2017 通道未启用
4001 获取视频链接地址异常
4004 码流id不合法

results matching ""

    No results matching ""