larksr_websdk 3.2.310 → 3.2.314

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

@@ -0,0 +1,37 @@
+export default class BrowserType {
+    static Type: {
+        Chrome: string;
+        iOSChrome: string;
+        Firefox: string;
+        Edge: string;
+        Opera: string;
+        IE: string;
+        Safari: string;
+    };
+    static Support: {
+        Chrome: number;
+        Firefox: number;
+        Edge: number;
+    };
+    static AdviseSupportVersion: {
+        Chrome: number;
+        Firefox: number;
+        Edge: number;
+    };
+    static SupportMobile: {
+        Chrome: number;
+        iOSChrome: number;
+        Firefox: number;
+        Edge: number;
+    };
+    static getBrowserType(): string;
+    /**
+     * @return
+     *        -2 推荐升级版本
+     *         -1  有问题版本
+     *         0 不支持
+     *         1 支持
+     */
+    static checkSupport(): 0 | 1 | -1 | -2;
+    static getBrowserVersion(type?: string): number;
+}

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

@@ -0,0 +1,52 @@
+declare class Capabilities {
+    /**
+     * @private
+     */
+    static $language: string;
+    /**
+     * @language zh_CN
+     * 表示运行内容的系统的语言代码。语言指定为 ISO 639-1 中的小写双字母语言代码。
+     * 对于中文，另外使用 ISO 3166 中的大写双字母国家/地区代码，以区分简体中文和繁体中文。<br/>
+     * 以下是可能但不限于的语言和值：
+     * <ul>
+     * <li>简体中文  zh-CN</li>
+     * <li>繁体中文  zh-TW</li>
+     * <li>英语      en</li>
+     * <li>日语      ja</li>
+     * <li>韩语      ko</li>
+     * </ul>
+     */
+    static get language(): string;
+    /**
+     * @private
+     */
+    static $isMobile: boolean;
+    /**
+     * 表示程序内容是否运行在移动设备中（例如移动电话或平板电脑）。
+     */
+    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
+     */
+    static $os: string;
+    /**
+     * @language zh_CN
+     * 指示当前的操作系统。os 属性返回下列字符串：
+     * <ul>
+     * <li>苹果手机操作系统     "iOS"</li>
+     * <li>安卓手机操作系统     "Android"</li>
+     * <li>微软手机操作系统     "Windows Phone"</li>
+     * <li>微软桌面操作系统     "Windows PC"</li>
+     * <li>苹果桌面操作系统     "Mac OS"</li>
+     * <li>未知操作系统        "Unknown"</li>
+     * </ul>
+     */
+    static get os(): string;
+}
+export default Capabilities;

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

@@ -0,0 +1,25 @@
+import { EventBase, LocalEvent } from '../event/event_base';
+export declare const enum FullScreenEventType {
+    FullScreenChange = 0,
+    FullScreenFailed = 1
+}
+export interface FullScreenEvent extends LocalEvent<FullScreenEventType> {
+    isFullScreen: boolean;
+    error: any;
+}
+/**
+ * 全屏显示
+ */
+export default class FullScreen extends EventBase<FullScreenEventType, FullScreenEvent> {
+    get isFullScreen(): boolean;
+    element: HTMLElement;
+    private _isFullScreen;
+    constructor();
+    startListening(): void;
+    stopListening(): void;
+    private fullscreenChange;
+    private fullscreenError;
+    launchFullScreen(): void;
+    exitFullscreen(): void;
+    private createEvent;
+}

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

@@ -0,0 +1,23 @@
+import { EventBase, LocalEvent } from '../event/event_base';
+export declare const enum LockPointerEventType {
+    LockPointChange = 0,
+    LockPointFailed = 1
+}
+export interface LockPointerEvent extends LocalEvent<LockPointerEventType> {
+    isLockPointer: boolean;
+    error: any;
+}
+export default class LockPointer extends EventBase<LockPointerEventType, LockPointerEvent> {
+    get isLockPointer(): boolean;
+    private _isLockPointer;
+    element: HTMLElement;
+    constructor(element: HTMLElement);
+    listenLockChange(): void;
+    removeListenLockChange(): void;
+    lockPointer(): void;
+    requestLockPointer(): void;
+    exitPointerLock(): void;
+    private pointerlockChange;
+    private lockscreenFailed;
+    private createEvent;
+}

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

