简要描述
- 该接口是进入应用的直接跳转接口,配合a标签使用,没有消息码的返回.
请求URL
{{adminHost:8181}}webclient
请求方式
- get
请求Query参数
参数名 | 示例值 | 必选 | 类型 | 说明 |
---|---|---|---|---|
appliId | 是 | long | 应用ID | |
endDate | 否 | long | 预定结束时间,为毫秒时间戳 | |
clientMac | 否 | string | 眼镜客户端Mac地址(眼镜客户端时必须,否则监控数据不显示) | |
groupId | 否 | long | 分组ID,用于服务器/客户端分组管理 | |
regionId | 否 | string | 数据中心分区ID,一般用于根据分区测试后客户端优先使用指定分区的服务器节点, 和groupId不能同时指定 | |
taskId | 否 | long | 运行应用实例的任务ID | |
playerMode | 否 | int | 启动模式:0-普通模式, 1-演示模式(一人操作多人观看),2-互动模式(键盘鼠标放开,需要应用配合) | |
userType | 否 | int | 演示模式/互动模式时用户类别,1-Task所有者(管控者),0-参与者 | |
nickname | 否 | string | 演示模式/互动模式时用户的昵称 | |
authCode | 否 | string | 演示模式/互动模式时房间口令,具有唯一性;私有应用的访问口令,不具有唯一性 | |
codeRate | 否 | string | 码率 | |
frameRate | 否 | string | 帧率 | |
audioCodeRate | 否 | string | 音频编码码率 | |
preferDecoder | 否 | string | 客户端优先使用的解码格式,可传’auto’ ,’vp8’ ,’vp9’ ,’h264’ ,’h265’ ,’hevc’ ,’av1’ ,’av1x’ | |
shareId | 否 | string | 分享链接ID | |
extraParam.XXX | 否 | string | 传递给云端应用的附加参数,参数总长度在7000字符以下,应用中可以通过命令行参数直接获取到附加参数,具体参见 参考样例2 | |
wsId | 否 | string | 工作空间id,当应用所属的工作区间加密,此参数必须传递 | |
timestamp | 否 | long | 时间戳(ms),当应用所属的工作区间加密,此参数必须传递 | |
signature | 否 | string | 签名,当应用所属的工作区间加密,此参数必须传递 |
成功返回示例
//参考样例1
<a href="http://192.168.0.55:8181/webclient?appliId=879408743551336448&codeRate=8000&frameRate=30" target="_blank">
<button>进入应用</button>
</a>
//参考样例2(附加参数)
1)默认传参【zhangsan 12 1200439309006536704】URL追加&cmdLineParamStyle=0参数或者不追加&cmdLineParamStyle参数
http://[服务器ip]:8181/webclient?appliId=[应用id]&extraParam.userName=zhangsan&extraParam.age=12&extraParam.cmdLineParamStyle=0
2)默认传参【 --cmdLineParamStyle=1 --userName=zhangsan --age=12 --taskId=1200439309006536704】URL追加&cmdLineParamStyle=1参数
http://[服务器ip]:8181/webclient?appliId=[应用id]&extraParam.userName=zhangsan&extraParam.age=12&extraParam.cmdLineParamStyle=1
3)默认传参【 -cmdLineParamStyle 2 -userName zhangsan -age 12 -taskId 1200439309006536704】URL追加&cmdLineParamStyle=2参数
http://[服务器ip]:8181/webclient?appliId=[应用id]&extraParam.userName=zhangsan&extraParam.age=12&extraParam.cmdLineParamStyle=1
//参考样例3(演示/互动模式)
1)口令模式
生成authCode
演示者:http://192.168.0.55:8181/webclient?appliId=879408743551336448playerMode=1&userType=1&authCode=888888
观看者(参与者):http://192.168.0.55:8181/appli/start?appliId=879408743551336448&playerMode=1&userType=0&authCode=888888
2)taskId模式(参与者的taskId为演示者进入应用之后产生的taskId)
演示者:http://192.168.0.55:8181/webclient?appliId=879408743551336448&playerMode=1&userType=1
观看者(参与者):http://192.168.0.55:8181/webclient?appliId=879408743551336448&playerMode=1&userType=0&taskId=733006441014624256
演示/互动模式使用工作空间加密访问
演示者:需要在密钥有效期内进入应用;
Url后面加参数:&wsId=77Ekeapp& timestamp=1594804883818&signature=EA4A9425AE1BBB52FEEC27B4A478E268466D3E
观看者(参与者):无需在密钥有效期内,只要演示者没有退出应用,就可以随时进入应用;
连接后面加参数:&wsId=77Ekeapp& timestamp=1594804883818&signature=EA4A9425AE1BBB52FEEC27B4A478E268466D3E
备注
签名的生成请参照