larksr_websdk 3.2.323 → 3.2.324

package/dist/types/screen_state.d.ts

@@ -0,0 +1,116 @@
+import { ViewPort } from "./common/interface";
+import { IAppliParams } from "./appli_params";
+import { CloudLark } from "./protobuf/cloudlark";
+import ScaleMode from "./utils/scale_mode";
+import { LocalEvent, EventBase } from './event/event_base';
+import { LarkSR } from "./larksr";
+export interface ContainerSize {
+    marginTop: number;
+    marginLeft: number;
+    width: number;
+    height: number;
+}
+export interface ContainerStyle {
+    marginTop: string;
+    marginLeft: string;
+    width: string;
+    height: string;
+    cursor: any;
+}
+export declare type ScreenOrientation = 'portrait' | 'landscape';
+export declare enum CursorType {
+    ARROW = 0,
+    IBEAM = 1,
+    WAIT = 2,
+    CROSS = 3,
+    SIZENWSE = 4,
+    SIZENESW = 5,
+    SIZEWE = 6,
+    SIZENS = 7,
+    SIZEALL = 8,
+    NO = 9,
+    HAND = 10,
+    CUSTOM = 11,
+    DEFAULT = 1000
+}
+export interface SyncCursorStyle {
+    type: CursorType;
+    hotX: number;
+    hotY: number;
+    width: number;
+    height: number;
+    customBase64: string;
+}
+export declare const enum SCREEN_EVENT_TYPE {
+    ReSize = 0
+}
+export interface ScreenEvent extends LocalEvent<SCREEN_EVENT_TYPE> {
+    container: ContainerSize;
+    viewPort: ViewPort;
+}
+export default class ScreenState extends EventBase<SCREEN_EVENT_TYPE, ScreenEvent> {
+    get appSize(): CloudLark.IAppResize;
+    set appSize(size: CloudLark.IAppResize);
+    private _appSize;
+    get viewPort(): ViewPort;
+    private _viewPort;
+    get viewPortStyle(): string;
+    get orientationIndexStyle(): {
+        width: string;
+        height: string;
+        top: string;
+        left: string;
+        transform: string;
+        transformOrigin: string;
+        backgroundColor: string;
+    } | {
+        width: string;
+        height: string;
+        transform: string;
+        transformOrigin: string;
+        backgroundColor: string;
+        top?: undefined;
+        left?: undefined;
+    };
+    get container(): ContainerSize;
+    private _container;
+    get containerStyle(): string;
+    get screenOrientation(): ScreenOrientation;
+    private _screenOrientation;
+    get scaleMode(): ScaleMode;
+    set scaleMode(scaleMode: ScaleMode);
+    private _scaleMode;
+    get isFullScreen(): boolean;
+    private _isFullScreen;
+    get cursorStyle(): SyncCursorStyle;
+    set cursorStyle(style: SyncCursorStyle);
+    private _cursorStyle;
+    private get cursorCSSStyle();
+    get appMouseMode(): CloudLark.IAppMouseMode;
+    set appMouseMode(mode: CloudLark.IAppMouseMode);
+    private _appMouseMode;
+    get operateScale(): {
+        scaleX: number;
+        scaleY: number;
+    };
+    get initCursorMode(): boolean;
+    set initCursorMode(mode: boolean);
+    private _initCursorMode;
+    get isMobile(): boolean;
+    private _isMobile;
+    get isLocalRenderMouse(): boolean | null | undefined;
+    get isLockMosue(): boolean | null | undefined;
+    get rootElement(): HTMLElement;
+    private _rootElement;
+    private mobileForceLandScape;
+    private bgColor;
+    get handelRootElementSize(): boolean;
+    private _handelRootElementSize;
+    private larksr;
+    get baseElementScale(): number;
+    private _baseElementScale;
+    constructor(rootElement: HTMLElement, params: IAppliParams, larksr: LarkSR, handelRootElementSize?: boolean);
+    reset(params: IAppliParams): void;
+    setMobileForceLandScape(force: boolean): void;
+    resize(baseElementScale?: number): void;
+}

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,54 @@
+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;
+    static $isIOSSafari: boolean;
+    static get isIOSSafari(): boolean;
+}
+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/ios-inner-height.d.ts

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

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,142 @@
+/**
+ * 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[];
+    /**
+     * 浏览器窗口大小相关
+     */
+    static getElementViewport(element: HTMLElement, baseElementScale?: number): ViewPort;
+    /**
+     * 获取某元素距离文档的距离
+     * @param element 元素对象
+     * @returns 高度
+     */
+    static elementTop(element: HTMLElement): number;
+    /**
+     * 获取元素距离文档左侧的距离
+     * @param element 元素对象
+     * @returns 左侧距离
+     */
+    static elementLeft(element: HTMLElement): number;
+    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.323",
+  "version": "3.2.324",
   "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

