1.3.1 查询应用一览


1.3.1 查询应用一览

请求类型 GET
请求URL http: //{LarkXR3.2中心服务器IP}:8181/appli/search

升级说明

  • 接口地址由 “/vrAppli/search”变更为“/appli/search”,默认端口由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共享)】
  • 去除同步进度相关内容,包括:syncStatus,syncMessage,syncPercent
  • 去除deleteFlag删除标识

参考样例

 
说明:adminKey,timestamp,signature这三个参数有两种方式传递
一种是以参数的形式传递,例如:http://192.168.1.11:8282/vrAppli/search?adminKey=603299366654678855& timestamp=1585729005673&signature=4C1BFE264A113A99C526BF5565EEBE642792A0B6
另一种是在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/search");
名称 类型 是否必须 描述
adminKey String 该参数为后台管理接入凭证,在LarkXR3.3后台接入管理中查看
timestamp Long 发送请求时的时间戳
signature String 该参数为密钥签名。将adminKey(LarkXR3.3后台接入管理中查看)和adminSecret(LarkXR3.3后台中接入管理查看)和当前时间戳(long型数值)按字母序排序,然后进行SHA-1摘要签名。请参考【获取凭证签名】的样例。
status Integer 状态:1:上架 0:下架
appliId Long 应用Id
appliName String 应用名称
appliType Integer 应用类型: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共享)
appKey String 客户区分
page Integer 第几页,默认第一页
pageSize Integer 一页显示几条数据,默认为20
返回结果:
名称 类型 是否非空 描述
code Integer 返回状态
message String 返回消息
result Object Code=1000的时候,Api返回的数据
appliId String 应用id
appliName String 应用名称
appliType String 应用类型:应用类型: 1:独占GPU、2:共享GPU、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共享))
appKey String 客户区分
zipFile String 上传的zip程序包的路径
fileSize String zip包的大小
picUrl String 封面图url
appliPath String 应用程序的保存路径
exeFileName String 应用的启动文件路径
param String 应用程序启动的命令行参数
instanceMax Integer 该应用最大允许客户端并发数
status String 1:上架 0:下架
hasExtraParam String 启动应用时是否传递taskId 1:带有 0:不带
initWinSize String 初始化窗口方式
0:按照原始窗口大小显示
2:尽量填充容器(保存宽高比)
4:完全填充容器(拉伸)
frameLowerLimit Integer 最低帧率阈值
initiativeSyncFlag String 主动同步标识,默认是1。
1:热数据,表示上传应用后主动同步
0:冷数据,上传应用不主动同步
initCursorMode String 鼠标模式,默认是0。
0:非锁定模式。
1:锁定模式
offScreen String 是否离屏渲染,离屏渲染时能减少部分资源消耗,默认是1。
0:不是。1:是
fullScreenMode String 全屏模式(效果等同F11键),默认是0;
0:手动触发,按下F11键盘或者是左下角的全屏按钮。
1:首次点击屏幕使用的时候触发
2:每次点击屏幕的时候触发。
mobileFullScreenMode Integer 手机端全屏模式,默认是0;
0:手动触发。
1:首次点击屏幕使用的时候触发
2:每次点击屏幕的时候触发。
screenBgColor String web客户端的背景色,默认为空,即无背景色
startProcType String 独占模式下启动模式,大部分为标准模式:0,少部分为兼容模式:1
useGamepad String 该应用是否使用手柄,默认为0;0:不使用,1:使用
mobileForceLandscape String 手机端时是否强制横屏,默认为1;0:否,1:是
mobileVirtualJoystick String 手机端是否初始显示虚拟摇杆,默认为1;0:否,1:是
mouseZoomDirection String 触屏放大手势与滚轮映射,默认为1;0:滚轮下滚,1:滚轮上滚
playerListToggle String 演示/互动模式时是否显示玩家列表,默认为1;0:否,1:是
limitMaxFps String 是否限制应用帧率,默认为1;0:否,1:是
playModeEnable String 是否开启演示/互动模式 ,1:开启,0:关闭
createUser String  
createDate Long 创建时间
updateUser String
updateDate Long 更新时间

说明:
对于runCnt= instanceMax,表示连接的用户达到了允许的上限值

返回信息格式:

 
{
    "code": 1000,
    "message": "Success",
    "result": {
        "records": [
            {
                "appliId": "879408743551336448",
                "appliName": "people",
                "appliType": 2,
                "appKey": "Jx3wQMD1",
                "zipFile": "/opt/appli/20210903090337191/883276034881880064.zip",
                "fileSize": "457066859",
                "appliPath": "20210903090337191",
                "exeFileName": "MyProject4/Binaries/Win64/MyProject4.exe",
                "param": "",
                "status": 1,
                "instanceMax": 10,
                "hasExtraParam": 1,
                "initWinSize": 0,
                "frameLowerLimit": 30,
                "initiativeSyncFlag": 1,
                "initCursorMode": 0,
                "offScreen": 1,
                "fullScreenMode": 0,
                "screenBgColor": "",
                "startProcType": 0,
                "useGamepad": 0,
                "mobileForceLandscape": 1,
                "mobileVirtualJoystick": 1,
                "mouseZoomDirection": 1,
                "playerListToggle": 1,
                "limitMaxFps": 1,
                "touchOperateMode": "mouse",
                "dcs": 1,
                "playMode": 1,
                "createUser": "443167382534356992",
                "updateUser": "443167382534356992",
                "updateDate": "1630631045290"
            },
            {
                "appliId": "880081872544071680",
                "appliName": "附加参数测试",
                "appliType": 2,
                "appKey": "Jx3wQMD1",
                "zipFile": "/opt/appli/20210825132858530/880081323031527424.zip",
                "fileSize": "20826095",
                "appliPath": "20210825132858530",
                "exeFileName": "SimpleExtraParam.exe",
                "param": "",
                "status": 1,
                "instanceMax": 10,
                "hasExtraParam": 1,
                "initWinSize": 0,
                "frameLowerLimit": 30,
                "initiativeSyncFlag": 1,
                "initCursorMode": 0,
                "offScreen": 1,
                "fullScreenMode": 0,
                "screenBgColor": "",
                "startProcType": 0,
                "useGamepad": 0,
                "mobileForceLandscape": 1,
                "mobileVirtualJoystick": 1,
                "mouseZoomDirection": 1,
                "playerListToggle": 1,
                "limitMaxFps": 1,
                "touchOperateMode": "mouse",
                "dcs": 1,
                "playMode": 1,
                "createUser": "443167382534356992",
                "updateUser": "443167382534356992",
                "updateDate": "1629869568208"
            }
        ],
        "total": "2",
        "size": "15",
        "current": "1",
        "orders": [],
        "searchCount": true,
        "pages": "1"
    }
}

admin 2025年11月14日 14:22 收藏文档

开发者交流群

QQ群号:1011308692