larksr_websdk 3.2.320 → 3.2.323

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "larksr_websdk",
-  "version": "3.2.320",
+  "version": "3.2.323",
   "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/api.d.ts

@@ -83,6 +83,7 @@ export default class API {
     private static PocHostApplGetUrl;
     private static TaskInfoClientStartedPath;
     private static PortMappingListPath;
+    private static GetTouchCtrMappingPath;
     static HostAppliGetUrl(params: {
         appliId: string;
         playerMode?: number;
@@ -120,5 +121,6 @@ export default class API {
     static ClientInfo(config: ILarkSRConfig, params: AppliParams): void;
     static TaskInfoClientStarted(config: ILarkSRConfig, params: AppliParams): void;
     static PortMappingList(config: ILarkSRConfig): Promise<unknown>;
+    static GetTouchCtrMapping(server: string, appliId?: string): Promise<unknown>;
     static joinParam(params: any): string;
 }

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 {
     /**
      * 普通模式
@@ -179,7 +180,12 @@ declare enum LarkSRClientEvent {
     /**
      * 对话出错详细信息
      */
-    AI_VOICE_ERROR = "aivoiceerror"
+    AI_VOICE_ERROR = "aivoiceerror",
+    /**
+     * 服务端 3.2.7.0 添加
+     *
+     */
+    TOUCH_CTR_MAPPING = "touchctrmapping"
 }
 /**
  * LarkSR 发出的事件
@@ -333,6 +339,19 @@ interface ILarkSRConfig {
      * 需要注意默认打开的是系统中默认的视频设备。
      */
     videoInputAutoStart?: boolean;
+    /**
+     * mouseZoomDirection
+     * 用于移动端捏合缩放操作与应用鼠标缩放的对应关系
+     * 1:鼠标滚轮向上为放大，
+     * 0:鼠标滚轮向下为放大(default)
+     */
+    mouseZoomDirection?: number;
+    /**
+     * 触摸指令模式，对应后台应用管理->应用编辑->移动端高级设置->触摸指令模式 优先级高于后台配置
+     * 触摸指令，移动端的触摸指令对应为云端的触屏还是鼠标
+     * 'touchScreen' | 'mouse'
+     */
+    touchOperateMode?: 'touchScreen' | 'mouse';
 }
 declare class LarkSR extends EventBase<LarkSRClientEvent, LarkSREvent> {
     /**
@@ -429,6 +448,21 @@ declare class LarkSR extends EventBase<LarkSRClientEvent, LarkSREvent> {
      * 是否显示移动端触摸点
      */
     set isEnableTouchPonit(enable: boolean);
+    set isEnableTouchPoint(enable: boolean);
+    /**
+     * 虚拟鼠标的当前位置,相对于整体容器
+     */
+    get virtualCursorPosition(): {
+        x: any;
+        y: any;
+    };
+    /**
+     * 虚拟鼠标的当前位置,内部缩放容器，与实际显示虚拟鼠标 CSS 样式相同
+     */
+    get virtualCursorPositionRaw(): {
+        x: any;
+        y: any;
+    };
     /**
      * 是否显示载入画面时底部文字
      */
@@ -542,6 +576,10 @@ declare class LarkSR extends EventBase<LarkSRClientEvent, LarkSREvent> {
      * 主动关闭连接
      */
     close(): void;
+    /**
+     * 从DOM种删除渲染组件，注意删除渲染组件之后将无法再次进入应用，所有状态将失效,不可恢复，只能重新new LarkSR
+     */
+    destroy(): void;
     /**
      * 设置是否强制横屏显示内容.
      * handelRootElementSize 必须设置为 true 才有作用。
@@ -607,8 +645,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;
+    };
     /**
      * 操作相关事件
      * 所有事件坐标相对于云端应用，不相对于网页
@@ -865,6 +908,7 @@ declare class LarkSR extends EventBase<LarkSRClientEvent, LarkSREvent> {
     addMediaTrack(track: MediaStreamTrack, ...streams: MediaStream[]): boolean | undefined;
     removeMediaTrack(track: RTCRtpSender): boolean | undefined;
     requestUserMediaPermission(constraints?: MediaStreamConstraints): Promise<MediaStream> | undefined;
+    getTouchCtrMapping(appliId?: string): Promise<unknown>;
     $emit(type: LarkEventType, data?: any, message?: string): void;
     $emitError(message?: string, code?: number): void;
     $emitInfo(message?: string, code?: number): void;
@@ -887,4 +931,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;
     /**
      * 获取某元素距离文档的距离

package/dist/doc/config.md

@@ -1,145 +0,0 @@
-# LarkSR 对象参数
-
-创建 LarkSR 对象参数如下
-
-```typescript
-/**
- * 构造 LarkSR 参数
- */
-interface ILarkSRConfig {
-    /**
-     * 必选项 根元素。组件会挂载到跟元素下面
-     * 注意*不要*设置为 document.documentElement
-     * 默认模式下会通过旋转根元素实现强制横屏模式。
-     * @see handelRootElementSize
-     * @see scaleMode
-     */
-    rootElement: HTMLElement;
-    /**
-     * 必选项 服务器地址. LarkServer 前台访问的地址
-     * 如： http://192.168.0.55:8181/
-     */
-    serverAddress: string;
-    /**
-     * 可选项。 sdk 授权码。如果不在此处填，则必须在后续的实例里调用 initSDKAuthCode 初始化。
-     */
-    authCode?: string;
-    /**
-     * 可选项，授权是否成功
-     *  @deprecated 目前不会回调该参数。如果SDK验证失败将在 connect 返回失败
-     */
-    authCodeCallback?: (isSuccess: boolean, e: any) => void;
-    /**
-     * 可选项，载入时的背景图片 url
-     */
-    loadingBgUrl?: string;
-    /**
-     * 可选项，是否同步传入根的组件的大小样式。
-     * 默认开启，将跟组件大小设置为浏览器视口大小
-     * 如果关闭，内部组件将按照传入的根元素大小去显示
-     * 注意，当关闭时不会自动填充根元素，如果根元素高度为 0 将显示不出来。
-     * 注意，当关闭时 mobileForceLandscape 将失去作用。
-     */
-    handelRootElementSize?: boolean;
-    /**
-     * 是否在sdk内部监听鼠标键盘等输入事件
-     * 如果关闭需要手动发送输入事件
-     * 注意关闭时全屏模式和锁定模式将失效,需要在sdk外部触发
-     * @see fullScreenMode
-     */
-    handlInput?: boolean;
-    /**
-     * 当视频播自动放失败时是否尝试静音播放,静音播放时将抛出事件
-     * 静音播放当用户操作屏幕时将尝试播放声音
-     */
-    mutePlayWhenFiled?: boolean;
-    /**
-     * 可选项，是否是 vr 监控类型。
-     */
-    isMonitor?: boolean;
-    /**
-     * 可选项，码率
-     */
-    codeRate?: number;
-    /**
-     * 可选项，帧率
-     */
-    frameRate?: number;
-    /**
-     * 可选项，音频帧率
-     */
-    audioCodeRate?: number;
-    /**
-     * 可选项，日志级别。默认为 warn
-     */
-    logLevel?: 'info' | 'warn' | 'error';
-    /**
-     * 可选项，载入超时时间. 默认为 60s。超过该事件停止载入
-     */
-    loadingTimeout?: number;
-    /**
-     * 可选项，是否自动同步剪贴板数据
-     */
-    syncLocalToCloudClipboard?: boolean;
-    /**
-     * 可选项，优选选择的视频编码格式
-     */
-    perferDecoder?: 'auto' | 'vp8' | 'vp9' | 'h264' | 'av1x';
-    /**
-     * 可选项，视频在容器中的缩放模式
-     * 'contain' | 'fill_clip' | 'fill_stretch'
-     * contain: 以应用原始尺寸的缩放
-     * fill_clip: 裁剪模式，完全填充屏幕但保留宽高比
-     * fill_stretch: 拉伸模式，完全填充屏幕但不保留宽高比
-     */
-    scaleMode?: ScaleMode;
-    /**
-     * 全屏模式
-     *  0 -》 用户手动触发
-     *  1 -》 首次点击进入触发
-     *  2 -》 每次点击触发
-     */
-    fullScreenMode?: number;
-    /**
-     * 可选项，手机端的全屏模式，值同  fullScreenMode
-     */
-    mobileFullScreenMode?: number;
-    /**
-     * 可选项，手机端是否强制横屏
-     */
-    mobileForceLandscape?: 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;
-    /**
-     * 是否提示输入文字 APP_REQUEST_INPUT
-     * 当服务端检测到输入法事件后会抛出事件，可在 web 层添加输入框，配合 inputText 发送文字到云端
-     * 默认打开，当手动关闭时将不会抛出 APP_REQUEST_INPUT 事件
-     */
-    textInputEventPrompt?: boolean;
-
-    /**
-     * 当启用音频输入功能，是否自动连入音频设备。
-     * 默认关闭。
-     * 需要注意默认打开的时系统中默认的音频设备。
-     */
-    audioInputAutoStart?: boolean;
-
-    /**
-     * 当启用视频输入功能，是否自动连入视频设备。
-     * 默认关闭。
-     * 需要注意默认打开的是系统中默认的视频设备。
-     */
-    videoInputAutoStart?: boolean;
-}
-```

package/dist/doc/events.md

@@ -1,139 +0,0 @@
-# LarkSR 事件系统
-
-在 LarkSR 整个生命周期内会抛出多种事件通知。使用方法类似:
-
-```javascript
-var larksr;
-
-// create code
-...
-
-// 监听连接成功事件
-larksr.on('connect', function(e) { 
-    console.log("LarkSRClientEvent CONNECT", e); 
-});
-```
-
-## 完整事件定义
-
-```javascript
-/**
- * LarkSR 实例完整事件定义
- */
-declare const enum LarkSRClientEvent {
-    /**
-     * TASK 创建成功，返回 Task 相关信息
-     */
-    TASK_CREATE_SUCCESS = 'taskcreatesuccess',
-
-    /**
-     * TASK 创建失败
-     */
-    TASK_CREATE_FAILED = 'taskcreatefailed',
-    /**
-     * 连接渲染服务器成功 .
-     */
-    CONNECT = "connect",
-    /**
-     * 登录成功时触发，会返回当前用户id .
-     */
-    LOGIN_SUCCESS = "loginsuccess",
-    /**
-     * 无操作超时时触发 .
-     */
-    NO_OPERATION_TIMEOUT = "operatetimeout",
-    /**
-     * 连接关闭.
-     */
-    CLOSE = "close",
-    /**
-     * 云端应用关闭，但连接未关闭
-     */
-    APP_CLOSE = "appclose",
-    /**
-     * 获取到远端视频流 .
-     */
-    GOT_REMOTE_STREAM = "gotremotesteam",
-    /**
-     * 视频加载成功，等待播放 .
-     */
-    MEDIA_LOADED = "meidaloaded",
-    /**
-     * 视频自动播放成功 .
-     */
-    MEDIA_PLAY_SUCCESS = "mediaplaysuccess",
-    /**
-     * 视频自动播放失败 .
-     */
-    MEDIA_PLAY_FAILED = "mediaplayfailed",
-    /**
-     * 自动播放声音失败，以静音模式播放 .
-     */
-    MEDIA_PLAY_MUTE = "meidaplaymute",
-    /**
-     * 云渲染连接状态改变 .
-     */
-    APPSTATE_CHANGE = "appstatechange",
-    /**
-     * 云端应用大小变化 .
-     */
-    APP_RESIZE = "appresize",
-    /**
-     * 云端应用鼠标模式变化时触发 .
-     */
-    APP_MOUSE_MODE = "appmousemode",
-    /**
-     * 云端应用鼠标状态变化 .
-     */
-    APP_CURSOR_MODE = "appcursormode",
-    /**
-     * 玩家列表 .
-     */
-    PLAYER_LIST = "playerlist",
-    /**
-     * 视频连接状态
-     */
-    PEERSTATUS_REPORT = "peerstatusreport",
-    /**
-     * 云端应用请求输入文字 .
-     */
-    APP_REQUEST_INPUT = "apprequestinput",
-    /**
-     * 云端应用请求手柄震动
-     */
-    APP_REQUEST_GAMEPAD_OUPUT = "apprequestgamepadoutput",
-    /**
-     * 截图成功.
-     */
-    CAPTURE_FRAME = "captureframe",
-    /**
-     * 数据通道打开 .
-     */
-    DATACHANNEL_OPEN = "datachannelopen",
-    /**
-     * 数据通道关闭 .
-     */
-    DATACHANNEL_CLOSE = "datachannelclose",
-    /**
-     * 数据通达收到文字消息 .
-     * > V3.2.314 版本对应服务器版本和数据通道版本为 3.2.5.1 及以上
-     */
-    DATACHANNEL_TEXT = "datachanneltext",
-    /**
-     * 数据通道收到字节消息 .
-     */
-    DATACHANNEL_BINARY = "datachannelbinary",
-    /**
-     * 更详细的事件状态，主要用于向iframe外部抛出 .
-     */
-    LarkEvent = "larkevent",
-    /**
-     * 发生错误时抛出
-     */
-    ERROR = "error",
-    /**
-     * 一般信息提示
-     */
-    INFO = "info"
-}
-```