@@ -0,0 +1,25 @@
+export declare class Level {
+    static INFO: string;
+    static WARN: string;
+    static ERR: string;
+    static TRACE: string;
+    static getLevelIndex(level: string): 0 | 2 | 1 | 3 | 4;
+}
+export interface LogObserver {
+    onLog(msg: string): void;
+}
+/**
+ *
+ */
+export default class Log {
+    static get logLevel(): string;
+    static set logLevel(level: string);
+    static _logLevel: string;
+    static info(...info: any[]): void;
+    static warn(...warn: any[]): void;
+    static err(...err: any[]): void;
+    static trace(...log: any[]): void;
+    static setObserver(ob: LogObserver): void;
+    private static _observer;
+    private static log;
+}

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

@@ -0,0 +1,26 @@
+export default class ScaleMode {
+    /**
+     * fit模式，完整的显示内容，如果太大就缩小至合适的大小
+     */
+    static FIT_SCREEN: string;
+    /**
+     * 以视频的宽高为基准缩放
+     */
+    static CONTAIN_VIDEO: string;
+    /**
+     * 以应用原始尺寸的缩放.
+     */
+    static CONTAIN_APP: string;
+    /**
+     * 裁剪模式，完全填充屏幕但保留宽高比
+     */
+    static FILL_CLIP: string;
+    /**
+     * 拉伸模式，完全填充屏幕但不保留宽高比
+     */
+    static FILL_STRETCH: string;
+    /**
+     * offset 控制条的高度
+     */
+    static OFFSET: number;
+}

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

@@ -0,0 +1,153 @@
+/**
+ * Unit 类 常用单元函数
+ */
+import { CSSPosition, Point, ViewPort, OffsetView, Vector } from '../common/interface';
+export default class Unit {
+    static queryString(name: string): string;
+    static queryURL(uri: URL, name: string): string;
+    /**
+     * 深度拷贝对象,创建新对象
+     * @param source 输入对象
+     */
+    static deepCopy(source: any): any;
+    static deepCopyArray<T>(source: T[]): T[];
+    /**
+     * 浏览器窗口大小相关
+     */
+    /**
+     * 获取浏览器窗口大小
+     * @returns { width: 窗口宽, height: 窗口高 }
+     */
+    static viewport(): ViewPort;
+    static getElementViewport(element: HTMLElement): ViewPort;
+    /**
+     * 获取某元素距离文档的距离
+     * @param element 元素对象
+     * @returns 高度
+     */
+    static elementTop(element: HTMLElement): number;
+    /**
+     * 获取元素距离文档左侧的距离
+     * @param element 元素对象
+     * @returns 左侧距离
+     */
+    static elementLeft(element: HTMLElement): number;
+    /**
+     * 获取元素相对文档位置
+     * @param element 元素对象
+     * @returns { offsetX:X, offsetY:Y }
+     */
+    static offsetViewport(element: HTMLElement): OffsetView;
+    static singlePointRelativePosition(e: Touch | MouseEvent, element: HTMLElement): Point;
+    /**
+     * 获取触摸点相对元素的坐标
+     * @param {e} e 触摸回调事件
+     * @param offset getOffsetViewport 获取的 offset 对象. {offsetX,offsetY}
+     * @return res[] 包含多指操作触摸点的数组
+     */
+    static touchRelativePosition(e: any, offset: OffsetView): Array<any>;
+    /**
+     * 计算两个点之间的距离
+     */
+    static pointsDistance(p1: Point, p2: Point): number;
+    /**
+     * 获取两点间的向量
+     * @p1 start point
+     * @p2 end point
+     */
+    static vector(p1: Point, p2: Point): Vector;
+    static vectorModule(v: Vector): number;
+    static vectorCosAngle(v1: Vector, v2: Vector): number;
+    static vectorDotProduct(v1: Vector, v2: Vector): number;
+    static vectorDet(v1: Vector, v2: Vector): number;
+    static midpointCoordinate(pointList: Point[]): Point;
+    /**
+     * 格式化输出时间
+     * @param t 输入时间，以秒计算
+     * @return 输出时间字符串 aa:bb:cc
+     */
+    static formatTimeString(t?: number): string;
+    /**
+     * 格式化输出时间
+     * @param t 输入时间，以分钟计算
+     * @return 输出时间字符串 aa:bb:cc
+     */
+    static formatMinTimeString(t?: number): string;
+    /**
+     * get sign
+     * -0 ===> -1
+     * +0 ===> +1
+     * 22 ===> +1
+     * -2 ===> -1
+     */
+    static sign(num: number): number;
+    /**
+     * cover css position to point
+     */
+    static coverPointToCssPosition(p: Point): CSSPosition;
+    /**
+     * cover point to css position
+     */
+    static coverCssPositionToPoint(p: CSSPosition): Point;
+    /**
+     * 获取浏览器窗口大小
+     * @returns { width: 窗口宽, height: 窗口高 }
+     */
+    static getViewport(): {
+        width: number;
+        height: number;
+    };
+    /**
+     * 获取某元素距离文档的距离
+     * @param element 元素对象
+     * @returns 高度
+     */
+    static getElementTop(element: HTMLElement): number;
+    /**
+     * 获取元素距离文档左侧的距离
+     * @param element 元素对象
+     * @returns 左侧距离
+     */
+    static getElementLeft(element: HTMLElement): number;
+    /**
+     * 获取元素相对文档位置
+     * @param element 元素对象
+     * @returns { offsetX:X, offsetY:Y }
+     */
+    static getOffsetViewport(element: HTMLElement): {
+        offsetX: number;
+        offsetY: number;
+    };
+    static getBoundingClientRect(element: HTMLElement): {
+        top: number;
+        left: number;
+        right: number;
+        bottom: number;
+    };
+    static getBoundingClientRectSize(element: HTMLElement): {
+        width: number;
+        height: number;
+    };
+    /**
+     * 获取鼠标相对元素的坐标
+     * @param {*} e 鼠标回调事件
+     * @param element dom 元素
+     */
+    static getMousePositon(e: MouseEvent, element: HTMLElement): {
+        x: number;
+        y: number;
+    };
+    /**
+     * 刷新当前页面
+     */
+    static fresh(): void;
+    static ab2str(buf: ArrayBuffer): string;
+    static strToU8Arraybuf(str: string): ArrayBuffer;
+    static bytesEqual(buf1: Uint8Array, buf2: Uint8Array): boolean;
+    /**
+     * 获取手机端相对像素
+     * ue图宽度 1340
+     */
+    static getMobliePixelWidth(px: number, mobilePixelUnit: number): number;
+    static IsIframe(): boolean;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "larksr_websdk",
-  "version": "3.2.310",
+  "version": "3.2.314",
   "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",
@@ -23,7 +23,7 @@
     "build": "webpack --config webpack.config.js",
     "build:typings": "tsc --build tsconfig.type.json",
     "copy-dts": "copyfiles -u 1 \"src/**/*.d.ts\" dist/types/",
-    "dist": "webpack --config webpack.config.js && copyfiles -u 1 \"src/**/*.d.ts\" ./types/ && copyfiles -u 1 \"doc/*\" dist/doc/ && copyfiles -u 1 \"types/*\" ./dist/types/"
+    "dist": "webpack --config webpack.config.js && copyfiles -u 1 \"src/**/*.d.ts\" ./types/ && copyfiles -u 1 \"doc/*\" dist/doc/ && copyfiles -u 1 \"types/**/*.d.ts\" ./dist/types/ && copyfiles -u 1 \"dist/*\" ./sample-plain-html/source/dist/"
   },
   "author": "fcx@pingxingyun.com",
   "license": "ISC",
