LarkXR3.3 API

getAppliList

Concise description
  • None
Request URL
  • {{adminHost:8181}}/appli/getAppliList
Request Method
  • get
Request Query Parameters
Field Name Sample Required Type Note
appliId   No string Application ID
appliName   No string apply name
wsId   No string Workspace ID
page   No string Page number, default to 1
pageSize   No string How many pieces of data are displayed on each page, default to 20
Success Response Example
{
  "code": 1000,
  "message": "Success",
  "result": {
    "records": [
      {
        "appliId": "1196464974600339456",
        "appliName": "test2",
        "appliType": 2,
        "accessType": 1,
        "wsId": "Jx3wQMD1",
        "groupId": "1194226279482654720",
        "fileSize": "2218391",
        "appliPath": "20240115144427815",
        "exeFileName": "dfdf/1.exe",
        "exeFileNameList": "dfdf/1.exe",
        "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",
        "arAlphaMask": 0,
        "dcs": 1,
        "playMode": 1,
        "scs": 0,
        "audioInput": 0,
        "audioInputAutoStart": 0,
        "videoInput": 0,
        "videoInputAutoStart": 0,
        "videoInputCnt": 1,
        "liveStreaming": 0,
        "textInputEventPrompt": 1,
        "vrControllerType": 0,
        "qpMin": 20,
        "qpMax": 35,
        "taskCloseType": 0,
        "delayCloseDuration": 20,
        "reqGpuMemMax": 0,
        "useWebCodec": 0,
        "preferDecoder": "h264",
        "createUser": "443167382534356992",
        "createDate": "1705301079189",
        "updateUser": "443167382534356992",
        "updateDate": "1706062110324",
        "deleteFlag": 0
      }
    ],
    "total": "2",
    "size": "15",
    "current": "1",
    "orders": [],
    "optimizeCountSql": true,
    "searchCount": true,
    "pages": "1"
  }
}
Parameter Note for Success Response Example
Field Name Type Note
code string Response code
message string Response message
result object Response result
records array Result List
records. appliId long Application Id
records. appliname string Application name
records. 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)
records. accesstype int 1: Public application, 0: Private application
records. wsId string Workplace Id
records. groupId long Group Id
records. fileSize int Application size
records. appliPath string The path to save the application
records. exeFilename string Application’s execution file path
records. exeFilenameList array List of exe applications
records. param string Command line parameters for application startup
records. status int 1: Put on shelves 0: Take off shelves
records. instanceMax int The maximum number of concurrent clients allowed for this application
records. hasExtraParam int Does the command line parameter for application startup pass TaskId, 0 (no), 1 (yes)
records. 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)
records. initResolutiontype int Initialize resolution method, 0: Apply default resolution, 1: Adapt to client window
records. frameLowerLimit int Minimum frame rate, default 30: 30 frames per second
records. initiativeSyncFlag int Active synchronization identifier, 0: Non active synchronization, 1: Active synchronization, 2: Semi active synchronization
records. initCursorMode int Mouse mode, 0: automatic judgment, 1: locked, 2: unlocked
records. offScreen int Whether to render off screen? Off screen rendering can reduce some resource consumption, default is 1. 0: not. 1: yes
records. 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.
records. 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.
records. startProctype int In exclusive mode, the startup mode is mostly standard mode: 0, and a few are compatibility mode: 1
records. useGamepad int Whether the application uses a controller, default to 0; 0: not used, 1: used
records. mobileForceLandscape int Whether to force landscape view on the mobile end, default to 1; 0: No, 1: Yes
records. mobileVirtualJoystick int Does the mobile end initially display a virtual joystick, default to 1; 0: No, 1: Yes
records. mobileKeyboardtype int Mobile input keyboard type, 0: default system keyboard, 1: virtual keyboard
records. mobileWebMenu type int Mobile menu type, 0: Control ball, 1: Menu bar
records. mouseZoomDirection int Touch screen zoom gesture and scroll wheel image, default to 1; 0: scroll wheel down, 1: scroll wheel up
records. playerListTag int Whether to display player list in demonstration/interactive mode, default to 1; 0: No, 1: Yes
records. limitMaxFps int Whether to limit the frame rate of the application itself in shared mode, default to 1; 0: No, 1: Yes
records. 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
records. arAlphaMask int The default values for AR applications using transparent masks are 1, 0: off, 1: on
records. dcs int Does the application level support data channel services? 1 supports, 0 does not.
records. playMode int Does the application level support interactive mode? 1 supports, 0 does not.
records. scs int Whether the application uses intelligent voice services, 1 uses, 0 does not use
records. audioInput int Whether to enable the client audio (microphone) input function, 1 enabled, 0 not enabled
records. audioInputAutoStart int Whether to automatically turn on the microphone, 1 on, 0 not on
records. videoInput int Whether to enable the client video (camera) input function, 1 enabled, 0 not enabled
records. videoInputAutoStart int Whether to automatically turn on the camera
records. videoInputCnt int Number of cameras used by the application
records. liveStreaming int Whether to enable live streaming, 1 enabled, 0 not enabled
records. textInputEventPrompt int Whether to enable client text input event prompt, 1 enabled, 0 not enabled
records. vrControllertype int VR controller type: 0: default, 1: Quest, 2: HTC, 3: Pico, 4: Nolo
records. qpMin int encoding qp minimum value
records. qpMax int Maximum value of encoding qp
records. taskClosetype int Instance shutdown method: 0 immediate shutdown (default), 1 delayed shutdown
records. delayCloseDuration int Delay time for closing delay, in seconds, default to 20 seconds
records. 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.
records. 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
records. preferDecoder string Priority decoding format standards: ‘auto’, ‘vp8’, ‘vp9’, ‘h264’, ‘h265’, ‘hevc’, ‘av1’, ‘av1x’, default value h264
records. createUser long Created user ID
records. createDate long Creation time
records. updateUser long Updated user ID
records. updateDate long Update time
records. deleteFlag string Delete identification, 0: Undeleted, 1 deleted
total string How many pieces of data in total
size string How many pieces of data per page
current string Current page number
pages string How many pages are there in total
Note
admin 2025年4月8日 14:13 收藏文档