larksr_websdk 3.2.9 → 3.2.13

package/dist/types/api.d.ts

@@ -67,6 +67,8 @@ export interface StartAppInfo {
     roomCode?: string;
     nickName?: string;
     nickname?: string;
+    appKey?: string;
+    groupId?: string;
 }
 export default class API {
     static CheckUTLockInfoPath: string;
@@ -96,6 +98,10 @@ export default class API {
         userType?: number;
         roomCode?: string;
         taskId?: string;
+        clientMac?: string;
+        groupId?: string;
+        regionId?: string;
+        targetServerIp?: string;
         appKey?: string;
         timestamp?: string;
         signature?: string;

package/dist/types/appli_params.d.ts

@@ -188,6 +188,8 @@ export interface IAppliParams {
     enableRttIcon: boolean;
     enableSoundRequire: boolean;
     toastLevel: number;
+    appKey: string;
+    groupId: string;
 }
 export declare enum AppliType {
     DESKTOP = 1,
@@ -245,6 +247,8 @@ export declare class AppliParams implements IAppliParams {
     enableRttIcon: boolean;
     enableSoundRequire: boolean;
     toastLevel: number;
+    appKey: string;
+    groupId: string;
     static copyAndCreate(params?: IAppliParams): AppliParams;
     static setUpWithSDKConfig(params: IAppliParams, config: ILarkSRConfig): AppliParams;
 }

package/dist/types/larksr.d.ts

@@ -15,7 +15,7 @@ import FullScreen from './utils/full_screen';
 import LockPointer from './utils/lock_pointer';
 import ScaleMode from './utils/scale_mode';
 import Capabilities from './utils/capabilities';
-declare const enum PlayerModeType {
+declare enum PlayerModeType {
     /**
      * 普通模式
      */
@@ -32,7 +32,7 @@ declare const enum PlayerModeType {
 /**
  * 当前用户的身份
  */
-declare const enum UserType {
+declare enum UserType {
     /**
      * 观看者
      */
@@ -164,6 +164,9 @@ interface LarkSREvent extends LocalEvent<LarkSRClientEvent> {
     code?: number;
     larkevent?: LarkEventType;
 }
+declare type PublicPortMapping = {
+    [key: string]: string;
+};
 /**
  * 构造 LarkSR 参数
  */
@@ -271,6 +274,19 @@ interface ILarkSRConfig {
      * 初始化鼠标模式, true 锁定，false 非锁定
      */
     initCursorMode?: boolean;
+    /**
+     * 渲染服务器外网端口映射
+     * 格式为  key=[渲染服务器IP:PORT] value=[外网IP:PORT]
+     * {
+     *    "RENDER-A-IP:RENDER-A-PORT1": "PUBLIC-A-IP:PORT1",
+     *    "RENDER-B-IP:RENDER-B-PORT1": "PUBLIC-A-IP:PORT2",
+     *    "RENDER-C-IP:RENDER-C-PORT1": "PUBLIC-A-IP:PORT3",
+     *    "RENDER-D-IP:RENDER-D-PORT1": "PUBLIC-B-IP:PORT1",
+     *    "RENDER-E-IP:RENDER-E-PORT1": "PUBLIC-B-IP:PORT2",
+     *    "RENDER-E-IP:RENDER-E-PORT2": "PUBLIC-C-IP:PORT1",
+     * }
+     */
+    publicPortMapping?: PublicPortMapping;
 }
 /**
  * 通过平行云托管平台创建客户端并启动应用
@@ -298,7 +314,13 @@ export declare function CreateLarkSRClientFromeAPI(config: ILarkSRConfig, params
     userType?: number;
     roomCode?: string;
     taskId?: string;
-    nickname?: string;
+    clientMac?: string;
+    groupId?: string;
+    regionId?: string;
+    targetServerIp?: string;
+    appKey?: string;
+    timestamp?: string;
+    signature?: string;
 }): Promise<LarkSR>;
 /**
  * 通过从url参数中获取云端应用相关参数
@@ -348,6 +370,10 @@ declare class LarkSR extends EventBase<LarkSRClientEvent, LarkSREvent> {
      */
     get screenState(): ScreenState;
     private _screenState;
+    /**
+     * 动态设置scalemode
+     */
+    set scaleMode(scaleMode: ScaleMode);
     /**
      * 当前的输入控制
      * @see Operation
@@ -388,6 +414,14 @@ declare class LarkSR extends EventBase<LarkSRClientEvent, LarkSREvent> {
      *
      */
     get viewportElement(): any;
+    /**
+     * 是否显示移动端触摸点
+     */
+    set isEnableTouchPonit(enable: boolean);
+    /**
+     * 是否显示载入画面时底部文字
+     */
+    set isEnableLoadingStateBar(enable: boolean);
     get rootElement(): HTMLElement;
     private _rootElement;
     get serverAddress(): string;
@@ -406,10 +440,14 @@ declare class LarkSR extends EventBase<LarkSRClientEvent, LarkSREvent> {
      */
     isTaskOwner(): boolean;
     _isTaskOwner: boolean;
+    /**
+     * true：锁定模式 false：非锁定模式
+     */
+    set initCursorMode(mode: boolean);
+    get initCursorMode(): boolean;
     /**
      * LarkSR 客户端。所有操作和事件通过该类传递
-     * 注意，如果手动创建该类，要清楚参数的意义，一般只有调试等特殊情况才手动创建该类
-     * @see CreateLarkSRClientFromeAPI, CreateLarkSRClientFromeUrl
+     * @see CreateLarkSRClientFromeAPI, @see CreateLarkSRClientFromeUrl @see CreateLarkSRClientFromePXYHost
      * @param config 本地配置，如果有 IAppliParams 相同的配置项，优先级最高
      * @param params [可选参数] 云端应用参数等，通过后台接口或者url参数获取。
      */
@@ -438,11 +476,18 @@ declare class LarkSR extends EventBase<LarkSRClientEvent, LarkSREvent> {
         userType?: number;
         roomCode?: string;
         taskId?: string;
-        nickname?: string;
+        clientMac?: string;
+        groupId?: string;
+        regionId?: string;
+        targetServerIp?: string;
         appKey?: string;
         timestamp?: string;
         signature?: string;
     }): Promise<void>;
+    /**
+     * 用户手动填昵称，需要在 start 或 connect 之前设置才能生效。
+     */
+    setNickname(nickname: string): void;
     /**
      * 手动重设进入应用参数
      * @param params
@@ -502,6 +547,11 @@ declare class LarkSR extends EventBase<LarkSRClientEvent, LarkSREvent> {
      * 可以不使用该方法退出页面
      */
     quit(): void;
+    resetAppMouseLockState(): void;
+    /**
+     * 采集一帧图像
+     */
+    captrueFrame(data: any): void;
     /**
      * 操作相关事件
      * 所有事件坐标相对于云端应用，不相对于网页

package/dist/types/screen_state.d.ts

@@ -78,11 +78,10 @@ export default class ScreenState extends EventBase<SCREEN_EVENT_TYPE, ScreenEven
     get screenOrientation(): ScreenOrientation;
     private _screenOrientation;
     get scaleMode(): ScaleMode;
+    set scaleMode(scaleMode: ScaleMode);
     private _scaleMode;
     get isFullScreen(): boolean;
     private _isFullScreen;
-    get isLockMouse(): boolean;
-    private _isLockMouse;
     get cursorStyle(): SyncCursorStyle;
     set cursorStyle(style: SyncCursorStyle);
     private _cursorStyle;
@@ -95,6 +94,7 @@ export default class ScreenState extends EventBase<SCREEN_EVENT_TYPE, ScreenEven
         scaleY: number;
     };
     get initCursorMode(): boolean;
+    set initCursorMode(mode: boolean);
     private _initCursorMode;
     get isMobile(): boolean;
     private _isMobile;
@@ -102,7 +102,6 @@ export default class ScreenState extends EventBase<SCREEN_EVENT_TYPE, ScreenEven
     get isLockMosue(): boolean | null | undefined;
     get rootElement(): HTMLElement;
     private _rootElement;
-    private videoViewPort;
     private mobileForceLandScape;
     private bgColor;
     private handelRootElementSize;

package/package.json

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

@@ -67,6 +67,8 @@ export interface StartAppInfo {
     roomCode?: string;
     nickName?: string;
     nickname?: string;
+    appKey?: string;
+    groupId?: string;
 }
 export default class API {
     static CheckUTLockInfoPath: string;
@@ -96,6 +98,10 @@ export default class API {
         userType?: number;
         roomCode?: string;
         taskId?: string;
+        clientMac?: string;
+        groupId?: string;
+        regionId?: string;
+        targetServerIp?: string;
         appKey?: string;
         timestamp?: string;
         signature?: string;

package/types/appli_params.d.ts

@@ -188,6 +188,8 @@ export interface IAppliParams {
     enableRttIcon: boolean;
     enableSoundRequire: boolean;
     toastLevel: number;
+    appKey: string;
+    groupId: string;
 }
 export declare enum AppliType {
     DESKTOP = 1,
@@ -245,6 +247,8 @@ export declare class AppliParams implements IAppliParams {
     enableRttIcon: boolean;
     enableSoundRequire: boolean;
     toastLevel: number;
+    appKey: string;
+    groupId: string;
     static copyAndCreate(params?: IAppliParams): AppliParams;
     static setUpWithSDKConfig(params: IAppliParams, config: ILarkSRConfig): AppliParams;
 }

package/types/lark/ice_candiadate_parser.d.ts

@@ -0,0 +1,24 @@
+export default class IceCandidateParser {
+    sdpMLineIndex: number | null;
+    sdpMid: string | null;
+    usernameFragment: string | null;
+    header: string;
+    private props;
+    constructor(ice: RTCIceCandidateInit);
+    get foundation(): string;
+    set foundation(f: string);
+    get component(): string;
+    set component(f: string);
+    get protocol(): string;
+    set protocol(p: string);
+    get priority(): string;
+    set priority(p: string);
+    get ip(): string;
+    set ip(ip: string);
+    get port(): string;
+    set port(port: string);
+    get type(): string;
+    get candidate(): string;
+    genNewIceCandidateInit(): RTCIceCandidateInit;
+    genNewIceCandidate(): RTCIceCandidate;
+}

package/types/lark/lark_event_type.d.ts

@@ -27,6 +27,7 @@ export declare enum LarkEventType {
     LK_RTC_EVENT_PEERCONNECTION_CONNECTED = 600,
     LK_RTC_EVENT_PEERCONNECTION_CLOSED = 601,
     LK_RTC_EVENT_PEERCONNECTION_ERROR = 602,
+    LK_RTC_EVENT_PEERCONNECTION_CREATE_FAILED = 603,
     LK_RTC_EVENT_PEERCONNECTION_STATE = 610,
     LK_RTC_EVENT_PEERCONNECTION_RETRY = 611,
     LK_VIDEO_LOADED = 700,

package/types/lark/peer_connection.d.ts

@@ -92,7 +92,7 @@ export default class PeerConnection extends EventBase<WEBRTC_EVENT_TYPE, WebRTCE
     createOffer(): void;
     close(): void;
     onRemoteDescription(des: RTCSessionDescriptionInit): void;
-    onReceiveCandidate(candateInit: RTCIceCandidateInit | null): void;
+    onReceiveCandidate(candateInit: RTCIceCandidateInit): void;
     startNetTest(): void;
     stopNetTest(): void;
     sendInput(input: Input.CloudLark.ClientInput): void;

package/types/larksr.d.ts

@@ -15,7 +15,7 @@ import FullScreen from './utils/full_screen';
 import LockPointer from './utils/lock_pointer';
 import ScaleMode from './utils/scale_mode';
 import Capabilities from './utils/capabilities';
-declare const enum PlayerModeType {
+declare enum PlayerModeType {
     /**
      * 普通模式
      */
@@ -32,7 +32,7 @@ declare const enum PlayerModeType {
 /**
  * 当前用户的身份
  */
-declare const enum UserType {
+declare enum UserType {
     /**
      * 观看者
      */
@@ -164,6 +164,9 @@ interface LarkSREvent extends LocalEvent<LarkSRClientEvent> {
     code?: number;
     larkevent?: LarkEventType;
 }
+declare type PublicPortMapping = {
+    [key: string]: string;
+};
 /**
  * 构造 LarkSR 参数
  */
@@ -271,6 +274,19 @@ interface ILarkSRConfig {
      * 初始化鼠标模式, true 锁定，false 非锁定
      */
     initCursorMode?: boolean;
+    /**
+     * 渲染服务器外网端口映射
+     * 格式为  key=[渲染服务器IP:PORT] value=[外网IP:PORT]
+     * {
+     *    "RENDER-A-IP:RENDER-A-PORT1": "PUBLIC-A-IP:PORT1",
+     *    "RENDER-B-IP:RENDER-B-PORT1": "PUBLIC-A-IP:PORT2",
+     *    "RENDER-C-IP:RENDER-C-PORT1": "PUBLIC-A-IP:PORT3",
+     *    "RENDER-D-IP:RENDER-D-PORT1": "PUBLIC-B-IP:PORT1",
+     *    "RENDER-E-IP:RENDER-E-PORT1": "PUBLIC-B-IP:PORT2",
+     *    "RENDER-E-IP:RENDER-E-PORT2": "PUBLIC-C-IP:PORT1",
+     * }
+     */
+    publicPortMapping?: PublicPortMapping;
 }
 /**
  * 通过平行云托管平台创建客户端并启动应用
@@ -298,7 +314,13 @@ export declare function CreateLarkSRClientFromeAPI(config: ILarkSRConfig, params
     userType?: number;
     roomCode?: string;
     taskId?: string;
-    nickname?: string;
+    clientMac?: string;
+    groupId?: string;
+    regionId?: string;
+    targetServerIp?: string;
+    appKey?: string;
+    timestamp?: string;
+    signature?: string;
 }): Promise<LarkSR>;
 /**
  * 通过从url参数中获取云端应用相关参数
@@ -348,6 +370,10 @@ declare class LarkSR extends EventBase<LarkSRClientEvent, LarkSREvent> {
      */
     get screenState(): ScreenState;
     private _screenState;
+    /**
+     * 动态设置scalemode
+     */
+    set scaleMode(scaleMode: ScaleMode);
     /**
      * 当前的输入控制
      * @see Operation
@@ -388,6 +414,14 @@ declare class LarkSR extends EventBase<LarkSRClientEvent, LarkSREvent> {
      *
      */
     get viewportElement(): any;
+    /**
+     * 是否显示移动端触摸点
+     */
+    set isEnableTouchPonit(enable: boolean);
+    /**
+     * 是否显示载入画面时底部文字
+     */
+    set isEnableLoadingStateBar(enable: boolean);
     get rootElement(): HTMLElement;
     private _rootElement;
     get serverAddress(): string;
@@ -406,10 +440,14 @@ declare class LarkSR extends EventBase<LarkSRClientEvent, LarkSREvent> {
      */
     isTaskOwner(): boolean;
     _isTaskOwner: boolean;
+    /**
+     * true：锁定模式 false：非锁定模式
+     */
+    set initCursorMode(mode: boolean);
+    get initCursorMode(): boolean;
     /**
      * LarkSR 客户端。所有操作和事件通过该类传递
-     * 注意，如果手动创建该类，要清楚参数的意义，一般只有调试等特殊情况才手动创建该类
-     * @see CreateLarkSRClientFromeAPI, CreateLarkSRClientFromeUrl
+     * @see CreateLarkSRClientFromeAPI, @see CreateLarkSRClientFromeUrl @see CreateLarkSRClientFromePXYHost
      * @param config 本地配置，如果有 IAppliParams 相同的配置项，优先级最高
      * @param params [可选参数] 云端应用参数等，通过后台接口或者url参数获取。
      */
@@ -438,11 +476,18 @@ declare class LarkSR extends EventBase<LarkSRClientEvent, LarkSREvent> {
         userType?: number;
         roomCode?: string;
         taskId?: string;
-        nickname?: string;
+        clientMac?: string;
+        groupId?: string;
+        regionId?: string;
+        targetServerIp?: string;
         appKey?: string;
         timestamp?: string;
         signature?: string;
     }): Promise<void>;
+    /**
+     * 用户手动填昵称，需要在 start 或 connect 之前设置才能生效。
+     */
+    setNickname(nickname: string): void;
     /**
      * 手动重设进入应用参数
      * @param params
@@ -502,6 +547,11 @@ declare class LarkSR extends EventBase<LarkSRClientEvent, LarkSREvent> {
      * 可以不使用该方法退出页面
      */
     quit(): void;
+    resetAppMouseLockState(): void;
+    /**
+     * 采集一帧图像
+     */
+    captrueFrame(data: any): void;
     /**
      * 操作相关事件
      * 所有事件坐标相对于云端应用，不相对于网页

package/types/operation/operation.d.ts

@@ -42,6 +42,7 @@ export default class Operation extends EventBase<OPREATION_EVENT_TYPE, Operation
     setTouchEnable(enable: boolean): void;
     resetLocalRendreMousePosition(): void;
     setAppMouseMode(mode: CloudLark.IAppMouseMode): void;
+    resetAppMouseLockState(): void;
     startListening(): void;
     stopListenling(): void;
     private startOperationCheck;

package/types/screen_state.d.ts

@@ -78,11 +78,10 @@ export default class ScreenState extends EventBase<SCREEN_EVENT_TYPE, ScreenEven
     get screenOrientation(): ScreenOrientation;
     private _screenOrientation;
     get scaleMode(): ScaleMode;
+    set scaleMode(scaleMode: ScaleMode);
     private _scaleMode;
     get isFullScreen(): boolean;
     private _isFullScreen;
-    get isLockMouse(): boolean;
-    private _isLockMouse;
     get cursorStyle(): SyncCursorStyle;
     set cursorStyle(style: SyncCursorStyle);
     private _cursorStyle;
@@ -95,6 +94,7 @@ export default class ScreenState extends EventBase<SCREEN_EVENT_TYPE, ScreenEven
         scaleY: number;
     };
     get initCursorMode(): boolean;
+    set initCursorMode(mode: boolean);
     private _initCursorMode;
     get isMobile(): boolean;
     private _isMobile;
@@ -102,7 +102,6 @@ export default class ScreenState extends EventBase<SCREEN_EVENT_TYPE, ScreenEven
     get isLockMosue(): boolean | null | undefined;
     get rootElement(): HTMLElement;
     private _rootElement;
-    private videoViewPort;
     private mobileForceLandScape;
     private bgColor;
     private handelRootElementSize;