@@ -62,9 +62,9 @@
     "typescript": "^4.4.3",
     "typescript-svelte-plugin": "^0.2.5",
     "url-loader": "^4.1.1",
+    "vconsole": "^3.12.1",
     "webpack": "^5.54.0",
     "webpack-cli": "^4.8.0",
-    "webpack-dev-server": "^4.3.0",
-    "vconsole": "^3.12.1"
+    "webpack-dev-server": "^4.3.0"
   }
 }

package/types/api.d.ts

@@ -33,6 +33,8 @@ export interface GetTaskResult {
     updateDate: string;
     useGamepad: number;
     wm: number;
+    textInputEventPrompt: number;
+    audioInput: number;
 }
 export interface StartAppInfo {
     appliId: string;
@@ -108,7 +110,7 @@ export default class API {
         appKey?: string;
         timestamp?: string;
         signature?: string;
-    }): Promise<StartAppInfo>;
+    } | any): Promise<StartAppInfo>;
     static CheckUTLockInfo(config: ILarkSRConfig): Promise<UTLockInfo>;
     static GetTask(config: ILarkSRConfig, taskid: string): Promise<GetTaskResult>;
     static LogError(errorCode: number, errorMsg: string, params: string, config: ILarkSRConfig): void;

package/types/appli_params.d.ts

