@rongcloud/plugin-rtc 5.3.7-alpha.1 → 5.3.7

package/dist/index.d.ts

@@ -1,7 +1,7 @@
 /*
- * RCRTC - v5.3.7-alpha.1
- * CommitId - aca944e2fa79b4f5e894c21aaaec789528e8f3fc
- * Fri Apr 15 2022 18:00:48 GMT+0800 (China Standard Time)
+ * RCRTC - v5.3.7
+ * CommitId - 9e19165cf1ecfebf6d1f6b6caa947acfa558b0b3
+ * Sat Apr 16 2022 18:34:55 GMT+0800 (China Standard Time)
  * ©2020 RongCloud, Inc. All rights reserved.
  */
 import { EventEmitter, LogLevel, RTCMode, IRuntime, RTCPluginContext, IServerRTCRoomEntry, IReceivedMessage, ErrorCode, IJoinRTCRoomData, KVString, RTCJoinType, IRTCUserData, IRTCJoinedInfo, IPluginGenerator } from '@rongcloud/engine';
@@ -1608,7 +1608,7 @@ interface IMCUConfig {
      */
     waterMark?: IMCUWaterMarkConfig;
     /**
-     * 设置合流混入音频、视频的模式
+     * MCU 拉流配置，决定 MCU 从 MediaServer 拉流的方式
      */
     inputFilterMode?: RCMixInputFilterMode;
     /**
@@ -2852,20 +2852,28 @@ declare class RCMCUConfigBuilder {
      */
     clearCustomizeLayoutVideo(): RCMCUConfigBuilder;
     /**
-     * 设置要合入 MCU 的音频
-     * @param trackIds 一组音频 trackId
+     * 覆盖设置合流媒体中的音频流
+     * @param trackIds 音频流 trackId 数组，当数组长度为 0 时，则合流媒体中将无音频输出
+     * @returns
+     */
+    setCustomizeInputAudio(trackIds: string[]): RCMCUConfigBuilder;
+    /**
+     * 向既有的音频流合流配置中增加一道音频流
+     * @param trackId 音频 trackId
+     * @since v5.3.7
      */
-    setCustomInputAudio(trackIds: string[]): RCMCUConfigBuilder;
+    addCustomizeInputAudio(trackId: string): RCMCUConfigBuilder;
     /**
-     * 清除某个已设置合入 MCU 的音频
+     * 从既有的音频流合流配置中删除一道音频流
      * @param trackId 音频对应的 trackId
+     * @since v5.3.7
      */
-    removeCustomInputAudio(trackId: string): RCMCUConfigBuilder;
+    removeCustomizeInputAudio(trackId: string): RCMCUConfigBuilder;
     /**
-     * 清除所有已设置合入 MCU 的音频
+     * 清除音频流合流配置，恢复房间内的全音频流合流输出
+     * @since v5.3.7
      */
-    clearCustomInputAudio(): RCMCUConfigBuilder;
-    private _validateInputVideoParams;
+    clearCustomizeInputAudio(): RCMCUConfigBuilder;
     /**
      * 设置 MCU 混流配置
      * @param videoList 视频输入混流列表，为 null 代表视频全混流，为空集合代表视频全不混流，否则按照输入列表进行混流
@@ -2879,10 +2887,18 @@ declare class RCMCUConfigBuilder {
      * * true 为增量混流
      * * false 为全量覆盖混流
      */
+    /**
+     * 重置所有合流配置
+     * @since v5.3.7
+     * @returns
+     */
+    reset(): RCMCUConfigBuilder;
     /**
      * 使已修改的配置生效，在调用该方法前，所有数据只会对本地配置进行修改，不会产生实际效果
+     * @param reset 调用完成后清空当前配置记录，默认为 `true`（v5.3.7 版本开始启用）
+     * @returns
      */
-    flush(): Promise<{
+    flush(reset?: boolean): Promise<{
         code: RCRTCCode;
     }>;
 }