larksr_websdk 3.2.7 → 3.2.11

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

@@ -1,12 +1,17 @@
 import { CloudLark } from '../protobuf/cloudlark';
 import { LocalEvent, EventBase } from '../event/event_base';
+import { Point } from '../common/interface';
 import { LarkSR } from '../larksr';
 export declare const enum OPREATION_EVENT_TYPE {
     Input = 0,
-    NoOperationTimeout = 1
+    NoOperationTimeout = 1,
+    ClipboardText = 2,
+    CursorMove = 3
 }
 export interface OperationEvent extends LocalEvent<OPREATION_EVENT_TYPE> {
     input?: CloudLark.ClientInput;
+    data?: any;
+    cursorPoint?: Point;
 }
 export default class Operation extends EventBase<OPREATION_EVENT_TYPE, OperationEvent> {
     private gestureHandler;
@@ -37,6 +42,7 @@ export default class Operation extends EventBase<OPREATION_EVENT_TYPE, Operation
     setTouchEnable(enable: boolean): void;
     resetLocalRendreMousePosition(): void;
     setAppMouseMode(mode: CloudLark.IAppMouseMode): void;
+    resetAppMouseLockState(): void;
     startListening(): void;
     stopListenling(): void;
     private startOperationCheck;
@@ -59,4 +65,5 @@ export default class Operation extends EventBase<OPREATION_EVENT_TYPE, Operation
     $emitTouchUp(id: number, x: number, y: number): void;
     $emitInputEvent(input: CloudLark.IClientInput): void;
     $emitNoOperationTimeoutEvent(): void;
+    $emitCursorMove(p: Point): void;
 }