简要描述
请求URL
{{adminHost:8181}}/appli/update
请求方式
| 字段名 |
示例值 |
必选 |
类型 |
说明 |
| adminKey |
603284317954637824 |
是 |
string |
该参数为后台管理接入凭证，在LarkXR3.3后台接入管理中查看 |
| timestamp |
8641706679604867 |
是 |
string |
发送请求时的时间戳，单位为毫秒 |
| signature |
9A02B47AE67664D80A2ED13FC2B1691512613790 |
是 |
string |
该参数为密钥签名。将adminKey（LarkXR3.2后台接入管理中查看）和adminSecret（LarkXR3.3后台中接入管理查看）和当前时间戳（long型数值）按字母序排序，然后进行SHA-1摘要签名。请参考【获取凭证签名】的样例 |
请求Body参数
| 参数名 |
示例值 |
必选 |
类型 |
说明 |
| appliId |
1217888371372720128 |
是 |
string |
必填项：应用Id |
| appliName |
111 |
否 |
string |
应用名称 |
| appliType |
2 |
是 |
string |
必填项：应用类型，分为1：SR独占，2：3D共享，3：SteamVR，5：VR(SteamVR:依赖Steam), 7:OpenXR, 9:PXY_AR, 11:NV_AR, 13：像素流送, 14:2D共享 |
| accessType |
|
否 |
string |
公开性：1：公开应用（默认） 0：私有应用 |
| pkgId |
100178 |
是 |
string |
必填项：程序包Id |
| version |
1 |
是 |
string |
必填项：程序包版本号 |
| lastUpdateDate |
1710482216090 |
是 |
string |
必填项：上次应用的更新时间 |
| param |
|
否 |
string |
应用的启动参数，启动时附加到命令行参数后面。V3.3.2.0及以后版本生效。 |
| groupId |
|
否 |
string |
组别ID，应用配置页面要么不指定，要么指定特定的其他组别，不用配置默认组别 |
| picUrl |
|
否 |
string |
封面图URL |
| instanceMax |
|
否 |
string |
最大并发数量，默认1（表示最多1个并发） |
| hasExtraParam |
|
否 |
string |
进入应用接口是否携带附加参数，默认0。 0（否）、1（是） |
| initWinSize |
|
否 |
string |
窗口填充方式 ，默认0。 0：按原始窗口大小显示（不超过终端屏幕）、5：按应用原始窗口显示（超过终端屏幕出现滚动条）、2：尽量填充容器（保存宽高比，不超过终端屏幕）、10：优先垂直方向填充（保持宽高比，水平方向允许出现滚动条）、15：优先垂直方向填充（保持宽高比，垂直方向允许出现滚动条）、4：完全填充容器（拉伸） |
| initResolutionType |
|
否 |
string |
初始化分辨率方式， 0：应用默认分辨率、 1：适应客户端窗口 |
| frameLowerLimit |
|
否 |
string |
最低帧率，默认30：每秒30帧 |
| initCursorMode |
|
否 |
string |
鼠标模式， 0：自动判断、1：锁定、2：非锁定 |
| offScreen |
|
否 |
string |
是否离屏渲染，离屏渲染时能减少部分资源消耗，默认是1。 0：不是。1：是 |
| fullScreenMode |
|
否 |
string |
全屏模式（效果等同F11键），默认是0； 0：手动触发，按下F11键盘或者是左下角的全屏按钮。 1：首次点击屏幕使用的时候触发 2：每次点击屏幕的时候触发。 |
| mobileFullScreenMode |
|
否 |
string |
手机端全屏模式，默认是0； 0：手动触发 1：首次点击屏幕使用的时候触发 2：每次点击屏幕的时候触发。 |
| startProcType |
|
否 |
string |
独占模式下启动模式，默认为0；大部分为标准模式：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：是 |
| touchOperateMode |
|
否 |
string |
移动端的触摸指令模式，默认为mouse； mouse：鼠标，touch：触摸，touch时，客户端的触摸指令直接以windows的原生触摸指令发送给渲染服务器，mix：混合模式，鼠标和触摸事件一起发送 |
| initiativeSyncFlag |
|
否 |
string |
主动同步标识，默认为1； 0：不主动同步、1：主动同步、2：半主动同步 |
| scs |
|
否 |
string |
应用是否使用智能语音服务，默认为0：1使用，0不使用 |
| arAlphaMask |
|
否 |
string |
AR应用是否使用了透明遮罩的，默认值为1，0：关闭，1：开启 |
| audioInput |
|
否 |
string |
是否开启客户端音频（麦克风）输入功能，默认为0；1开启，0不开启 |
| audioInputAutoStart |
|
否 |
string |
是否自动开启麦克风，默认为0；1开启，0不开启 |
| videoInput |
|
否 |
string |
是否开启客户端视频（摄像头）输入功能，默认为0；1开启，0不开启 |
| videoInputAutoStart |
|
否 |
string |
是否自动开启摄像头，默认为0；1开启，0不开启 |
| videoInputCnt |
|
否 |
string |
应用使用的摄像头数量，默认为1 |
| textInputEventPrompt |
|
否 |
string |
是否启用客户端文字输入事件提示，默认为1；1开启，0不开启 |
| liveStreaming |
|
否 |
string |
是否开启直播推流，默认为0；1开启，0不开启 |
| vrControllerType |
|
否 |
string |
VR手柄类型，默认为0；0:默认,1:Quest,2:HTC,3:Pico,4:Nolo |
| qpMin |
|
否 |
string |
编码qp最小值，默认为20； |
| qpMax |
|
否 |
string |
编码qp最大值，默认为35； |
| mobileKeyboardType |
|
否 |
string |
移动端输入键盘类型 ，默认为0；0:默认系统键盘，1:虚拟键盘 |
| mobileWebMenuType |
|
否 |
string |
移动端菜单类型，默认为0； 0：控制球、 1：菜单栏 |
| taskCloseType |
|
否 |
string |
实例关闭方式，默认为0；0即时关闭(默认)、1延迟关闭 |
| delayCloseDuration |
|
否 |
string |
延迟关闭的延迟时间，单位秒，默认20秒 |
| reqGpuMemMax |
|
否 |
string |
最大GPU显存需求量（单位M）,用于分配请求时检查显存是否充足，默认值0：不考虑当前应用显存需求，只检查当前GPU显存使用量 |
| useWebCodec |
|
否 |
string |
是否使用WebCodec，默认为0；0：不使用、1：使用。当使用时，可以配合preferDecoder传递h265编码，在https的环境下使用8K |
| preferDecoder |
|
否 |
string |
优先使用的解码格式标准：’auto’ 、’vp8’ 、 ‘vp9’ 、 ‘h264’ 、 ‘h265’ 、’hevc’ 、’av1’ 、’av1x’,默认值h264 |
成功返回示例
{
"code": 1000,
"message": "更新成功",
"result": {
"appliName": "",
"accessType": 1,
"wsId": "Jx3wQMD1",
"picUrl": "",
"zipFile": "",
"appliPath": "",
"exeFileName": "1.exe",
"exeFileNameList": "",
"param": "",
"status": 1,
"instanceMax": 1,
"hasExtraParam": 0,
"initWinSize": 0,
"initResolutionType": 0,
"frameLowerLimit": 30,
"initiativeSyncFlag": 1,
"initCursorMode": 0,
"offScreen": 1,
"fullScreenMode": 0,
"mobileFullScreenMode": 0,
"startProcType": 0,
"useGamepad": 0,
"mobileForceLandscape": 1,
"mobileVirtualJoystick": 1,
"mobileKeyboardType": 0,
"mobileWebMenuType": 0,
"mouseZoomDirection": 1,
"playerListToggle": 1,
"limitMaxFps": 1,
"touchOperateMode": "mouse",
"dcs": 1,
"playMode": 1,
"scs": 0,
"audioInput": 0,
"audioInputAutoStart": 0,
"videoInput": 0,
"videoInputAutoStart": 0,
"videoInputCnt": 1,
"liveStreaming": 0,
"textInputEventPrompt": 1,
"qpMin": 20,
"qpMax": 35,
"taskCloseType": 0,
"delayCloseDuration": 20,
"reqGpuMemMax": 0,
"useWebCodec": 0,
"preferDecoder": "h264",
"updateDate": "1706778954206"
}
}
成功返回示例的参数说明
| 参数名 |
类型 |
说明 |
| code |
string |
响应码 |
| message |
string |
响应消息 |
| result |
object |
响应结果 |
| appliName |
string |
应用名称 |
| appliType |
int |
应用类型： 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共享）) |
| accessType |
int |
1：公开应用、 0：私有应用 |
| wsId |
string |
工作空间Id |
| picUrl |
string |
封面图 |
| zipFile |
string |
应用zuip包全路径 |
| appliPath |
string |
应用程序的保存路径 |
| exeFileName |
string |
应用的执行文件路径 |
| exeFileNameList |
array |
应用的exe列表 |
| param |
string |
应用程序启动的命令行参数 |
| status |
int |
1：上架 0：下架 |
| instanceMax |
int |
该应用最大允许客户端并发数 |
| hasExtraParam |
int |
应用启动的命令行参数是否传递TaskId， 0（否）、1（是） |
| initWinSize |
int |
窗口填充方式 ， 0：按原始窗口大小显示（不超过终端屏幕）、5：按应用原始窗口显示（超过终端屏幕出现滚动条）、2：尽量填充容器（保存宽高比，不超过终端屏幕）、10：优先垂直方向填充（保持宽高比，水平方向允许出现滚动条）、15：优先垂直方向填充（保持宽高比，垂直方向允许出现滚动条）、4：完全填充容器（拉伸） |
| initResolutionType |
int |
初始化分辨率方式， 0：应用默认分辨率、 1：适应客户端窗口 |
| frameLowerLimit |
int |
最低帧率，默认30：每秒30帧 |
| initiativeSyncFlag |
int |
主动同步标识， 0：不主动同步、1：主动同步、2：半主动同步 |
| initCursorMode |
int |
鼠标模式， 0：自动判断、1：锁定、2：非锁定 |
| offScreen |
int |
是否离屏渲染，离屏渲染时能减少部分资源消耗，默认是1。 0：不是。1：是 |
| fullScreenMode |
int |
全屏模式（效果等同F11键），默认是0； 0：手动触发，按下F11键盘或者是左下角的全屏按钮。 1：首次点击屏幕使用的时候触发 2：每次点击屏幕的时候触发。 |
| mobileFullScreenMode |
int |
手机端全屏模式，默认是0； 0：手动触发 1：首次点击屏幕使用的时候触发 2：每次点击屏幕的时候触发。 |
| startProcType |
int |
独占模式下启动模式，大部分为标准模式：0，少部分为兼容模式：1 |
| useGamepad |
int |
该应用是否使用手柄，默认为0；0：不使用，1：使用 |
| mobileForceLandscape |
int |
手机端时是否强制横屏，默认为1；0：否，1：是 |
| mobileVirtualJoystick |
int |
手机端是否初始显示虚拟摇杆，默认为1；0：否，1：是 |
| mobileKeyboardType |
int |
移动端输入键盘类型 ，0:默认系统键盘，1:虚拟键盘 |
| mobileWebMenuType |
int |
移动端菜单类型， 0：控制球、 1：菜单栏 |
| mouseZoomDirection |
int |
触屏放大手势与滚轮映射，默认为1；0：滚轮下滚，1：滚轮上滚 |
| playerListToggle |
int |
演示/互动模式是否显示玩家列表，默认为1；0：否，1：是 |
| limitMaxFps |
int |
在共享模式下是否限制应用本身的帧率，默认为1；0：否，1：是 |
| touchOperateMode |
string |
移动端的触摸指令模式，mouse：鼠标，touch：触摸，touch时，客户端的触摸指令直接以windows的原生触摸指令发送给渲染服务器，mix：混合模式，鼠标和触摸事件一起发送 |
| dcs |
int |
应用级别是否支持数据通道服务，1支持，0不支持 |
| playMode |
int |
应用级别是否支持互动模式，1支持，0不支持 |
| scs |
int |
应用是否使用智能语音服务，1使用，0不使用 |
| audioInput |
int |
是否开启客户端音频（麦克风）输入功能，1开启，0不开启 |
| audioInputAutoStart |
int |
是否自动开启麦克风，1开启，0不开启 |
| videoInput |
int |
是否开启客户端视频（摄像头）输入功能，1开启，0不开启 |
| videoInputAutoStart |
int |
是否自动开启摄像头 |
| videoInputCnt |
int |
应用使用的摄像头数量 |
| liveStreaming |
int |
是否开启直播推流，1开启，0不开启 |
| textInputEventPrompt |
int |
是否启用客户端文字输入事件提示，1开启，0不开启 |
| qpMin |
int |
编码qp最小值 |
| qpMax |
int |
编码qp最大值 |
| taskCloseType |
int |
实例关闭方式：0即时关闭(默认)、1延迟关闭 |
| delayCloseDuration |
int |
延迟关闭的延迟时间，单位秒，默认20秒 |
| reqGpuMemMax |
int |
最大GPU显存需求量（单位M）,用于分配请求时检查显存是否充足，默认值0：不考虑当前应用显存需求，只检查当前GPU显存使用量 |
| useWebCodec |
int |
是否使用WebCodec，0：不使用、1：使用。当使用时，可以配合preferDecoder传递h265编码，在https的环境下使用8K |
| preferDecoder |
string |
优先使用的解码格式标准：’auto’ 、’vp8’ 、 ‘vp9’ 、 ‘h264’ 、 ‘h265’ 、’hevc’ 、’av1’ 、’av1x’,默认值h264 |
| updateDate |
long |
更新时间 |
失败返回示例
{
"code": 500,
"message": "appliId不能为空"
}
失败返回示例的参数说明
| 参数名 |
类型 |
说明 |
| code |
string |
无 |
| message |
string |
无 |
备注
