larksr_websdk 3.2.320 → 3.2.321

package/dist/types/index.d.ts

@@ -1,5 +1,5 @@
 import 'core-js/stable/symbol';
-import { LarkSR, 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, GESTURE_TYPE } from "./larksr";
 declare const _default: {
     LarkSR: typeof LarkSR;
     API: typeof API;
@@ -16,6 +16,7 @@ declare const _default: {
     Operation: typeof Operation;
     LarkSRClientEvent: typeof LarkSRClientEvent;
     LarkEventType: typeof LarkEventType;
+    GESTURE_TYPE: typeof GESTURE_TYPE;
     KEYMAP: import("./operation/keymap").VritualKeyMapOptions;
 };
 export default _default;

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

@@ -89,7 +89,7 @@ export default class Application extends EventBase<APP_EVENT_TYPE, AppEvent> {
     startMonitorSteam(): void;
     restart(): void;
     restartApp(): void;
-    rtcOffer(): void;
+    rtcOffer(): Promise<void>;
     setAnswer(sdp: string): void;
     setIce(sdpMlineindex: number, sdpmid: string, candidate: string): void;
     sendInput(input: Msg.CloudLark.ClientInput): void;
@@ -113,6 +113,7 @@ export default class Application extends EventBase<APP_EVENT_TYPE, AppEvent> {
     private onRemoteStream;
     private onAudioRemoteStream;
     private onRtcError;
+    private onRtcInfo;
     private onIceStateChange;
     retryPeerconnection(): void;
     setAudioEnable(enable: boolean): void | undefined;

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

@@ -29,7 +29,8 @@ export declare enum WEBRTC_EVENT_TYPE {
     AI_VOICE_STATUS = 18,
     AI_VOICE_ASR_RESULT = 19,
     AI_VOICE_DM_RESULT = 20,
-    AI_VOICE_ERROR = 21
+    AI_VOICE_ERROR = 21,
+    INFO = 22
 }
 export interface GoogleBitRate {
     start: number;
@@ -105,7 +106,7 @@ export default class PeerConnection extends EventBase<WEBRTC_EVENT_TYPE, WebRTCE
     private localShareTrackBinding;
     private sdpCreateSuccess;
     constructor(larksr: LarkSR, config: WebRTCConfig);
-    create(): void;
+    create(streams?: MediaStream | undefined | null): Promise<void>;
     createOffer(): void;
     close(): void;
     setAudioEnable(enable: boolean): void;

package/dist/types/larksr.d.ts

@@ -16,6 +16,7 @@ import LockPointer from './utils/lock_pointer';
 import ScaleMode from './utils/scale_mode';
 import Capabilities from './utils/capabilities';
 import Recorder from './lark/recoder';
+import { GESTURE_TYPE } from './operation/gesture';
 declare enum PlayerModeType {
     /**
      * 普通模式
@@ -333,6 +334,19 @@ interface ILarkSRConfig {
      * 需要注意默认打开的是系统中默认的视频设备。
      */
     videoInputAutoStart?: boolean;
+    /**
+     * mouseZoomDirection
+     * 用于移动端捏合缩放操作与应用鼠标缩放的对应关系
+     * 1:鼠标滚轮向上为放大，
+     * 0:鼠标滚轮向下为放大(default)
+     */
+    mouseZoomDirection?: number;
+    /**
+     * 触摸指令模式，对应后台应用管理->应用编辑->移动端高级设置->触摸指令模式 优先级高于后台配置
+     * 触摸指令，移动端的触摸指令对应为云端的触屏还是鼠标
+     * 'touchScreen' | 'mouse'
+     */
+    touchOperateMode?: 'touchScreen' | 'mouse';
 }
 declare class LarkSR extends EventBase<LarkSRClientEvent, LarkSREvent> {
     /**
@@ -542,6 +556,10 @@ declare class LarkSR extends EventBase<LarkSRClientEvent, LarkSREvent> {
      * 主动关闭连接
      */
     close(): void;
+    /**
+     * 从DOM种删除渲染组件，注意删除渲染组件之后将无法再次进入应用，所有状态将失效,不可恢复，只能重新new LarkSR
+     */
+    destroy(): void;
     /**
      * 设置是否强制横屏显示内容.
      * handelRootElementSize 必须设置为 true 才有作用。
@@ -607,8 +625,13 @@ declare class LarkSR extends EventBase<LarkSRClientEvent, LarkSREvent> {
     resetAppMouseLockState(): void;
     /**
      * 采集一帧图像
+     * @params data: any 抛出采集事件时抛出的附加data，比如采集的时间戳
+     * @return { data: any, base64: base64string } 返回传入的 data 和采集的 base64 字符串
      */
-    captrueFrame(data: any): void;
+    captrueFrame(data: any): {
+        data: any;
+        base64: any;
+    };
     /**
      * 操作相关事件
      * 所有事件坐标相对于云端应用，不相对于网页
@@ -887,4 +910,4 @@ declare class LarkSR extends EventBase<LarkSRClientEvent, LarkSREvent> {
     private onOperationTimeout;
     private onOperationInput;
 }
-export { LarkSR, ILarkSRConfig, PlayerModeType, UserType, LarkSREvent, LarkEventType, LarkSRClientEvent, AppliParams, AppliParamsUtils, LoadAppliParamsFromUrl, LoadAppliParamsStartAppInfo, EventBase, API, Operation, Capabilities, ScaleMode, VirtualKey, KEYMAP, CloudLark, FullScreen, LockPointer, Recorder, };
+export { LarkSR, ILarkSRConfig, PlayerModeType, UserType, LarkSREvent, LarkEventType, LarkSRClientEvent, AppliParams, AppliParamsUtils, LoadAppliParamsFromUrl, LoadAppliParamsStartAppInfo, EventBase, API, Operation, Capabilities, ScaleMode, VirtualKey, KEYMAP, CloudLark, FullScreen, LockPointer, Recorder, GESTURE_TYPE, };

package/dist/types/operation/gesture.d.ts

@@ -9,7 +9,7 @@ export interface GestureEvent extends LocalEvent<GESTRUE_EVENT_TYPE> {
     motion: Vector;
     distance: number;
 }
-export declare const enum GESTURE_TYPE {
+export declare enum GESTURE_TYPE {
     SINGLE_FINGER_TOUCH_START = 1,
     SINGLE_FINGER_TAP = 2,
     SINGLE_FINGER_TAP_DOWN = 3,
@@ -43,6 +43,8 @@ export default class Gesture extends EventBase<GESTRUE_EVENT_TYPE, GestureEvent>
     private touchStartPoints;
     private touchChangedPoins;
     private tapStart;
+    setTapLimitRadius(radius: number): void;
+    setTapLimitTimeout(timeout: number): void;
     private tapLimit;
     private lastTap;
     private tapPressTimeout;

package/dist/types/operation/gesture_handler.d.ts

@@ -1,4 +1,5 @@
 import Operation from './operation';
+import { GESTURE_TYPE } from './gesture';
 import HandlerBase from './handler_base';
 export default class GestureHandler extends HandlerBase {
     private gesture;
@@ -7,6 +8,42 @@ export default class GestureHandler extends HandlerBase {
     set mouseZoomDirection(direction: number);
     get mouseZoomDirection(): number;
     private _mouseZoomDirection;
+    /**
+     *
+     */
+    set tapLimitRadius(radius: number);
+    /**
+     *
+     */
+    set tapLimitTimeout(timeout: number);
+    /**
+     *
+     */
+    set relativeMouseMoveSpeed(speed: number);
+    get relativeMouseMoveSpeed(): number;
+    private _relativeMouseMoveSpeed;
+    /**
+     *
+     */
+    set gestureCallback(callback: null | ((event: {
+        type: GESTURE_TYPE;
+        x: number;
+        y: number;
+        rx: number;
+        ry: number;
+        edge: boolean;
+        rawEvent: any;
+    }) => void));
+    get gestureCallback(): null | ((event: {
+        type: GESTURE_TYPE;
+        x: number;
+        y: number;
+        rx: number;
+        ry: number;
+        edge: boolean;
+        rawEvent: any;
+    }) => void);
+    private _gestureCallback;
     constructor(rootElement: HTMLElement, op: Operation);
     startListening(): void;
     stopListening(): void;

package/dist/types/operation/keyboard_handler.d.ts

@@ -4,6 +4,9 @@ export default class KeyboardHandler extends HandlerBase {
     private needSyncKeyState;
     private fistSyncKeyState;
     private pressedKeys;
+    set preventKeys(keys: string[]);
+    get preventKeys(): string[];
+    private _preventKeys;
     constructor(op: Operation);
     startListening(): void;
     stopListening(): void;

package/dist/types/operation/operation.d.ts

@@ -1,6 +1,11 @@
 import { CloudLark } from '../protobuf/cloudlark';
 import { LocalEvent, EventBase } from '../event/event_base';
 import { Point } from '../common/interface';
+import GestureHandler from './gesture_handler';
+import KeyboardHandler from './keyboard_handler';
+import MouseHandler from './mouse_handler';
+import GamepadHandler from './gamepad_handler';
+import TouchHandler from './touch_handler';
 import { LarkSR } from '../larksr';
 export declare const enum OPREATION_EVENT_TYPE {
     Input = 0,
@@ -14,11 +19,31 @@ export interface OperationEvent extends LocalEvent<OPREATION_EVENT_TYPE> {
     cursorPoint?: Point;
 }
 export default class Operation extends EventBase<OPREATION_EVENT_TYPE, OperationEvent> {
-    private gestureHandler;
-    private keyboardHandler;
-    private mouseHandler;
-    private gamepadHandler;
-    private touchHandler;
+    /**
+     * 移动端手势处理
+     */
+    get gestureHandler(): GestureHandler;
+    private _gestureHandler;
+    /**
+     * 键盘处理
+     */
+    get keyboardHandler(): KeyboardHandler;
+    private _keyboardHandler;
+    /**
+     * 鼠标处理
+     */
+    get mouseHandler(): MouseHandler;
+    private _mouseHandler;
+    /**
+     * 游戏手柄处理
+     */
+    get gamepadHandler(): GamepadHandler;
+    private _gamepadHandler;
+    /**
+     * 触摸屏输入处理
+    */
+    get touchHandler(): TouchHandler;
+    private _touchHandler;
     private _startListen;
     set enableParse(enable: boolean);
     get enableParse(): boolean;

package/dist/types/utils/capabilities.d.ts

@@ -48,5 +48,7 @@ declare class Capabilities {
      * </ul>
      */
     static get os(): string;
+    static $isIOSSafari: boolean;
+    static get isIOSSafari(): boolean;
 }
 export default Capabilities;

package/dist/types/utils/ios-inner-height.d.ts

@@ -0,0 +1,4 @@
+declare module "ios-inner-height" {
+    function innerHeight(): number;
+    export = innerHeight;
+}

package/dist/types/utils/unit.d.ts

@@ -14,11 +14,6 @@ export default class Unit {
     /**
      * 浏览器窗口大小相关
      */
-    /**
-     * 获取浏览器窗口大小
-     * @returns { width: 窗口宽, height: 窗口高 }
-     */
-    static viewport(): ViewPort;
     static getElementViewport(element: HTMLElement, baseElementScale?: number): ViewPort;
     /**
      * 获取某元素距离文档的距离

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "larksr_websdk",
-  "version": "3.2.320",
+  "version": "3.2.321",
   "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",
@@ -32,6 +32,7 @@
     "bowser": "^2.11.0",
     "core-js": "^3.18.1",
     "crypto-js": "^4.1.1",
+    "ios-inner-height": "^1.1.1",
     "protobufjs": "^6.11.2",
     "webrtc-adapter": "^8.1.0",
     "weixin-js-sdk": "^1.6.0"

package/types/index.d.ts

@@ -1,5 +1,5 @@
 import 'core-js/stable/symbol';
-import { LarkSR, 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, GESTURE_TYPE } from "./larksr";
 declare const _default: {
     LarkSR: typeof LarkSR;
     API: typeof API;
@@ -16,6 +16,7 @@ declare const _default: {
     Operation: typeof Operation;
     LarkSRClientEvent: typeof LarkSRClientEvent;
     LarkEventType: typeof LarkEventType;
+    GESTURE_TYPE: typeof GESTURE_TYPE;
     KEYMAP: import("./operation/keymap").VritualKeyMapOptions;
 };
 export default _default;

package/types/lark/application.d.ts

@@ -89,7 +89,7 @@ export default class Application extends EventBase<APP_EVENT_TYPE, AppEvent> {
     startMonitorSteam(): void;
     restart(): void;
     restartApp(): void;
-    rtcOffer(): void;
+    rtcOffer(): Promise<void>;
     setAnswer(sdp: string): void;
     setIce(sdpMlineindex: number, sdpmid: string, candidate: string): void;
     sendInput(input: Msg.CloudLark.ClientInput): void;
@@ -113,6 +113,7 @@ export default class Application extends EventBase<APP_EVENT_TYPE, AppEvent> {
     private onRemoteStream;
     private onAudioRemoteStream;
     private onRtcError;
+    private onRtcInfo;
     private onIceStateChange;
     retryPeerconnection(): void;
     setAudioEnable(enable: boolean): void | undefined;

package/types/lark/peer_connection.d.ts

@@ -29,7 +29,8 @@ export declare enum WEBRTC_EVENT_TYPE {
     AI_VOICE_STATUS = 18,
     AI_VOICE_ASR_RESULT = 19,
     AI_VOICE_DM_RESULT = 20,
-    AI_VOICE_ERROR = 21
+    AI_VOICE_ERROR = 21,
+    INFO = 22
 }
 export interface GoogleBitRate {
     start: number;
@@ -105,7 +106,7 @@ export default class PeerConnection extends EventBase<WEBRTC_EVENT_TYPE, WebRTCE
     private localShareTrackBinding;
     private sdpCreateSuccess;
     constructor(larksr: LarkSR, config: WebRTCConfig);
-    create(): void;
+    create(streams?: MediaStream | undefined | null): Promise<void>;
     createOffer(): void;
     close(): void;
     setAudioEnable(enable: boolean): void;

package/types/larksr.d.ts

@@ -16,6 +16,7 @@ import LockPointer from './utils/lock_pointer';
 import ScaleMode from './utils/scale_mode';
 import Capabilities from './utils/capabilities';
 import Recorder from './lark/recoder';
+import { GESTURE_TYPE } from './operation/gesture';
 declare enum PlayerModeType {
     /**
      * 普通模式
@@ -333,6 +334,19 @@ interface ILarkSRConfig {
      * 需要注意默认打开的是系统中默认的视频设备。
      */
     videoInputAutoStart?: boolean;
+    /**
+     * mouseZoomDirection
+     * 用于移动端捏合缩放操作与应用鼠标缩放的对应关系
+     * 1:鼠标滚轮向上为放大，
+     * 0:鼠标滚轮向下为放大(default)
+     */
+    mouseZoomDirection?: number;
+    /**
+     * 触摸指令模式，对应后台应用管理->应用编辑->移动端高级设置->触摸指令模式 优先级高于后台配置
+     * 触摸指令，移动端的触摸指令对应为云端的触屏还是鼠标
+     * 'touchScreen' | 'mouse'
+     */
+    touchOperateMode?: 'touchScreen' | 'mouse';
 }
 declare class LarkSR extends EventBase<LarkSRClientEvent, LarkSREvent> {
     /**
@@ -542,6 +556,10 @@ declare class LarkSR extends EventBase<LarkSRClientEvent, LarkSREvent> {
      * 主动关闭连接
      */
     close(): void;
+    /**
+     * 从DOM种删除渲染组件，注意删除渲染组件之后将无法再次进入应用，所有状态将失效,不可恢复，只能重新new LarkSR
+     */
+    destroy(): void;
     /**
      * 设置是否强制横屏显示内容.
      * handelRootElementSize 必须设置为 true 才有作用。
@@ -607,8 +625,13 @@ declare class LarkSR extends EventBase<LarkSRClientEvent, LarkSREvent> {
     resetAppMouseLockState(): void;
     /**
      * 采集一帧图像
+     * @params data: any 抛出采集事件时抛出的附加data，比如采集的时间戳
+     * @return { data: any, base64: base64string } 返回传入的 data 和采集的 base64 字符串
      */
-    captrueFrame(data: any): void;
+    captrueFrame(data: any): {
+        data: any;
+        base64: any;
+    };
     /**
      * 操作相关事件
      * 所有事件坐标相对于云端应用，不相对于网页
@@ -887,4 +910,4 @@ declare class LarkSR extends EventBase<LarkSRClientEvent, LarkSREvent> {
     private onOperationTimeout;
     private onOperationInput;
 }
-export { LarkSR, ILarkSRConfig, PlayerModeType, UserType, LarkSREvent, LarkEventType, LarkSRClientEvent, AppliParams, AppliParamsUtils, LoadAppliParamsFromUrl, LoadAppliParamsStartAppInfo, EventBase, API, Operation, Capabilities, ScaleMode, VirtualKey, KEYMAP, CloudLark, FullScreen, LockPointer, Recorder, };
+export { LarkSR, ILarkSRConfig, PlayerModeType, UserType, LarkSREvent, LarkEventType, LarkSRClientEvent, AppliParams, AppliParamsUtils, LoadAppliParamsFromUrl, LoadAppliParamsStartAppInfo, EventBase, API, Operation, Capabilities, ScaleMode, VirtualKey, KEYMAP, CloudLark, FullScreen, LockPointer, Recorder, GESTURE_TYPE, };

package/types/operation/gesture.d.ts

@@ -9,7 +9,7 @@ export interface GestureEvent extends LocalEvent<GESTRUE_EVENT_TYPE> {
     motion: Vector;
     distance: number;
 }
-export declare const enum GESTURE_TYPE {
+export declare enum GESTURE_TYPE {
     SINGLE_FINGER_TOUCH_START = 1,
     SINGLE_FINGER_TAP = 2,
     SINGLE_FINGER_TAP_DOWN = 3,
@@ -43,6 +43,8 @@ export default class Gesture extends EventBase<GESTRUE_EVENT_TYPE, GestureEvent>
     private touchStartPoints;
     private touchChangedPoins;
     private tapStart;
+    setTapLimitRadius(radius: number): void;
+    setTapLimitTimeout(timeout: number): void;
     private tapLimit;
     private lastTap;
     private tapPressTimeout;

package/types/operation/gesture_handler.d.ts

@@ -1,4 +1,5 @@
 import Operation from './operation';
+import { GESTURE_TYPE } from './gesture';
 import HandlerBase from './handler_base';
 export default class GestureHandler extends HandlerBase {
     private gesture;
@@ -7,6 +8,42 @@ export default class GestureHandler extends HandlerBase {
     set mouseZoomDirection(direction: number);
     get mouseZoomDirection(): number;
     private _mouseZoomDirection;
+    /**
+     *
+     */
+    set tapLimitRadius(radius: number);
+    /**
+     *
+     */
+    set tapLimitTimeout(timeout: number);
+    /**
+     *
+     */
+    set relativeMouseMoveSpeed(speed: number);
+    get relativeMouseMoveSpeed(): number;
+    private _relativeMouseMoveSpeed;
+    /**
+     *
+     */
+    set gestureCallback(callback: null | ((event: {
+        type: GESTURE_TYPE;
+        x: number;
+        y: number;
+        rx: number;
+        ry: number;
+        edge: boolean;
+        rawEvent: any;
+    }) => void));
+    get gestureCallback(): null | ((event: {
+        type: GESTURE_TYPE;
+        x: number;
+        y: number;
+        rx: number;
+        ry: number;
+        edge: boolean;
+        rawEvent: any;
+    }) => void);
+    private _gestureCallback;
     constructor(rootElement: HTMLElement, op: Operation);
     startListening(): void;
     stopListening(): void;

package/types/operation/keyboard_handler.d.ts

@@ -4,6 +4,9 @@ export default class KeyboardHandler extends HandlerBase {
     private needSyncKeyState;
     private fistSyncKeyState;
     private pressedKeys;
+    set preventKeys(keys: string[]);
+    get preventKeys(): string[];
+    private _preventKeys;
     constructor(op: Operation);
     startListening(): void;
     stopListening(): void;

package/types/operation/operation.d.ts

@@ -1,6 +1,11 @@
 import { CloudLark } from '../protobuf/cloudlark';
 import { LocalEvent, EventBase } from '../event/event_base';
 import { Point } from '../common/interface';
+import GestureHandler from './gesture_handler';
+import KeyboardHandler from './keyboard_handler';
+import MouseHandler from './mouse_handler';
+import GamepadHandler from './gamepad_handler';
+import TouchHandler from './touch_handler';
 import { LarkSR } from '../larksr';
 export declare const enum OPREATION_EVENT_TYPE {
     Input = 0,
@@ -14,11 +19,31 @@ export interface OperationEvent extends LocalEvent<OPREATION_EVENT_TYPE> {
     cursorPoint?: Point;
 }
 export default class Operation extends EventBase<OPREATION_EVENT_TYPE, OperationEvent> {
-    private gestureHandler;
-    private keyboardHandler;
-    private mouseHandler;
-    private gamepadHandler;
-    private touchHandler;
+    /**
+     * 移动端手势处理
+     */
+    get gestureHandler(): GestureHandler;
+    private _gestureHandler;
+    /**
+     * 键盘处理
+     */
+    get keyboardHandler(): KeyboardHandler;
+    private _keyboardHandler;
+    /**
+     * 鼠标处理
+     */
+    get mouseHandler(): MouseHandler;
+    private _mouseHandler;
+    /**
+     * 游戏手柄处理
+     */
+    get gamepadHandler(): GamepadHandler;
+    private _gamepadHandler;
+    /**
+     * 触摸屏输入处理
+    */
+    get touchHandler(): TouchHandler;
+    private _touchHandler;
     private _startListen;
     set enableParse(enable: boolean);
     get enableParse(): boolean;

package/types/utils/capabilities.d.ts

@@ -48,5 +48,7 @@ declare class Capabilities {
      * </ul>
      */
     static get os(): string;
+    static $isIOSSafari: boolean;
+    static get isIOSSafari(): boolean;
 }
 export default Capabilities;

package/types/utils/ios-inner-height.d.ts

@@ -0,0 +1,4 @@
+declare module "ios-inner-height" {
+    function innerHeight(): number;
+    export = innerHeight;
+}

package/types/utils/unit.d.ts

@@ -14,11 +14,6 @@ export default class Unit {
     /**
      * 浏览器窗口大小相关
      */
-    /**
-     * 获取浏览器窗口大小
-     * @returns { width: 窗口宽, height: 窗口高 }
-     */
-    static viewport(): ViewPort;
     static getElementViewport(element: HTMLElement, baseElementScale?: number): ViewPort;
     /**
      * 获取某元素距离文档的距离