larksr_websdk 3.2.34 → 3.2.37

package/dist/types/appli_params.d.ts

@@ -263,5 +263,17 @@ export declare class AppliParamsUtils {
     static getIntOption(option: string | null | undefined, emptyValue?: number): number;
     static getBgColor(option: string | null | undefined): string;
 }
+/**
+ * WARNING 服务器端返回数据随机性较大，统一在该函数里做兼容处理
+ * 服务器端可能随意修改字段名称或值，需要注意测试
+ * @param startAppInfo
+ * @returns
+ */
 export declare function LoadAppliParamsFromUrl(): IAppliParams;
+/**
+ * WARNING 服务器端返回数据随机性较大，统一在该函数里做兼容处理
+ * 服务器端可能随意修改字段名称或值，需要注意测试
+ * @param startAppInfo
+ * @returns
+ */
 export declare function LoadAppliParamsStartAppInfo(startAppInfo: StartAppInfo): IAppliParams;

package/dist/types/larksr.d.ts

@@ -173,7 +173,11 @@ declare enum LarkSRClientEvent {
     /**
      * 对话返回的结果
      */
-    AI_VOICE_DM_RESULT = "aivoicedmresult"
+    AI_VOICE_DM_RESULT = "aivoicedmresult",
+    /**
+     * 对话出错详细信息
+     */
+    AI_VOICE_ERROR = "aivoiceerror"
 }
 /**
  * LarkSR 发出的事件
@@ -447,6 +451,8 @@ declare class LarkSR extends EventBase<LarkSRClientEvent, LarkSREvent> {
         userType?: number;
         roomCode?: string;
         taskId?: string;
+        regionId?: string;
+        groupId?: string;
     }): Promise<void>;
     /**
      * 连接云端渲染资源
@@ -494,6 +500,13 @@ declare class LarkSR extends EventBase<LarkSRClientEvent, LarkSREvent> {
      * 主动关闭连接
      */
     close(): void;
+    /**
+     * 设置是否强制横屏显示内容.
+     * handelRootElementSize 必须设置为 true 才有作用。
+     * 要注意强制横屏模式下网页的坐标系xy和视觉上相反，如果通过外部输入 input 事件。要注意调整
+     * @param force 是否强制横屏
+     */
+    setMobileForceLandScape(force: boolean): void;
     /**
      * 切换当前操作者
      * @param uid 用户id
@@ -637,10 +650,29 @@ declare class LarkSR extends EventBase<LarkSRClientEvent, LarkSREvent> {
      */
     keyUp(key: string): void;
     /**
+     * 手柄接口消息按照 windows xbox 360 手柄标准定义，即包含 xbox 360 手柄的功能，如按钮，摇杆，扳机键。windows 上最多支持4个手柄，
+     * 当前版本服务端只处理1个手柄，后续会放开多个手柄的支持。接口中发送的按键值为对应的 windows 中定义的按键值。
      * 向云端发送手柄按钮按下事件
-     * 參考 https://developer.mozilla.org/zh-CN/docs/Web/API/Gamepad_API/Using_the_Gamepad_API
-     * @param userIndex 手柄的索引
-     * @param button 按鍵
+     * 參考 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
      */
