larksr_websdk 3.2.0

package/dist/larksr-web-sdk.min.worker.js

@@ -0,0 +1 @@
+!function(){"use strict";const e=self;var s=!1,t=0;e.addEventListener("message",(a=>{switch(a.data){case"start":s||(s=!0,t=setInterval((()=>{e.postMessage("tick")}),1e4));break;case"stop":clearInterval(t),s=!1}}),!1)}();

package/dist/types/api.d.ts

@@ -0,0 +1,85 @@
+import { ILarkSRConfig } from './larksr';
+import { AppliParams } from './appli_params';
+export interface UTLockInfo {
+    checkUtLockMessage: string;
+    checkUtLockResult: boolean;
+    remainMinutes: number;
+}
+export interface GetTaskResult {
+    adminViewer: number;
+    appKey: string;
+    appliId: string;
+    appliType: number;
+    city: string;
+    clientIp: string;
+    country: string;
+    createDate: string;
+    dcs: number;
+    limitMaxFps: number;
+    offScreen: number;
+    playerListToggle: number;
+    playerMode: number;
+    province: string;
+    publicIp: string;
+    reserveFlag: number;
+    serverId: string;
+    serverIp: string;
+    shareUrl: string;
+    startAt: string;
+    startParam: string;
+    startProcType: number;
+    status: number;
+    taskId: string;
+    updateDate: string;
+    useGamepad: number;
+    wm: number;
+}
+export interface StartAppInfo {
+    appliId: string;
+    taskId: string;
+    renderServerIp: string;
+    wsProxy: string;
+    preferPublicIp: string;
+    renderServerPort: number;
+    initCursorMode: number;
+    rttLimit: string;
+    touchOperateMode: string;
+    fullScreenMode: number;
+    mobileForceLandscape: number;
+    mobileFullScreenMode: number;
+    language: string;
+    noOperationTimeout: string;
+    serverId: string;
+    network: string;
+    playerListToggle: number;
+    bgColor: string;
+    logLevel: string;
+    mobileVirtualJoystick: number;
+    initWinSize: number;
+    taskStatus: number;
+    mouseZoomDirection: number;
+    useGamepad: number;
+    rttLimitInterval: string;
+    playerMode?: number;
+    userType?: number;
+    roomCode?: string;
+    nickname?: string;
+}
+export default class API {
+    static CheckUTLockInfoPath: string;
+    static GetTaskPATH: string;
+    static ClientLogErrorPath: string;
+    static GetStartInfoPath: string;
+    static GetStartInfo(serverAddress: string, params: {
+        appliId: string;
+        playerMode?: number;
+        userType?: number;
+        roomCode?: string;
+        taskId?: string;
+    }): 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;
+    static ClientInfo(config: ILarkSRConfig, params: AppliParams): void;
+    static joinParam(params: any): string;
+}

package/dist/types/appli_params.d.ts

