larksr_websdk 3.2.30 → 3.2.34

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';
@@ -161,7 +161,19 @@ declare enum LarkSRClientEvent {
     /**
      * 一般信息提示
      */
-    INFO = "info"
+    INFO = "info",
+    /**
+     * 语音对话的状态
+     */
+    AI_VOICE_STATUS = "aivoicestatus",
+    /**
+     * 语音识别转文字的结果
+     */
+    AI_VOICE_ASR_RESULT = "aivoiceasrresult",
+    /**
+     * 对话返回的结果
+     */
+    AI_VOICE_DM_RESULT = "aivoicedmresult"
 }
 /**
  * LarkSR 发出的事件
@@ -463,7 +475,7 @@ declare class LarkSR extends EventBase<LarkSRClientEvent, LarkSREvent> {
      * 手动重设进入应用参数
      * @param params
      */
-    private setAppliParams;
+    setAppliParams(params: IAppliParams): void;
     /**
      * 开始云渲染流程
      * 启动时应用参数不能为空，包括 taskID，appServer，appPort
@@ -492,6 +504,24 @@ declare class LarkSR extends EventBase<LarkSRClientEvent, LarkSREvent> {
      * @param text 文字
      */
     inputText(text: string): void;
+    /**
+     * 开始智能语音对话文本输入
+     * 应在只能语音为开始状态下开始输入
+     * @param text 输入的文本
+     * @returns 返回对话 ID
+     */
+    aiDmTextInput(text: string): number;
+    /**
+     * 开始智能语音对话语音输入，自动请求录音权限
+     * 应在只能语音为开始状态下开始输入
+     * @returns 成功返回对话id，失败返回异常
+     */
+    startAiDmVoiceInput(): Promise<number>;
+    /**
+     * 停止智能语音输入，通知语音引擎当前用户输入对话结束
+     * @returns 返回当前对话的id
+     */
+    stopAiDmVoiceInput(): number;
     /**
      * 发送文字消息给数据通道
      * 注意 云端应用要继承数据通道功能
@@ -526,23 +556,155 @@ 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;
+    /**
+     * 向云端发送手柄按钮按下事件
+     * 參考 https://developer.mozilla.org/zh-CN/docs/Web/API/Gamepad_API/Using_the_Gamepad_API
+     * @param userIndex 手柄的索引
+     * @param button 按鍵
+     * @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的值
+     * @returns
+     */
     gamepadTrigger(userIndex: number, isleft: boolean, value: number): void;
+    /**
+     * 向云端发送手柄按摇杆的值，即 axes 值
+     * 參考 https://developer.mozilla.org/zh-CN/docs/Web/API/Gamepad_API/Using_the_Gamepad_API
+     * @param userIndex 手柄的索引
+     * @param thumblx 手柄摇杆的x轴坐标
+     * @param thumbly 手柄摇杆的y轴坐标
+     * @param thumbrx 手柄摇杆的x轴相对坐标
+     * @param thumbry 手柄摇杆的y轴相对坐标
+     * @returns
+     */
     joystick(userIndex: number, thumblx: number, thumbly: number, thumbrx: number, thumbry: number): void;
