larksr_websdk 3.2.16 → 3.2.30

package/README.md

@@ -21,6 +21,11 @@ SDK 功能包括:
 * 处理全屏模式，并可配置
 * 自动处理横屏模式，手机端强制横屏模式，并可配置
 
+### 注意
+
+> V3.2.30 开始仅支持服务端 [V3.2.3.1](https://www.pingxingyun.com/devCenter.html) 以上版本。
+> [老版本 SDK Demo 下载](https://github.com/pingxingyun/lark_sr_websdk_demos/releases/tag/V3.2.10)
+
 ## 快速接入
 
 ### 安装
@@ -42,7 +47,7 @@ npm i larksr_websdk
 使用前应准备好
 
 1. Lark 服务器前台可访问的地址, 如：http://222.128.6.137:8181/
-2. SDK 授权码，联系 business@pingxingyun.com 获取,注意是 SDK 本身的授权码，不是服务器上的授权
+2. SDK 授权码，联系 business@pingxingyun.com 获取, 注意是 SDK 本身的授权码，不是服务器上的授权
 3. 系统中获取的应用 ID,如 http://222.128.6.137:8181/ 系统下的 879408743551336448
 
 ```javascript
@@ -53,36 +58,29 @@ var client = new LarkSR({
     // 服务器地址,实际使用中填写您的服务器地址
     // 如：http://222.128.6.137:8181/
     // 当使用平行云托管服务时服务器地址自动分配,可留空。
-    // 使用平行云托管服务时使用 CreateLarkSRClientFromePXYHost 或 larksr.connectWithPxyHost 进入应用
+    // larksr.connectWithPxyHost 进入应用
     serverAddress: "Lark 服务器前台地址",
     // SDK ID 也可在 initSDKAuthCode 设置
-    // authCode: '您的 SDK ID',
+    authCode: '您的 SDK ID',
     // 测试载入背景图
     // loadingBgUrl: 'https://home-obs.pingxingyun.com/homePage_4_0/bg.jpg',
 });
 
-// 授权码,验证成功之后才能调用 connect
-client.initSDKAuthCode('您的 SDK ID')
+// start connect;
+// 使用平行云托管服务时，用 connectWithPxyHost 进入应用并自动分配服务器.
+client.connect({
+    // 要使用的云端资源的应用 ID，从后云雀后台接口获取
+    // 参考查询应用一栏文档
+    // https://www.pingxingyun.com/online/api3_2.html?id=476
+    // 如 222.128.6.137:8181 系统下的 879408743551336448 应用
+    appliId: "应用ID"
+})
 .then(() => {
-    // start connect;
-    // 使用平行云托管服务时，用 connectWithPxyHost 进入应用并自动分配服务器.
-    client.connect({
-        // 要使用的云端资源的应用 ID，从后云雀后台接口获取
-        // 参考查询应用一栏文档
-        // https://www.pingxingyun.com/online/api3_2.html?id=476
-        // 如 222.128.6.137:8181 系统下的 879408743551336448 应用
-        appliId: "应用ID"
-    })
-    .then(() => {
-        console.log('enter success');
-    })
-    .catch((e) => {
-        console.error(e);
-    }); 
+    console.log('enter success');
 })
 .catch((e) => {
     console.error(e);
-});
+}); 
 // ...
 // 主动关闭并清理资源
 // client.close();

package/dist/doc/config.md

@@ -26,6 +26,7 @@ interface ILarkSRConfig {
     authCode?: string;
     /**
      * 可选项，授权是否成功
+     *  @deprecated 目前不会回调该参数。如果SDK验证失败将在 connect 返回失败
      */
     authCodeCallback?: (isSuccess: boolean, e: any) => void;
     /**

package/dist/doc/index.md

@@ -18,70 +18,19 @@ npm i larksr_websdk
 
 ## 使用
 
-主要使用 LarkSR 对象实例，所有基本操作和事件通过该实例实现。创建该对象一般通过 `CreateLarkSRClientFromeAPI` , `CreateLarkSRClientFromePXYHost`, `CreateLarkSRClientFromeUrl` 函数创建 LarkSR 实例。
+### 注意
 
-```typescript
-/**
- * 通过调用后台接口获取云端应用参数
- * @param config 传入 config @see ILarkSRConfig
- * @param params 进入应用接口参数。appliId 为必填项
- * @returns Promise 创建 larksr client 是否成功
- */
-export declare function CreateLarkSRClientFromeAPI(config: ILarkSRConfig, params: {
-    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>;
+> V3.2.30 开始仅支持服务端 [V3.2.3.1](https://www.pingxingyun.com/devCenter.html) 以上版本。
+> [老版本 SDK Demo 下载](https://github.com/pingxingyun/lark_sr_websdk_demos/releases/tag/V3.2.10)
 
-/**
- * 通过从url参数中获取云端应用相关参数
- * @param config 传入 config @see ILarkSRConfig
- * @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>;
-```
-
-## 手动创建
+## 创建 LarkSR 实例
 
 ```typescript
 /**
 * LarkSR 客户端。所有操作和事件通过该类传递
-* @see CreateLarkSRClientFromeAPI, CreateLarkSRClientFromeUrl, CreateLarkSRClientFromePXYHost
-* @param config 本地配置，如果有 IAppliParams 相同的配置项，优先级最高
-* @param params 云端应用参数等，通过后台接口或者url参数获取。
+* @param config 本地配置, 优先级最高
 */
-constructor(config: ILarkSRConfig, params?: IAppliParams);
+constructor(config: ILarkSRConfig);
 ```
 
 example:
@@ -93,34 +42,30 @@ var client = new LarkSR({
     rootElement: document.getElementById('container'),
     // 服务器地址,实际使用中填写您的服务器地址
     // 如：http://222.128.6.137:8181/
+    // 当使用平行云托管服务时服务器地址自动分配,可留空。
+    // larksr.connectWithPxyHost 进入应用
     serverAddress: "Lark 服务器前台地址",
     // SDK ID 也可在 initSDKAuthCode 设置
-    // authCode: '您的 SDK ID',
+    authCode: '您的 SDK ID',
     // 测试载入背景图
     // loadingBgUrl: 'https://home-obs.pingxingyun.com/homePage_4_0/bg.jpg',
 });
 
-// 授权码,验证成功之后才能调用 connect
-client.initSDKAuthCode('您的 SDK ID')
+// start connect;
+// 使用平行云托管服务时，用 connectWithPxyHost 进入应用并自动分配服务器.
+client.connect({
+    // 要使用的云端资源的应用 ID，从后云雀后台接口获取
+    // 参考查询应用一栏文档
+    // https://www.pingxingyun.com/online/api3_2.html?id=476
+    // 如 222.128.6.137:8181 系统下的 879408743551336448 应用
+    appliId: "应用ID"
+})
 .then(() => {
-    // start connect;
-    client.connect({
-        // 要使用的云端资源的应用 ID，从后云雀后台接口获取
-        // 参考查询应用一栏文档
-        // https://www.pingxingyun.com/online/api3_2.html?id=476
-        // 如 222.128.6.137:8181 系统下的 879408743551336448 应用
-        appliId: "应用ID"
-    })
-    .then(() => {
-        console.log('enter success');
-    })
-    .catch((e) => {
-        console.error(e);
-    }); 
+    console.log('enter success');
 })
 .catch((e) => {
     console.error(e);
-});
+}); 
 // ...
 // 主动关闭并清理资源
 // client.close();
@@ -132,3 +77,5 @@ client.initSDKAuthCode('您的 SDK ID')
 ### [LarkSR 对象方法](./functons.md)
 ### [LarkSR 事件](./events.md)
 ### [LarkSR 对象成员](./member_variables.md)
+### [SDK ID 加密](./sdkid_encryption.md)
+### [SDK 更新](./update.md)

package/dist/doc/sdkid_encryption.md

@@ -0,0 +1,40 @@
+# SDK ID 加密配置
+
+使用 larksr SDK 首先需要从平行云商务 business@pingxingyun.com 或者在 https://www.pingxingyun.com/console 获取 SDK 授权码（注意不是服务器端的授权码）。
+
+通过 larksr config 传入 `authCode` 或者通过 larksr.initSDKAuthCode('您的SDKID') 方法设置授权码。
+
+为保护 SDK ID 的安全性，可以从服务端 3.2.3.0 开始可以对 SDK ID 进行加密配置。
+
+配置 SDK 加密：
+
+1. 首先在 larkxr 平台后台登陆，找到系统设定->接入管理->SDKID密钥管理生成 SDK ID 加密 KEY
+
+2. 对 SDK ID 进行加密
+
+以下 java 代码为例:
+
+```java
+public static void main(String[] args) {
+    /**
+    * @param res   被加密的原生字符串
+    * @param key  16位字符作为加密的key
+    */
+    try {
+        String res = "被加密的原生字符串";
+        String key = "16位字符作为加密的key";
+        String ALGORITHM = "AES";
+        String CHARSET = "UTF-8";
+        SecretKeySpec sks = new SecretKeySpec(key.getBytes(CHARSET), ALGORITHM);
+        Cipher cipher = Cipher.getInstance(ALGORITHM);
+        cipher.init(cipher.ENCRYPT_MODE, sks);
+        byte[] result = cipher.doFinal(res.getBytes());
+        // BASE64Encoder encoder = new BASE64Encoder();      //java8
+        Base64.Encoder encoder = Base64.getEncoder(); //java9+
+        System.out.println(encoder.encodeToString(result));
+    }catch (Exception e){
+    }
+}
+```
+
+3. 获取到加密好的字符串传入 lark 配置中即可。

package/dist/doc/update.md

@@ -0,0 +1,10 @@
+# 更新
+
+## V3.2.30
+
+> V3.2.30 仅支持服务端 [V3.2.3.1](https://www.pingxingyun.com/devCenter.html) 以上版本。
+> [老版本 SDK Demo 下载](https://github.com/pingxingyun/lark_sr_websdk_demos/releases/tag/V3.2.10)
+
+1. [添加像素流送支持](https://docs.unrealengine.com/4.27/zh-CN/SharingAndReleasing/PixelStreaming/PixelStreamingIntro/)。
+2. 完善安全性, 添加 SDK ID 加密配置。
+3. 移除 CreateLarkSRClientFromePXYHost，CreateLarkSRClientFromeAPI, CreateLarkSRClientFromeUrl 函数。直接使用 `new LarkSR(config: ILarkSRConfig)` 方式创建对象。