larksr_websdk 3.2.16 → 3.2.30

package/dist/types/api.d.ts

@@ -93,6 +93,7 @@ export default class API {
         };
     }>;
     static GetStartInfo(serverAddress: string, params: {
+        sdkId: string;
         appliId: string;
         playerMode?: number;
         userType?: number;

package/dist/types/appli_params.d.ts

@@ -132,7 +132,7 @@ export interface IAppliParams {
     /**
      * 口令:8位唯一码,写入TaskInfo. 房间code，备用。
      */
-    roomCode: number;
+    roomCode: string;
     /**
      * debug task. 跳过task检测
      */
@@ -231,7 +231,7 @@ export declare class AppliParams implements IAppliParams {
     playerMode: number;
     userType: number;
     nickname: string;
-    roomCode: number;
+    roomCode: string;
     debugTask: boolean;
     debugWebServer: string;
     loadingTimeout: number;

package/dist/types/index.d.ts

@@ -1,10 +1,7 @@
 import 'core-js/stable/symbol';
-import { LarkSR, CreateLarkSRClientFromePXYHost, CreateLarkSRClientFromeAPI, CreateLarkSRClientFromeUrl, LarkEventType, LarkSRClientEvent, AppliParams, LoadAppliParamsFromUrl, AppliParamsUtils, LoadAppliParamsStartAppInfo, EventBase, API, Operation, Capabilities, ScaleMode, CloudLark, FullScreen, LockPointer, ILarkSRConfig, PlayerModeType, UserType, LarkSREvent } from "./larksr";
+import { LarkSR, LarkEventType, LarkSRClientEvent, AppliParams, LoadAppliParamsFromUrl, AppliParamsUtils, LoadAppliParamsStartAppInfo, EventBase, API, Operation, Capabilities, ScaleMode, CloudLark, FullScreen, LockPointer, ILarkSRConfig, PlayerModeType, UserType, LarkSREvent } from "./larksr";
 declare const _default: {
     LarkSR: typeof LarkSR;
-    CreateLarkSRClientFromePXYHost: typeof CreateLarkSRClientFromePXYHost;
-    CreateLarkSRClientFromeAPI: typeof CreateLarkSRClientFromeAPI;
-    CreateLarkSRClientFromeUrl: typeof CreateLarkSRClientFromeUrl;
     API: typeof API;
     AppliParams: typeof AppliParams;
     LoadAppliParamsFromUrl: typeof LoadAppliParamsFromUrl;

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, IAppliParams, LoadAppliParamsFromUrl, LoadAppliParamsStartAppInfo } from './appli_params';
+import { AppliParams, AppliParamsUtils, LoadAppliParamsFromUrl, LoadAppliParamsStartAppInfo } from './appli_params';
 import { LarkEventType } from './lark/lark_event_type';
 import API from './api';
 import ScreenState from './screen_state';
@@ -46,6 +46,14 @@ declare enum UserType {
  * LarkSR 实例会发出的事件
  */
 declare enum LarkSRClientEvent {
+    /**
+     * TASK 创建成功，返回 Task 相关信息
+     */
+    TASK_CREATE_SUCCESS = "taskcreatesuccess",
+    /**
+     * TASK 创建失败
+     */
+    TASK_CREATE_FAILED = "taskcreatefailed",
     /**
      * 连接渲染服务器成功 .
      */
@@ -192,6 +200,7 @@ interface ILarkSRConfig {
     authCode?: string;
     /**
      * 可选项，授权是否成功
+     * @deprecated 目前不会回调该参数。如果SDK验证失败将在 connect 返回失败
      */
     authCodeCallback?: (isSuccess: boolean, e: any) => void;
     /**
@@ -288,46 +297,6 @@ interface ILarkSRConfig {
      */
     publicPortMapping?: PublicPortMapping;
 }
-/**
- * 通过平行云托管平台创建客户端并启动应用
- * @param config 传入 config @see ILarkSRConfig
- * @param params 进入应用接口参数。appliId 为必填项
- * @returns Promise 创建 larksr client 是否成功
- */
-export declare function CreateLarkSRClientFromePXYHost(config: ILarkSRConfig, params: {
-    appliId: string;
-    playerMode?: number;
-    userType?: number;
-    roomCode?: string;
-    taskId?: string;
-    nickname?: string;
-}): Promise<LarkSR>;
-/**
- * 通过调用后台接口获取云端应用参数
- * @param config 传入 config @see ILarkSRConfig
- * @param params 进入应用接口参数。appliId 为必填项
- * @returns Promise 创建 larksr client 是否成功
- */
-export declare function CreateLarkSRClientFromeAPI(config: ILarkSRConfig, params: {
-    appliId: string;
-    playerMode?: number;
-    userType?: number;
-    roomCode?: string;
-    taskId?: string;
-    clientMac?: string;
-    groupId?: string;
-    regionId?: string;
-    targetServerIp?: string;
-    appKey?: string;
-    timestamp?: string;
-    signature?: string;
-}): Promise<LarkSR>;
-/**
- * 通过从url参数中获取云端应用相关参数
- * @param config 传入 config @see ILarkSRConfig
- * @returns Promise 创建 larksr client 是否成功
- */
-export declare function CreateLarkSRClientFromeUrl(config: ILarkSRConfig): Promise<LarkSR>;
 declare class LarkSR extends EventBase<LarkSRClientEvent, LarkSREvent> {
     /**
      * 应用参数，构建时传入
@@ -434,7 +403,6 @@ declare class LarkSR extends EventBase<LarkSRClientEvent, LarkSREvent> {
     get config(): ILarkSRConfig;
     private _config;
     private loadingTimeout;
-    private sdkAuth;
     /**
      * 后台分配的用户id
      */
@@ -452,13 +420,11 @@ declare class LarkSR extends EventBase<LarkSRClientEvent, LarkSREvent> {
     get initCursorMode(): boolean;
     /**
      * LarkSR 客户端。所有操作和事件通过该类传递
-     * @see CreateLarkSRClientFromeAPI, @see CreateLarkSRClientFromeUrl @see CreateLarkSRClientFromePXYHost
-     * @param config 本地配置，如果有 IAppliParams 相同的配置项，优先级最高
-     * @param params [可选参数] 云端应用参数等，通过后台接口或者url参数获取。
+     * @param config 本地配置，优先级最高
      */
-    constructor(config: ILarkSRConfig, params?: IAppliParams);
+    constructor(config: ILarkSRConfig);
     /**
-     *
+     * 单独设置sdk授权码，目前总会返回成功 promise，具体验证失败将在 connectWithPxyHost 或 connect 返回
      * @param id sdk id 初始化sdkid
      * @returns
      */
@@ -497,13 +463,13 @@ declare class LarkSR extends EventBase<LarkSRClientEvent, LarkSREvent> {
      * 手动重设进入应用参数
      * @param params
      */
-    setAppliParams(params: IAppliParams): void;
+    private setAppliParams;
     /**
      * 开始云渲染流程
      * 启动时应用参数不能为空，包括 taskID，appServer，appPort
      * @returns 是否成功。主要校验授权码是否成功
      */
-    start(): Promise<void>;
+    private start;
     /**
      * 重新开始云渲染流程
      */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "larksr_websdk",
-  "version": "3.2.16",
+  "version": "3.2.30",
   "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

@@ -93,6 +93,7 @@ export default class API {
         };
     }>;
     static GetStartInfo(serverAddress: string, params: {
+        sdkId: string;
         appliId: string;
         playerMode?: number;
         userType?: number;

package/types/appli_params.d.ts

@@ -132,7 +132,7 @@ export interface IAppliParams {
     /**
      * 口令:8位唯一码,写入TaskInfo. 房间code，备用。
      */
-    roomCode: number;
+    roomCode: string;
     /**
      * debug task. 跳过task检测
      */
@@ -231,7 +231,7 @@ export declare class AppliParams implements IAppliParams {
     playerMode: number;
     userType: number;
     nickname: string;
-    roomCode: number;
+    roomCode: string;
     debugTask: boolean;
     debugWebServer: string;
     loadingTimeout: number;

package/types/index.d.ts

@@ -1,10 +1,7 @@
 import 'core-js/stable/symbol';
-import { LarkSR, CreateLarkSRClientFromePXYHost, CreateLarkSRClientFromeAPI, CreateLarkSRClientFromeUrl, LarkEventType, LarkSRClientEvent, AppliParams, LoadAppliParamsFromUrl, AppliParamsUtils, LoadAppliParamsStartAppInfo, EventBase, API, Operation, Capabilities, ScaleMode, CloudLark, FullScreen, LockPointer, ILarkSRConfig, PlayerModeType, UserType, LarkSREvent } from "./larksr";
+import { LarkSR, LarkEventType, LarkSRClientEvent, AppliParams, LoadAppliParamsFromUrl, AppliParamsUtils, LoadAppliParamsStartAppInfo, EventBase, API, Operation, Capabilities, ScaleMode, CloudLark, FullScreen, LockPointer, ILarkSRConfig, PlayerModeType, UserType, LarkSREvent } from "./larksr";
 declare const _default: {
     LarkSR: typeof LarkSR;
-    CreateLarkSRClientFromePXYHost: typeof CreateLarkSRClientFromePXYHost;
-    CreateLarkSRClientFromeAPI: typeof CreateLarkSRClientFromeAPI;
-    CreateLarkSRClientFromeUrl: typeof CreateLarkSRClientFromeUrl;
     API: typeof API;
     AppliParams: typeof AppliParams;
     LoadAppliParamsFromUrl: typeof LoadAppliParamsFromUrl;

package/types/lark/lark_event_type.d.ts

@@ -1,7 +1,7 @@
 export declare enum LarkEventType {
     LK_WEB_CLIENT_LOAD_SUCCESS = 1,
-    LK_API_ENTERAPPLI_SUCCESS = 10,
-    LK_API_ENTERAPPLI_FAILED = 11,
+    LK_TASK_CREATE_SUCCESS = 10,
+    LK_TASK_CREATE_FAILED = 11,
     LK_TASK_SYNC_APP = 20,
     LK_TASK_SYNC_APP_FAILED = 21,
     LK_RENDER_SERVER_CONNECTED = 100,
@@ -33,6 +33,7 @@ export declare enum LarkEventType {
     LK_VIDEO_LOADED = 700,
     LK_VIDEO_PLAY_FAILED = 701,
     LK_GOT_REMOTE_STREAM = 710,
+    LK_VIDEO_PLAY_SUCCSS = 711,
     LK_NOTIFY_CLIENT_LOGOUT_PLAYER_LOGOUT = 800,
     LK_NOTIFY_CLIENT_LOGOUT_TASKOWNER_LOGOUT = 801,
     LK_APP_PROCESS_NOTIFI_APP_QUIT = 900,

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, IAppliParams, LoadAppliParamsFromUrl, LoadAppliParamsStartAppInfo } from './appli_params';
+import { AppliParams, AppliParamsUtils, LoadAppliParamsFromUrl, LoadAppliParamsStartAppInfo } from './appli_params';
 import { LarkEventType } from './lark/lark_event_type';
 import API from './api';
 import ScreenState from './screen_state';
@@ -46,6 +46,14 @@ declare enum UserType {
  * LarkSR 实例会发出的事件
  */
 declare enum LarkSRClientEvent {
+    /**
+     * TASK 创建成功，返回 Task 相关信息
+     */
+    TASK_CREATE_SUCCESS = "taskcreatesuccess",
+    /**
+     * TASK 创建失败
+     */
+    TASK_CREATE_FAILED = "taskcreatefailed",
     /**
      * 连接渲染服务器成功 .
      */
@@ -192,6 +200,7 @@ interface ILarkSRConfig {
     authCode?: string;
     /**
      * 可选项，授权是否成功
+     * @deprecated 目前不会回调该参数。如果SDK验证失败将在 connect 返回失败
      */
     authCodeCallback?: (isSuccess: boolean, e: any) => void;
     /**
@@ -288,46 +297,6 @@ interface ILarkSRConfig {
      */
     publicPortMapping?: PublicPortMapping;
 }
-/**
- * 通过平行云托管平台创建客户端并启动应用
- * @param config 传入 config @see ILarkSRConfig
- * @param params 进入应用接口参数。appliId 为必填项
- * @returns Promise 创建 larksr client 是否成功
- */
-export declare function CreateLarkSRClientFromePXYHost(config: ILarkSRConfig, params: {
-    appliId: string;
-    playerMode?: number;
-    userType?: number;
-    roomCode?: string;
-    taskId?: string;
-    nickname?: string;
-}): Promise<LarkSR>;
-/**
- * 通过调用后台接口获取云端应用参数
- * @param config 传入 config @see ILarkSRConfig
- * @param params 进入应用接口参数。appliId 为必填项
- * @returns Promise 创建 larksr client 是否成功
- */
-export declare function CreateLarkSRClientFromeAPI(config: ILarkSRConfig, params: {
-    appliId: string;
-    playerMode?: number;
-    userType?: number;
-    roomCode?: string;
-    taskId?: string;
-    clientMac?: string;
-    groupId?: string;
-    regionId?: string;
-    targetServerIp?: string;
-    appKey?: string;
-    timestamp?: string;
-    signature?: string;
-}): Promise<LarkSR>;
-/**
- * 通过从url参数中获取云端应用相关参数
- * @param config 传入 config @see ILarkSRConfig
- * @returns Promise 创建 larksr client 是否成功
- */
-export declare function CreateLarkSRClientFromeUrl(config: ILarkSRConfig): Promise<LarkSR>;
 declare class LarkSR extends EventBase<LarkSRClientEvent, LarkSREvent> {
     /**
      * 应用参数，构建时传入
@@ -434,7 +403,6 @@ declare class LarkSR extends EventBase<LarkSRClientEvent, LarkSREvent> {
     get config(): ILarkSRConfig;
     private _config;
     private loadingTimeout;
-    private sdkAuth;
     /**
      * 后台分配的用户id
      */
@@ -452,13 +420,11 @@ declare class LarkSR extends EventBase<LarkSRClientEvent, LarkSREvent> {
     get initCursorMode(): boolean;
     /**
      * LarkSR 客户端。所有操作和事件通过该类传递
-     * @see CreateLarkSRClientFromeAPI, @see CreateLarkSRClientFromeUrl @see CreateLarkSRClientFromePXYHost
-     * @param config 本地配置，如果有 IAppliParams 相同的配置项，优先级最高
-     * @param params [可选参数] 云端应用参数等，通过后台接口或者url参数获取。
+     * @param config 本地配置，优先级最高
      */
-    constructor(config: ILarkSRConfig, params?: IAppliParams);
+    constructor(config: ILarkSRConfig);
     /**
-     *
+     * 单独设置sdk授权码，目前总会返回成功 promise，具体验证失败将在 connectWithPxyHost 或 connect 返回
      * @param id sdk id 初始化sdkid
      * @returns
      */
@@ -497,13 +463,13 @@ declare class LarkSR extends EventBase<LarkSRClientEvent, LarkSREvent> {
      * 手动重设进入应用参数
      * @param params
      */
-    setAppliParams(params: IAppliParams): void;
+    private setAppliParams;
     /**
      * 开始云渲染流程
      * 启动时应用参数不能为空，包括 taskID，appServer，appPort
      * @returns 是否成功。主要校验授权码是否成功
      */
-    start(): Promise<void>;
+    private start;
     /**
      * 重新开始云渲染流程
      */

package/types/operation/keyboard_handler.d.ts

@@ -3,13 +3,16 @@ import HandlerBase from './handler_base';
 export default class KeyboardHandler extends HandlerBase {
     private needSyncKeyState;
     private fistSyncKeyState;
+    private pressedKeys;
     constructor(op: Operation);
     startListening(): void;
     stopListening(): void;
+    private onLockPointChange;
     private keyboardListenerSetup;
     private onKeyDown;
     private onKeyUp;
     private onWindowBlur;
     private onWindowFocus;
     private onWindowVisibilityChange;
+    private releaseKeys;
 }

package/types/operation/mouse_handler.d.ts

@@ -8,6 +8,7 @@ export default class MouseHandler extends HandlerBase {
     private isFocus;
     private rootElement;
     private subscribeUpdatePlayerListFromProtoAction;
+    private pressedMouseButtons;
     constructor(rootElement: HTMLElement, op: Operation);
     resetLocalRendreMousePosition(p: Point): void;
     setRootElement(rootElement: HTMLElement): void;
@@ -36,5 +37,6 @@ export default class MouseHandler extends HandlerBase {
     private onWindowBlur;
     private onWindowFocus;
     private onWindowVisibilityChange;
+    private releaseMouseButtons;
     private toastMsg;
 }

package/types/utils/capabilities.d.ts

@@ -27,6 +27,10 @@ declare class Capabilities {
     static get isMobile(): boolean;
     static $isWeChat: boolean;
     static get isWeChat(): boolean;
+    static $isQQ: boolean;
+    static get isQQ(): boolean;
+    static $isHuawei: boolean;
+    static get isHuawei(): boolean;
     /**
      * @private
      */

package/types/utils/log.d.ts

@@ -3,7 +3,7 @@ export declare class Level {
     static WARN: string;
     static ERR: string;
     static TRACE: string;
-    static getLevelIndex(level: string): 2 | 0 | 1 | 3 | 4;
+    static getLevelIndex(level: string): 0 | 2 | 1 | 3 | 4;
 }
 export interface LogObserver {
     onLog(msg: string): void;

package/dist/types/sdk_auth.d.ts

@@ -1,11 +0,0 @@
-export declare class SDKAuth {
-    get isSuccess(): boolean;
-    private _isSuccess;
-    get error(): any;
-    private _error;
-    constructor();
-    auth(id: string): Promise<void>;
-    signature(key: string, secret: string, timestamp: string): string;
-    check(id: string): boolean;
-    save(id: string, expire: string): void;
-}

package/types/sdk_auth.d.ts

@@ -1,11 +0,0 @@
-export declare class SDKAuth {
-    get isSuccess(): boolean;
-    private _isSuccess;
-    get error(): any;
-    private _error;
-    constructor();
-    auth(id: string): Promise<void>;
-    signature(key: string, secret: string, timestamp: string): string;
-    check(id: string): boolean;
-    save(id: string, expire: string): void;
-}