+    /**
+     * 向云端发送触摸按下事件
+     * 坐标位置与 mouseMove 相同，相对与云端的鼠标移动位置
+     * @param id 手指的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.30",
+  "version": "3.2.34",
   "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",

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/lark/application.d.ts

@@ -4,6 +4,7 @@ import WebSocektChannel from './websocket_channel';
 import WebsocketProxy from './websocket_proxy';
 import { LarkSR } from '../larksr';
 import PixelStreamingWebsocketChannel from './test_pixel_streaming';
+import { RECORDER_STATE } from './recoder';
 export declare enum APP_STATE {
     BEFORE_CREATE = 0,
     INITED = 1,
@@ -37,7 +38,10 @@ export declare enum APP_EVENT_TYPE {
     LK_DATA_CHANNEL_RENDERSERVER_TEXT_MESSAGE = 14,
     LK_DATA_CHANNEL_RENDERSERVER_BINARY_MESSAGE = 15,
     LK_DATA_CHANNEL_RENDERSERVER_OPEN = 16,
-    LK_DATA_CHANNEL_RENDERSERVER_CLOSE = 17
+    LK_DATA_CHANNEL_RENDERSERVER_CLOSE = 17,
+    AI_VOICE_STATUS = 18,
+    AI_VOICE_ASR_RESULT = 19,
+    AI_VOICE_DM_RESULT = 20
 }
 export interface AppEvent extends LocalEvent<APP_EVENT_TYPE> {
     data?: any;
@@ -53,6 +57,9 @@ export default class Application extends EventBase<APP_EVENT_TYPE, AppEvent> {
     private _state;
     private retryTime;
     private larksr;
+    get voiceId(): number;
+    get recodeState(): RECORDER_STATE;
+    private recoder;
     constructor(larksr: LarkSR);
     init(): void;
     initPc(): void;
@@ -62,6 +69,10 @@ export default class Application extends EventBase<APP_EVENT_TYPE, AppEvent> {
     inputText(text: string): void;
     sendTextToDataChannel(text: string): void;
     sendBinaryToDataChannel(binary: Uint8Array): void;
+    aiDmTextInput(text: string): number;
+    startAiDmVoiceInput(): Promise<number>;
+    stopAiDmVoiceInput(): number;
+    private onRecoderData;
     start(): Promise<void>;
     connect(): Promise<PixelStreamingWebsocketChannel> | Promise<WebsocketProxy> | Promise<WebSocektChannel> | undefined;
     disConnect(): void;
@@ -113,6 +124,9 @@ export default class Application extends EventBase<APP_EVENT_TYPE, AppEvent> {
     private onDataChannelOpen;
     private onDataChannelClose;
     private onPeerConnectionState;
+    private onAiVoiceStatus;
+    private onAiVoiceAsrResult;
+    private onAiVoiceDMResult;
     appStateChange(state: APP_STATE): void;
     private infoMsg;
     private errorMsg;

package/types/lark/peer_connection.d.ts

@@ -25,7 +25,10 @@ export declare enum WEBRTC_EVENT_TYPE {
     BAD_NETWORK = 14,
     ERROR = 15,
     RTC_SDP = 16,
-    RTC_ICECANDIDATE = 17
+    RTC_ICECANDIDATE = 17,
+    AI_VOICE_STATUS = 18,
+    AI_VOICE_ASR_RESULT = 19,
+    AI_VOICE_DM_RESULT = 20
 }
 export interface GoogleBitRate {
     start: number;

package/types/lark/recoder.d.ts

@@ -0,0 +1,55 @@
+import { EventBase, LocalEvent } from '../event/event_base';
+export declare enum RECORDER_STATE {
+    READY = 0,
+    RECORDING = 1
+}
+export declare const RECODER_DEFAULT_CONFIG: {
+    sampleRate: number;
+    sampleBits: number;
+    bufferSize: number;
+};
+/**
+ * LarkSR 实例会发出的事件
+ */
+export declare enum RecodeEventType {
+    DATA = 0
+}
+/**
+ * LarkSR 发出的事件
+ */
+export interface RecodeEvent extends LocalEvent<RecodeEventType> {
+    voiceId: number;
+    sliceId: number;
+    data: Uint8Array;
+}
+export default class Recorder extends EventBase<RecodeEventType, RecodeEvent> {
+    get state(): RECORDER_STATE;
+    private _state;
+    private ctx;
+    private sampleRate;
+    private sampleBits;
+    private recorder;
+    private source;
+    private stream;
+    private buffer;
+    private bufferSize;
+    get voiceId(): number;
+    updateVoiceId(): number;
+    private _voiceId;
+    constructor({ bufferSize, sampleRate, sampleBits, }?: {
+        sampleRate: number;
+        sampleBits: number;
+        bufferSize: number;
+    });
+    start(): Promise<number>;
+    pause(): void;
+    clear(): void;
+    /**
+     * @deprecated
+     * @returns
+     */
+    private getRecord;
+    private merge;
+    private compress;
+    private encodeToPCM;
+}

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';
@@ -161,7 +161,19 @@ declare enum LarkSRClientEvent {
     /**
      * 一般信息提示
      */
-    INFO = "info"
+    INFO = "info",
+    /**
+     * 语音对话的状态
+     */
+    AI_VOICE_STATUS = "aivoicestatus",
+    /**
+     * 语音识别转文字的结果
+     */
+    AI_VOICE_ASR_RESULT = "aivoiceasrresult",
+    /**
+     * 对话返回的结果
+     */
+    AI_VOICE_DM_RESULT = "aivoicedmresult"
 }
 /**
  * LarkSR 发出的事件
@@ -463,7 +475,7 @@ declare class LarkSR extends EventBase<LarkSRClientEvent, LarkSREvent> {
      * 手动重设进入应用参数
      * @param params
      */
