Browse Source

更新版本到 1.3.0

ChangeLog
1. joinRoom 方法的成功回调改为返回当前房间其他用户及正在发布的流的信息
2. leaveRoom 方法的成功回调不再返回冗余数据
3. publish 去除无效的成功回调函数,发布的成功以 stream-published 事件为准
4. subscribe 去除无效的成功回调函数,订阅的成功以 stream-subscribe 事件为准
5. setServers 配置 log 的地址设为空字符串时,可关闭日志上报功能
6. 规范日志上报的设备信息格式
7. API 文档中,添加水印功能暂未开放的提示
8. 修复 Safari 浏览器推流时,Chrome 浏览器订阅成功但不能显示视频的Bug
9. 修复 Safari 浏览器连续多次发布及取消发布后代码报错的问题
kevin.song 6 years ago
parent
commit
7ad52ecf2e
4 changed files with 44 additions and 59 deletions
  1. 3 3
      Manual.md
  2. 37 52
      README.md
  3. 3 3
      lib/index.js
  4. 1 1
      package.json

+ 3 - 3
Manual.md

@@ -49,16 +49,16 @@ const client = new UCloudRTC.Client(appId, token);
 client.on('stream-published', (stream) => {
 client.on('stream-published', (stream) => {
     // 使用 HtmlMediaElement 播放媒体流。将流的 mediaStream 给 Video/Audio 元素的 srcObject 属性,即可播放,注意设置 autoplay 属性以支持视频的自动播放,其他属性请参见 [<video>](https://developer.mozilla.org/zh-CN/docs/Web/HTML/Element/video)
     // 使用 HtmlMediaElement 播放媒体流。将流的 mediaStream 给 Video/Audio 元素的 srcObject 属性,即可播放,注意设置 autoplay 属性以支持视频的自动播放,其他属性请参见 [<video>](https://developer.mozilla.org/zh-CN/docs/Web/HTML/Element/video)
     htmlMediaElement.srcObject = stream.mediaStream;
     htmlMediaElement.srcObject = stream.mediaStream;
-}); // 监听本地流发布成功事件,在当前用户执行 publish 后,与服务器经多次协商,建立好连接后,会触发此事件
+}); // 监听本地流发布成功事件,在当前用户执行 publish 后,与服务器经多次协商,成功后会触发此事件
 
 
 client.on('stream-subscribed', (stream) => {
 client.on('stream-subscribed', (stream) => {
     // 使用 HtmlMediaElement 播放媒体流
     // 使用 HtmlMediaElement 播放媒体流
     htmlMediaElement.srcObject = stream.mediaStream;
     htmlMediaElement.srcObject = stream.mediaStream;
-}); // 监听远端流订阅成功事件,在当前用户执行 subscribe 后,与服务器经多次协商,建立好连接后,会触发此事件
+}); // 监听远端流订阅成功事件,在当前用户执行 subscribe 后,与服务器经多次协商,成功后会触发此事件
 
 
 client.on('stream-added', (stream) => {
 client.on('stream-added', (stream) => {
     client.subscribe(stream.sid);
     client.subscribe(stream.sid);
-}); // 监听新增远端流事件,在远端用户新发布流后,服务器会推送此事件的消息。注:当刚进入房间时,若房间已有流,也会收到此事件的通知
+}); // 监听新增远端流事件,在远端用户新发布流后,服务器会推送此事件的消息。注:当刚进入房间时,若房间已有的正在发布的流,也会通过此事件进行通知业务侧
 ```
 ```
 
 
 ## 3. 加入一个房间,然后发布本地流
 ## 3. 加入一个房间,然后发布本地流

+ 37 - 52
README.md

@@ -96,20 +96,12 @@ client.joinRoom(RoomId, UserId, onSuccess, onFailure)
 - onSuccess: function 类型,选传,方法调用成功时执行的回调函数,函数说明如下
 - onSuccess: function 类型,选传,方法调用成功时执行的回调函数,函数说明如下
 
 
 ```
 ```
