larksr_websdk 3.2.10 → 3.2.14

package/dist/doc/config.md

@@ -104,5 +104,18 @@ interface ILarkSRConfig {
      * 可选项，手机端是否强制横屏
      */
     mobileForceLandscape?: 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;
 }
 ```

package/dist/doc/functions.md

@@ -63,3 +63,12 @@ sendTextToDataChannel(text: string): void;
  */
 sendBinaryToDataChannel(binary: Uint8Array): void;
 ```
+
+## 其他
+
+```typescript
+/**
+* 采集一帧图像
+*/
+captrueFrame(data: any)
+```

package/dist/doc/index.md

@@ -18,7 +18,7 @@ npm i larksr_websdk
 
 ## 使用
 
-主要使用 LarkSR 对象实例，所有基本操作和事件通过该实例实现。创建该对象一般通过 `CreateLarkSRClientFromeAPI` 和 `CreateLarkSRClientFromeUrl` 函数创建 LarkSR 实例。
+主要使用 LarkSR 对象实例，所有基本操作和事件通过该实例实现。创建该对象一般通过 `CreateLarkSRClientFromeAPI` , `CreateLarkSRClientFromePXYHost`, `CreateLarkSRClientFromeUrl` 函数创建 LarkSR 实例。
 
 ```typescript
 /**
@@ -28,11 +28,25 @@ npm i larksr_websdk
  * @returns Promise 创建 larksr client 是否成功
  */
 export declare function CreateLarkSRClientFromeAPI(config: ILarkSRConfig, params: {
-    appliId: string;
-    playerMode?: number;
-    userType?: number;
-    roomCode?: string;
-    taskId?: string;
+    appliId: string,
+    // 互动模式
+    //启动模式：0：普通模式, 1：互动模式（一人操作多人观看），2: 多人协同（键盘鼠标放开，需要应用配合）
+    playerMode?: number,
+    //Task所有者:1 /  观察者:0
+    userType?: number,
+    //口令:8位唯一码,写入TaskInfo
+    roomCode?: string,
+    taskId?: string,
+    // groups
+    clientMac?: string,
+    groupId?: string,
+    regionId?: string,
+    //指定节点分配
+    targetServerIp?: string,
+    // keys
+    appKey?: string,
+    timestamp?: string,
+    signature?: string,
 }): Promise<LarkSR>;
 
 /**
@@ -41,6 +55,21 @@ export declare function CreateLarkSRClientFromeAPI(config: ILarkSRConfig, params
  * @returns Promise 创建 larksr client 是否成功
  */
 export declare function CreateLarkSRClientFromeUrl(config: ILarkSRConfig): Promise<LarkSR>;
+
+/**
+ * 通过平行云托管平台创建客户端并启动应用
+ * @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>;
 ```
 
 ## 手动创建
@@ -48,8 +77,7 @@ export declare function CreateLarkSRClientFromeUrl(config: ILarkSRConfig): Promi
 ```typescript
 /**
 * LarkSR 客户端。所有操作和事件通过该类传递
-* 注意，如果手动创建该类，要清楚参数的意义，一般只有调试等特殊情况才手动创建该类
-* @see CreateLarkSRClientFromeAPI, CreateLarkSRClientFromeUrl
+* @see CreateLarkSRClientFromeAPI, CreateLarkSRClientFromeUrl, CreateLarkSRClientFromePXYHost
 * @param config 本地配置，如果有 IAppliParams 相同的配置项，优先级最高
 * @param params 云端应用参数等，通过后台接口或者url参数获取。
 */
@@ -102,4 +130,5 @@ client.initSDKAuthCode('您的 SDK ID')
 
 ### [参数配置](./config.md)
 ### [LarkSR 对象方法](./functons.md)
-### [LarkSR 事件](./functons.md)
+### [LarkSR 事件](./events.md)
+### [LarkSR 对象成员](./member_variables.md)

package/dist/doc/member_variables.md

@@ -33,6 +33,20 @@ larksr.videoComponent.captrueFrame(data);
 larksr.videoElement;
 ```
 
+3. 控制显示元素
+
+```javascript
+// 是否显示移动端触摸点
+larksr.isEnableTouchPonit = false;
+// 是否显示载入画面时底部文字
+larksr.isEnableLoadingStateBar = false;
+```
+
+```javascript
+// 设置缩放模式
+larksr.scaleMode = ScaleMode.CONTAIN_APP;
+```
+
 ## 配置参数
 
 ```javascript