ソースを参照

更新版本到 1.6.2

ChangeLog
1. 开启录制/转推 API 新增参数 keyUser,用于指定关键用户停止推流时,停止录制/转推任务
2. 修订 API 文档
kevin.song 5 年 前
コミット
b72e75cbdf
4 ファイル変更12 行追加5 行削除
  1. 7 1
      README.md
  2. 3 3
      lib/index.js
  3. 1 1
      package.json
  4. 1 0
      types/index.d.ts

+ 7 - 1
README.md

@@ -1825,6 +1825,8 @@ client.startRecord(StartRecordOptions, callback)
   waterMark?: WaterMarkOptions  // 选传,水印设置,类型说明见下面的 WaterMarkOptions 类型,不传时将不添加水印
 
   streams?: MixStream[]         // 选传,指定需要录制的流,类型说明见下面的 MixStream 类型。不传或传空数组时,会自动添加房间内所有用户的流,如果指定了流,则仅录制指定的流
+
+  keyUser?: string;             // 选传,用户ID,指定关键用户(userId)不再推流后,录制任务自动关闭,不填时,默认为房间内没有用户推流后录制任务自动关闭
 }
 ```
 
@@ -2017,6 +2019,8 @@ client.startRelay(StartRelayOptions, callback)
   outputMode?: MixOutputMode    // 选传,转推后输出模式,MixOutputMode 为字符串,有 'audio-video' | 'audio' 两种可填,分别代表:输出音视频 | 只输出音频,不填时,默认为 'audio-video'
 
   streamAddMode?: MixStreamAddMode  // 选传,转推流的添加模式,MixStreamAddMode 为字符串,有 'automatic' | 'manual' 两种可填,分别代表:自动添加(有新流时) | 手动添加,不填时,默认为 'automatic'
+
+  keyUser?: string;             // 选传,用户ID,指定关键用户(userId)不再推流后,转推任务自动关闭,不填时,默认为房间内没有用户推流后转推任务自动关闭
 }
 ```
 
@@ -2268,10 +2272,12 @@ client.unpublishStream(previewId, callback)
 - callback: function 类型,选传,方法的回调函数,函数说明如下
 
 ```js
-function callback(Error) {}
+function callback(Error, Stream) {}
 ```
 Error 为返回值,为空时,说明已执行成功,否则执行失败,值为执行失败的错误
 
+Stream 为返回值,[Stream 类型](#stream),执行失败时,此值为空,执行成功时,此值为执行结果
+
 > 注:
 > 1. 取消发布的流必须为使用通过 createStream 方法创建并为发布状态的本地流。
 > 2. 通过 publish 方法直接发布时生成的本地流,请使用 unpublish 方法进行取消发布。

ファイルの差分が大きいため隠しています
+ 3 - 3
lib/index.js


+ 1 - 1
package.json

@@ -1,6 +1,6 @@
 {
   "name": "urtc-sdk",
-  "version": "1.6.1",
+  "version": "1.6.2",
   "description": "UCloud RTC javascript SDK",
   "main": "lib/index.js",
   "types": "types",

+ 1 - 0
types/index.d.ts

@@ -260,6 +260,7 @@ export interface MixOptions {
   streamAddMode?: MixStreamAddMode;
 
   timeoutPeriod?: number; // 超时周期,任务检测到没有(指定)流后超过此时间,将自动停止,单位是s,最长24小时
+  keyUser?: string; // 指定关键用户,退出房间后,录制/转推任务自动关闭
 }
 
 export interface StopMixOptions {