@@ -38,6 +38,7 @@ export interface GetTaskResult {
     audioInputAutoStart: number;
     videoInput: number;
     videoInputAutoStart: number;
+    liveStreaming: number;
 }
 export interface StartAppInfo {
     appliId: string;
@@ -84,6 +85,8 @@ export default class API {
     private static TaskInfoClientStartedPath;
     private static PortMappingListPath;
     private static GetTouchCtrMappingPath;
+    private static GetAppliListPath;
+    private static RegionListPath;
     static HostAppliGetUrl(params: {
         appliId: string;
         playerMode?: number;
@@ -122,5 +125,7 @@ export default class API {
     static TaskInfoClientStarted(config: ILarkSRConfig, params: AppliParams): void;
     static PortMappingList(config: ILarkSRConfig): Promise<unknown>;
     static GetTouchCtrMapping(server: string, appliId?: string): Promise<unknown>;
+    static GetAppliList(server: string, params: any): Promise<unknown>;
+    static RegionList(server: string, params: any): Promise<unknown>;
     static joinParam(params: any): string;
 }

package/types/appli_params.d.ts

@@ -195,6 +195,7 @@ export interface IAppliParams {
     audioInputAutoStart: boolean;
     videoInput: boolean;
     videoInputAutoStart: boolean;
+    liveStreaming: boolean;
 }
 export declare enum AppliType {
     DESKTOP = 1,
@@ -259,6 +260,7 @@ export declare class AppliParams implements IAppliParams {
     audioInputAutoStart: boolean;
     videoInput: boolean;
     videoInputAutoStart: boolean;
+    liveStreaming: boolean;
     static copyAndCreate(params?: IAppliParams): AppliParams;
     static setUpWithSDKConfig(params: IAppliParams, config: ILarkSRConfig): AppliParams;
 }

package/types/lark/application.d.ts

@@ -43,7 +43,9 @@ export declare enum APP_EVENT_TYPE {
     AI_VOICE_STATUS = 18,
     AI_VOICE_ASR_RESULT = 19,
     AI_VOICE_DM_RESULT = 20,
-    AI_VOICE_ERROR = 21
+    AI_VOICE_ERROR = 21,
+    RTMP_STREAM_STATE = 22,
+    RTMP_STREAM_ERROR = 23
 }
 export interface AppEvent extends LocalEvent<APP_EVENT_TYPE> {
     data?: any;
@@ -114,6 +116,8 @@ export default class Application extends EventBase<APP_EVENT_TYPE, AppEvent> {
     private onAudioRemoteStream;
     private onRtcError;
     private onRtcInfo;
+    private onRtmpStreamingState;
+    private onRtmpStreamingError;
     private onIceStateChange;
     retryPeerconnection(): void;
     setAudioEnable(enable: boolean): void | undefined;
@@ -151,6 +155,8 @@ export default class Application extends EventBase<APP_EVENT_TYPE, AppEvent> {
     addMediaTrack(track: MediaStreamTrack, ...streams: MediaStream[]): boolean | undefined;
     removeMediaTrack(track: RTCRtpSender): boolean | undefined;
     requestUserMediaPermission(constraints?: MediaStreamConstraints): Promise<MediaStream> | undefined;
+    StartCloudLiveStreaming(params: Msg.CloudLark.IRtmp_Start): Promise<void> | undefined;
+    StopLiveStreaming(): void | undefined;
     private onPeerConnectionDisconnect;
     private onBadNetwork;
     private onPixelStreamingPlayerList;

package/types/lark/peer_connection.d.ts

@@ -30,7 +30,9 @@ export declare enum WEBRTC_EVENT_TYPE {
     AI_VOICE_ASR_RESULT = 19,
     AI_VOICE_DM_RESULT = 20,
     AI_VOICE_ERROR = 21,
-    INFO = 22
+    RTMP_STREAM_STATE = 22,
+    RTMP_STREAM_ERROR = 23,
+    INFO = 24
 }
 export interface GoogleBitRate {
     start: number;
@@ -157,6 +159,8 @@ export default class PeerConnection extends EventBase<WEBRTC_EVENT_TYPE, WebRTCE
     sendBuffer(buffer: ArrayBuffer): void;
     sendToAppTextMsg(msg: string): void;
     sendToAppBinaryMsg(binary: Uint8Array): void;
+    StartCloudLiveStreaming(params: Input.CloudLark.IRtmp_Start): Promise<void>;
+    StopLiveStreaming(): void;
     changeOperater(uid: number): void;
     inputText(txt: string): void;
     private getStats;

package/types/larksr.d.ts

@@ -185,7 +185,17 @@ declare enum LarkSRClientEvent {
      * 服务端 3.2.7.0 添加
      *
      */
-    TOUCH_CTR_MAPPING = "touchctrmapping"
+    TOUCH_CTR_MAPPING = "touchctrmapping",
+    /**
+     * 服务端 3.2.7.0 添加
+     * rtmp 直播推流状态
+     */
+    RTMP_STREAM_STATE = "rtmpstreamstate",
+    /**
+     * 服务端 3.2.7.0 添加
+     * rtmp 直播推流出错
+     */
+    RTMP_STREAM_ERROR = "rtmpstreamerror"
 }
 /**
  * LarkSR 发出的事件
@@ -908,6 +918,40 @@ 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;
+    /**
+     * 启动云端推流功能
+     * @param params {
+     *  // rtmp push url 必须填
+     *  path: "",
+     *  //rtmp push key
+     *  key: "",
+     *  // 推流的宽
+     *  width: 1280,
+     *  // 推流的高
+     *  height: 720,
+     *  framerate: 30,
+     *  // kbps
+     *  bitrate: 1024 * 2,
+     *  // 是否支持断线重连
+     *  reconnect: true,
+     *  //最大重连次数
+     *  reconnectRetries: 3,
+     *  //是否串流麦克风(语音输入支持的情况)
+     *  voice: audioInput,
+     * }
+     * @returns Promise
+     */
+    StartCloudLiveStreaming(params: CloudLark.IRtmp_Start): Promise<void> | undefined;
+    /**
+     * 关闭云端推流功能
+     * @returns
+     */
+    StopLiveStreaming(): void | undefined;
+    /**
+     * 获取当前服务器应用手柄配置
+     * @param appliId 应用id，传空为当前应用
+     * @returns
+     */
     getTouchCtrMapping(appliId?: string): Promise<unknown>;
     $emit(type: LarkEventType, data?: any, message?: string): void;
     $emitError(message?: string, code?: number): void;