larksr_websdk 3.2.404 → 3.3.101

package/dist/types/api.d.ts

@@ -7,7 +7,7 @@ export interface UTLockInfo {
 }
 export interface GetTaskResult {
     adminViewer: number;
-    appKey: string;
+    wsId: string;
     appliId: string;
     appliType: number;
     city: string;
@@ -24,7 +24,6 @@ export interface GetTaskResult {
     reserveFlag: number;
     serverId: string;
     serverIp: string;
-    shareUrl: string;
     startAt: string;
     startParam: string;
     startProcType: number;
@@ -33,12 +32,13 @@ export interface GetTaskResult {
     updateDate: string;
     useGamepad: number;
     wm: number;
-    textInputEventPrompt: number;
-    audioInput: number;
-    audioInputAutoStart: number;
-    videoInput: number;
-    videoInputAutoStart: number;
-    liveStreaming: number;
+    shareUrl?: string;
+    textInputEventPrompt?: number;
+    audioInput?: number;
+    audioInputAutoStart?: number;
+    videoInput?: number;
+    videoInputAutoStart?: number;
+    liveStreaming?: number;
     mobileKeyboardType?: number;
 }
 export interface StartAppInfo {
@@ -75,13 +75,24 @@ export interface StartAppInfo {
     authCode?: string;
     nickName?: string;
     nickname?: string;
-    appKey?: string;
+    wsId?: string;
     groupId?: string;
     initResolutionType?: number;
+    useWebCodec?: number;
+    preferDecoder?: string;
+    mobileWebMenuType?: number;
+    shareUrl?: string;
+    textInputEventPrompt?: number;
+    audioInput?: number;
+    audioInputAutoStart?: number;
+    videoInput?: number;
+    videoInputAutoStart?: number;
+    liveStreaming?: number;
+    mobileKeyboardType?: number;
 }
 declare type HostAppliGetUrlReturnParams = {
     appliId: string;
-    appKey: string;
+    wsId: string;
     timestamp: string;
     signature: string;
     groupId?: string;
@@ -97,6 +108,7 @@ export default class API {
     private static GetTouchCtrMappingPath;
     private static GetAppliListPath;
     private static RegionListPath;
+    private static TestEnableWaitQueue;
     static HostAppliGetUrl(params: {
         appliId: string;
         playerMode?: number;
@@ -119,7 +131,7 @@ export default class API {
         groupId?: string;
         regionId?: string;
         targetServerIp?: string;
-        appKey?: string;
+        wsId?: string;
         timestamp?: string;
         signature?: string;
     } | any): Promise<StartAppInfo>;
@@ -132,6 +144,9 @@ export default class API {
     static GetTouchCtrMapping(server: string, appliId?: string): Promise<unknown>;
     static GetAppliList(server: string, params: any): Promise<unknown>;
     static RegionList(server: string, params: any): Promise<unknown>;
+    static IsEnableWaitQueue(server: string, params: any): Promise<{
+        enableWaitQueue: boolean;
+    }>;
     static heartbeat(server: string, taskId: string): Promise<unknown>;
     static joinParam(params: any): string;
 }

package/dist/types/appli_params.d.ts

@@ -194,7 +194,7 @@ export interface IAppliParams {
     enableRttIcon: boolean;
     enableSoundRequire: boolean;
     toastLevel: number;
-    appKey: string;
+    wsId: string;
     groupId: string;
     textInputEventPrompt: boolean;
     audioInput: boolean;
@@ -205,7 +205,8 @@ export interface IAppliParams {
     useSeparateMediaSharePeer: boolean;
     mobileKeyboardType: number;
     initResolutionType: number;
-    useWebcodec: boolean;
+    useWebCodec: boolean;
+    mobileWebMenuType: number;
 }
 export declare enum AppliType {
     DESKTOP = 1,
@@ -265,7 +266,7 @@ export declare class AppliParams implements IAppliParams {
     enableRttIcon: boolean;
     enableSoundRequire: boolean;
     toastLevel: number;
-    appKey: string;
+    wsId: string;
     groupId: string;
     textInputEventPrompt: boolean;
     audioInput: boolean;
@@ -276,7 +277,8 @@ export declare class AppliParams implements IAppliParams {
     useSeparateMediaSharePeer: boolean;
     mobileKeyboardType: number;
     initResolutionType: number;
-    useWebcodec: boolean;
+    useWebCodec: boolean;
+    mobileWebMenuType: number;
     static copyAndCreate(params?: IAppliParams): AppliParams;
     static setUpWithSDKConfig(params: IAppliParams, config: ILarkSRConfig): AppliParams;
 }
@@ -288,7 +290,7 @@ export declare class AppliParamsUtils {
     static getBoolOption(option: string | null | undefined | boolean, emptyValue?: boolean): boolean;
     static getNumberBoolOption(option: string | null | undefined | number, emptyValue?: boolean): boolean;
     static getStringOption(option: string | null | undefined, emptyValue?: string): string;
-    static getIntOption(option: string | null | undefined, emptyValue?: number): number;
+    static getIntOption(option: string | number | null | undefined, emptyValue?: number): number;
     static getBgColor(option: string | null | undefined): string;
 }
 /**

package/dist/types/lark/peer_connection.d.ts

@@ -3,6 +3,7 @@ import * as Input from '../protobuf/cloudlark';
 import { LarkSR } from '../larksr';
 import { MediaShareInterface, RTCMediaTrackBinding } from './media_share_interface';
 import { CloudLark } from '@/protobuf/cloudlark';
+import WebCodec from './webcodec';
 export declare enum IceState {
     DISCONNECT = 1,
     BAD = 2,
@@ -119,7 +120,8 @@ export default class PeerConnection extends EventBase<WEBRTC_EVENT_TYPE, WebRTCE
     private _serverStatics;
     get currentAppSize(): CloudLark.IAppResize | null;
     private _currentAppSize;
-    constructor(larksr: LarkSR, config: WebRTCConfig);
+    private webcodec;
+    constructor(larksr: LarkSR, config: WebRTCConfig, webcodec: WebCodec);
     create(streams?: MediaStream | undefined | null, config?: CloudLark.IRTCConfiguration | null | undefined): Promise<void>;
     createOffer(): void;
     close(): void;

package/dist/types/lark/webcodec.d.ts

@@ -21,17 +21,38 @@ export default class WebCodec extends EventBase<WEB_CODEC_EVENT_TYPE, WebCodecEv
     private larksr;
     private decoder;
     private codec;
-    private width;
-    private height;
+    get width(): number;
+    private _width;
+    get height(): number;
+    private _height;
     private canvas;
     private context;
     private frameData;
     private dataOffset;
     private firstFrame;
+    get inited(): boolean;
+    private _inited;
+    private decodeCost;
+    private decodeCosts;
+    private renderCost;
+    private renderCosts;
+    private firstPackage;
+    private packageCost;
+    private packageCosts;
+    private frameCount;
+    private dataCount;
+    private lastState;
     constructor(larksr: LarkSR);
     setCanvas(canvas: HTMLCanvasElement, context: CanvasRenderingContext2D): void;
     init(frame: CloudLark.IStreamVideoFrame): Promise<boolean | undefined>;
     onStreamVideoFrame(frame: CloudLark.IStreamVideoFrame): Promise<void>;
+    stats(): {
+        fps: number;
+        bitrateKbps: number;
+        package: number;
+        decode: number;
+        render: number;
+    };
     private checkConfig;
     private onFrameDecode;
     private onFrameError;

package/dist/types/lark/websocket_waitqueue.d.ts

@@ -0,0 +1,36 @@
+import { EventBase, LocalEvent } from '../event/event_base';
+export declare enum WAITQUEUE_EVENT_TYPE {
+    OPEN = 0,
+    CLOSE = 1,
+    ERROR = 2,
+    TRY = 3,
+    STAUTS = 4
+}
+export interface WaitQueueEvent extends LocalEvent<WAITQUEUE_EVENT_TYPE> {
+    waitCount?: number;
+}
+export interface WaitQueueConfig {
+    serverAddress: string;
+    appliId: string;
+    groupId?: string;
+    targetServerIp?: string;
+}
+export default class WaitQueue extends EventBase<WAITQUEUE_EVENT_TYPE, WaitQueueEvent> {
+    private get wsServer();
+    private config;
+    private connection;
+    private keepAliveTimeout;
+    private queueId;
+    isOpen(): boolean;
+    constructor(config: WaitQueueConfig);
+    /**
+     *
+     */
+    connect(): Promise<this>;
+    /**
+     *
+     */
+    close(): Promise<void>;
+    private startKeepAlive;
+    private stopKeepAlive;
+}

package/dist/types/larksr.d.ts

@@ -62,7 +62,7 @@ declare enum LarkSRClientEvent {
             // 服务端返回的错误码，服务端请求正确返回时存在。需要注意渲染资源不足类型的错误码。
             // 可用 type == 0 判断是否是渲染资源不足类型的错误,再用 code 进行细节处理，或者只用 type == 0 进行处理。
             // 813=当前应用的运行数量已达到最大值：{0},请稍后再试
-            // 814=同一appKey下的应用运行数量达到最大值：{0}，请稍后再试
+            // 814=同一wsId下的应用运行数量达到最大值：{0}，请稍后再试
             // 815=应用运行数量已达到最大授权并发数量，请稍后再试
             // 816=VR应用运行数量已达到最大授权并发数量，请稍后再试
             // 817=渲染资源不足，请稍后再试
@@ -499,7 +499,12 @@ interface ILarkSRConfig {
     /**
      * 是否使用 webcodec
      */
-    useWebcodec?: boolean;
+    useWebCodec?: boolean;
+    /**
+     * 是否启用等待队列
+     * 优先级高于后台配置
+     */
+    disableWaitQueue?: boolean;
 }
 declare class LarkSR extends EventBase<LarkSRClientEvent, LarkSREvent> {
     /**
@@ -740,6 +745,7 @@ declare class LarkSR extends EventBase<LarkSRClientEvent, LarkSREvent> {
     stopAerialview(): void;
     get syncClientViewport(): boolean;
     set syncClientViewport(sync: boolean);
+    private waitQueue;
     /**
      * LarkSR 客户端。所有操作和事件通过该类传递
      * @param config 本地配置，优先级最高
@@ -787,7 +793,7 @@ declare class LarkSR extends EventBase<LarkSRClientEvent, LarkSREvent> {
             // 服务端返回的错误码，服务端请求正确返回时存在。需要注意渲染资源不足类型的错误码。
             // 可用 type == 0 判断是否是渲染资源不足类型的错误,再用 code 进行细节处理，或者只用 type == 0 进行处理。
             // 813=当前应用的运行数量已达到最大值：{0},请稍后再试
-            // 814=同一appKey下的应用运行数量达到最大值：{0}，请稍后再试
+            // 814=同一wsId下的应用运行数量达到最大值：{0}，请稍后再试
             // 815=应用运行数量已达到最大授权并发数量，请稍后再试
             // 816=VR应用运行数量已达到最大授权并发数量，请稍后再试
             // 817=渲染资源不足，请稍后再试

package/dist/types/localization/message.d.ts

@@ -78,4 +78,5 @@ export default class Message extends LocalizationBase {
     get LK_NOTIFY_CLIENT_LOGOUT_TASKOWNER_LOGOUT(): string;
     get LK_APP_PROCESS_NOTIFI_APP_QUIT(): string;
     get LK_LOADING_TIMEOUT(): string;
+    get WAIT_QUEUE_COUNT(): string;
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "larksr_websdk",
-  "version": "3.2.404",
-  "description": "Larksr websdk. Easy to build a cloud render client for larksr system or ue4 pixelstreaming.docs: https://pingxingyun.github.io/webclient_sdk/",
+  "version": "3.3.101",
+  "description": "Larksr websdk. Easy to build a cloud render client for larksr system or ue4 pixelstreaming.docs: https://paraversetechnology.github.io/en/webclient_sdk/",
   "keywords": [
     "pingxingyun",
     "larksr",

package/types/api.d.ts

@@ -7,7 +7,7 @@ export interface UTLockInfo {
 }
 export interface GetTaskResult {
     adminViewer: number;
-    appKey: string;
+    wsId: string;
     appliId: string;
     appliType: number;
     city: string;
@@ -24,7 +24,6 @@ export interface GetTaskResult {
     reserveFlag: number;
     serverId: string;
     serverIp: string;
-    shareUrl: string;
     startAt: string;
     startParam: string;
     startProcType: number;
@@ -33,12 +32,13 @@ export interface GetTaskResult {
     updateDate: string;
     useGamepad: number;
     wm: number;
-    textInputEventPrompt: number;
-    audioInput: number;
-    audioInputAutoStart: number;
-    videoInput: number;
-    videoInputAutoStart: number;
-    liveStreaming: number;
+    shareUrl?: string;
+    textInputEventPrompt?: number;
+    audioInput?: number;
+    audioInputAutoStart?: number;
+    videoInput?: number;
+    videoInputAutoStart?: number;
+    liveStreaming?: number;
     mobileKeyboardType?: number;
 }
 export interface StartAppInfo {
@@ -75,13 +75,24 @@ export interface StartAppInfo {
     authCode?: string;
     nickName?: string;
     nickname?: string;
-    appKey?: string;
+    wsId?: string;
     groupId?: string;
     initResolutionType?: number;
+    useWebCodec?: number;
+    preferDecoder?: string;
+    mobileWebMenuType?: number;
+    shareUrl?: string;
+    textInputEventPrompt?: number;
+    audioInput?: number;
+    audioInputAutoStart?: number;
+    videoInput?: number;
+    videoInputAutoStart?: number;
+    liveStreaming?: number;
+    mobileKeyboardType?: number;
 }
 declare type HostAppliGetUrlReturnParams = {
     appliId: string;
-    appKey: string;
+    wsId: string;
     timestamp: string;
     signature: string;
     groupId?: string;
@@ -97,6 +108,7 @@ export default class API {
     private static GetTouchCtrMappingPath;
     private static GetAppliListPath;
     private static RegionListPath;
+    private static TestEnableWaitQueue;
     static HostAppliGetUrl(params: {
         appliId: string;
         playerMode?: number;
@@ -119,7 +131,7 @@ export default class API {
         groupId?: string;
         regionId?: string;
         targetServerIp?: string;
-        appKey?: string;
+        wsId?: string;
         timestamp?: string;
         signature?: string;
     } | any): Promise<StartAppInfo>;
@@ -132,6 +144,9 @@ export default class API {
     static GetTouchCtrMapping(server: string, appliId?: string): Promise<unknown>;
     static GetAppliList(server: string, params: any): Promise<unknown>;
     static RegionList(server: string, params: any): Promise<unknown>;
+    static IsEnableWaitQueue(server: string, params: any): Promise<{
+        enableWaitQueue: boolean;
+    }>;
     static heartbeat(server: string, taskId: string): Promise<unknown>;
     static joinParam(params: any): string;
 }

package/types/appli_params.d.ts

@@ -194,7 +194,7 @@ export interface IAppliParams {
     enableRttIcon: boolean;
     enableSoundRequire: boolean;
     toastLevel: number;
-    appKey: string;
+    wsId: string;
     groupId: string;
     textInputEventPrompt: boolean;
     audioInput: boolean;
@@ -205,7 +205,8 @@ export interface IAppliParams {
     useSeparateMediaSharePeer: boolean;
     mobileKeyboardType: number;
     initResolutionType: number;
-    useWebcodec: boolean;
+    useWebCodec: boolean;
+    mobileWebMenuType: number;
 }
 export declare enum AppliType {
     DESKTOP = 1,
@@ -265,7 +266,7 @@ export declare class AppliParams implements IAppliParams {
     enableRttIcon: boolean;
     enableSoundRequire: boolean;
     toastLevel: number;
-    appKey: string;
+    wsId: string;
     groupId: string;
     textInputEventPrompt: boolean;
     audioInput: boolean;
@@ -276,7 +277,8 @@ export declare class AppliParams implements IAppliParams {
     useSeparateMediaSharePeer: boolean;
     mobileKeyboardType: number;
     initResolutionType: number;
-    useWebcodec: boolean;
+    useWebCodec: boolean;
+    mobileWebMenuType: number;
     static copyAndCreate(params?: IAppliParams): AppliParams;
     static setUpWithSDKConfig(params: IAppliParams, config: ILarkSRConfig): AppliParams;
 }
@@ -288,7 +290,7 @@ export declare class AppliParamsUtils {
     static getBoolOption(option: string | null | undefined | boolean, emptyValue?: boolean): boolean;
     static getNumberBoolOption(option: string | null | undefined | number, emptyValue?: boolean): boolean;
     static getStringOption(option: string | null | undefined, emptyValue?: string): string;
-    static getIntOption(option: string | null | undefined, emptyValue?: number): number;
+    static getIntOption(option: string | number | null | undefined, emptyValue?: number): number;
     static getBgColor(option: string | null | undefined): string;
 }
 /**

package/types/lark/peer_connection.d.ts

@@ -3,6 +3,7 @@ import * as Input from '../protobuf/cloudlark';
 import { LarkSR } from '../larksr';
 import { MediaShareInterface, RTCMediaTrackBinding } from './media_share_interface';
 import { CloudLark } from '@/protobuf/cloudlark';
+import WebCodec from './webcodec';
 export declare enum IceState {
     DISCONNECT = 1,
     BAD = 2,
@@ -119,7 +120,8 @@ export default class PeerConnection extends EventBase<WEBRTC_EVENT_TYPE, WebRTCE
     private _serverStatics;
     get currentAppSize(): CloudLark.IAppResize | null;
     private _currentAppSize;
-    constructor(larksr: LarkSR, config: WebRTCConfig);
+    private webcodec;
+    constructor(larksr: LarkSR, config: WebRTCConfig, webcodec: WebCodec);
     create(streams?: MediaStream | undefined | null, config?: CloudLark.IRTCConfiguration | null | undefined): Promise<void>;
     createOffer(): void;
     close(): void;

package/types/lark/webcodec.d.ts

@@ -21,17 +21,38 @@ export default class WebCodec extends EventBase<WEB_CODEC_EVENT_TYPE, WebCodecEv
     private larksr;
     private decoder;
     private codec;
-    private width;
-    private height;
+    get width(): number;
+    private _width;
+    get height(): number;
+    private _height;
     private canvas;
     private context;
     private frameData;
     private dataOffset;
     private firstFrame;
+    get inited(): boolean;
+    private _inited;
+    private decodeCost;
+    private decodeCosts;
+    private renderCost;
+    private renderCosts;
+    private firstPackage;
+    private packageCost;
+    private packageCosts;
+    private frameCount;
+    private dataCount;
+    private lastState;
     constructor(larksr: LarkSR);
     setCanvas(canvas: HTMLCanvasElement, context: CanvasRenderingContext2D): void;
     init(frame: CloudLark.IStreamVideoFrame): Promise<boolean | undefined>;
     onStreamVideoFrame(frame: CloudLark.IStreamVideoFrame): Promise<void>;
+    stats(): {
+        fps: number;
+        bitrateKbps: number;
+        package: number;
+        decode: number;
+        render: number;
+    };
     private checkConfig;
     private onFrameDecode;
     private onFrameError;

package/types/lark/websocket_waitqueue.d.ts

@@ -0,0 +1,36 @@
+import { EventBase, LocalEvent } from '../event/event_base';
+export declare enum WAITQUEUE_EVENT_TYPE {
+    OPEN = 0,
+    CLOSE = 1,
+    ERROR = 2,
+    TRY = 3,
+    STAUTS = 4
+}
+export interface WaitQueueEvent extends LocalEvent<WAITQUEUE_EVENT_TYPE> {
+    waitCount?: number;
+}
+export interface WaitQueueConfig {
+    serverAddress: string;
+    appliId: string;
+    groupId?: string;
+    targetServerIp?: string;
+}
+export default class WaitQueue extends EventBase<WAITQUEUE_EVENT_TYPE, WaitQueueEvent> {
+    private get wsServer();
+    private config;
+    private connection;
+    private keepAliveTimeout;
+    private queueId;
+    isOpen(): boolean;
+    constructor(config: WaitQueueConfig);
+    /**
+     *
+     */
+    connect(): Promise<this>;
+    /**
+     *
+     */
+    close(): Promise<void>;
+    private startKeepAlive;
+    private stopKeepAlive;
+}

package/types/larksr.d.ts

@@ -62,7 +62,7 @@ declare enum LarkSRClientEvent {
             // 服务端返回的错误码，服务端请求正确返回时存在。需要注意渲染资源不足类型的错误码。
             // 可用 type == 0 判断是否是渲染资源不足类型的错误,再用 code 进行细节处理，或者只用 type == 0 进行处理。
             // 813=当前应用的运行数量已达到最大值：{0},请稍后再试
-            // 814=同一appKey下的应用运行数量达到最大值：{0}，请稍后再试
+            // 814=同一wsId下的应用运行数量达到最大值：{0}，请稍后再试
             // 815=应用运行数量已达到最大授权并发数量，请稍后再试
             // 816=VR应用运行数量已达到最大授权并发数量，请稍后再试
             // 817=渲染资源不足，请稍后再试
@@ -499,7 +499,12 @@ interface ILarkSRConfig {
     /**
      * 是否使用 webcodec
      */
-    useWebcodec?: boolean;
+    useWebCodec?: boolean;
+    /**
+     * 是否启用等待队列
+     * 优先级高于后台配置
+     */
+    disableWaitQueue?: boolean;
 }
 declare class LarkSR extends EventBase<LarkSRClientEvent, LarkSREvent> {
     /**
@@ -740,6 +745,7 @@ declare class LarkSR extends EventBase<LarkSRClientEvent, LarkSREvent> {
     stopAerialview(): void;
     get syncClientViewport(): boolean;
     set syncClientViewport(sync: boolean);
+    private waitQueue;
     /**
      * LarkSR 客户端。所有操作和事件通过该类传递
      * @param config 本地配置，优先级最高
@@ -787,7 +793,7 @@ declare class LarkSR extends EventBase<LarkSRClientEvent, LarkSREvent> {
             // 服务端返回的错误码，服务端请求正确返回时存在。需要注意渲染资源不足类型的错误码。
             // 可用 type == 0 判断是否是渲染资源不足类型的错误,再用 code 进行细节处理，或者只用 type == 0 进行处理。
             // 813=当前应用的运行数量已达到最大值：{0},请稍后再试
-            // 814=同一appKey下的应用运行数量达到最大值：{0}，请稍后再试
+            // 814=同一wsId下的应用运行数量达到最大值：{0}，请稍后再试
             // 815=应用运行数量已达到最大授权并发数量，请稍后再试
             // 816=VR应用运行数量已达到最大授权并发数量，请稍后再试
             // 817=渲染资源不足，请稍后再试

package/types/localization/message.d.ts

@@ -78,4 +78,5 @@ export default class Message extends LocalizationBase {
     get LK_NOTIFY_CLIENT_LOGOUT_TASKOWNER_LOGOUT(): string;
     get LK_APP_PROCESS_NOTIFI_APP_QUIT(): string;
     get LK_LOADING_TIMEOUT(): string;
+    get WAIT_QUEUE_COUNT(): string;
 }