Concise description
-
- If you choose to upload the application package,you must first call the interface for uploading the ZIP package,and then call the interface for creating the package.
Request URL
{{adminHost:8181}}/appli/add
Request Method
- post
Header
| Field Name | Sample | Required | Type | Note |
|---|---|---|---|---|
| adminKey | 603284317954637824 | Yes | string | This parameter is for backend management access credentials, which can be viewed in LarkXR3.3 backend access management |
| timestamp | 8641706679604867 | Yes | string | The timestamp when sending a request, in milliseconds |
| signature | 9A02B47AE67664D80A2ED13FC2B1691512613790 | Yes | string | This parameter is a key signature. Sort the adminKey (viewed in LarkXR3.2 backend access management), adminSecret (viewed in LarkXR3.3 backend access management), and current timestamp (long value) in alphabetical order, and then perform SHA-1 summary signature. Please refer to the example of [Obtaining Voucher Signature] |
Request Body Parameters
| Field Name | Sample | Required | Type | Note |
|---|---|---|---|---|
| appliName | 111 | Yes | string | Application name |
| appliType | 2 | Yes | string | Application types, divided into 1: SR exclusive, 2: 3D sharing, 3: SteamVR, 5: VR (SteamVR: dependent on Steam), 7: OpenXR, 9: PXY-AR, 11: NV-AR, 13: Pixel streaming, 14:2D sharing |
| accessType | No | string | Publicity: 1: Public application (default) 0: Private application | |
| pgmId | No | string | If you choose to upload the application package, you must provide the pgmId parameter to specify the package project ID (corresponding to the pgmId returned by adding the package interface). | |
| wsId | No | string | If pgmId is passed, there is no need to pass this field. The system backend directly obtains the wsId corresponding to the package. | |
| groupId | No | string | Group ID, the application configuration page either does not specify it or specifies a specific other group, without configuring the default group. | |
| syncRegions | No | string | If you choose to upload the application package and select the synchronization area during semi-active synchronization (initiativeSyncFlag pass 2), all areas are represented when the area is empty. The area ID is separated by commas (corresponding to the syncRegions value returned by the package query or creation interface). |
|
| syncCoefficent | No | string | If you choose to upload the application package and choose the synchronization coefficient for semi-active synchronization, it defaults to 1. This means that only one node is selected in a region to synchronize an application (corresponding to the ‘syncCoefficent’ value returned by the package query or creation interface). | |
| picUrl | No | string | Cover image URL | |
| instanceMax | No | string | Maximum concurrent quantity, default to 1 (indicating a maximum of 1 concurrent) | |
| hasExtraParam | No | string | Whether to carry additional parameters when entering the application interface, default to 0. 0 (no), 1 (yes) | |
| initWinSize | No | string | Window filling method, default to 0. 0: Display according to the original window size (not exceeding the terminal screen), 5: Display according to the original window size of the application (scrolling bars appear when exceeding the terminal screen), 2: Try to fill the container as much as possible (maintaining aspect ratio, not exceeding the terminal screen), 10: Priority is given to vertical filling (maintaining aspect ratio, scrolling bars are allowed in the horizontal direction), 15: Priority is given to vertical filling (maintaining aspect ratio, scrolling bars are allowed in the vertical direction), 4: Complete filling of the container (stretching) | |
| initResolutionType | No | string | Initialize resolution method, 0: Apply default resolution, 1: Adapt to client window | |
| frameLowerLimit | No | string | Minimum frame rate, default 30: 30 frames per second | |
| initCursorMode | No | string | Mouse mode, 0: automatic judgment, 1: locked, 2: unlocked | |
| offScreen | No | string | Whether to render off screen? Off screen rendering can reduce some resource consumption, default is 1. 0: not. 1: yes | |
| fullScreenMode | No | string | Full screen mode (equivalent to F11 key), default is 0; 0: Manually triggered by pressing the F11 keyboard or the full screen button in the bottom left corner. 1: Triggered when the screen is clicked for the first time. 2: Triggered every time the screen is clicked. | |
| MobileFullScreenMode | No | string | Full screen mode on the mobile phone, default to 0; 0: manual trigger 1: triggered when first clicking on the screen 2: triggered every time the screen is clicked. | |
| startProcType | No | string | Starting mode in exclusive mode, default to 0; most in standard mode: 0, a few in compatibility mode: 1 | |
| useGamepad | No | string | Whether the application uses a handle, default to 0; 0: not used, 1: used | |
| MobileForceLandscape | No | string | Whether to force landscape view on the mobile end, default to 1; 0: No, 1: Yes | |
| MobileVirtualJoystick | No | string | Does the mobile end initially display a virtual joystick, default to 1; 0: No, 1: Yes | |
| mouseZoomDirection | No | string | Touch screen zoom gesture and scroll wheel image, default to 1; 0: scroll wheel down, 1: scroll wheel up | |
| playerListTag | No | string | Whether to display player list in demonstration/interactive mode, default to 1; 0: No, 1: Yes | |
| limitMaxFps | No | string | Whether to limit the frame rate of the application itself in shared mode, default to 1; 0: No, 1: Yes | |
| touchOperateMode | No | string | The touch command mode on the mobile end is set to ‘mouse’ by default. ‘mouse’: mouse ‘,’ touch ‘: touch’. When touching, the client’s touch command is directly sent to the rendering server as the native touch command of Windows. ‘mix’: mixed mode. The mouse and touch events are sent together. | |
| initiativeSyncFlag | No | string | Active synchronization identifier, default to 1; 0: No active synchronization, 1: Active synchronization, 2: Semi active synchronization | |
| scs | No | string | Whether the application uses intelligent voice service, default to 0:1 use, 0 not use | |
| arAlphaMask | No | string | Does the AR application use a transparent mask? The default values are 1, 0: off, 1: on. | |
| audioInput | No | string | Whether to enable client audio (microphone) input function, default to 0; 1 enabled, 0 not enabled | |
| audioInputAutoStart | No | string | Whether to automatically turn on the microphone, default to 0; 1 on, 0 not on | |
| videoInput | No | string | Whether to enable the client video (camera) input function, default to 0; 1 enabled, 0 not enabled | |
| videoInputAutoStart | No | string | Whether to automatically turn on the camera, default to 0; 1 on, 0 not on | |
| videoInputCnt | No | string | The number of cameras used by the application, defaults to 1 | |
| textInputEventPrompt | No | string | Whether to enable client text input event prompts, default to 1; 1 enabled, 0 not enabled | |
| liveStreaming | No | string | Whether to enable live streaming, default to 0; 1 enabled, 0 not enabled | |
| vrControllerType | No | string | VR controller type, default to 0; 0: default, 1: Quest, 2: HTC, 3: Pico, 4: Nolo | |
| qpMin | No | string | The minimum value of encoding qp, default to 20; | |
| qpMax | No | string | The maximum value of encoding qp, default to 35; | |
| MobileKeyboardType | No | string | Mobile input keyboard type, default to 0; 0: default system keyboard, 1: virtual keyboard | |
| MobileWebMenu type | No | string | Mobile menu type, default to 0; 0: Control ball, 1: Menu bar | |
| taskCloseType | No | string | Instance shutdown method, default to 0; 0 immediate shutdown (default), 1 delayed shutdown | |
| delayCloseDuration | No | string | Delay time for closing delay, in seconds, default to 20 seconds | |
| reqGpuMemMax | No | string | Maximum GPU memory demand (in units of M), used to check if there is sufficient memory when allocating requests. Default value 0: does not consider the current application memory demand, only checks the current GPU memory usage. | |
| useWebCodec | No | string | Whether to use WebCodec, default to 0; 0: not used, 1: used. When used, it can be used in conjunction with preferDecoder to pass H265 encoding, using 8K in an HTTPS environment. | |
| preferDecoder | No | string | Priority decoding format standards: ‘auto’, ‘vp8’, ‘vp9’, ‘h264’, ‘h265’, ‘hevc’, ‘av1’, ‘av1x’, default value of h264 |
Success Response Example
{
"code": 1000,
"message": "success",
"result": {
"appliId": "1202661036155469824",
"appliName": "111",
"appliType": 111,
"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": "1",
"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",
"createDate": "1706778335381",
"updateDate": "1706778335381",
"deleteFlag": 0
}
}
Parameter Note for Success Response Example
| Field Name | Type | Note |
|---|---|---|
| code | string | Response code |
| message | string | Response message |
| result | object | Response result |
| appliId | long | Application Id |
| appliName | string | Application name |
| appliType | int | Application types: 1: Exclusive GPU, 2: Shared GPU, 3: VR (SteamVR), 5: VR (SteamVR: Dependent on Steam), 6: VR (Nvidia), 7: VR (OpenXR), 9: AR (PXY), 11: AR (Nvidia), 13: SR (Shared GPU-UE Pixel Streaming), 14: SR (2D Sharing) |
| accessType | int | 1: Public application, 0: Private application |
| wsId | string | Workplace Id |
| groupId | long | Group Id |
| fileSize | int | Application size |
| appliPath | string | The path to save the application |
| exeFileName | string | Application’s execution file path |
| exeFileNameList | array | List of exe applications |
| param | string | Command line parameters for application startup |
| status | int | 1: Put on shelves 0: Take off shelves |
| instanceMax | int | The maximum number of concurrent clients allowed for this application |
| hasExtraParam | int | Does the command line parameter for application startup pass TaskId, 0 (no), 1 (yes) |
| initWinSize | int | Window filling method, 0: Display according to the original window size (not exceeding the terminal screen), 5: Display according to the original window size of the application (scrolling bars appear when exceeding the terminal screen), 2: Try to fill the container as much as possible (save aspect ratio, not exceeding the terminal screen), 10: Priority is given to vertical filling (maintain aspect ratio, scrolling bars are allowed in the horizontal direction), 15: Priority is given to vertical filling (maintain aspect ratio, scrolling bars are allowed in the vertical direction), 4: Fully fill the container (stretch) |
| initResolutionType | int | Initialize resolution method, 0: Apply default resolution, 1: Adapt to client window |
| frameLowerLimit | int | Minimum frame rate, default 30: 30 frames per second |
| initiativeSyncFlag | int | Active synchronization identifier, 0: Non active synchronization, 1: Active synchronization, 2: Semi active synchronization |
| initCursorMode | int | Mouse mode, 0: automatic judgment, 1: locked, 2: unlocked |
| offScreen | int | Whether to render off screen? Off screen rendering can reduce some resource consumption, default is 1. 0: not. 1: yes |
| fullScreenMode | int | Full screen mode (equivalent to F11 key), default is 0; 0: Manually triggered, press the F11 keyboard or the full screen button in the bottom left corner. 1: Triggered when the screen is first clicked. 2: Triggered every time the screen is clicked. |
| MobileFullScreenMode | int | Full screen mode on the mobile phone, default to 0; 0: manual trigger 1: triggered when first clicking on the screen 2: triggered every time the screen is clicked. |
| startProcType | int | In exclusive mode, the startup mode is mostly standard mode: 0, and a few are compatibility mode: 1 |
| useGamepad | int | Whether the application uses a controller, default to 0; 0: not used, 1: used |
| MobileForceLandscape | int | Whether to force landscape view on the mobile end, default to 1; 0: No, 1: Yes |
| MobileVirtualJoystick | int | Does the mobile end initially display a virtual joystick, default to 1; 0: No, 1: Yes |
| MobileKeyboardType | int | Mobile input keyboard type, 0: default system keyboard, 1: virtual keyboard |
| MobileWebMenu type | int | Mobile menu type, 0: Control ball, 1: Menu bar |
| mouseZoomDirection | int | Touch screen zoom gesture and scroll wheel image, default to 1; 0: scroll wheel down, 1: scroll wheel up |
| playerListTag | int | Whether to display player list in demonstration/interactive mode, default to 1; 0: No, 1: Yes |
| limitMaxFps | int | Whether to limit the frame rate of the application itself in shared mode, default to 1; 0: No, 1: Yes |
| touchOperateMode | string | The touch command mode of the mobile end, mouse: mouse, touch: touch, when touch, the client’s touch command is directly sent to the rendering server in Windows’ native touch command, mix: mixed mode, mouse and touch events are sent together |
| arAlphaMask | int | The default values for AR applications using transparent masks are 1, 0: off, 1: on |
| dcs | int | Does the application level support data channel services? 1 supports, 0 does not. |
| playMode | int | Does the application level support interactive mode? 1 supports, 0 does not. |
| scs | int | Whether the application uses intelligent voice services, 1 uses, 0 does not use |
| audioInput | int | Whether to enable the client audio (microphone) input function, 1 enabled, 0 not enabled |
| audioInputAutoStart | int | Whether to automatically turn on the microphone, 1 on, 0 not on |
| videoInput | int | Whether to enable the client video (camera) input function, 1 enabled, 0 not enabled |
| videoInputAutoStart | int | Whether to automatically turn on the camera |
| videoInputCnt | int | Number of cameras used by the application |
| liveStreaming | int | Whether to enable live streaming, 1 enabled, 0 not enabled |
| textInputEventPrompt | int | Whether to enable client text input event prompt, 1 enabled, 0 not enabled |
| vrControllerType | int | VR controller type: 0: default, 1: Quest, 2: HTC, 3: Pico, 4: Nolo |
| qpMin | int | encoding qp minimum value |
| qpMax | int | Maximum value of encoding qp |
| taskCloseType | int | Instance shutdown method: 0 immediate shutdown (default), 1 delayed shutdown |
| delayCloseDuration | int | Delay time for closing delay, in seconds, default to 20 seconds |
| reqGpuMemMax | int | Maximum GPU memory demand (in units of M), used to check if there is sufficient memory when allocating requests. The default value is 0: does not consider the current application memory demand, only checks the current GPU memory usage. |
| useWebCodec | int | Whether to use WebCodec, 0: not used, 1: used. When used, it can be used in conjunction with preferDecoder to pass H265 encoding, and 8K can be used in an HTTPS environment |
| preferDecoder | string | Priority decoding format standards: ‘auto’, ‘vp8’, ‘vp9’, ‘h264’, ‘h265’, ‘hevc’, ‘av1’, ‘av1x’, default value h264 |
| createUser | long | Created user ID |
| createDate | long | Creation time |
| updateUser | long | Updated user ID |
| updateDate | long | Update time |
| deleteFlag | string | Delete identification, 0: Undeleted, 1 deleted |
Failure Response Example
{
"code": 500,
"message": "exeFileName can not be null or empty"
}
Parameter Note for Failure Response Example
| Field Name | Type | Note |
|---|---|---|
| code | string | None |
| message | string | None |