简要描述
- 在启动应用时候调用,获取到URL后立即访问,20S后链接超时失效
请求URL
{{adminHost:8181}}/appli/getStartURL
请求方式
- get
请求Query参数
参数名 | 示例值 | 必选 | 类型 | 说明 |
---|---|---|---|---|
appliId | 1199762458126843904 | 是 | string | 应用ID |
endDate | 否 | string | 预定结束时间,为毫秒时间戳 | |
clientMac | 否 | string | 眼镜客户端Mac地址(眼镜客户端时必须,否则监控数据不显示) | |
groupId | 否 | string | 分组ID,用于服务器/客户端分组管理 | |
regionId | 否 | string | 数据中心分区ID,一般用于根据分区测试后客户端优先使用指定分区的服务器节点, 和groupId不能同时指定 | |
taskId | 否 | string | 运行应用实例的任务ID | |
playerMode | 否 | string | 启动模式:0-普通模式, 1-演示模式(一人操作多人观看),2-互动模式(键盘鼠标放开,需要应用配合) | |
userType | 否 | string | 演示模式/互动模式时用户类别,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 | 否 | string | 时间戳(ms),当应用所属的工作区间加密,此参数必须传递 | |
signature | 否 | string | 签名,当应用所属的工作区间加密,此参数必须传递 |
成功返回示例
{
"code": 1000,
"message": "",
"result": "/webclient/?appliId=1199762458126843904&appliType=2&taskId=1201901299344343040&taskStatus=1&codeRate=15000&frameRate=60&audioCodeRate=32&preferDecoder=h264&useWebCodec=0&renderServerIp=192.168.0.28&renderServerPort=10002&renderSSLServerPort=10004&preferPublicIp=&serverId=c255ced0be4451c5ba5524b926a53816&wsProxy=0&initWinSize=0&initResolutionType=0&initCursorMode=0&fullScreenMode=0&mobileFullScreenMode=0&mobileForceLandscape=1&mobileVirtualJoystick=1&useGamepad=0&mouseZoomDirection=1&playerListToggle=1&noOperationTimeout=0&touchOperateMode=mouse&vrControllerType=0&logLevel=warn&rttLimit=80&rttLimitInterval=30&appliName=test33&wsId=Jx3wQMD1&language=zh-CN&random=1706597200142"
}
失败返回示例
{
"code": 500,
"message": "appliId不能为空"
}
备注
获取到结果之后,需要拼接前端页面的域名使用,可以直接打开URL,需要注意的是,连接有效期为20S