-function onSuccess(User) {}
+function onSuccess(Users, Streams) {}
 ```
 ```
 
 
-函数参数 User 为返回值,Object 类型,为用户信息。User 类型说明如下
+函数参数 Users 为返回值,User 类型的数组,代表当前房间内已有的其他用户的信息,User 类型说明见 [User](#user);函数参数 Streams 为返回值,Stream 类型的数组,代表当前房间内其他用户正在发布的流。Stream 类型说明见 [Stream](#stream)
 
 
-<a name='user'></a>
-
-User:
-
-```
-{
-  uid: string   // 为用户ID
-}
-```
+> 注:当加入房间成功后,当前房间内已有的其他用户的信息以及正在发布的流,都会分别由 `user-added` 和 `stream-added` 事件再进行通知。如需订阅正在发布的流,建议在 `stream-added` 事件函数中统一处理,此处 `onSuccess` 函数的参数 `Users` 和 `Streams` 数据仅用于展示。
 
 
 - onFailure: 选传,函数类型,方法调用失败时执行的回调函数。
 - onFailure: 选传,函数类型,方法调用失败时执行的回调函数。
 
 
@@ -133,11 +125,9 @@ client.leaveRoom(onSuccess, onFailure)
 - onSuccess: function 类型,选传,方法调用成功时执行的回调函数,函数说明如下
 - onSuccess: function 类型,选传,方法调用成功时执行的回调函数,函数说明如下
 
 
 ```
 ```
-function onSuccess(User) {}
+function onSuccess() {}
 ```
 ```
 
 
-函数参数 User 为返回值,类型说明见 [User](#user)
-
 - onFailure: 选传,函数类型,方法调用失败时执行的回调函数。
 - onFailure: 选传,函数类型,方法调用失败时执行的回调函数。
 
 
 ```
 ```
@@ -152,7 +142,7 @@ Err 为错误信息
 发布本地流,示例代码:
 发布本地流,示例代码:
 
 
 ```
 ```
-client.publish(Options, onSuccess, onFailure)
+client.publish(Options, onFailure)
 ```
 ```
 
 
 #### 参数说明
 #### 参数说明
@@ -169,31 +159,6 @@ client.publish(Options, onSuccess, onFailure)
 }
 }
 ```
 ```
 
 
-- onSuccess: function 类型,选传,方法调用成功时执行的回调函数,函数说明如下
-
-```
-function onSuccess(Stream) {}
-```
-
-函数参数 Stream 为返回值,Object 类型,为流信息。Stream 类型说明如下
-
-<a name='stream'></a>
-
-Stream:
-
-```
-{
-  sid: string                     // 流ID
-  uid: string                     // 对应的用户的ID
-  type: 'publish'|'subscribe'     // 流类型,分别为 publish 和 subscribe 两种,
-  video: boolean                  // 是否包含音频
-  audio: boolean                  // 是否包含视频
-  muteAudio: boolean              // 音频是否静音
-  muteVideo: boolean              // 视频是否静音
-  mediaStream?: MediaStream       // 使用的媒体流,可用 HTMLMediaElement 进行播放,此属性的值可能为空,当流被正常发布或订阅流,此值有效
-}
-```
-
 - onFailure: 选传,函数类型,方法调用失败时执行的回调函数。
 - onFailure: 选传,函数类型,方法调用失败时执行的回调函数。
 
 
 ```
 ```
@@ -212,7 +177,6 @@ client.unpublish(onSuccess, onFailure)
 ```
 ```
 
 
 #### 参数说明
 #### 参数说明
-
 - onSuccess: function 类型,选传,方法调用成功时执行的回调函数,函数说明如下
 - onSuccess: function 类型,选传,方法调用成功时执行的回调函数,函数说明如下
 
 
 ```
 ```
@@ -235,19 +199,12 @@ Err 为错误信息
 订阅远端流,,示例代码:
 订阅远端流,,示例代码:
 
 
 ```
 ```