@@ -0,0 +1,244 @@
+import ScaleMode from './utils/scale_mode';
+import { StartAppInfo } from './api';
+export interface IAppliParams {
+    /**
+     * appserver 的ip地址
+     */
+    appServer: string;
+    /**
+     * appserver 的端口号
+     */
+    appPort: string;
+    /**
+     * 是否使用 websocket 代理
+     */
+    wsProxy: boolean;
+    /**
+     * 优先使用的外网ip. 用在webrtc ice处替换为高优先级的ip
+     */
+    preferPubOutIp: string;
+    /**
+     * taskid
+     */
+    taskid: string;
+    /**
+     * 当前应用名称
+     */
+    courseName: string;
+    /**
+     * @deprecated
+     * 应用的宽高。现在云端自动获取宽高
+     */
+    width: number;
+    /**
+     * @deprecated
+     * 应用的宽高。现在云端自动获取宽高
+     */
+    height: number;
+    /**
+     * 缩放模式
+     */
+    scaleMode: ScaleMode;
+    /**
+     * 日志级别
+     * @default 'info'
+     */
+    logLevel: 'info' | 'warn' | 'error';
+    /**
+     * 无操作时间。超时断开连接.
+     */
+    noOperationTimeout: number;
+    /**
+     * 是否显示右下角的水印。
+     */
+    waterMark: boolean;
+    /**
+     * 检测的rtt值，rtt超过该值将提示用户网络环境差
+     */
+    rttLimit: number;
+    /**
+     * 检测的丢包率。丢包率超过该值提示用户网络环境差
+     */
+    packetLostLimit: number;
+    /**
+     * 丢包率和rtt提示的时间间隔。
+     */
+    rttLimitInterval: number;
+    /**
+     * 码率. 用在在创建 webrtc sdp时替换为此码率。
+     */
+    codeRate: number;
+    /**
+     * audio code rate
+     * https://stackoverflow.com/questions/33649283/how-to-set-up-sdp-for-high-quality-opus-audio
+     * a=fmtp:111 minptime=10;useinbandfec=1; stereo=1; maxaveragebitrate=510000
+     */
+    audioCodeRate: number;
+    /**
+     * 帧率，在登录task时传给后端。
+     */
+    frameRate: number;
+    /**
+     * 网络状态，影响 webrtc offer 创建时最低码率。
+     */
+    network: 'local' | 'public';
+    /**
+     * 使用的语言，目前只支持英语和中文。
+     */
+    language: string;
+    /**
+     * 初始的鼠标锁定模式
+     * false：非锁定模式
+     * true：锁定模式
+     */
+    initCursorMode: boolean;
+    /**
+     * 背景颜色
+     */
+    bgColor: string;
+    /**
+     * 全屏模式
+     *  0 -》 用户手动触发
+     *  1 -》 首次点击进入触发
+     *  2 -》 每次点击触发
+     */
+    fullScreenMode: number;
+    /**
+     * 手机端全屏模式
+     *  0 -》 用户手动触发
+     *  1 -》 首次点击进入触发
+     *  2 -》 每次点击触发
+     */
+    mobileFullScreenMode: number;
+    /**
+     * 一人操作多人看 0 普通模式 1 交互模式（可以一人操作多人看）
+     * 2 多人互动模式，鼠标键盘都放开
+     */
+    playerMode: number;
+    /**
+     * 用户类型 number
+     * 所有者:1  观察者:0;
+     */
+    userType: number;
+    /**
+     * 用户昵称
+     */
+    nickname: string;
+    /**
+     * 口令:8位唯一码,写入TaskInfo. 房间code，备用。
+     */
+    roomCode: number;
+    /**
+     * debug task. 跳过task检测
+     */
+    debugTask: boolean;
+    /**
+     * debug webserver
+     */
+    debugWebServer: string;
+    /**
+     * laoding timeout
+     * 5 * 60
+     */
+    loadingTimeout: number;
+    /**
+     * share url
+     */
+    shareUrl: boolean;
+    /**
+     * 是否强制横屏
+     */
+    mobileForceLandscape: boolean;
+    /**
+     * 移动端初始化初始化是否显示手柄
+     */
+    mobileVirtualJoystick: boolean;
+    /**
+     * mouseZoomDirection
+     * 用于移动端捏合缩放操作与应用鼠标缩放的对应关系
+     * 1:鼠标滚轮向上为放大，
+     * 0:鼠标滚轮向下为放大(default)
+     */
+    mouseZoomDirection: number;
+    /**
+     * 初始是否显示玩家列表
+     */
+    showPlayerList: boolean;
+    /**
+     * 优先使用的解码器
+     */
+    perferDecoder: 'auto' | 'vp8' | 'vp9' | 'h264' | 'av1x';
+    /**
+     * 触摸操作对应的操作方式，触摸屏还是鼠标
+     */
+    touchOperateMode: 'touchScreen' | 'mouse';
+    /**
+     * appid
+     */
+    appliId: string;
+    /**
+     *
+     */
+    syncLocalToCloudClipboard: boolean;
+    enableRttIcon: boolean;
+    enableSoundRequire: boolean;
+    toastLevel: number;
+}
+export declare class AppliParams implements IAppliParams {
+    appServer: string;
+    appPort: string;
+    wsProxy: boolean;
+    preferPubOutIp: string;
+    taskid: string;
+    courseName: string;
+    width: number;
+    height: number;
+    scaleMode: ScaleMode;
+    logLevel: 'info' | 'warn' | 'error';
+    noOperationTimeout: number;
+    waterMark: boolean;
+    rttLimit: number;
+    packetLostLimit: number;
+    rttLimitInterval: number;
+    codeRate: number;
+    audioCodeRate: number;
+    frameRate: number;
+    network: 'local' | 'public';
+    language: string;
+    initCursorMode: boolean;
+    bgColor: string;
+    fullScreenMode: number;
+    mobileFullScreenMode: number;
+    playerMode: number;
+    userType: number;
+    nickname: string;
+    roomCode: number;
+    debugTask: boolean;
+    debugWebServer: string;
+    loadingTimeout: number;
+    shareUrl: boolean;
+    mobileForceLandscape: boolean;
+    mobileVirtualJoystick: boolean;
+    mouseZoomDirection: number;
+    showPlayerList: boolean;
+    perferDecoder: 'auto' | 'vp8' | 'vp9' | 'h264' | 'av1x';
+    touchOperateMode: 'touchScreen' | 'mouse';
+    appliId: string;
+    syncLocalToCloudClipboard: boolean;
+    enableRttIcon: boolean;
+    enableSoundRequire: boolean;
+    toastLevel: number;
+}
+export declare function CreateAppliParams(): IAppliParams;
+export declare class AppliParamsUtils {
+    static getScaleMode(init: number | null | undefined): string;
+    static getNetwork(init: number | null | undefined): 'local' | 'public';
+    static getLogLevel(level: string | null | undefined): 'info' | 'warn';
+    static getBoolOption(option: string | null | undefined | boolean, emptyValue?: boolean): boolean;
+    static getNumberBoolOption(option: string | null | undefined | number, emptyValue?: boolean): boolean;
+    static getStringOption(option: string | null | undefined, emptyValue?: string): string;
+    static getIntOption(option: string | null | undefined, emptyValue?: number): number;
+    static getBgColor(option: string | null | undefined): string;
+}
+export declare function LoadAppliParamsFromUrl(): IAppliParams;
+export declare function LoadAppliParamsStartAppInfo(startAppInfo: StartAppInfo): IAppliParams;

