@rongcloud/plugin-rtc 5.3.6 → 5.3.8

package/dist/index.d.ts

@@ -1,7 +1,7 @@
 /*
- * RCRTC - v5.3.6
- * CommitId - 1e9a3a8b922cdecd969ae06d93c8108fbd1308b5
- * Thu Apr 07 2022 02:36:32 GMT+0800 (China Standard Time)
+ * RCRTC - v5.3.8
+ * CommitId - 96f2ec1b07322a73468bf584cd477e8baadd406a
+ * Mon Apr 18 2022 21:36: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';
@@ -1318,6 +1318,41 @@ declare enum RCInnerCDNModel {
     STOP = 2
 }
 
+declare enum RCMixInputFilterMode {
+    /** 全合流，后续加入房间的用户会自动合流 */
+    AUDIO_VIDEO_ALL = 0,
+    /** 全不合流，后续加入本房间的用户 */
+    AUDIO_VIDEO_NO = 1,
+    /** 音频全订阅, 视频全不订阅 */
+    AUDIO_ALL_VIDEO_NO = 2,
+    /** 视频全订阅, 音频全不订阅 */
+    AUDIO_NO_VIDEO_ALL = 3,
+    /**
+     * 根据设置的音频合流列表和视频合流列表合并媒体流
+     */
+    AUDIO_VIDEO_INPUT = 4,
+    /** 音频全订阅，视频根据设置的视频合流列表 */
+    AUDIO_ALL_VIDEO_INPUT = 5,
+    /** 音频全不订阅, 视频根据input里面的视频项订阅 */
+    AUDIO_NO_VIDEO_INPUT = 6,
+    /** 视频全订阅, 音频根据input里面的音频项订阅 */
+    AUDIO_INPUT_VIDEO_ALL = 7,
+    /** 视频全不订阅, 音频根据input里面的音频项订阅 */
+    AUDIO_INPUT_VIDEO_NO = 8,
+    /** 按房间列表订阅音视频(保留当前已经订阅的, 但没在房间列表里的音视频) */
+    ROOM_AUDIO_VIDEO_APPEND = 9,
+    /** 按房间列表订阅音视频(清理当前已经订阅的, 但没在房间列表里的音视频) */
+    ROOM_AUDIO_VIDEO_NOT_APPEND = 10,
+    /** 按房间列表订阅音频, 不订阅视频(保留当前已经订阅的, 但没在房间列表里的音频) */
+    ROOM_AUDIO_APPEND = 11,
+    /** 按房间列表订阅音视, 不订阅视频(清理当前已经订阅的, 但没在房间列表里的音频) */
+    ROOM_AUDIO_NOT_APPEND = 12,
+    /** 按房间列表订阅视频, 不订阅音频(保留当前已经订阅的, 但没在房间列表里的视频) */
+    ROOM_VIDEO_APPEND = 13,
+    /** 按房间列表订阅视频, 不订阅音频(清理当前已经订阅的, 但没在房间列表里的视频) */
+    ROOM_VIDEO_NOT_APPEND = 14
+}
+
 /**
  * 合流后的 video 输出编码配置，包含分辨率、帧率、码率配置项
  */
@@ -1339,6 +1374,13 @@ interface IMCUOutputVideoAttrs {
      */
     bitrate?: number;
 }
+/**
+ * 合并入 MCU 的音频流
+ */
+interface IMCUInputAudio {
+    user_id: string;
+    stream_id: string;
+}
 /**
  * 自定义布局中的单一视频流布局
  */
@@ -1554,7 +1596,8 @@ interface IMCUConfig {
      * 自定义布局输入定义，只有在 mode 值为 `MixLayoutMode.CUSTOMIZE` 时需传值
      */
     input?: {
-        video: IMCUInputVideoLayout[];
+        video?: IMCUInputVideoLayout[];
+        audio?: IMCUInputAudio[];
     };
     /**
      * 合流后的媒体输出配置
@@ -1564,6 +1607,14 @@ interface IMCUConfig {
      * 水印配置
      */
     waterMark?: IMCUWaterMarkConfig;
+    /**
+     * MCU 拉流配置，决定 MCU 从 MediaServer 拉流的方式
+     */
+    inputFilterMode?: RCMixInputFilterMode;
+    /**
+     * MCU 混入列表中房间内的资源
+     */
+    mixRooms?: string[];
 }
 /**
  * 设置开启、停用内置 CDN 数据
@@ -2249,6 +2300,7 @@ declare class RCLivingPKHandler {
     leaveOtherRoom(room: RCLivingRoom, isQuitPK?: boolean): Promise<{
         code: RCRTCCode;
     }>;
+    private _leaveOtherRoom;
     /**
      * 获取连麦信息
      * @param roomId 连麦房间的 roomId
@@ -2799,10 +2851,54 @@ declare class RCMCUConfigBuilder {
      * 清除已添加的自定义布局中的视频流配置
      */
     clearCustomizeLayoutVideo(): RCMCUConfigBuilder;
+    /**
+     * 覆盖设置合流媒体中的音频流
+     * @param trackIds 音频流 trackId 数组，当数组长度为 0 时，则合流媒体中将无音频输出
+     * @returns
+     */
+    setCustomizeInputAudio(trackIds: string[]): RCMCUConfigBuilder;
+    /**
+     * 向既有的音频流合流配置中增加一道音频流
+     * @param trackId 音频 trackId
+     * @since v5.3.7
+     */
+    addCustomizeInputAudio(trackId: string): RCMCUConfigBuilder;
+    /**
+     * 从既有的音频流合流配置中删除一道音频流
+     * @param trackId 音频对应的 trackId
+     * @since v5.3.7
+     */
+    removeCustomizeInputAudio(trackId: string): RCMCUConfigBuilder;
+    /**
+     * 清除音频流合流配置，恢复房间内的全音频流合流输出
+     * @since v5.3.7
+     */
+    clearCustomizeInputAudio(): RCMCUConfigBuilder;
+    /**
+     * 设置 MCU 混流配置
+     * @param videoList 视频输入混流列表，为 null 代表视频全混流，为空集合代表视频全不混流，否则按照输入列表进行混流
+     * @param audioList 音频输入混流列表，为 null 代表音频全混流，为空集合代表音频全不混流，否则按照输入列表进行混流
+     */
+    /**
+     * 设置 MCU 混流配置
+     * @param roomIds 混流房间列表
+     * @param mediaType 混流媒体类型
+     * @param isAppend 是否为增量混流
+     * * true 为增量混流
+     * * false 为全量覆盖混流
+     */
+    /**
+     * 重置所有合流配置
+     * @since v5.3.7
+     * @returns
+     */
+    reset(): RCMCUConfigBuilder;
     /**
      * 使已修改的配置生效，在调用该方法前，所有数据只会对本地配置进行修改，不会产生实际效果
+     * @param reset 调用完成后清空当前配置记录，默认为 `true`（v5.3.7 版本开始启用）
+     * @returns
      */
-    flush(): Promise<{
+    flush(reset?: boolean): Promise<{
         code: RCRTCCode;
     }>;
 }