larksr_websdk 3.2.32 → 3.2.35

package/dist/types/api.d.ts

@@ -76,6 +76,7 @@ export default class API {
     static ClientLogErrorPath: string;
     static GetStartInfoPath: string;
     private static PocHostApplGetUrl;
+    private static TaskInfoClientStartedPath;
     static HostAppliGetUrl(params: {
         appliId: string;
         playerMode?: number;
@@ -111,5 +112,6 @@ export default class API {
     static GetTask(config: ILarkSRConfig, taskid: string): Promise<GetTaskResult>;
     static LogError(errorCode: number, errorMsg: string, params: string, config: ILarkSRConfig): void;
     static ClientInfo(config: ILarkSRConfig, params: AppliParams): void;
+    static TaskInfoClientStarted(config: ILarkSRConfig, params: AppliParams): void;
     static joinParam(params: any): string;
 }

package/dist/types/larksr.d.ts

@@ -4,7 +4,7 @@
  */
 import { EventBase, LocalEvent } from './event/event_base';
 import Application, { APP_STATE } from './lark/application';
-import { AppliParams, AppliParamsUtils, LoadAppliParamsFromUrl, LoadAppliParamsStartAppInfo } from './appli_params';
+import { AppliParams, AppliParamsUtils, IAppliParams, LoadAppliParamsFromUrl, LoadAppliParamsStartAppInfo } from './appli_params';
 import { LarkEventType } from './lark/lark_event_type';
 import API from './api';
 import ScreenState from './screen_state';
@@ -475,7 +475,7 @@ declare class LarkSR extends EventBase<LarkSRClientEvent, LarkSREvent> {
      * 手动重设进入应用参数
      * @param params
      */
-    private setAppliParams;
+    setAppliParams(params: IAppliParams): void;
     /**
      * 开始云渲染流程
      * 启动时应用参数不能为空，包括 taskID，appServer，appPort
@@ -556,23 +556,180 @@ declare class LarkSR extends EventBase<LarkSRClientEvent, LarkSREvent> {
     /**
      * 操作相关事件
      * 所有事件坐标相对于云端应用，不相对于网页
+     * CloudLark.IClientInput 是所有操作指令接口对象的合集
+     * 可以单独使用下面 moseMove 等接口
      * @param input 操作指令
      */
     sendInput(input: CloudLark.IClientInput): void;
+    /**
+     * 向云端发送鼠标移动事件
+     * 事件坐标相对于云端应用，不相对于网页
+     * 计算方式可以参考  https://github.com/pingxingyun/lark_sr_websdk_demos 例子中 v_cursor.vue getVMouseTouchPosition 方法
+     * 原理是通过 LarkSR 对象的成员 screenState.operateScale 获取相对的缩放，
+     * 本地坐标 X larksr.screenState.operateScale.scaleX / scaleY 即可得到相对云端的坐标
+     *
+     * @param PosX 相对云端鼠标 X 点坐标
+     * @param PosY 相对云端鼠标 Y 点坐标
+     * @param DeltaX 相对云端鼠标 X 轴移动距离
+     * @param DeltaY 相对云端鼠标 X 轴移动距离
+     */
+    mouseMove(PosX: number, PosY: number, DeltaX: number, DeltaY: number): void;
+    /**
+     * 向云端发送鼠标移动事件
+     * 事件坐标相对于云端应用，不相对于网页
+     * 计算方式可以参考  https://github.com/pingxingyun/lark_sr_websdk_demos 例子中 v_cursor.vue getVMouseTouchPosition 方法
+     * 原理是通过 LarkSR 对象的成员 screenState.operateScale 获取相对的缩放，
+     * 本地坐标 X larksr.screenState.operateScale.scaleX / scaleY 即可得到相对云端的坐标
+     *
+     * @param PosX 相对云端鼠标 X 点坐标
+     * @param PosY 相对云端鼠标 Y 点坐标
+     * @param DeltaX 相对云端鼠标 X 轴移动距离
+     * @param DeltaY 相对云端鼠标 X 轴移动距离
+     */
     moseMove(PosX: number, PosY: number, DeltaX: number, DeltaY: number): void;
+    /**
+     * 向云端发送鼠标单击事件
+     * X Y 坐标计算方式同 mouseMove
+     *
+     * @param PosX 相对云端鼠标 X 点坐标
+     * @param PosY 相对云端鼠标 Y 点坐标
+     * @param key  LEFT = 0,RIGHT = 1, MIDDLE = 2
+     */
     mouseTap(PosX: number, PosY: number, key: CloudLark.MouseKey): void;
+    /**
+     * 向云端发送鼠标按下事件
+     * X Y 坐标计算方式同 mouseMove
+     *
+     * @param PosX 相对云端鼠标 X 点坐标
+     * @param PosY 相对云端鼠标 Y 点坐标
+     * @param key  LEFT = 0,RIGHT = 1, MIDDLE = 2
+     */
     mouseDown(PosX: number, PosY: number, key: CloudLark.MouseKey): void;
+    /**
+     * 向云端发送鼠标抬起事件
+     * X Y 坐标计算方式同 mouseMove
+     *
+     * @param PosX 相对云端鼠标 X 点坐标
+     * @param PosY 相对云端鼠标 Y 点坐标
+     * @param key  LEFT = 0,RIGHT = 1, MIDDLE = 2
+     */
     mouseUp(PosX: number, PosY: number, key: CloudLark.MouseKey): void;
+    /**
+     * 向云端发送鼠标滚轮事件
+     * X Y 坐标计算方式同 mouseMove
+     *
+     * @param PosX 相对云端鼠标 X 点坐标
+     * @param PosY 相对云端鼠标 Y 点坐标
+     * @param Delata  120/-120 鼠标滚轮滚动的数值
+     */
     mouseWheel(PosX: number, PosY: number, Delata: number): void;
+    /**
+     * 向云端发送键盘按键按下事件
+     * @param key KeyboardEvent.code 字段，具体内容参考 Chrome https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/code/code_values
+     * @param isRepeat KeyboardEvent.repeat 字段，参考https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/repeat
+     * @returns 是否发送成功，如果key参数传递错误可能发送失败
+     */
     keyDown(key: string, isRepeat: boolean): void;
+    /**
+     * 向云端发送键盘按键抬起事件
+     * @param key KeyboardEvent.code 字段，具体内容参考 Chrome https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/code/code_values
+     * @returns 是否发送成功，如果key参数传递错误可能发送失败
+     */
     keyUp(key: string): void;
+    /**
+     * 手柄接口消息按照 windows xbox 360 手柄标准定义，即包含 xbox 360 手柄的功能，如按钮，摇杆，扳机键。windows 上最多支持4个手柄，
+     * 当前版本服务端只处理1个手柄，后续会放开多个手柄的支持。接口中发送的按键值为对应的 windows 中定义的按键值。
+     * 向云端发送手柄按钮按下事件
+     * 參考 js 中获取手柄事件，参考 https://developer.mozilla.org/zh-CN/docs/Web/API/Gamepad_API/Using_the_Gamepad_API
+     * @param userIndex 手柄的索引,硬件设备索引 0-3. 第一个连接的手柄为0，第二个为1，以此类推。
+     * @param button 按鍵 @see https://docs.microsoft.com/en-us/windows/win32/api/xinput/ns-xinput-xinput_gamepad
+     * export const enum XINPUT_BUTTONS {
+     *       XINPUT_GAMEPAD_DPAD_UP        = 0x0001,
+     *       XINPUT_GAMEPAD_DPAD_DOWN      = 0x0002,
+     *       XINPUT_GAMEPAD_DPAD_LEFT      = 0x0004,
+     *       XINPUT_GAMEPAD_DPAD_RIGHT     = 0x0008,
+     *       XINPUT_GAMEPAD_START          = 0x0010,
+     *       XINPUT_GAMEPAD_BACK           = 0x0020,
+     *       XINPUT_GAMEPAD_LEFT_THUMB     = 0x0040,
+     *       XINPUT_GAMEPAD_RIGHT_THUMB    = 0x0080,
+     *       XINPUT_GAMEPAD_LEFT_SHOULDER  = 0x0100,
+     *       XINPUT_GAMEPAD_RIGHT_SHOULDER = 0x0200,
+     *       XINPUT_GAMEPAD_A              = 0x1000,
+     *       XINPUT_GAMEPAD_B              = 0x2000,
+     *       XINPUT_GAMEPAD_X              = 0x4000,
+     *       XINPUT_GAMEPAD_Y              = 0x8000,
+     *       XINPUT_UNKNOWN                = -1,
+     *   }
+     * @param isRepeat 是否重复按下
+     * @returns
+     */
     gamepadButtonDown(userIndex: number, button: number, isRepeat: boolean): void;
+    /**
+     * 向云端发送手柄按钮抬起事件
+     * 參考 https://developer.mozilla.org/zh-CN/docs/Web/API/Gamepad_API/Using_the_Gamepad_API
+     * @param userIndex 手柄的索引
+     * @param button 按鍵
+     * @returns
+     */
     gamepadButtonUp(userIndex: number, button: number): void;
+    /**
+     * 向云端发送手柄按trigger键事件
+     * 參考 https://developer.mozilla.org/zh-CN/docs/Web/API/Gamepad_API/Using_the_Gamepad_API
+     * @param userIndex 手柄的索引
+     * @param isleft 是否是左trigger
+     * @param value trigger的值 扳机键的值 0-255
+     * @returns
+     */
     gamepadTrigger(userIndex: number, isleft: boolean, value: number): void;
+    /**
+     * 向云端发送手柄按摇杆的值，即 axes 值
+     * win      MAX
+     *           |
+     *  MIN-------------MAX
+     *          |
+     *         MIN
+     * js 中获取硬件手柄參考 https://developer.mozilla.org/zh-CN/docs/Web/API/Gamepad_API/Using_the_Gamepad_API
+     * @param userIndex 手柄的索引
+     * @param thumblx 左摇杆 X 值，-32767 到 32767
+     * @param thumbly 左摇杆 Y 值，-32767 到 32767
+     * @param thumbrx 右摇杆 X 值，-32767 到 32767
+     * @param thumbry 右摇杆 Y 值，-32767 到 32767
+     * @returns
+     */
     joystick(userIndex: number, thumblx: number, thumbly: number, thumbrx: number, thumbry: number): void;
+    /**
+     * 向云端发送触摸按下事件
+     * 坐标位置与 mouseMove 相同，相对与云端的鼠标移动位置
+     * @param id 手指的id,当前触摸事件按下手指的 id，同一个手指 id 相同。id 应每次触摸增加。即 touchdown 时 +1，
+     * touch move 和 touch up 时保持。当前手指未离开，又有新的手指 touchdown 时再 +1 获得新的 id
+     * @param x 相对云端的x轴坐标
+     * @param y 相对云端的y轴坐标
+     * @returns
+     */
     touchDown(id: number, x: number, y: number): void;
+    /**
+     * 向云端发送触摸移动事件
+     * 坐标位置与 mouseMove 相同，相对与云端的鼠标移动位置
+     * @param id 手指的id
+     * @param x 相对云端的x轴坐标
+     * @param y 相对云端的y轴坐标
+     * @returns
+     */
     touchMove(id: number, x: number, y: number): void;
+    /**
+     * 向云端发送触摸抬起事件
+     * 坐标位置与 mouseMove 相同，相对与云端的鼠标移动位置
+     * @param id 手指的id
+     * @param x 相对云端的x轴坐标
+     * @param y 相对云端的y轴坐标
+     * @returns
+     */
     touchUp(id: number, x: number, y: number): void;
+    /**
+     * 字符串转换为输入的鼠标按键值
+     * @param button 'left' | 'mid' | 'right'
+     * @returns  LEFT = 0,RIGHT = 1,MIDDLE = 2
+     */
     getMouseButtonType(button: 'left' | 'mid' | 'right'): CloudLark.MouseKey;
     $emit(type: LarkEventType, data?: any, message?: string): void;
     $emitError(message?: string, code?: number): void;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "larksr_websdk",
-  "version": "3.2.32",
+  "version": "3.2.35",
   "description": "Larksr websdk. Easy to build a cloud render client for larksr system or ue4 pixelstreaming.docs: https://pingxingyun.github.io/webclient_sdk/",
   "keywords": [
     "pingxingyun",
@@ -64,6 +64,7 @@
     "url-loader": "^4.1.1",
     "webpack": "^5.54.0",
     "webpack-cli": "^4.8.0",
-    "webpack-dev-server": "^4.3.0"
+    "webpack-dev-server": "^4.3.0",
+    "vconsole": "^3.12.1"
   }
 }

package/types/api.d.ts

@@ -76,6 +76,7 @@ export default class API {
     static ClientLogErrorPath: string;
     static GetStartInfoPath: string;
     private static PocHostApplGetUrl;
+    private static TaskInfoClientStartedPath;
     static HostAppliGetUrl(params: {
         appliId: string;
         playerMode?: number;
@@ -111,5 +112,6 @@ export default class API {
     static GetTask(config: ILarkSRConfig, taskid: string): Promise<GetTaskResult>;
     static LogError(errorCode: number, errorMsg: string, params: string, config: ILarkSRConfig): void;
     static ClientInfo(config: ILarkSRConfig, params: AppliParams): void;
+    static TaskInfoClientStarted(config: ILarkSRConfig, params: AppliParams): void;
     static joinParam(params: any): string;
 }

package/types/larksr.d.ts

@@ -4,7 +4,7 @@
  */
 import { EventBase, LocalEvent } from './event/event_base';
 import Application, { APP_STATE } from './lark/application';
-import { AppliParams, AppliParamsUtils, LoadAppliParamsFromUrl, LoadAppliParamsStartAppInfo } from './appli_params';
+import { AppliParams, AppliParamsUtils, IAppliParams, LoadAppliParamsFromUrl, LoadAppliParamsStartAppInfo } from './appli_params';
 import { LarkEventType } from './lark/lark_event_type';
 import API from './api';
 import ScreenState from './screen_state';
@@ -475,7 +475,7 @@ declare class LarkSR extends EventBase<LarkSRClientEvent, LarkSREvent> {
      * 手动重设进入应用参数
      * @param params
      */
-    private setAppliParams;
+    setAppliParams(params: IAppliParams): void;
     /**
      * 开始云渲染流程
      * 启动时应用参数不能为空，包括 taskID，appServer，appPort
@@ -556,23 +556,180 @@ declare class LarkSR extends EventBase<LarkSRClientEvent, LarkSREvent> {
     /**
      * 操作相关事件
      * 所有事件坐标相对于云端应用，不相对于网页
+     * CloudLark.IClientInput 是所有操作指令接口对象的合集
+     * 可以单独使用下面 moseMove 等接口
      * @param input 操作指令
      */
     sendInput(input: CloudLark.IClientInput): void;
+    /**
+     * 向云端发送鼠标移动事件
+     * 事件坐标相对于云端应用，不相对于网页
+     * 计算方式可以参考  https://github.com/pingxingyun/lark_sr_websdk_demos 例子中 v_cursor.vue getVMouseTouchPosition 方法
+     * 原理是通过 LarkSR 对象的成员 screenState.operateScale 获取相对的缩放，
+     * 本地坐标 X larksr.screenState.operateScale.scaleX / scaleY 即可得到相对云端的坐标
+     *
+     * @param PosX 相对云端鼠标 X 点坐标
+     * @param PosY 相对云端鼠标 Y 点坐标
+     * @param DeltaX 相对云端鼠标 X 轴移动距离
+     * @param DeltaY 相对云端鼠标 X 轴移动距离
+     */
+    mouseMove(PosX: number, PosY: number, DeltaX: number, DeltaY: number): void;
+    /**
+     * 向云端发送鼠标移动事件
+     * 事件坐标相对于云端应用，不相对于网页
+     * 计算方式可以参考  https://github.com/pingxingyun/lark_sr_websdk_demos 例子中 v_cursor.vue getVMouseTouchPosition 方法
+     * 原理是通过 LarkSR 对象的成员 screenState.operateScale 获取相对的缩放，
+     * 本地坐标 X larksr.screenState.operateScale.scaleX / scaleY 即可得到相对云端的坐标
+     *
+     * @param PosX 相对云端鼠标 X 点坐标
+     * @param PosY 相对云端鼠标 Y 点坐标
+     * @param DeltaX 相对云端鼠标 X 轴移动距离
+     * @param DeltaY 相对云端鼠标 X 轴移动距离
+     */
     moseMove(PosX: number, PosY: number, DeltaX: number, DeltaY: number): void;
+    /**
+     * 向云端发送鼠标单击事件
+     * X Y 坐标计算方式同 mouseMove
+     *
+     * @param PosX 相对云端鼠标 X 点坐标
+     * @param PosY 相对云端鼠标 Y 点坐标
+     * @param key  LEFT = 0,RIGHT = 1, MIDDLE = 2
+     */
     mouseTap(PosX: number, PosY: number, key: CloudLark.MouseKey): void;
+    /**
+     * 向云端发送鼠标按下事件
+     * X Y 坐标计算方式同 mouseMove
+     *
+     * @param PosX 相对云端鼠标 X 点坐标
+     * @param PosY 相对云端鼠标 Y 点坐标
+     * @param key  LEFT = 0,RIGHT = 1, MIDDLE = 2
+     */
     mouseDown(PosX: number, PosY: number, key: CloudLark.MouseKey): void;
+    /**
+     * 向云端发送鼠标抬起事件
+     * X Y 坐标计算方式同 mouseMove
+     *
+     * @param PosX 相对云端鼠标 X 点坐标
+     * @param PosY 相对云端鼠标 Y 点坐标
+     * @param key  LEFT = 0,RIGHT = 1, MIDDLE = 2
+     */
     mouseUp(PosX: number, PosY: number, key: CloudLark.MouseKey): void;
+    /**
+     * 向云端发送鼠标滚轮事件
+     * X Y 坐标计算方式同 mouseMove
+     *
+     * @param PosX 相对云端鼠标 X 点坐标
+     * @param PosY 相对云端鼠标 Y 点坐标
+     * @param Delata  120/-120 鼠标滚轮滚动的数值
+     */
     mouseWheel(PosX: number, PosY: number, Delata: number): void;
+    /**
+     * 向云端发送键盘按键按下事件
+     * @param key KeyboardEvent.code 字段，具体内容参考 Chrome https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/code/code_values
+     * @param isRepeat KeyboardEvent.repeat 字段，参考https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/repeat
+     * @returns 是否发送成功，如果key参数传递错误可能发送失败
+     */
     keyDown(key: string, isRepeat: boolean): void;
+    /**
+     * 向云端发送键盘按键抬起事件
+     * @param key KeyboardEvent.code 字段，具体内容参考 Chrome https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/code/code_values
+     * @returns 是否发送成功，如果key参数传递错误可能发送失败
+     */
     keyUp(key: string): void;
+    /**
+     * 手柄接口消息按照 windows xbox 360 手柄标准定义，即包含 xbox 360 手柄的功能，如按钮，摇杆，扳机键。windows 上最多支持4个手柄，
+     * 当前版本服务端只处理1个手柄，后续会放开多个手柄的支持。接口中发送的按键值为对应的 windows 中定义的按键值。
+     * 向云端发送手柄按钮按下事件
+     * 參考 js 中获取手柄事件，参考 https://developer.mozilla.org/zh-CN/docs/Web/API/Gamepad_API/Using_the_Gamepad_API
+     * @param userIndex 手柄的索引,硬件设备索引 0-3. 第一个连接的手柄为0，第二个为1，以此类推。
+     * @param button 按鍵 @see https://docs.microsoft.com/en-us/windows/win32/api/xinput/ns-xinput-xinput_gamepad
+     * export const enum XINPUT_BUTTONS {
+     *       XINPUT_GAMEPAD_DPAD_UP        = 0x0001,
+     *       XINPUT_GAMEPAD_DPAD_DOWN      = 0x0002,
+     *       XINPUT_GAMEPAD_DPAD_LEFT      = 0x0004,
+     *       XINPUT_GAMEPAD_DPAD_RIGHT     = 0x0008,
+     *       XINPUT_GAMEPAD_START          = 0x0010,
+     *       XINPUT_GAMEPAD_BACK           = 0x0020,
+     *       XINPUT_GAMEPAD_LEFT_THUMB     = 0x0040,
+     *       XINPUT_GAMEPAD_RIGHT_THUMB    = 0x0080,
+     *       XINPUT_GAMEPAD_LEFT_SHOULDER  = 0x0100,
+     *       XINPUT_GAMEPAD_RIGHT_SHOULDER = 0x0200,
+     *       XINPUT_GAMEPAD_A              = 0x1000,
+     *       XINPUT_GAMEPAD_B              = 0x2000,
+     *       XINPUT_GAMEPAD_X              = 0x4000,
+     *       XINPUT_GAMEPAD_Y              = 0x8000,
+     *       XINPUT_UNKNOWN                = -1,
+     *   }
+     * @param isRepeat 是否重复按下
+     * @returns
+     */
     gamepadButtonDown(userIndex: number, button: number, isRepeat: boolean): void;
+    /**
+     * 向云端发送手柄按钮抬起事件
+     * 參考 https://developer.mozilla.org/zh-CN/docs/Web/API/Gamepad_API/Using_the_Gamepad_API
+     * @param userIndex 手柄的索引
+     * @param button 按鍵
+     * @returns
+     */
     gamepadButtonUp(userIndex: number, button: number): void;
+    /**
+     * 向云端发送手柄按trigger键事件
+     * 參考 https://developer.mozilla.org/zh-CN/docs/Web/API/Gamepad_API/Using_the_Gamepad_API
+     * @param userIndex 手柄的索引
+     * @param isleft 是否是左trigger
+     * @param value trigger的值 扳机键的值 0-255
+     * @returns
+     */
     gamepadTrigger(userIndex: number, isleft: boolean, value: number): void;
+    /**
+     * 向云端发送手柄按摇杆的值，即 axes 值
+     * win      MAX
+     *           |
+     *  MIN-------------MAX
+     *          |
+     *         MIN
+     * js 中获取硬件手柄參考 https://developer.mozilla.org/zh-CN/docs/Web/API/Gamepad_API/Using_the_Gamepad_API
+     * @param userIndex 手柄的索引
+     * @param thumblx 左摇杆 X 值，-32767 到 32767
+     * @param thumbly 左摇杆 Y 值，-32767 到 32767
+     * @param thumbrx 右摇杆 X 值，-32767 到 32767
+     * @param thumbry 右摇杆 Y 值，-32767 到 32767
+     * @returns
+     */
     joystick(userIndex: number, thumblx: number, thumbly: number, thumbrx: number, thumbry: number): void;
+    /**
+     * 向云端发送触摸按下事件
+     * 坐标位置与 mouseMove 相同，相对与云端的鼠标移动位置
+     * @param id 手指的id,当前触摸事件按下手指的 id，同一个手指 id 相同。id 应每次触摸增加。即 touchdown 时 +1，
+     * touch move 和 touch up 时保持。当前手指未离开，又有新的手指 touchdown 时再 +1 获得新的 id
+     * @param x 相对云端的x轴坐标
+     * @param y 相对云端的y轴坐标
+     * @returns
+     */
     touchDown(id: number, x: number, y: number): void;
+    /**
+     * 向云端发送触摸移动事件
+     * 坐标位置与 mouseMove 相同，相对与云端的鼠标移动位置
+     * @param id 手指的id
+     * @param x 相对云端的x轴坐标
+     * @param y 相对云端的y轴坐标
+     * @returns
+     */
     touchMove(id: number, x: number, y: number): void;
+    /**
+     * 向云端发送触摸抬起事件
+     * 坐标位置与 mouseMove 相同，相对与云端的鼠标移动位置
+     * @param id 手指的id
+     * @param x 相对云端的x轴坐标
+     * @param y 相对云端的y轴坐标
+     * @returns
+     */
     touchUp(id: number, x: number, y: number): void;
+    /**
+     * 字符串转换为输入的鼠标按键值
+     * @param button 'left' | 'mid' | 'right'
+     * @returns  LEFT = 0,RIGHT = 1,MIDDLE = 2
+     */
     getMouseButtonType(button: 'left' | 'mid' | 'right'): CloudLark.MouseKey;
     $emit(type: LarkEventType, data?: any, message?: string): void;
     $emitError(message?: string, code?: number): void;