larksr_websdk 3.2.7 → 3.2.11

package/dist/types/api.d.ts

@@ -67,18 +67,44 @@ export interface StartAppInfo {
     roomCode?: string;
     nickName?: string;
     nickname?: string;
+    appKey?: string;
+    groupId?: 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;
+        clientMac?: string;
+        groupId?: string;
+        regionId?: string;
+        targetServerIp?: 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

@@ -188,6 +188,8 @@ export interface IAppliParams {
     enableRttIcon: boolean;
     enableSoundRequire: boolean;
     toastLevel: number;
+    appKey: string;
+    groupId: string;
 }
 export declare enum AppliType {
     DESKTOP = 1,
@@ -245,6 +247,8 @@ export declare class AppliParams implements IAppliParams {
     enableRttIcon: boolean;
     enableSoundRequire: boolean;
     toastLevel: number;
+    appKey: string;
+    groupId: string;
     static copyAndCreate(params?: IAppliParams): AppliParams;
     static setUpWithSDKConfig(params: IAppliParams, config: ILarkSRConfig): AppliParams;
 }

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

@@ -15,7 +15,7 @@ import FullScreen from './utils/full_screen';
 import LockPointer from './utils/lock_pointer';
 import ScaleMode from './utils/scale_mode';
 import Capabilities from './utils/capabilities';
-declare const enum PlayerModeType {
+declare enum PlayerModeType {
     /**
      * 普通模式
      */
@@ -32,7 +32,7 @@ declare const enum PlayerModeType {
 /**
  * 当前用户的身份
  */
-declare const enum UserType {
+declare enum UserType {
     /**
      * 观看者
      */
@@ -69,7 +69,11 @@ declare enum LarkSRClientEvent {
     /**
      * 获取到远端视频流 .
      */
-    GOT_REMOTE_STREAM = "gotremotesteam",
+    GOT_REMOTE_STREAM = "gotremotestream",
+    /**
+     * 获取到远端音频流 .
+     */
+    GOT_REMOTE_AUDIO_STREAM = "gotremoteaudiostream",
     /**
      * 视频加载成功，等待播放 .
      */
@@ -160,6 +164,9 @@ interface LarkSREvent extends LocalEvent<LarkSRClientEvent> {
     code?: number;
     larkevent?: LarkEventType;
 }
+declare type PublicPortMapping = {
+    [key: string]: string;
+};
 /**
  * 构造 LarkSR 参数
  */
@@ -173,10 +180,12 @@ interface ILarkSRConfig {
      */
     rootElement: HTMLElement;
     /**
-     * 必选项 服务器地址. LarkServer 前台访问的地址
+     * 可选项 服务器地址. LarkServer 前台访问的地址
      * 如： http://192.168.0.55:8181/
+     * 当使用托管服务时服务器地址自动分配,可留空。
+     * 使用托管服务时@see CreateLarkSRClientFromePXYHost @see larksr.connectWithPxyHost
      */
-    serverAddress: string;
+    serverAddress?: string;
     /**
      * 可选项。 sdk 授权码。如果不在此处填，则必须在后续的实例里调用 initSDKAuthCode 初始化。
      */
@@ -265,7 +274,34 @@ interface ILarkSRConfig {
      * 初始化鼠标模式, true 锁定，false 非锁定
      */
     initCursorMode?: boolean;
+    /**
+     * 渲染服务器外网端口映射
+     * 格式为  key=[渲染服务器IP:PORT] value=[外网IP:PORT]
+     * {
+     *    "RENDER-A-IP:RENDER-A-PORT1": "PUBLIC-A-IP:PORT1",
+     *    "RENDER-B-IP:RENDER-B-PORT1": "PUBLIC-A-IP:PORT2",
+     *    "RENDER-C-IP:RENDER-C-PORT1": "PUBLIC-A-IP:PORT3",
+     *    "RENDER-D-IP:RENDER-D-PORT1": "PUBLIC-B-IP:PORT1",
+     *    "RENDER-E-IP:RENDER-E-PORT1": "PUBLIC-B-IP:PORT2",
+     *    "RENDER-E-IP:RENDER-E-PORT2": "PUBLIC-C-IP:PORT1",
+     * }
+     */
+    publicPortMapping?: PublicPortMapping;
 }
+/**
+ * 通过平行云托管平台创建客户端并启动应用
+ * @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
@@ -278,7 +314,13 @@ export declare function CreateLarkSRClientFromeAPI(config: ILarkSRConfig, params
     userType?: number;
     roomCode?: string;
     taskId?: string;
-    nickname?: string;
+    clientMac?: string;
+    groupId?: string;
+    regionId?: string;
+    targetServerIp?: string;
+    appKey?: string;
+    timestamp?: string;
+    signature?: string;
 }): Promise<LarkSR>;
 /**
  * 通过从url参数中获取云端应用相关参数
@@ -352,6 +394,14 @@ declare class LarkSR extends EventBase<LarkSRClientEvent, LarkSREvent> {
      * 视频显示组件
      */
     get videoComponent(): any;
+    /**
+     * 音频元素
+     */
+    get audioElement(): HTMLAudioElement;
+    /**
+     * 是否有单独的音频流
+     */
+    get isSeprateAudioTrack(): any;
     /**
      * 视频显示组件的父容器
      */
@@ -363,7 +413,6 @@ declare class LarkSR extends EventBase<LarkSRClientEvent, LarkSREvent> {
     get rootElement(): HTMLElement;
     private _rootElement;
     get serverAddress(): string;
-    private _serverAddress;
     get serverIp(): string;
     get config(): ILarkSRConfig;
     private _config;
@@ -393,6 +442,13 @@ declare class LarkSR extends EventBase<LarkSRClientEvent, LarkSREvent> {
      * @returns
      */
     initSDKAuthCode(id: string): Promise<void>;
+    connectWithPxyHost(params: {
+        appliId: string;
+        playerMode?: number;
+        userType?: number;
+        roomCode?: string;
+        taskId?: string;
+    }): Promise<void>;
     /**
      * 连接云端渲染资源
      * @params appID 云端资源的 ID
@@ -404,8 +460,18 @@ declare class LarkSR extends EventBase<LarkSRClientEvent, LarkSREvent> {
         userType?: number;
         roomCode?: string;
         taskId?: string;
-        nickname?: string;
+        clientMac?: string;
+        groupId?: string;
+        regionId?: string;
+        targetServerIp?: string;
+        appKey?: string;
+        timestamp?: string;
+        signature?: string;
     }): Promise<void>;
+    /**
+     * 用户手动填昵称，需要在 start 或 connect 设置才能生效。
+     */
+    setNickname(nickname: string): void;
     /**
      * 手动重设进入应用参数
      * @param params
@@ -465,6 +531,7 @@ declare class LarkSR extends EventBase<LarkSRClientEvent, LarkSREvent> {
      * 可以不使用该方法退出页面
      */
     quit(): void;
+    resetAppMouseLockState(): void;
     /**
      * 操作相关事件
      * 所有事件坐标相对于云端应用，不相对于网页
@@ -490,10 +557,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,7 +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,6 +1,6 @@
 {
   "name": "larksr_websdk",
-  "version": "3.2.7",
+  "version": "3.2.11",
   "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

@@ -67,18 +67,44 @@ export interface StartAppInfo {
     roomCode?: string;
     nickName?: string;
     nickname?: string;
+    appKey?: string;
+    groupId?: 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;
+        clientMac?: string;
+        groupId?: string;
+        regionId?: string;
+        targetServerIp?: string;
+        appKey?: string;
+        timestamp?: string;
+        signature?: string;
     }): Promise<StartAppInfo>;
     static CheckUTLockInfo(config: ILarkSRConfig): Promise<UTLockInfo>;
     static GetTask(config: ILarkSRConfig, taskid: string): Promise<GetTaskResult>;

package/types/appli_params.d.ts

@@ -188,6 +188,8 @@ export interface IAppliParams {
     enableRttIcon: boolean;
     enableSoundRequire: boolean;
     toastLevel: number;
+    appKey: string;
+    groupId: string;
 }
 export declare enum AppliType {
     DESKTOP = 1,
@@ -245,6 +247,8 @@ export declare class AppliParams implements IAppliParams {
     enableRttIcon: boolean;
     enableSoundRequire: boolean;
     toastLevel: number;
+    appKey: string;
+    groupId: string;
     static copyAndCreate(params?: IAppliParams): AppliParams;
     static setUpWithSDKConfig(params: IAppliParams, config: ILarkSRConfig): AppliParams;
 }

package/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/types/lark/application.d.ts

@@ -26,17 +26,18 @@ export declare enum APP_EVENT_TYPE {
     INFO = 3,
     APP_CLOSE = 4,
     REMOTE_STREAM = 5,
-    SYNC_CURSORSTYLE = 6,
-    APP_STATE_CHANGE = 7,
-    NET_STATE = 8,
-    LK_APP_RESIZE = 9,
-    LK_APP_MOUSE_MODE = 10,
-    LK_APP_PLAER_LIST = 11,
-    LK_APP_REQUEST_TEXT = 12,
-    LK_DATA_CHANNEL_RENDERSERVER_TEXT_MESSAGE = 13,
-    LK_DATA_CHANNEL_RENDERSERVER_BINARY_MESSAGE = 14,
-    LK_DATA_CHANNEL_RENDERSERVER_OPEN = 15,
-    LK_DATA_CHANNEL_RENDERSERVER_CLOSE = 16
+    REMOTE_AUDIO_STREAM = 6,
+    SYNC_CURSORSTYLE = 7,
+    APP_STATE_CHANGE = 8,
+    NET_STATE = 9,
+    LK_APP_RESIZE = 10,
+    LK_APP_MOUSE_MODE = 11,
+    LK_APP_PLAER_LIST = 12,
+    LK_APP_REQUEST_TEXT = 13,
+    LK_DATA_CHANNEL_RENDERSERVER_TEXT_MESSAGE = 14,
+    LK_DATA_CHANNEL_RENDERSERVER_BINARY_MESSAGE = 15,
+    LK_DATA_CHANNEL_RENDERSERVER_OPEN = 16,
+    LK_DATA_CHANNEL_RENDERSERVER_CLOSE = 17
 }
 export interface AppEvent extends LocalEvent<APP_EVENT_TYPE> {
     data?: any;
@@ -76,6 +77,8 @@ export default class Application extends EventBase<APP_EVENT_TYPE, AppEvent> {
     setIce(sdpMlineindex: number, sdpmid: string, candidate: string): void;
     sendInput(input: Msg.CloudLark.ClientInput): void;
     sendInputBuffer(buffer: ArrayBuffer): void;
+    private sendToWebsocektChannelBuffer;
+    private sendToWebsocektChannelMsg;
     private onChannelOpen;
     private onClose;
     private onChannelMsg;
@@ -91,11 +94,15 @@ export default class Application extends EventBase<APP_EVENT_TYPE, AppEvent> {
     private onLocalSdp;
     private onLoacalIce;
     private onRemoteStream;
+    private onAudioRemoteStream;
     private onRtcError;
     private onIceStateChange;
     retryPeerconnection(): void;
     private onPeerConnectionDisconnect;
     private onBadNetwork;
+    private onPixelStreamingPlayerList;
+    private onPixelStreamingDataChannelState;
+    private onPixelStreamingDataChannelData;
     private onCursorStyle;
     private onAppResize;
     private onAppMouseMode;

package/types/lark/ice_candiadate_parser.d.ts

@@ -0,0 +1,24 @@
+export default class IceCandidateParser {
+    sdpMLineIndex: number | null;
+    sdpMid: string | null;
+    usernameFragment: string | null;
+    header: string;
+    private props;
+    constructor(ice: RTCIceCandidateInit);
+    get foundation(): string;
+    set foundation(f: string);
+    get component(): string;
+    set component(f: string);
+    get protocol(): string;
+    set protocol(p: string);
+    get priority(): string;
+    set priority(p: string);
+    get ip(): string;
+    set ip(ip: string);
+    get port(): string;
+    set port(port: string);
+    get type(): string;
+    get candidate(): string;
+    genNewIceCandidateInit(): RTCIceCandidateInit;
+    genNewIceCandidate(): RTCIceCandidate;
+}

package/types/lark/peer_connection.d.ts

@@ -9,22 +9,23 @@ export declare enum IceState {
 }
 export declare enum WEBRTC_EVENT_TYPE {
     GOT_REMOTE_STREAM = 0,
-    ICE_STATE_CHANGE = 1,
-    LK_APP_RESIZE = 2,
-    LK_APP_MOUSE_MODE = 3,
-    LK_APP_PLAER_LIST = 4,
-    LK_APP_REQUEST_TEXT = 5,
-    LK_DATA_CHANNEL_RENDERSERVER_TEXT_MESSAGE = 6,
-    LK_DATA_CHANNEL_RENDERSERVER_BINARY_MESSAGE = 7,
-    LK_DATA_CHANNEL_RENDERSERVER_OPEN = 8,
-    LK_DATA_CHANNEL_RENDERSERVER_CLOSE = 9,
-    LK_RTC_EVENT_PEERCONNECTION_STATE = 10,
-    NET_STATE = 11,
-    SYNC_CURSORSTYLE = 12,
-    BAD_NETWORK = 13,
-    ERROR = 14,
-    RTC_SDP = 15,
-    RTC_ICECANDIDATE = 16
+    GOT_REMOTE_AUDIO_STREAM = 1,
+    ICE_STATE_CHANGE = 2,
+    LK_APP_RESIZE = 3,
+    LK_APP_MOUSE_MODE = 4,
+    LK_APP_PLAER_LIST = 5,
+    LK_APP_REQUEST_TEXT = 6,
+    LK_DATA_CHANNEL_RENDERSERVER_TEXT_MESSAGE = 7,
+    LK_DATA_CHANNEL_RENDERSERVER_BINARY_MESSAGE = 8,
+    LK_DATA_CHANNEL_RENDERSERVER_OPEN = 9,
+    LK_DATA_CHANNEL_RENDERSERVER_CLOSE = 10,
+    LK_RTC_EVENT_PEERCONNECTION_STATE = 11,
+    NET_STATE = 12,
+    SYNC_CURSORSTYLE = 13,
+    BAD_NETWORK = 14,
+    ERROR = 15,
+    RTC_SDP = 16,
+    RTC_ICECANDIDATE = 17
 }
 export interface GoogleBitRate {
     start: number;
@@ -84,12 +85,14 @@ export default class PeerConnection extends EventBase<WEBRTC_EVENT_TYPE, WebRTCE
     private lastPacktetsLost;
     private lastPacktetsReceived;
     private larksr;
+    private audioStream;
+    private videoStream;
     constructor(larksr: LarkSR, config: WebRTCConfig);
     create(): void;
     createOffer(): void;
     close(): void;
     onRemoteDescription(des: RTCSessionDescriptionInit): void;
-    onReceiveCandidate(candateInit: RTCIceCandidateInit | null): void;
+    onReceiveCandidate(candateInit: RTCIceCandidateInit): void;
     startNetTest(): void;
     stopNetTest(): void;
     sendInput(input: Input.CloudLark.ClientInput): void;
@@ -105,7 +108,7 @@ export default class PeerConnection extends EventBase<WEBRTC_EVENT_TYPE, WebRTCE
     private onCreateOfferSuccess;
     private onIceCandidate;
     private onIceStateChange;
-    private gotRemoteStream;
+    private ontrack;
     private addIceCandidate;
     private iceStateChange;
     private $emit;