package/dist/types/common/cmd.d.ts

@@ -0,0 +1,28 @@
+declare const enum CMD {
+    SESSIONKEY = 1,
+    APPSTART = 2,
+    VIDEO = 3,
+    MOUSE_DOWN = 4,
+    MOUSE_UP = 5,
+    MOUSE_MOVE = 6,
+    KEY_DOWN = 7,
+    KEY_UP = 8,
+    KEY_PRESS = 9,
+    CONNECT_APP_SERVER = 10,
+    APP_SERVER_CONNECTED = 11,
+    APP_SERVER_CONNECT_FAILED = 12,
+    CONNECT_ALREADY_EXIST = 13,
+    MOUSE_RIGHT = 14,
+    MOUSE_WHEELE = 15,
+    WEBRTC_GETICESERVER = 16,
+    WEBRTC_GET_REMOTE_ICECANDIDATE = 17,
+    WEBRTC_CALL = 18,
+    WEBRTC_ADD_ICECANDIDATE = 19,
+    WEBRTC_HANGUP = 20,
+    WEBRTC_GETDEVICELIST = 21,
+    REMOTE_APP_CLOSE = 22,
+    MOUSE_BUTTON = 23,
+    KEEP_ALIVE = 24,
+    REMOTE_APP_COUSOR_CHANGE = 25
+}
+export default CMD;

