直播嵌入
请求地址
GET https://live.hst.com/room/{liveUri}
注:
- liveUri为房间链接后面的除域名外的短链接
- 支持公开、自定义密码、第三方鉴权
请求参数
字段 | 是否可选 | 类型 | 描述 |
---|---|---|---|
name | 是 | String | 用户昵称 注:该参数只对直播嵌入有效 |
username | 是 | String | 用户名,用户唯一标识 注:相同用户名的用户只允许同时在线一位 |
embed | 是 | String | 嵌入类型 取值:video(单视频嵌入) 默认值:全嵌入 |
vid | 是 | String | 视频ID 注:vid为空则为直播嵌入,否则为点播视频嵌入 |
code | 是 | String | 自定义密码 注:如房间设置鉴权设置为自定义密码则需必填 |
auth_key | 是 | String | 鉴权key 注:如房间设置鉴权设置为第三方鉴权则需必填 |
type | 是 | String | 页面类型 取值:pc(电脑端页面),mobile(移动端页面) 默认通过User-Agent判断 |
lang | 是 | String | 页面语言 取值:zh-CN(中文页面),en-US(英文页面) 默认中文页面 |
第三方鉴权
流程说明
调用开启第三方鉴权接口,为对应的直播房间设置鉴权地址
按照规则生成直播嵌入链接,并带上auth_key字段
客户系统接收鉴权请求,返回鉴权结果
系统根据客户返回的鉴权结果是否为0,判断是否鉴权成功
鉴权请求
- 请求地址:开启第三方鉴权接口设置的authUrl
- 请求方式:POST
- 请求格式:JSON
- 请求参数:
字段 | 是否可选 | 类型 | 描述 |
---|---|---|---|
room_id | 否 | int | 直播房间ID |
auth_key | 否 | String | 客户链接上auth_key对应的值 |
- 结果:认证成功,请返回0;否则判断认证失败