更新版本到 1.2.2

Manual.md

@@ -1,10 +1,6 @@
-# SDK 使用说明
+# SDK 使用说明 - 简单步骤
 
-查看 [API 文档](./README.md)
-
-## 使用的简单步骤
-
-### 1. 创建一个 URTC Client
+## 1. 创建一个 URTC Client
 
 有两种方式：
 
@@ -13,7 +9,13 @@
 1) 使用 [npm](https://www.npmjs.com/) 或 [Yarn](https://yarnpkg.com/) 安装 sdk:
 
 ```
-npm install urtc-sdk
+npm install --save urtc-sdk
+```
+
+或
+
+```
+yarn add urtc-sdk
 ```
 
 2) 项目中引入并创建 client
@@ -21,7 +23,7 @@ npm install urtc-sdk
 ```
 import { Client } from 'urtc-sdk';
 
-const client = new Client(appId, token); // 默认为直播模式（大班课），若为连麦模式（小班课）时，需要传入第三个参数 { type: 'rtc' }，更多配置见 sdk API 说明
+const client = new Client(appId, token); // 默认为连麦模式（小班课），若为直播模式（大班课）时，需要传入第三个参数 { type: 'live' }，更多配置见 sdk API 说明
 ```
 
 - 直接在页面中用 script 标签将 sdk 引入，此时会有全局对象 UCloudRTC
@@ -41,7 +43,7 @@ const client = new UCloudRTC.Client(appId, token);
 
 > 注：创建 client 时传的 token 需要使用 AppId 和 AppKey 等数据生成，测试阶段，可临时使用 sdk 提供的 generateToken 方法生成，但为保证 AppKey 不暴露于公网，在生产环境中强烈建议自建服务，由服务器按规则生成 token 供 sdk 使用。
 
-### 2. 监听流事件
+## 2. 监听流事件
 
 ```
 client.on('stream-published', (stream) => {
@@ -59,7 +61,7 @@ client.on('stream-added', (stream) => {
 }); // 监听新增远端流事件，在远端用户新发布流后，服务器会推送此事件的消息。注：当刚进入房间时，若房间已有流，也会收到此事件的通知
 ```
 
-### 3. 加入一个房间，然后发布本地流
+## 3. 加入一个房间，然后发布本地流
 
 ```
 client.joinRoom(roomId, userId, () => {
@@ -67,14 +69,14 @@ client.joinRoom(roomId, userId, () => {
 }); // 在 joinRoom 的 onSuccess 回调函数中执行 publish 发布本地流
 ```
 
-### 4. 取消发布本地流或取消订阅远端流
+## 4. 取消发布本地流或取消订阅远端流
 
 ```
 client.unpublish();
 client.unsubscibe(streamId);
 ```
 
-### 5. 退出房间
+## 5. 退出房间
 
 ```
 client.leaveRoom();

README.md

@@ -71,9 +71,9 @@ new Client(AppId, Token, Options);
 
 ```
 {
-  type?: "live"|"rtc",  // 选填，设置房间类型，有两种 "live" 和 "rtc" 类型可选 ，分别对应直播模式和连麦模式，默认为 live
-  role?: "pull" | "push" | "push-and-pull",   // 选填，设置用户角色，可设 "pull" | "push" | "push-and-pull" 三种角色，分别对应拉流、推流、推+拉流，默认为 "pull"，特别地，当房间类型为连麦模式时，此参数将被忽视，会强制为 "push-and-pull"，即推+拉流
-  codec?: "vp8"|"h264", // 选填，设置视频编码格式，可设 "vp8" 或 "h264"，默认为 "vp8"
+  type?: "rtc"|"live",  // 选填，设置房间类型，有两种 "live" 和 "rtc" 类型可选 ，分别对应直播模式和连麦模式，默认为 rtc
+  role?: "pull" | "push" | "push-and-pull",   // 选填，设置用户角色，可设 "pull" | "push" | "push-and-pull" 三种角色，分别对应拉流、推流、推+拉流，默认为 "push-and-pull"，特别地，当房间类型为连麦模式（rtc）时，此参数将被忽视，会强制为 "push-and-pull"，即推+拉流
+  codec?: "vp8"|"h264", // 选填，设置视频编码格式，可设 "vp8" 或 "h264"，默认为 "vp8"，注：部分老版本浏览器不支持 vp8 的视频编解码时（譬如 macOS 10.14.4 平台的 Safar 12.1 及以上版本才支持 vp8），可选择 h264 编码格式
 }
 ```
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "urtc-sdk",
-  "version": "1.2.1",
+  "version": "1.2.2",
   "description": "UCloud WebRTC javascript SDK",
   "main": "lib/index.js",
   "repository": {