package/dist/types/common/constant.d.ts

@@ -0,0 +1,4 @@
+export declare const VIDEO_ID = "video";
+export declare const IMAGE_CURSOR_ID = "cursorid";
+export declare const EMPTY_PNG = "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAAAJcEhZcwAADsMAAA7DAcdvqGQAAAAZdEVYdFNvZnR3YXJlAFBhaW50Lk5FVCB2My41LjbQg61aAAAADUlEQVQYV2P4//8/IwAI/QL/+TZZdwAAAABJRU5ErkJggg==";
+export declare const TOKEN_EXPIRED = "TOKEN_EXPIRED";

package/dist/types/common/interface.d.ts

@@ -0,0 +1,30 @@
+export interface Point {
+    x: number;
+    y: number;
+}
+export interface Vector {
+    x: number;
+    y: number;
+    startPoint: Point;
+    endPoint: Point;
+}
+export interface Stage {
+    width: number;
+    height: number;
+    Position: Point;
+}
+export interface CSSPosition {
+    top: number;
+    left: number;
+}
+export interface ViewPort {
+    width: number;
+    height: number;
+}
+export interface Toggle {
+    show: boolean;
+}
+export interface OffsetView {
+    offsetX: number;
+    offsetY: number;
+}

package/dist/types/config.d.ts

@@ -0,0 +1,59 @@
+import ScaleModel from './utils/scale_mode';
+export default class Config {
+    static BuildType: 'local' | 'public';
+    static LocalHomepagePath: string;
+    /**
+     */
+    static VersionMarjor: number;
+    static VersionMinorr: number;
+    static VersionRevise: number;
+    static VersionBuild: number;
+    /**
+     * webrtc 断开连接重试次数
+     */
+    static RetryTime: number;
+    /**
+     * design width/height
+     * TODO reset with 0. check with render server.
+     */
+    static OriginW: number;
+    static OriginH: number;
+    /**
+     * 默认码率从应用服务器接收码率
+     */
+    static CodeRate: number;
+    static AudioCodeRate: number;
+    static FrameRate: number;
+    /**
+     * default scale mode. 以应用原始尺寸的缩放
+     */
+    static ScaleMode: ScaleModel;
+    /**
+     * default net work.
+     */
+    static Network: 'local' | 'public';
+    /**
+     * 鼠标模式
+     * 0 == 相对
+     * 1 == 绝对
+     */
+    static MouseMode: number;
+    /**
+     * replace server ip for aws
+     */
+    static ForceIceAddr: boolean;
+    /**
+     * 禁用 VPX
+     */
+    static DisableVPX: boolean;
+    /**
+     * 是否启用相对鼠标移动虚拟摇杆
+     */
+    static RelativeMouseMove: boolean;
+    /**
+     * 虚拟摇杆精度
+     */
+    static VirtualRackerScale: number;
+    static ErrChromeAndroidVersion: string[];
+    static DownloadChromium: string;
+}

package/dist/types/event/bus.d.ts

@@ -0,0 +1,8 @@
+import { EventBase, LocalEvent } from './event_base';
+import GLOBAL_EVENT_TYPE from './events';
+interface GlobalEvent extends LocalEvent<GLOBAL_EVENT_TYPE> {
+}
+declare class Global extends EventBase<GLOBAL_EVENT_TYPE, GlobalEvent> {
+}
+declare const Bus: Global;
+export default Bus;

package/dist/types/event/event_base.d.ts

