3.2 接口文档
获取凭证的签名
1. 第三方接口开发说明
1.1.1 基础版接口说明
1.1.2 开发版接口说明
1.2基础版接口
1.2.1 获取开放的应用列表
1.2.2 进入应用
1.2.3 获取进入应用URL
1.2.4 获取请求附加参数
1.2.5 获取区域信息
1.2.6 生成roomCode-authCode
1.2.7 获取运行数
1.3开发版接口-应用管理
1.3.1 查询应用一览
1.3.2 上传应用程序包接口
1.3.3 上传课程封面图接口
1.3.4 创建应用
1.3.5 修改应用
1.3.6 更新应用上-下架状态
1.3.7 删除应用
1.3.8 后台启动VR应用
1.3.9 后台关闭VR应用
1.3.10 批量停止正在运行的应用
1.3.11 获取运行应用一览
1.3.12 获取已结束进程一览
1.4开发版接口-预启动应用
1.4.1 查询预启动应用一览
1.4.2 创建预启动应用接口
1.4.3 更新预启动应用接口
1.4.4 删除预启动应用接口
1.5开发版接口-Task管理
1.5.1 获取指定Task信息
1.5.2 获取使用次数最高的10个应用
1.5.3获取使用时长最高的10个应用
1.5.4按省统计应用使用情况
1.5.5按某个省统计各市使用情况
1.5.6统计其他使用情况
1.5.7统计总使用次数
1.5.8统计总使用时长
1.5.9统计当日使用次数
1.5.10统计当日使用时长
1.6开发版接口-节点管理
1.6.1渲染节点查询(分页
1.7开发版接口--VR管理
1.7.1客户端查询(分页)
1.7.2获取VR客户端资源使用情况
1.7.3VR客户端监控页面
1.8开发版接口-分组管理
1.8.1 分组查询
1.8.2添加组别
1.8.3修改组别
1.8.4删除组别
1.8.5设置组别的运行模式
1.8.6 获取组别的运行模式
1.8.7渲染服务器绑定组别
1.8.8组别批量绑定服务器
1.8.9渲染服务器解绑定组别
1.8.10组别批量解绑定服务器
1.8.11通过服务器ID和组别ID解绑定渲染服务器组别
1.9开发版接口-接入管理
1.9.1接入管理一览(分页)
1.9.2添加接入凭证
1.9.3更新接入管理
1.9.4删除接入管理
1.9.5更新接入后台密钥
1.9.6创建客户端凭证密钥
1.9.7清除客户端凭证密钥
1.10开发版接口-其他
1.10.1获取系统名称
1.10.2获取系统版本号
1.10.3获取眼镜客户端资源监控数据
1.10.4获取服务端资源监控数据
1.10.5 远程桌面连接
1.11开发版接口-参数设置
1.11.1参数设置查询
1.11.2无操作时限-查询
1.11.3无操作超时-更新
1.11.4存储-查询
1.11.5应用存储类型存储-更新
1.11.6是否保存VR监控数据-更新
1.11.7VR监控数据保存期限-更新
1.11.8VR是否保存服务器资源使用率数据-更新
1.11.9是否开启应用一览页面-查询
1.11.10是否开启应用一览页面-保存
1.11.11 IP黑白名单-查询
1.11.12 IP黑白名单-新增
1.11.13 IP黑白名单-删除
1.11.14 端口映射-查询
1.11.15 端口映射-新增
1.11.16 端口映射-更新
1.11.17 端口映射-删除
1.11.18 定制免费版Logo-查询
1.11.19 定制免费版Logo-更新
1.11.20 免费版Logo-清除
1.11.21免费版Logo圆盘-保存
2.code对照
code对照
3.后台功能
3.1接入管理
-
+
首页
1.3.4 创建应用
**1.3.4 创建应用** 请求参数: | 请求类型 | POST | | ------------ | ------------ | | **请求URL** |http: //{LarkXR3.2管理服务器的IP}:8181/appli/add | **升级说明** - 接口地址由“/vrAppli/add”变更为“/appli/add”,默认端口由8282变为8181 - 上架下架状态由“startFlag”改为“status” - 应用类型(appliType)字段的选型由 【应用类型: 1:独占GPU、2:SR(3D共享)、3:VR(SteamVR)、5:VR(SteamVR:依赖Steam)、6:VR(Nvidia)、7:VR(OpenXR)、9:AR(PXY)、11:AR(Nvidia)、13:SR(共享GPU-UE像素流送)】 、14:SR(2D共享)】 - 启动应用时命令行参数是否传递TaskId字段的可选值由 N(否)、Y(是) 变更为 0(否)、1(是) **参考样例** ``` 说明:adminKey,timestamp,signature这三个参数需要在OkHttp请求的header中传递 例如:Request.Builder builder = new Request.Builder(). addHeader("adminKey", "603299366654678855") .addHeader("timestamp", "1585729005673") .addHeader("signature", "4C1BFE264A113A99C526BF5565EEBE642792A0B6") .url("http://192.168.1.11:8181/appli/add"); ``` | 名称 | 类型 | 是否非空 | 描述 | | ------------ | ------------ | ------------ | ------------ | | appliName | String | 是 | 应用名称 | | appliType | String | 是 | 应用类型:1:独占GPU、2:SR(3D共享)、3:VR(SteamVR)、5:VR(SteamVR:依赖Steam)、6:VR(Nvidia)、7:VR(OpenXR)、9:AR(PXY)、11:AR(Nvidia)、13:SR(共享GPU-UE像素流送)】 、14:SR(2D共享) | | zipFile | String | 否 | 应用程序包的完整路径,对应【上传应用程序包】接口返回值的zipFilePath参数 (注意:选择上传zip包方式发布应用时,此参数为必填项) | | fileSize | String | 否 | 应用程序的大小,对应应用程序包上传接口返回值的fileSize参数 (注意:上传zip包时,此参数为必填项) | | appliPath | String | 否 | 应用程序压缩包保存路径,对应应用程序包上传接口返回值的appliPath参数 ,没上传应用时,传空值 | | appKey | String | 是 | 所属客户端凭证 ,默认传入"Jx3wQMD1" | | picUrl | String | 否 | 封面图路径,对应课程封面图接口返回值的fileName参数 | | exeFileName | String | 是 | 应用的启动文件路径(压缩包内的相对路径) | | param | String | 否 | 启动应用的命令行参数 | | status | Integer | 否 | 1:上架 0:下架 | | instanceMax | Integer | 否 | 应用最大同时运行数量 ,默认为1 | | hasExtraParam | Integer | 是 | 应用启动的命令行参数是否传递TaskId: 0(否)、1(是) | | initWinSize | Integer | 否 | 初始化窗口方式, 默认值:0 .<br/> 0:按照原始窗口大小显示<br/>2:尽量填充容器(保存宽高比)<br/>4:完全填充容器(拉伸)| | frameLowerLimit | Integer | 否 | 最低帧率阈值 | | initiativeSyncFlag | Integer | 是 | 冷热数据,默认是1。1:热数据,表示上传应用后主动同步,0:冷数据,上传应用不主动同步 | | initCursorMode | Integer | 否 | 鼠标模式,默认是0。<br/>0:非锁定模式,1:锁定模式 | | offScreen | Integer | 是 | 是否离屏渲染,默认是1,离屏渲染时能减少部分资源消耗。0:不是离屏渲染。1:是离屏渲染 | | fullScreenMode | Integer | 是 | 全屏模式(效果等同F11键),默认是0;<br/>0:手动触发,按下F11键盘或者是左下角的全屏按钮。<br/>1:首次点击屏幕使用的时候触发 <br/>2:每次点击屏幕的时候触发。 | | mobileFullScreenMode | Integer | 是 | 手机端全屏模式,默认是0;<br/>0:手动触发。<br/>1:首次点击屏幕使用的时候触发<br/> 2:每次点击屏幕的时候触发。 | | screenBgColor | String | 否 | web客户端的背景色,默认为空,即无背景色 | | startProcType | Integer | 是 | 独占模式下启动模式,大部分为标准模式:0,少部分为兼容模式:1 | | useGamepad | Integer | 是 | 该应用是否使用手柄,默认为0;0:不使用,1:使用 | | mobileForceLandscape | Integer | 是 | 手机端时是否强制横屏,默认为1;0:否,1:是 | | mobileVirtualJoystick | Integer | 是 | 手机端是否初始显示虚拟摇杆,默认为1;0:否,1:是 | | mouseZoomDirection | Integer | 是 | 触屏放大手势与滚轮映射,默认为为1;0:滚轮下滚,1:滚轮上滚 | | playerListToggle | Integer | 是 | 演示/互动模式是否显示玩家列表,默认为为1;0:否,1:是 | | limitMaxFps | Integer | 否 | 共享模式下是否限制应用本身的渲染帧率,默认为为1;0:否,1:是 | | touchOperateMode | String | 否 | 移动端的触摸指令模式,默认值为mouse;<br/>mouse:鼠标,<br/>touch:触摸,<br/>当使用【touch】时,客户端的触摸指令直接以windows的原生触摸指令发送给渲染服务器 | | dcs | Integer | 否 | 是否使用数据通道,默认值为1;<br/>0:否,1:是 | | playMode | Integer | 否 | 是否使用演示/互动模式,默认值为1; <br/>0:否,1:是 | | arAlphaMask | Integer | 否 | AR应用是否使用透明遮罩; <br/>0:否,1:是 | | audioInput | Integer | 否 | 是否使用客户端音频输入(麦克风),默认值为0;<br/>0:否,1:是 | | audioInputAutoStart | Integer | 否 | 是否自动开启客户端音频输入,默认值为0;<br/>0:否,1:是 | | videoInput | Integer | 否 | 是否使用客户端视频输入(摄像头),默认值为0;<br/>0:否,1:是 | | videoInputAutoStart | Integer | 否 | 是否自动开启客户端视频输入,默认值为0;<br/>0:否,1:是 | | textInputEventPrompt | Integer | 否 | 是否启用客户端文字输入事件提示,默认值为0;<br/>0:否,1:是 | | liveStreaming | Integer | 否 | 是否开启直播推流功能,默认值为0;<br/>0:否,1:是 | | vrControllerType | Integer | 否 | VR手柄类型,<br/>0:默认,<br/>1:Quest,2:HTC,<br/>3:Pico,4:Nolo | | qpMin | Integer | 否 | QP 最小值,默认值为20,取值范围15-25 | | qpMax | Integer | 否 | QP 最大值,默认值为35,取值范围30-40 | | mobileKeyboardType | Integer | 否 | 手机端输入键盘类型,默认值为0;<br/>0:默认系统键盘,1:虚拟键盘 | | adminKey | String | 是 | 参见1.3.1 | | timestamp | Long | 是 | 参见1.3.1 | | signature | String | 是 | 参见1.3.1 | 返回结果: | 名称 | 类型 | 是否非空 | 描述 | | ------------ | ------------ | ------------ | ------------ | | code | Integer | 是 | 返回状态 | | message | String | 否 | 返回消息 | |result |Object | 否 | 返回应用信息 | **说明:** 1)调用该接口之前需要使用上传应用程序包接口进行应用程序的上传。
admin
2025年3月13日 19:20
转发文档
收藏文档
上一篇
下一篇
手机扫码
复制链接
手机扫一扫转发分享
复制链接
开发者交流群
QQ群号:1011308692
Markdown文件
Word文件
PDF文档
PDF文档(打印)
分享
链接
类型
密码
更新密码
有效期