larksr_websdk 3.2.0 → 3.2.1

package/README.md

@@ -1,31 +1,77 @@
-//必须参数
-Long appliId,  
-
-
-Long endDate,
-String clientMac,
-Long groupId,
-String regionId,
-Long taskId,
-//启动模式：0：普通模式, 1：互动模式（一人操作多人观看），2: 多人协同（键盘鼠标放开，需要应用配合）
-Integer playerMode,
-//Task所有者:1 /  观察者:0
-Integer userType,
-//Task所有者的名称写入TaskInfo，
-String nickname,
-//口令:8位唯一码,写入TaskInfo
-String roomCode,
-String targetServerIp,
-//默认值是1
-String network,    
-//network=1时codeRate默认值8000，network不等于1时默认值5000，客户指定了特定值，就使用特定值
-String codeRate,
-//默认值60
-String frameRate,
-//默认值32
-String audioCodeRate,
-//指定节点分配
-String targetServerIp,
-appKey,
-timeStamp,
-signature,
+# LarkSR WebClient 接入 SDK
+
+SDK 适用于自定义 LarkSR 云渲 Web 客户端的二次开发，自定义 UI 和操作逻辑等。有较高的灵活性。
+
+对于不需要二次开发，或者简单修改，可以参照使用 iframe 的接入方式，将标准 Web 客户端网页嵌入到系统中去。
+
+参考连接：
+
+[平行云产品介绍](https://www.pingxingyun.com/index.html)
+
+[LarkSR 系统部署和文档](https://www.pingxingyun.com/devCenter.html)
+
+[即刻体验](https://www.pingxingyun.com/experience/experience.html)
+
+## 快速接入
+
+### 安装
+
+1. npm 方式
+
+```cmd
+npm i larksr_websdk
+```
+
+2. 直接引入
+
+```html
+<script src="larksr-web-sdk.min.js"></script>
+```
+
+### 使用
+
+```javascript
+var client;
+// 直接调用进入应用接口创建实例，自动配置连接云端资源
+larksr_websdk.LarkSR.CreateLarkSRClientFromeAPI({
+        // 设置挂在显示的元素
+        rootElement: document.getElementById('container'),
+        // 服务器地址
+        serverAddress: "http://222.128.6.137:8181/",
+        // 授权码
+        authCode: '您的 SDK 授权码',
+        loadingBgUrl: 'https://home-obs.pingxingyun.com/homePage_4_0/bg.jpg',
+    }, {
+        // 要使用的云端资源的应用 ID，从后云雀后台接口获取
+        // 参考查询应用一栏文档
+        // https://www.pingxingyun.com/online/api3_2.html?id=476
+        appliId: "879408743551336448"
+    })
+    .then((res) => {
+        console.log('enter appli success', res);
+        // 创建成返回 LarkSR 实例
+        client = res;
+        // 开始流程
+        client.start();
+    })
+    .catch((e) => {
+        // 创建失败返回错误
+        console.error('enter appli falied', e);
+    });
+```
+
+SDK 加载成功之后，导出接口在全局对象 larksr_websdk 下。
+
+连接云端资源，管理生命周期和事件等主要在 LarkSR 对象下。通过调用 CreateLarkSRClientFromeAPI 配置后台请求参数，创建 LarkSR 对象实例。
+
+> 默认情况下自动连接云端资源，将容器设置为浏览器视口高度，并配置网页 100% 宽高显示。SDK 内部自动处理按键输入输出。
+
+> SDK 只包含loading，内部不包含其他 UI。主要目的时二次开发云渲染客户端自定义 UI 使用。
+
+
+## 参考 DEMO 和文档
+
+更多使用方式和 API 文档可以参考下面项目和 .d.ts 中的注释
+
+[Demos](https://github.com/pingxingyun/lark_sr_websdk_demos)
+