larksr_websdk 3.2.35 → 3.2.38

package/dist/types/api.d.ts

@@ -77,6 +77,7 @@ export default class API {
     static GetStartInfoPath: string;
     private static PocHostApplGetUrl;
     private static TaskInfoClientStartedPath;
+    private static PortMappingListPath;
     static HostAppliGetUrl(params: {
         appliId: string;
         playerMode?: number;
@@ -113,5 +114,6 @@ export default class API {
     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 PortMappingList(config: ILarkSRConfig): Promise<unknown>;
     static joinParam(params: any): string;
 }

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 发出的事件
@@ -420,6 +424,11 @@ declare class LarkSR extends EventBase<LarkSRClientEvent, LarkSREvent> {
      */
     get uid(): number;
     private _uid;
+    /**
+     * 云端应用是否是预启动状态
+     */
+    get isPreStart(): boolean;
+    private _isPreStart;
     /**
      * @returns 是否是 Task的拥有者
      */
@@ -447,6 +456,8 @@ declare class LarkSR extends EventBase<LarkSRClientEvent, LarkSREvent> {
         userType?: number;
         roomCode?: string;
         taskId?: string;
+        regionId?: string;
+        groupId?: string;
     }): Promise<void>;
     /**
      * 连接云端渲染资源
@@ -494,6 +505,13 @@ declare class LarkSR extends EventBase<LarkSRClientEvent, LarkSREvent> {
      * 主动关闭连接
      */
     close(): void;
+    /**
+     * 设置是否强制横屏显示内容.
+     * handelRootElementSize 必须设置为 true 才有作用。
+     * 要注意强制横屏模式下网页的坐标系xy和视觉上相反，如果通过外部输入 input 事件。要注意调整
+     * @param force 是否强制横屏
+     */
+    setMobileForceLandScape(force: boolean): void;
     /**
      * 切换当前操作者
      * @param uid 用户id

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.35",
+  "version": "3.2.38",
   "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

@@ -77,6 +77,7 @@ export default class API {
     static GetStartInfoPath: string;
     private static PocHostApplGetUrl;
     private static TaskInfoClientStartedPath;
+    private static PortMappingListPath;
     static HostAppliGetUrl(params: {
         appliId: string;
         playerMode?: number;
@@ -113,5 +114,6 @@ export default class API {
     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 PortMappingList(config: ILarkSRConfig): Promise<unknown>;
     static joinParam(params: any): string;
 }

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 发出的事件
@@ -420,6 +424,11 @@ declare class LarkSR extends EventBase<LarkSRClientEvent, LarkSREvent> {
      */
     get uid(): number;
     private _uid;
+    /**
+     * 云端应用是否是预启动状态
+     */
+    get isPreStart(): boolean;
+    private _isPreStart;
     /**
      * @returns 是否是 Task的拥有者
      */
@@ -447,6 +456,8 @@ declare class LarkSR extends EventBase<LarkSRClientEvent, LarkSREvent> {
         userType?: number;
         roomCode?: string;
         taskId?: string;
+        regionId?: string;
+        groupId?: string;
     }): Promise<void>;
     /**
      * 连接云端渲染资源
@@ -494,6 +505,13 @@ declare class LarkSR extends EventBase<LarkSRClientEvent, LarkSREvent> {
      * 主动关闭连接
      */
     close(): void;
+    /**
+     * 设置是否强制横屏显示内容.
+     * handelRootElementSize 必须设置为 true 才有作用。
+     * 要注意强制横屏模式下网页的坐标系xy和视觉上相反，如果通过外部输入 input 事件。要注意调整
+     * @param force 是否强制横屏
+     */
+    setMobileForceLandScape(force: boolean): void;
     /**
      * 切换当前操作者
      * @param uid 用户id

package/types/protobuf/cloudlark.d.ts

@@ -430,6 +430,9 @@ export namespace CloudLark {
 
         /** TaskResponse uid */
         uid?: (number|null);
+
+        /** TaskResponse prestart */
+        prestart?: (boolean|null);
     }
 
     /** Represents a TaskResponse. */
@@ -447,6 +450,9 @@ export namespace CloudLark {
         /** TaskResponse uid. */
         public uid: number;
 
+        /** TaskResponse prestart. */
+        public prestart: boolean;
+
         /**
          * Creates a new TaskResponse instance using the specified properties.
          * @param [properties] Properties to set
@@ -6884,6 +6890,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 +7252,9 @@ export namespace CloudLark {
 
         /** AppNotification aiVoiceServiceStatus */
         aiVoiceServiceStatus?: (CloudLark.IAiVoiceServiceStatus|null);
+
+        /** AppNotification aiVoiceErr */
+        aiVoiceErr?: (CloudLark.IAivoiceError|null);
     }
 
     /** Represents an AppNotification. */
@@ -7194,8 +7299,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;
 }