@@ -0,0 +1,14 @@
+/**
+ * TODO
+ */
+export interface LocalEvent<E> {
+    type: E;
+    target?: any;
+}
+export declare type Callback<E> = (e: E, ...params: any[]) => void;
+export declare abstract class EventBase<T, E extends LocalEvent<T>> {
+    private listeners;
+    on(type: T, callback: Callback<E>, self?: any): void;
+    off(type: T, callback: Callback<E>, self?: any): void;
+    emit(event: E, ...params: any[]): void;
+}

package/dist/types/event/events.d.ts

@@ -0,0 +1,126 @@
+import { LocalEvent } from './event_base';
+export declare enum GLOBAL_EVENT_TYPE {
+    /**
+     * video 元素已挂载
+     */
+    MOUNTED = 1,
+    /**
+     * 打开 socket
+     */
+    SOCKET_OPEN = 2,
+    /**
+     * 消息窗口
+     */
+    ALERT = 3,
+    /**
+     * 获取远程视频流
+     */
+    GOT_REMOTE_STREAM = 4,
+    /**
+     * 视频流加载成功
+     */
+    LOADEDMETADATA = 5,
+    /**
+     * 重设config
+     */
+    RECONFIG = 6,
+    /**
+     * 开始点对点连接
+     */
+    STARTPC = 7,
+    /**
+     * 连接失败
+     */
+    PC_FAILED = 8,
+    /**
+     * 结束点对点连接
+     */
+    STOPPC = 9,
+    /**
+     * 结束点对点连接
+     */
+    RTSP_SUCCESS = 10,
+    /**
+     * 刷新连接
+     */
+    REFRESH = 11,
+    /**
+     * 开始计时
+     */
+    START_TIMER = 12,
+    /**
+     * 计时结束 结束应用
+     */
+    COURSE_OVER = 13,
+    /**
+     * 退出
+     */
+    QUIT = 14,
+    /**
+     * 虚拟按键按下事件
+     */
+    VIRTUAL_KEY_DOWN = 15,
+    /**
+     * 虚拟按键抬起
+     */
+    VIRTUAL_KEY_UP = 16,
+    /**
+     * 摇杆事件
+     */
+    JOY_STICK_MOUSE_MOVE = 17,
+    /**
+     * 虚拟鼠标移动
+     */
+    VIRTUAL_MOUSE_MOVE = 18,
+    /**
+     * 虚拟鼠标触摸点移动
+     */
+    VIRTUAL_MOUSE_POINTER = 19,
+    /**
+     *
+     */
+    VIRTUAL_MOUSE_DOWN = 20,
+    /**
+     *
+     */
+    VIRTUAL_MOUSE_UP = 21,
+    /**
+     * 虚拟滚轮滚动
+     */
+    VIRTUAL_MOUSE_WHEEL = 22,
+    /***
+     * pc鼠标事件转发
+     */
+    MOUSE_MOVE = 23,
+    MOUSE_WHEEL = 24,
+    MOUSE_DOWN = 25,
+    MOUSE_UP = 26,
+    /**
+     *  鼠标指针移动
+     */
+    CURSOR_MOVE = 27,
+    /**
+     *  鼠标变化
+     */
+    APP_CURSOR_CHANGE = 28,
+    FULL_SCREEN_CHANGE = 29,
+    REMOTE_SCREEN_READY = 30,
+    DISPATCH_CONTROLLER = 31,
+    LK_RE_CONNECT_DATA_CHANNEL = 32,
+    LK_CLOSE_DATA_CHANNEL = 33,
+    LK_DATA_CHANNEL_SEND_TEXT = 34,
+    LK_DATA_CHANNEL_SEND_BINARY = 35,
+    LK_DATA_CHANNEL_SEND_VIEW_PORT = 36,
+    LK_DATA_CHANNEL_SEND_CLIENT_INFO = 37,
+    LK_DATA_CHANNEL_RENDERSERVER_SEND_TEXT = 38,
+    LK_DATA_CHANNEL_RENDERSERVER_SEND_BINARY = 39,
+    INPUT_TEXT = 40,
+    SET_VOLUME = 41,
+    LK_IFRAME_POSTER_FUNC_RESTART_CLOUD_APP = 42,
+    LK_IFRAME_POSTER_FUNC_WX_JS_BRIDGE_READY = 43,
+    LK_REQUEST_CAPTURE_FRAME = 44,
+    LK_REQUEST_CAPTURE_FRAME_WITH_EXTRA_DATA = 45
+}
+export declare type GlobalEvent = LocalEvent<GLOBAL_EVENT_TYPE>;
+export declare function createGlobalEvent(type: GLOBAL_EVENT_TYPE, target?: any): GlobalEvent;
+export default GLOBAL_EVENT_TYPE;