@@ -658,25 +690,31 @@ declare class LarkSR extends EventBase<LarkSRClientEvent, LarkSREvent> {
      * 參考 https://developer.mozilla.org/zh-CN/docs/Web/API/Gamepad_API/Using_the_Gamepad_API
      * @param userIndex 手柄的索引
      * @param isleft 是否是左trigger
-     * @param value trigger的值
+     * @param value trigger的值 扳机键的值 0-255
      * @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
+     * 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轴坐标
-     * @param thumbly 手柄摇杆的y轴坐标
-     * @param thumbrx 手柄摇杆的x轴相对坐标
-     * @param thumbry 手柄摇杆的y轴相对坐标
+     * @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
+     * @param id 手指的id,当前触摸事件按下手指的 id，同一个手指 id 相同。id 应每次触摸增加。即 touchdown 时 +1，
+     * touch move 和 touch up 时保持。当前手指未离开，又有新的手指 touchdown 时再 +1 获得新的 id
      * @param x 相对云端的x轴坐标
      * @param y 相对云端的y轴坐标
      * @returns

package/dist/types/screen_state.d.ts

@@ -108,5 +108,6 @@ export default class ScreenState extends EventBase<SCREEN_EVENT_TYPE, ScreenEven
     private larksr;
     constructor(rootElement: HTMLElement, params: IAppliParams, larksr: LarkSR, handelRootElementSize?: boolean);
     reset(params: IAppliParams): void;
+    setMobileForceLandScape(force: boolean): void;
     resize(): void;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "larksr_websdk",
-  "version": "3.2.34",
+  "version": "3.2.37",
   "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/appli_params.d.ts

@@ -263,5 +263,17 @@ export declare class AppliParamsUtils {
     static getIntOption(option: string | null | undefined, emptyValue?: number): number;
     static getBgColor(option: string | null | undefined): string;
 }
+/**
+ * WARNING 服务器端返回数据随机性较大，统一在该函数里做兼容处理
+ * 服务器端可能随意修改字段名称或值，需要注意测试
+ * @param startAppInfo
+ * @returns
+ */
 export declare function LoadAppliParamsFromUrl(): IAppliParams;
+/**
+ * WARNING 服务器端返回数据随机性较大，统一在该函数里做兼容处理
+ * 服务器端可能随意修改字段名称或值，需要注意测试
+ * @param startAppInfo
+ * @returns
+ */
 export declare function LoadAppliParamsStartAppInfo(startAppInfo: StartAppInfo): IAppliParams;

package/types/lark/application.d.ts

@@ -41,7 +41,8 @@ export declare enum APP_EVENT_TYPE {
     LK_DATA_CHANNEL_RENDERSERVER_CLOSE = 17,
     AI_VOICE_STATUS = 18,
     AI_VOICE_ASR_RESULT = 19,
-    AI_VOICE_DM_RESULT = 20
+    AI_VOICE_DM_RESULT = 20,
+    AI_VOICE_ERROR = 21
 }
 export interface AppEvent extends LocalEvent<APP_EVENT_TYPE> {
     data?: any;
@@ -127,6 +128,7 @@ export default class Application extends EventBase<APP_EVENT_TYPE, AppEvent> {
     private onAiVoiceStatus;
     private onAiVoiceAsrResult;
     private onAiVoiceDMResult;
+    private onAiVoiceError;
     appStateChange(state: APP_STATE): void;
     private infoMsg;
     private errorMsg;

package/types/lark/peer_connection.d.ts

@@ -28,7 +28,8 @@ export declare enum WEBRTC_EVENT_TYPE {
     RTC_ICECANDIDATE = 17,
     AI_VOICE_STATUS = 18,
     AI_VOICE_ASR_RESULT = 19,
-    AI_VOICE_DM_RESULT = 20
+    AI_VOICE_DM_RESULT = 20,
+    AI_VOICE_ERROR = 21
 }
 export interface GoogleBitRate {
     start: number;

package/types/larksr.d.ts

@@ -173,7 +173,11 @@ declare enum LarkSRClientEvent {
     /**
      * 对话返回的结果
      */
-    AI_VOICE_DM_RESULT = "aivoicedmresult"
+    AI_VOICE_DM_RESULT = "aivoicedmresult",
+    /**
+     * 对话出错详细信息
+     */
+    AI_VOICE_ERROR = "aivoiceerror"
 }
 /**
  * LarkSR 发出的事件
@@ -447,6 +451,8 @@ declare class LarkSR extends EventBase<LarkSRClientEvent, LarkSREvent> {
         userType?: number;
         roomCode?: string;
         taskId?: string;
+        regionId?: string;
+        groupId?: string;
     }): Promise<void>;
     /**
      * 连接云端渲染资源
@@ -494,6 +500,13 @@ declare class LarkSR extends EventBase<LarkSRClientEvent, LarkSREvent> {
      * 主动关闭连接
      */
     close(): void;
+    /**
+     * 设置是否强制横屏显示内容.
+     * handelRootElementSize 必须设置为 true 才有作用。
+     * 要注意强制横屏模式下网页的坐标系xy和视觉上相反，如果通过外部输入 input 事件。要注意调整
+     * @param force 是否强制横屏
+     */
+    setMobileForceLandScape(force: boolean): void;
     /**
      * 切换当前操作者
      * @param uid 用户id
@@ -637,10 +650,29 @@ declare class LarkSR extends EventBase<LarkSRClientEvent, LarkSREvent> {
      */
     keyUp(key: string): void;
     /**
+     * 手柄接口消息按照 windows xbox 360 手柄标准定义，即包含 xbox 360 手柄的功能，如按钮，摇杆，扳机键。windows 上最多支持4个手柄，
+     * 当前版本服务端只处理1个手柄，后续会放开多个手柄的支持。接口中发送的按键值为对应的 windows 中定义的按键值。
      * 向云端发送手柄按钮按下事件
-     * 參考 https://developer.mozilla.org/zh-CN/docs/Web/API/Gamepad_API/Using_the_Gamepad_API
-     * @param userIndex 手柄的索引
-     * @param button 按鍵
+     * 參考 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
      */
@@ -658,25 +690,31 @@ declare class LarkSR extends EventBase<LarkSRClientEvent, LarkSREvent> {
      * 參考 https://developer.mozilla.org/zh-CN/docs/Web/API/Gamepad_API/Using_the_Gamepad_API
      * @param userIndex 手柄的索引
      * @param isleft 是否是左trigger
-     * @param value trigger的值
+     * @param value trigger的值 扳机键的值 0-255
      * @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
+     * 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轴坐标
-     * @param thumbly 手柄摇杆的y轴坐标
-     * @param thumbrx 手柄摇杆的x轴相对坐标
-     * @param thumbry 手柄摇杆的y轴相对坐标
+     * @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
+     * @param id 手指的id,当前触摸事件按下手指的 id，同一个手指 id 相同。id 应每次触摸增加。即 touchdown 时 +1，
+     * touch move 和 touch up 时保持。当前手指未离开，又有新的手指 touchdown 时再 +1 获得新的 id
      * @param x 相对云端的x轴坐标
      * @param y 相对云端的y轴坐标
      * @returns

package/types/protobuf/cloudlark.d.ts

@@ -6884,6 +6884,102 @@ export namespace CloudLark {
         public toJSON(): { [k: string]: any };
     }
 
+    /** Properties of an AivoiceError. */
+    interface IAivoiceError {
+
+        /** AivoiceError voiceId */
+        voiceId?: (number|null);
+
+        /** AivoiceError text */
+        text?: (string|null);
+    }
+
+    /** Represents an AivoiceError. */
+    class AivoiceError implements IAivoiceError {
+
+        /**
+         * Constructs a new AivoiceError.
+         * @param [properties] Properties to set
+         */
+        constructor(properties?: CloudLark.IAivoiceError);
+
+        /** AivoiceError voiceId. */
+        public voiceId: number;
+
+        /** AivoiceError text. */
+        public text: string;
+
+        /**
+         * Creates a new AivoiceError instance using the specified properties.
+         * @param [properties] Properties to set
+         * @returns AivoiceError instance
+         */
+        public static create(properties?: CloudLark.IAivoiceError): CloudLark.AivoiceError;
+
+        /**
+         * Encodes the specified AivoiceError message. Does not implicitly {@link CloudLark.AivoiceError.verify|verify} messages.
+         * @param message AivoiceError message or plain object to encode
+         * @param [writer] Writer to encode to
+         * @returns Writer
+         */
+        public static encode(message: CloudLark.IAivoiceError, writer?: $protobuf.Writer): $protobuf.Writer;
+
+        /**
+         * Encodes the specified AivoiceError message, length delimited. Does not implicitly {@link CloudLark.AivoiceError.verify|verify} messages.
+         * @param message AivoiceError message or plain object to encode
+         * @param [writer] Writer to encode to
+         * @returns Writer
+         */
+        public static encodeDelimited(message: CloudLark.IAivoiceError, writer?: $protobuf.Writer): $protobuf.Writer;
+
+        /**
+         * Decodes an AivoiceError message from the specified reader or buffer.
+         * @param reader Reader or buffer to decode from
+         * @param [length] Message length if known beforehand
+         * @returns AivoiceError
+         * @throws {Error} If the payload is not a reader or valid buffer
+         * @throws {$protobuf.util.ProtocolError} If required fields are missing
+         */
+        public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): CloudLark.AivoiceError;
+
+        /**
+         * Decodes an AivoiceError message from the specified reader or buffer, length delimited.
+         * @param reader Reader or buffer to decode from
+         * @returns AivoiceError
+         * @throws {Error} If the payload is not a reader or valid buffer
+         * @throws {$protobuf.util.ProtocolError} If required fields are missing
+         */
+        public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): CloudLark.AivoiceError;
+
+        /**
+         * Verifies an AivoiceError message.
+         * @param message Plain object to verify
+         * @returns `null` if valid, otherwise the reason why it is not
+         */
+        public static verify(message: { [k: string]: any }): (string|null);
+
+        /**
+         * Creates an AivoiceError message from a plain object. Also converts values to their respective internal types.
+         * @param object Plain object
+         * @returns AivoiceError
+         */
+        public static fromObject(object: { [k: string]: any }): CloudLark.AivoiceError;
+
+        /**
+         * Creates a plain object from an AivoiceError message. Also converts values to other types if specified.
+         * @param message AivoiceError
+         * @param [options] Conversion options
+         * @returns Plain object
+         */
+        public static toObject(message: CloudLark.AivoiceError, options?: $protobuf.IConversionOptions): { [k: string]: any };
+
+        /**
+         * Converts this AivoiceError to JSON.
+         * @returns JSON object
+         */
+        public toJSON(): { [k: string]: any };
+    }
+
     /** Properties of a ClientInput. */
     interface IClientInput {
 
@@ -7150,6 +7246,9 @@ export namespace CloudLark {
 
         /** AppNotification aiVoiceServiceStatus */
         aiVoiceServiceStatus?: (CloudLark.IAiVoiceServiceStatus|null);
+
+        /** AppNotification aiVoiceErr */
+        aiVoiceErr?: (CloudLark.IAivoiceError|null);
     }
 
     /** Represents an AppNotification. */
@@ -7194,8 +7293,11 @@ export namespace CloudLark {
         /** AppNotification aiVoiceServiceStatus. */
         public aiVoiceServiceStatus?: (CloudLark.IAiVoiceServiceStatus|null);
 
+        /** AppNotification aiVoiceErr. */
+        public aiVoiceErr?: (CloudLark.IAivoiceError|null);
+
         /** AppNotification notify. */
-        public notify?: ("resize"|"mousemode"|"updatePlayers"|"requestInput"|"gamepadOutput"|"datachannelState"|"appDcMsg"|"cursorStyle"|"aiVoiceRealtimeParseresult"|"aiVoiceResult"|"aiVoiceServiceStatus");
+        public notify?: ("resize"|"mousemode"|"updatePlayers"|"requestInput"|"gamepadOutput"|"datachannelState"|"appDcMsg"|"cursorStyle"|"aiVoiceRealtimeParseresult"|"aiVoiceResult"|"aiVoiceServiceStatus"|"aiVoiceErr");
 
         /**
          * Creates a new AppNotification instance using the specified properties.

package/types/screen_state.d.ts

@@ -108,5 +108,6 @@ export default class ScreenState extends EventBase<SCREEN_EVENT_TYPE, ScreenEven
     private larksr;
     constructor(rootElement: HTMLElement, params: IAppliParams, larksr: LarkSR, handelRootElementSize?: boolean);
     reset(params: IAppliParams): void;
+    setMobileForceLandScape(force: boolean): void;
     resize(): void;
 }