@@ -190,6 +190,9 @@ export interface IAppliParams {
     toastLevel: number;
     appKey: string;
     groupId: string;
+    textInputEventPrompt: boolean;
+    audioInput: boolean;
+    audioInputAutoStart: boolean;
 }
 export declare enum AppliType {
     DESKTOP = 1,
@@ -249,6 +252,9 @@ export declare class AppliParams implements IAppliParams {
     toastLevel: number;
     appKey: string;
     groupId: string;
+    textInputEventPrompt: boolean;
+    audioInput: boolean;
+    audioInputAutoStart: boolean;
     static copyAndCreate(params?: IAppliParams): AppliParams;
     static setUpWithSDKConfig(params: IAppliParams, config: ILarkSRConfig): AppliParams;
 }

package/types/lark/application.d.ts

@@ -1,6 +1,7 @@
 import { EventBase, LocalEvent } from '../event/event_base';
 import * as Msg from '../protobuf/cloudlark';
 import WebSocektChannel from './websocket_channel';
+import { RTCMediaTrackBinding } from './peer_connection';
 import WebsocketProxy from './websocket_proxy';
 import { LarkSR } from '../larksr';
 import PixelStreamingWebsocketChannel from './test_pixel_streaming';
@@ -56,6 +57,8 @@ export default class Application extends EventBase<APP_EVENT_TYPE, AppEvent> {
     get state(): APP_STATE;
     set state(state: APP_STATE);
     private _state;
+    get audioDeviceId(): string | undefined;
+    get audioTrack(): MediaStreamTrack | undefined;
     private retryTime;
     private larksr;
     get voiceId(): number;
@@ -110,6 +113,41 @@ export default class Application extends EventBase<APP_EVENT_TYPE, AppEvent> {
     private onRtcError;
     private onIceStateChange;
     retryPeerconnection(): void;
+    setAudioEnable(enable: boolean): void | undefined;
+    setVideoEnable(enable: boolean): void | undefined;
+    setShareEnable(enable: boolean): void | undefined;
+    closeAudio(): boolean | undefined;
+    closeVideo(): boolean | undefined;
+    closeShare(): boolean | undefined;
+    openAudio(deviceId?: string): Promise<{
+        streams: MediaStream;
+        rtcRtpSenders: RTCMediaTrackBinding[];
+    } | undefined>;
+    openVideo(audio?: boolean, cameraId?: string): Promise<{
+        streams: MediaStream;
+        rtcRtpSenders: RTCMediaTrackBinding[];
+    } | undefined>;
+    openDefaultMedia(video?: boolean, audio?: boolean): Promise<void | undefined>;
+    openShareMediaDevice(): Promise<void | undefined>;
+    getConnectedAudioinputDevices(): Promise<MediaDeviceInfo[] | undefined>;
+    getConnectedAudioOutputDevices(): Promise<MediaDeviceInfo[] | undefined>;
+    getConnectedVideoinputDevices(): Promise<MediaDeviceInfo[] | undefined>;
+    getConnectedDevices(type: MediaDeviceKind): Promise<MediaDeviceInfo[] | undefined>;
+    openAudioDevice(deviceId: string, kind?: "audioinput" | "audiooutput"): Promise<{
+        streams: MediaStream;
+        rtcRtpSenders: RTCMediaTrackBinding[];
+    } | undefined>;
+    openCamera(cameraId: string, minWidth?: number, minHeight?: number): Promise<{
+        streams: MediaStream;
+        rtcRtpSenders: RTCMediaTrackBinding[];
+    } | undefined>;
+    openUserMeida(constraints?: MediaStreamConstraints): Promise<{
+        streams: MediaStream;
+        rtcRtpSenders: RTCMediaTrackBinding[];
+    } | undefined>;
+    addMediaTrack(track: MediaStreamTrack, ...streams: MediaStream[]): boolean | undefined;
+    removeMediaTrack(track: RTCRtpSender): boolean | undefined;
+    requestUserMediaPermission(constraints?: MediaStreamConstraints): Promise<MediaStream> | undefined;
     private onPeerConnectionDisconnect;
     private onBadNetwork;
     private onPixelStreamingPlayerList;

package/types/lark/lark_event_type.d.ts

@@ -71,6 +71,8 @@ export declare enum LarkEventType {
     LK_IFRAME_POSTER_OPERATE_GAMEPAD_BUTTON_UP = 10031,
     LK_IFRAME_POSTER_OPERATE_GAMEPAD_TRIGGER_VALUE = 10032,
     LK_IFRAME_POSTER_OPERATE_GAMEPAD_JOYSTICK_STATES = 10033,
+    LK_IFRAME_POSTER_OPENAUDIO_INPUT = 10040,
+    LK_IFRAME_POSTER_CLOSE_AUDIO_INPUT = 10041,
     LK_IFRAME_POSTER_FUNC_MOUSE_MODE = 10100,
     LK_IFRAME_POSTER_FUNC_SCALE_MODE = 10101,
     LK_IFRAME_POSTER_FUNC_RESTART_CLOUD_APP = 10102,

package/types/lark/message.d.ts

@@ -15,6 +15,6 @@ export default class Message {
     static getStartStreamResponseMsg(ressponse: Msg.CloudLark.StartStreamResponse.Response): string;
     static getCloudlarkTaskEvent(ressponse: Msg.CloudLark.TaskResponse.Response): LarkEventType;
     static getCloudlarkStartStreamEvent(ressponse: Msg.CloudLark.StartStreamResponse.Response): LarkEventType;
-    static getCloudlarkTaskEventMsg(type: LarkEventType): string;
+    static getCloudlarkTaskEventMsg(type: LarkEventType, reason?: string | null | undefined): string;
     static getCloudlarkStartStreamingEventMsg(type: LarkEventType): string;
 }

package/types/lark/peer_connection.d.ts

@@ -77,6 +77,11 @@ export interface AggregatedStats {
     currentRoundTripTime: number;
     packetsLostPerc: number;
 }
+export interface RTCMediaTrackBinding {
+    deviceId: string;
+    track: MediaStreamTrack;
+    sender: RTCRtpSender | undefined;
+}
 export default class PeerConnection extends EventBase<WEBRTC_EVENT_TYPE, WebRTCEvent> {
     private config;
     private pc;
@@ -91,10 +96,56 @@ export default class PeerConnection extends EventBase<WEBRTC_EVENT_TYPE, WebRTCE
     private larksr;
     private audioStream;
     private videoStream;
+    get audioDeviceId(): string | undefined;
+    get audioTrack(): MediaStreamTrack | undefined;
+    private localAudioTrackBinding;
+    private localVideoTrackBinding;
+    private localShareTrackBinding;
+    private sdpCreateSuccess;
     constructor(larksr: LarkSR, config: WebRTCConfig);
     create(): void;
     createOffer(): void;
     close(): void;
+    setAudioEnable(enable: boolean): void;
+    setVideoEnable(enable: boolean): void;
+    setShareEnable(enable: boolean): void;
+    closeAudio(): boolean;
+    closeVideo(): boolean;
+    closeShare(): boolean;
+    private stopLocalTrackBing;
+    openAudio(deviceId?: string): Promise<{
+        streams: MediaStream;
+        rtcRtpSenders: RTCMediaTrackBinding[];
+    }>;
+    openVideo(audio?: boolean, cameraId?: string): Promise<{
+        streams: MediaStream;
+        rtcRtpSenders: RTCMediaTrackBinding[];
+    }>;
+    openDefaultMedia(video?: boolean, audio?: boolean): Promise<void>;
+    openShareMediaDevice(): Promise<void>;
+    getConnectedAudioinputDevices(): Promise<MediaDeviceInfo[]>;
+    getConnectedAudioOutputDevices(): Promise<MediaDeviceInfo[]>;
+    getConnectedVideoinputDevices(): Promise<MediaDeviceInfo[]>;
+    getConnectedDevices(type: MediaDeviceKind): Promise<MediaDeviceInfo[]>;
+    openAudioDevice(deviceId: string, kind?: "audioinput" | "audiooutput"): Promise<{
+        streams: MediaStream;
+        rtcRtpSenders: RTCMediaTrackBinding[];
+    }>;
+    openCamera(cameraId: string, minWidth?: number, minHeight?: number): Promise<{
+        streams: MediaStream;
+        rtcRtpSenders: RTCMediaTrackBinding[];
+    }>;
+    openUserMeida(constraints?: MediaStreamConstraints): Promise<{
+        streams: MediaStream;
+        rtcRtpSenders: RTCMediaTrackBinding[];
+    }>;
+    addMediaTrack(track: MediaStreamTrack, ...streams: MediaStream[]): boolean;
+    removeMediaTrack(track: RTCRtpSender): boolean;
+    requestUserMediaPermission(constraints?: MediaStreamConstraints): Promise<MediaStream>;
+    /**
+     * 接收到sdp
+     * @param des sdp
+     */
     onRemoteDescription(des: RTCSessionDescriptionInit): void;
     onReceiveCandidate(candateInit: RTCIceCandidateInit): void;
     startNetTest(): void;