-client.subscribe(StreamId, onSuccess, onFailure)
+client.subscribe(StreamId, onFailure)
 ```
 ```
 
 
 #### 参数说明
 #### 参数说明
 
 
 - StreamId: string 类型,必传,为需要订阅的远端流的 sid
 - StreamId: string 类型,必传,为需要订阅的远端流的 sid
-- onSuccess: function 类型,选传,方法调用成功时执行的回调函数,函数说明如下
-
-```
-function onSuccess(Stream) {}
-```
-
-函数参数 Stream 为返回值,Object 类型,为流信息,类型说明见 [Stream](#stream)
 
 
 - onFailure: 选传,函数类型,方法调用失败时执行的回调函数。
 - onFailure: 选传,函数类型,方法调用失败时执行的回调函数。
 
 
@@ -270,6 +227,7 @@ client.unsubscribe(StreamId, onSuccess, onFailure)
 #### 参数说明
 #### 参数说明
 
 
 - StreamId: string 类型,必传,为需要订阅的远端流的 sid
 - StreamId: string 类型,必传,为需要订阅的远端流的 sid
+
 - onSuccess: function 类型,选传,方法调用成功时执行的回调函数,函数说明如下
 - onSuccess: function 类型,选传,方法调用成功时执行的回调函数,函数说明如下
 
 
 ```
 ```
@@ -397,7 +355,7 @@ client.startRecording(RecordOptions, onSuccess, onFailure)
 
 
 ```
 ```
 {
 {
-  waterMarkPosition: 'left-top' | 'left-bottom' | 'right-top' | 'right-bottom'    // 必填,指定水印的位置,前面四种类型分别对应 左上,左下,右上,右下
+  waterMarkPosition: 'left-top' | 'left-bottom' | 'right-top' | 'right-bottom'    // 必填,指定水印的位置,前面四种类型分别对应 左上,左下,右上,右下,注:水印功能暂未开放,请随意填一个有效值
   bucket: string  // 存储的 bucket, URTC 使用 UCloud 的 UFile 产品进行在存储,相关信息见控制台操作文档
   bucket: string  // 存储的 bucket, URTC 使用 UCloud 的 UFile 产品进行在存储,相关信息见控制台操作文档
   region: string  // 存储服务所在的地域
   region: string  // 存储服务所在的地域
 }
 }
@@ -460,7 +418,17 @@ const result = client.getUser()
 
 
 #### 返回值说明
 #### 返回值说明
 
 
-- result: User 类型,类型说明见 [User](#user)
+- result: User 类型,类型说明如下
+
+<a name='user'></a>
+
+User:
+
+```
+{
+  uid: string   // 为用户ID
+}
+```
 
 
 
 
 <a name="client-getusers"></a>
 <a name="client-getusers"></a>
@@ -490,7 +458,24 @@ const result = client.getStream()
 
 
 #### 返回值说明
 #### 返回值说明
 
 
-- result: Stream 类型,Stream 类型说明见 [Stream](#stream)
+- result: Stream 类型,Stream 类型说明如下
+
+<a name='stream'></a>
+
+Stream:
+
+```
+{
+  sid: string                     // 流ID
+  uid: string                     // 对应的用户的ID
+  type: 'publish'|'subscribe'     // 流类型,分别为 publish 和 subscribe 两种,
+  video: boolean                  // 是否包含音频
+  audio: boolean                  // 是否包含视频
+  muteAudio: boolean              // 音频是否静音
+  muteVideo: boolean              // 视频是否静音
+  mediaStream?: MediaStream       // 使用的媒体流,可用 HTMLMediaElement 进行播放,此属性的值可能为空,当流被正常发布或订阅流,此值有效
+}
+```
 
 
 
 
 <a name="client-getstreams"></a>
 <a name="client-getstreams"></a>

File diff suppressed because it is too large
+ 3 - 3
lib/index.js


+ 1 - 1
package.json

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