package/dist/types/event/iframe_poster.d.ts

@@ -0,0 +1,9 @@
+import { LarkEventType } from '../lark/lark_event_type';
+import { LarkSR } from '../larksr';
+export declare const PREX = "pxymessage";
+export declare const LOG_ERROR_EVENT_TYPE: LarkEventType[];
+export default class IframeHandler {
+    larksr: LarkSR;
+    constructor(larksr: LarkSR);
+    listenParent(): void;
+}

package/dist/types/event/message.d.ts

@@ -0,0 +1,69 @@
+export declare class Msglevel {
+    static get INFO(): string;
+    static get WARING(): string;
+    static get ERROR(): string;
+}
+export declare class Msg {
+    /**
+     * peerconnection messages
+     */
+    static get CONNECT_WEBRTC(): string;
+    static get ICE_FAILED(): string;
+    static get ICE_SUCCESS(): string;
+    static get WEBRTC_HANGUP(): string;
+    /**
+     * app server messages
+     */
+    static get CONNECT_WS_ERR(): string;
+    static get CONNECT_WS_ERR_1(): string;
+    static get CONNECT_WS_CLOSE(): string;
+    static get APP_LOGIN_ERR_1(): string;
+    static get APP_LOGIN_ERR_2(): string;
+    static get CONNECT_APP_ERR(): string;
+    static get CONNECT_APP_ERR2(): string;
+    static get SIGNALING_APP_TIMEOUT(): string;
+    static get REMOTE_APP_FAILED(): string;
+    static get REMOTE_APP_CLOSE(): string;
+    /**
+     * control message
+     */
+    static get REFRESH(): string;
+    static get COURSE_OVER(): string;
+    static get COURSE_QUIT(): string;
+    /**
+     * 开启横屏
+     */
+    static get ORIENTATION(): string;
+    /**
+     * 请求相对鼠标模式
+     */
+    static get REQUEST_LOCK_MOUSE(): string;
+    /**
+     * 进入独占模式
+     */
+    static get LOCK_MOUSE(): string;
+    /**
+     * 输入参数错误
+     */
+    static get PARAM_ERROR(): string;
+    /**
+     *
+     */
+    static get LOAD_CONFIG_FAILED(): string;
+    /**
+     *
+     */
+    static get TOKEN_EXPIRED(): string;
+    /**
+     *  浏览器需要用户确认播放视频
+     */
+    static get REQUEST_PLAY_VIDEO(): string;
+    /**
+     * 无操作超时
+     */
+    static get NO_OPERATION_TIMEOUT(): string;
+    /**
+     * 超过载入时间
+     */
+    static get LK_LOADING_TIMEOUT(): string;
+}

package/dist/types/index.d.ts

@@ -0,0 +1 @@
+export { LarkSR, ILarkSRConfig, PlayerModeType, UserType, LarkSREvent, AppliParams, AppliParamsUtils, LoadAppliParamsStartAppInfo, EventBase, LocalEvent, API, Operation, Capabilities, ScaleMode, KEYMAP, CloudLark, FullScreen, LockPointer, } from "./larksr";

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

@@ -0,0 +1,3 @@
+declare const ctx: Worker;
+declare var fading: boolean;
+declare var interval: any;