-    private setAppliParams;
+    setAppliParams(params: IAppliParams): void;
     /**
      * 开始云渲染流程
      * 启动时应用参数不能为空，包括 taskID，appServer，appPort
@@ -492,6 +504,24 @@ declare class LarkSR extends EventBase<LarkSRClientEvent, LarkSREvent> {
      * @param text 文字
      */
     inputText(text: string): void;
+    /**
+     * 开始智能语音对话文本输入
+     * 应在只能语音为开始状态下开始输入
+     * @param text 输入的文本
+     * @returns 返回对话 ID
+     */
+    aiDmTextInput(text: string): number;
+    /**
+     * 开始智能语音对话语音输入，自动请求录音权限
+     * 应在只能语音为开始状态下开始输入
+     * @returns 成功返回对话id，失败返回异常
+     */
+    startAiDmVoiceInput(): Promise<number>;
+    /**
+     * 停止智能语音输入，通知语音引擎当前用户输入对话结束
+     * @returns 返回当前对话的id
+     */
+    stopAiDmVoiceInput(): number;
     /**
      * 发送文字消息给数据通道
      * 注意 云端应用要继承数据通道功能
@@ -526,23 +556,155 @@ 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;
+    /**
+     * 向云端发送手柄按钮按下事件
+     * 參考 https://developer.mozilla.org/zh-CN/docs/Web/API/Gamepad_API/Using_the_Gamepad_API
+     * @param userIndex 手柄的索引
+     * @param button 按鍵
+     * @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的值
+     * @returns
+     */
     gamepadTrigger(userIndex: number, isleft: boolean, value: number): void;
+    /**
+     * 向云端发送手柄按摇杆的值，即 axes 值
+     * 參考 https://developer.mozilla.org/zh-CN/docs/Web/API/Gamepad_API/Using_the_Gamepad_API
+     * @param userIndex 手柄的索引
+     * @param thumblx 手柄摇杆的x轴坐标
+     * @param thumbly 手柄摇杆的y轴坐标
+     * @param thumbrx 手柄摇杆的x轴相对坐标
+     * @param thumbry 手柄摇杆的y轴相对坐标
+     * @returns
+     */
     joystick(userIndex: number, thumblx: number, thumbly: number, thumbrx: number, thumbry: number): void;
+    /**
+     * 向云端发送触摸按下事件
+     * 坐标位置与 mouseMove 相同，相对与云端的鼠标移动位置
+     * @param id 手指的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/types/operation/operation.d.ts

@@ -18,7 +18,6 @@ export default class Operation extends EventBase<OPREATION_EVENT_TYPE, Operation
     private keyboardHandler;
     private mouseHandler;
     private gamepadHandler;
-    private useTouch;
     private touchHandler;
     private _startListen;
     set enableParse(enable: boolean);