larksr_websdk 3.2.5 → 3.2.9

package/dist/types/api.d.ts

@@ -36,6 +36,8 @@ export interface GetTaskResult {
 }
 export interface StartAppInfo {
     appliId: string;
+    appliType: number;
+    appliName: string;
     taskId: string;
     renderServerIp: string;
     wsProxy: string;
@@ -63,6 +65,7 @@ export interface StartAppInfo {
     playerMode?: number;
     userType?: number;
     roomCode?: string;
+    nickName?: string;
     nickname?: string;
 }
 export default class API {
@@ -70,12 +73,32 @@ export default class API {
     static GetTaskPATH: string;
     static ClientLogErrorPath: string;
     static GetStartInfoPath: string;
+    private static PocHostApplGetUrl;
+    static HostAppliGetUrl(params: {
+        appliId: string;
+        playerMode?: number;
+        userType?: number;
+        roomCode?: string;
+        taskId?: string;
+    }): Promise<{
+        host: string;
+        origin: string;
+        params: {
+            appliId: string;
+            appKey: string;
+            timestamp: string;
+            signature: string;
+        };
+    }>;
     static GetStartInfo(serverAddress: string, params: {
         appliId: string;
         playerMode?: number;
         userType?: number;
         roomCode?: string;
         taskId?: string;
+        appKey?: string;
+        timestamp?: string;
+        signature?: string;
     }): Promise<StartAppInfo>;
     static CheckUTLockInfo(config: ILarkSRConfig): Promise<UTLockInfo>;
     static GetTask(config: ILarkSRConfig, taskid: string): Promise<GetTaskResult>;

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地址
@@ -9,6 +10,10 @@ export interface IAppliParams {
      * appserver 的端口号
      */
     appPort: string;
+    /**
+     * appli type
+     */
+    appliType: number;
     /**
      * 是否使用 websocket 代理
      */
@@ -24,7 +29,7 @@ export interface IAppliParams {
     /**
      * 当前应用名称
      */
-    courseName: string;
+    appliName: string;
     /**
      * @deprecated
      * 应用的宽高。现在云端自动获取宽高
@@ -184,13 +189,25 @@ export interface IAppliParams {
     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;
-    courseName: string;
+    appliName: string;
     width: number;
     height: number;
     scaleMode: ScaleMode;
@@ -228,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/index.d.ts

@@ -1,7 +1,8 @@
 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";
+import { LarkSR, CreateLarkSRClientFromePXYHost, 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;
+    CreateLarkSRClientFromePXYHost: typeof CreateLarkSRClientFromePXYHost;
     CreateLarkSRClientFromeAPI: typeof CreateLarkSRClientFromeAPI;
     CreateLarkSRClientFromeUrl: typeof CreateLarkSRClientFromeUrl;
     API: typeof API;

package/dist/types/larksr.d.ts

@@ -69,7 +69,11 @@ declare enum LarkSRClientEvent {
     /**
      * 获取到远端视频流 .
      */
-    GOT_REMOTE_STREAM = "gotremotesteam",
+    GOT_REMOTE_STREAM = "gotremotestream",
+    /**
+     * 获取到远端音频流 .
+     */
+    GOT_REMOTE_AUDIO_STREAM = "gotremoteaudiostream",
     /**
      * 视频加载成功，等待播放 .
      */
@@ -173,10 +177,12 @@ interface ILarkSRConfig {
      */
     rootElement: HTMLElement;
     /**
-     * 必选项 服务器地址. LarkServer 前台访问的地址
+     * 可选项 服务器地址. LarkServer 前台访问的地址
      * 如： http://192.168.0.55:8181/
+     * 当使用托管服务时服务器地址自动分配,可留空。
+     * 使用托管服务时@see CreateLarkSRClientFromePXYHost @see larksr.connectWithPxyHost
      */
-    serverAddress: string;
+    serverAddress?: string;
     /**
      * 可选项。 sdk 授权码。如果不在此处填，则必须在后续的实例里调用 initSDKAuthCode 初始化。
      */
@@ -261,7 +267,25 @@ interface ILarkSRConfig {
      * 可选项，手机端是否强制横屏
      */
     mobileForceLandscape?: boolean;
+    /**
+     * 初始化鼠标模式, true 锁定，false 非锁定
+     */
+    initCursorMode?: boolean;
 }
+/**
+ * 通过平行云托管平台创建客户端并启动应用
+ * @param config 传入 config @see ILarkSRConfig
+ * @param params 进入应用接口参数。appliId 为必填项
+ * @returns Promise 创建 larksr client 是否成功
+ */
+export declare function CreateLarkSRClientFromePXYHost(config: ILarkSRConfig, params: {
+    appliId: string;
+    playerMode?: number;
+    userType?: number;
+    roomCode?: string;
+    taskId?: string;
+    nickname?: string;
+}): Promise<LarkSR>;
 /**
  * 通过调用后台接口获取云端应用参数
  * @param config 传入 config @see ILarkSRConfig
@@ -274,6 +298,7 @@ export declare function CreateLarkSRClientFromeAPI(config: ILarkSRConfig, params
     userType?: number;
     roomCode?: string;
     taskId?: string;
+    nickname?: string;
 }): Promise<LarkSR>;
 /**
  * 通过从url参数中获取云端应用相关参数
@@ -285,7 +310,7 @@ declare class LarkSR extends EventBase<LarkSRClientEvent, LarkSREvent> {
     /**
      * 应用参数，构建时传入
      */
-    get params(): IAppliParams;
+    get params(): AppliParams;
     private _params;
     /**
      * 当前的玩家模式，
@@ -304,6 +329,7 @@ declare class LarkSR extends EventBase<LarkSRClientEvent, LarkSREvent> {
      * 当前是否是交互模式，交互默认即可以操作的模式
      */
     get isInteractiveMode(): boolean;
+    get isPixelStreaming(): boolean;
     /**
      * 当前 app 的状态
      */
@@ -328,6 +354,10 @@ declare class LarkSR extends EventBase<LarkSRClientEvent, LarkSREvent> {
      */
     get op(): Operation;
     private _op;
+    /**
+     * 像素流送输入控制
+     */
+    private pixelInput;
     private iframeHandler;
     get fullScreen(): FullScreen;
     private _fullScreen;
@@ -337,36 +367,90 @@ declare class LarkSR extends EventBase<LarkSRClientEvent, LarkSREvent> {
     /**
      * 视频元素
      */
-    get videoElement(): any;
+    get videoElement(): HTMLVideoElement;
     /**
      * 视频显示组件
      */
     get videoComponent(): any;
+    /**
+     * 音频元素
+     */
+    get audioElement(): HTMLAudioElement;
+    /**
+     * 是否有单独的音频流
+     */
+    get isSeprateAudioTrack(): any;
+    /**
+     * 视频显示组件的父容器
+     */
+    get containerElement(): any;
+    /**
+     *
+     */
+    get viewportElement(): any;
     get rootElement(): HTMLElement;
     private _rootElement;
     get serverAddress(): string;
-    private _serverAddress;
     get serverIp(): string;
     get config(): ILarkSRConfig;
     private _config;
     private loadingTimeout;
     private sdkAuth;
+    /**
+     * 后台分配的用户id
+     */
+    get uid(): number;
+    private _uid;
+    /**
+     * @returns 是否是 Task的拥有者
+     */
+    isTaskOwner(): boolean;
+    _isTaskOwner: boolean;
     /**
      * LarkSR 客户端。所有操作和事件通过该类传递
      * 注意，如果手动创建该类，要清楚参数的意义，一般只有调试等特殊情况才手动创建该类
      * @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>;
+    connectWithPxyHost(params: {
+        appliId: string;
+        playerMode?: number;
+        userType?: number;
+        roomCode?: string;
+        taskId?: string;
+    }): Promise<void>;
+    /**
+     * 连接云端渲染资源
+     * @params appID 云端资源的 ID
+     * @returns Promise 调用接口并校验授权通过返回成功并自动开始连接
+     */
+    connect(params: {
+        appliId: string;
+        playerMode?: number;
+        userType?: number;
+        roomCode?: string;
+        taskId?: string;
+        nickname?: string;
+        appKey?: string;
+        timestamp?: string;
+        signature?: string;
+    }): Promise<void>;
+    /**
+     * 手动重设进入应用参数
+     * @param params
+     */
+    setAppliParams(params: IAppliParams): void;
     /**
      * 开始云渲染流程
+     * 启动时应用参数不能为空，包括 taskID，appServer，appPort
      * @returns 是否成功。主要校验授权码是否成功
      */
     start(): Promise<void>;
@@ -378,6 +462,10 @@ declare class LarkSR extends EventBase<LarkSRClientEvent, LarkSREvent> {
      * 重新启动云端应用
      */
     restartApp(): void;
+    /**
+     * 主动关闭连接
+     */
+    close(): void;
     /**
      * 切换当前操作者
      * @param uid 用户id
@@ -439,10 +527,12 @@ declare class LarkSR extends EventBase<LarkSRClientEvent, LarkSREvent> {
     $emitError(message?: string, code?: number): void;
     $emitInfo(message?: string, code?: number): void;
     private createEvent;
+    private setupListener;
     private taskProcess;
     private startProcess;
     private onAppStateChange;
     private onGotRemoteStream;
+    private onGotRemoteAudioStream;
     private onCursorStyle;
     private onAppResize;
     private onAppMouseMode;

package/dist/types/screen_state.d.ts

@@ -3,6 +3,7 @@ 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;
@@ -83,7 +84,9 @@ export default class ScreenState extends EventBase<SCREEN_EVENT_TYPE, ScreenEven
     get isLockMouse(): boolean;
     private _isLockMouse;
     get cursorStyle(): SyncCursorStyle;
+    set cursorStyle(style: SyncCursorStyle);
     private _cursorStyle;
+    private get cursorCSSStyle();
     get appMouseMode(): CloudLark.IAppMouseMode;
     set appMouseMode(mode: CloudLark.IAppMouseMode);
     private _appMouseMode;
@@ -103,6 +106,8 @@ export default class ScreenState extends EventBase<SCREEN_EVENT_TYPE, ScreenEven
     private mobileForceLandScape;
     private bgColor;
     private handelRootElementSize;
-    constructor(rootElement: HTMLElement, params: IAppliParams, handelRootElementSize?: boolean);
+    private larksr;
+    constructor(rootElement: HTMLElement, params: IAppliParams, larksr: LarkSR, handelRootElementSize?: boolean);
+    reset(params: IAppliParams): void;
     resize(): void;
 }

package/package.json

@@ -1,18 +1,21 @@
 {
   "name": "larksr_websdk",
-  "version": "3.2.5",
-  "description": "larksr websdk. http://www.pingxingyun.com",
+  "version": "3.2.9",
+  "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,108 @@
+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;
+    private static PocHostApplGetUrl;
+    static HostAppliGetUrl(params: {
+        appliId: string;
+        playerMode?: number;
+        userType?: number;
+        roomCode?: string;
+        taskId?: string;
+    }): Promise<{
+        host: string;
+        origin: string;
+        params: {
+            appliId: string;
+            appKey: string;
+            timestamp: string;
+            signature: string;
+        };
+    }>;
+    static GetStartInfo(serverAddress: string, params: {
+        appliId: string;
+        playerMode?: number;
+        userType?: number;
+        roomCode?: string;
+        taskId?: string;
+        appKey?: string;
+        timestamp?: string;
+        signature?: 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;
+}