larksr_websdk 3.2.6 → 3.2.7

package/dist/types/api.d.ts

@@ -65,6 +65,7 @@ export interface StartAppInfo {
     playerMode?: number;
     userType?: number;
     roomCode?: string;
+    nickName?: string;
     nickname?: string;
 }
 export default class API {

package/dist/types/appli_params.d.ts

@@ -1,5 +1,6 @@
 import ScaleMode from './utils/scale_mode';
 import { StartAppInfo } from './api';
+import { ILarkSRConfig } from './larksr';
 export interface IAppliParams {
     /**
      * appserver 的ip地址
@@ -244,6 +245,8 @@ export declare class AppliParams implements IAppliParams {
     enableRttIcon: boolean;
     enableSoundRequire: boolean;
     toastLevel: number;
+    static copyAndCreate(params?: IAppliParams): AppliParams;
+    static setUpWithSDKConfig(params: IAppliParams, config: ILarkSRConfig): AppliParams;
 }
 export declare function CreateAppliParams(): IAppliParams;
 export declare class AppliParamsUtils {

package/dist/types/larksr.d.ts

@@ -278,6 +278,7 @@ export declare function CreateLarkSRClientFromeAPI(config: ILarkSRConfig, params
     userType?: number;
     roomCode?: string;
     taskId?: string;
+    nickname?: string;
 }): Promise<LarkSR>;
 /**
  * 通过从url参数中获取云端应用相关参数
@@ -289,7 +290,7 @@ declare class LarkSR extends EventBase<LarkSRClientEvent, LarkSREvent> {
     /**
      * 应用参数，构建时传入
      */
-    get params(): IAppliParams;
+    get params(): AppliParams;
     private _params;
     /**
      * 当前的玩家模式，
@@ -383,17 +384,36 @@ declare class LarkSR extends EventBase<LarkSRClientEvent, LarkSREvent> {
      * 注意，如果手动创建该类，要清楚参数的意义，一般只有调试等特殊情况才手动创建该类
      * @see CreateLarkSRClientFromeAPI, CreateLarkSRClientFromeUrl
      * @param config 本地配置，如果有 IAppliParams 相同的配置项，优先级最高
-     * @param params 云端应用参数等，通过后台接口或者url参数获取。
+     * @param params [可选参数] 云端应用参数等，通过后台接口或者url参数获取。
      */
-    constructor(config: ILarkSRConfig, params: IAppliParams);
+    constructor(config: ILarkSRConfig, params?: IAppliParams);
     /**
      *
      * @param id sdk id 初始化sdkid
      * @returns
      */
     initSDKAuthCode(id: string): Promise<void>;
+    /**
+     * 连接云端渲染资源
+     * @params appID 云端资源的 ID
+     * @returns Promise 调用接口并校验授权通过返回成功并自动开始连接
+     */
+    connect(params: {
+        appliId: string;
+        playerMode?: number;
+        userType?: number;
+        roomCode?: string;
+        taskId?: string;
+        nickname?: string;
+    }): Promise<void>;
+    /**
+     * 手动重设进入应用参数
+     * @param params
+     */
+    setAppliParams(params: IAppliParams): void;
     /**
      * 开始云渲染流程
+     * 启动时应用参数不能为空，包括 taskID，appServer，appPort
      * @returns 是否成功。主要校验授权码是否成功
      */
     start(): Promise<void>;
@@ -405,6 +425,10 @@ declare class LarkSR extends EventBase<LarkSRClientEvent, LarkSREvent> {
      * 重新启动云端应用
      */
     restartApp(): void;
+    /**
+     * 主动关闭连接
+     */
+    close(): void;
     /**
      * 切换当前操作者
      * @param uid 用户id

package/dist/types/screen_state.d.ts

@@ -104,5 +104,6 @@ export default class ScreenState extends EventBase<SCREEN_EVENT_TYPE, ScreenEven
     private bgColor;
     private handelRootElementSize;
     constructor(rootElement: HTMLElement, params: IAppliParams, handelRootElementSize?: boolean);
+    reset(params: IAppliParams): void;
     resize(): void;
 }

package/package.json

@@ -1,18 +1,21 @@
 {
   "name": "larksr_websdk",
-  "version": "3.2.6",
-  "description": "larksr websdk. http://www.pingxingyun.com",
+  "version": "3.2.7",
+  "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",
     "larksr",
     "cloudrendeing",
     "webrtc",
-    "cloudxr"
+    "cloudxr",
+    "pixelstreaming"
   ],
   "main": "./dist/larksr-web-sdk.min.js",
-  "types": "./dist/types/index.d.ts",
+  "types": "./types/index.d.ts",
   "files": [
-    "dist"
+    "dist",
+    "types",
+    "doc,"
   ],
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1",
@@ -20,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\" dist/types/ && copyfiles -u 1 \"doc/*\" dist/doc/"
+    "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/"
   },
   "author": "fcx@pingxingyun.com",
   "license": "ISC",

package/types/api.d.ts

@@ -0,0 +1,88 @@
+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;
+    appliType: number;
+    appliName: 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;
+    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/types/appli_params.d.ts

@@ -0,0 +1,263 @@
+import ScaleMode from './utils/scale_mode';
+import { StartAppInfo } from './api';
+import { ILarkSRConfig } from './larksr';
+export interface IAppliParams {
+    /**
+     * appserver 的ip地址
+     */
+    appServer: string;
+    /**
+     * appserver 的端口号
+     */
+    appPort: string;
+    /**
+     * appli type
+     */
+    appliType: number;
+    /**
+     * 是否使用 websocket 代理
+     */
+    wsProxy: boolean;
+    /**
+     * 优先使用的外网ip. 用在webrtc ice处替换为高优先级的ip
+     */
+    preferPubOutIp: string;
+    /**
+     * taskid
+     */
+    taskid: string;
+    /**
+     * 当前应用名称
+     */
+    appliName: string;
+    /**
+     * @deprecated
+     * 应用的宽高。现在云端自动获取宽高
+     */
+    width: number;
+    /**
+     * @deprecated
+     * 应用的宽高。现在云端自动获取宽高
+     */
+    height: number;
+    /**
+     * 缩放模式
+     */
+    scaleMode: ScaleMode;
+    /**
+     * 日志级别
+     * @default 'warn'
+     */
+    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 enum AppliType {
+    DESKTOP = 1,
+    SHARED = 2,
+    PIXEL_STREAMING = 13,
+    VR = 3,
+    VR_STEAM = 5,
+    NV_VR = 6,
+    XR = 7,
+    PXY_AR = 9,
+    NV_AR = 11
+}
+export declare class AppliParams implements IAppliParams {
+    appServer: string;
+    appPort: string;
+    appliType: AppliType;
+    wsProxy: boolean;
+    preferPubOutIp: string;
+    taskid: string;
+    appliName: 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;
+    static copyAndCreate(params?: IAppliParams): AppliParams;
+    static setUpWithSDKConfig(params: IAppliParams, config: ILarkSRConfig): AppliParams;
+}
+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/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/types/index.d.ts

@@ -0,0 +1,24 @@
+import 'core-js/stable/symbol';
+import { LarkSR, CreateLarkSRClientFromeAPI, CreateLarkSRClientFromeUrl, LarkEventType, LarkSRClientEvent, AppliParams, LoadAppliParamsFromUrl, AppliParamsUtils, LoadAppliParamsStartAppInfo, EventBase, API, Operation, Capabilities, ScaleMode, CloudLark, FullScreen, LockPointer, ILarkSRConfig, PlayerModeType, UserType, LarkSREvent } from "./larksr";
+declare const _default: {
+    LarkSR: typeof LarkSR;
+    CreateLarkSRClientFromeAPI: typeof CreateLarkSRClientFromeAPI;
+    CreateLarkSRClientFromeUrl: typeof CreateLarkSRClientFromeUrl;
+    API: typeof API;
+    AppliParams: typeof AppliParams;
+    LoadAppliParamsFromUrl: typeof LoadAppliParamsFromUrl;
+    AppliParamsUtils: typeof AppliParamsUtils;
+    LoadAppliParamsStartAppInfo: typeof LoadAppliParamsStartAppInfo;
+    EventBase: typeof EventBase;
+    ScaleMode: typeof ScaleMode;
+    Capabilities: typeof Capabilities;
+    CloudLark: typeof CloudLark;
+    FullScreen: typeof FullScreen;
+    LockPointer: typeof LockPointer;
+    Operation: typeof Operation;
+    LarkSRClientEvent: typeof LarkSRClientEvent;
+    LarkEventType: typeof LarkEventType;
+    KEYMAP: import("./operation/keymap").VritualKeyMapOptions;
+};
+export default _default;
+export { ILarkSRConfig, PlayerModeType, UserType, LarkSREvent, };