@rongcloud/plugin-rtc 5.2.2 → 5.2.4-beem.2

package/dist/index.d.ts

@@ -1,7 +1,7 @@
 /*
- * RCRTC - v5.2.2
- * CommitId - cbd066a7185af8c1b56ef6bf88f1332ec9444daa
- * Thu Nov 25 2021 17:52:32 GMT+0800 (China Standard Time)
+ * RCRTC - v5.2.4-beem.2
+ * CommitId - 51c7e1de9a288f3456394ed2bc6ee9e09c4afa8c
+ * Mon May 16 2022 17:37:30 GMT+0800 (China Standard Time)
  * ©2020 RongCloud, Inc. All rights reserved.
  */
 import { EventEmitter, LogLevel, RTCMode, IRuntime, RTCPluginContext, IServerRTCRoomEntry, IJoinRTCRoomData, IReceivedMessage, KVString, RTCJoinType, IRTCJoinedInfo, IPluginGenerator } from '@rongcloud/engine';
@@ -770,7 +770,7 @@ interface IRoomEventListener extends IRCRTCTrackEventListener {
      * 另一种可能是己方 rtcPing 失败次数超出上限
      * @param byServer 当值为 `false` 时，说明本端 rtcPing 超时；当值为 `true` 时，说明本端收到被踢出房间通知
      */
-    onKickOff?(byServer: boolean, state?: RCKickReason): void;
+    onKickOff?(byServer: boolean, state?: RCKickReason, kickExtra?: any): void;
     /**
      * 接收到房间信令时回调，用户可通过房间实例的 sendMessage 接口发送信令
      * @param name 信令名
@@ -910,6 +910,14 @@ interface IAudioLevelChangeHandler {
 declare type RoomData = {
     [userId: string]: IPublishedResource[];
 };
+/**
+ * 观众加房间返回给客户的 CDN 信息
+ */
+interface IJoinResCDNInfo {
+    resolution?: RCResolution;
+    fps?: RCFrameRate;
+    CDNEnable?: boolean;
+}
 
 declare enum RCInnerCDNPushMode {
     AUTOMATIC = 0,
@@ -1686,9 +1694,21 @@ declare class RCAudienceLivingRoom {
     private readonly _joinResData;
     readonly _livingType: RCLivingType;
     private readonly _service;
+    /**
+     * 主播列表
+     */
     private _roomAnchorList;
+    /**
+     * 合流、分流资源
+     */
     private _roomRes;
+    /**
+     * 主播分流资源
+     */
     private _roomAnchorRes;
+    /**
+     * 合流、分流 remoteTracks
+     */
     private _remoteTracks;
     private _appListener;
     private _pc;
@@ -1709,8 +1729,12 @@ declare class RCAudienceLivingRoom {
     private _CDNUris;
     constructor(_context: RTCPluginContext, _runtime: IRuntime, _initOptions: IRCRTCInitOptions, _roomId: string, _joinResData: {
         token: string;
-        kvEntries?: IServerRTCRoomEntry[];
+        kvEntries: IServerRTCRoomEntry[];
     }, _livingType: RCLivingType);
+    /**
+     * 解析服务端返回的 KV 数据，赋值 room 内数据
+     */
+    private _setInitData;
     protected _assertRoomDestroyed(): RCRTCCode | undefined;
     /**
      * @description 信令数据处理
@@ -1769,8 +1793,7 @@ declare class RCAudienceLivingRoom {
     private _diffCDNUris;
     /**
      * 获取 CDN 资源对应的拉流地址
-     * 首次获取 CDNPlayUrl 时，需传入 url，
-     * 业务层调用时使用内存中 _CDNUris 的 url，无 _CDNUris 时说明观众端未赋值过 _CDNUris
+     * _CDNUris 无 url 时，说明未开启 CDN 推送
      * @returns CDNPlayUrl
      */
     private _getCDNPlayUrl;
@@ -1864,6 +1887,26 @@ declare class RCAudienceLivingRoom {
      * @returns
      */
     getRemoteTracks(): RCRemoteTrack[];
+    /**
+     * 获取远端 RTC tracks
+     */
+    getRemoteRTCTracks(): RCRemoteTrack[];
+    /**
+     * 获取远端 MCU tracks
+     */
+    getRemoteMCUTracks(): RCRemoteTrack[];
+    /**
+     * 获取房间内 CDN 信息
+     */
+    getCDNInfo(): {
+        resolution: RCResolution;
+        fps: RCFrameRate;
+        CDNEnable: boolean | undefined;
+    } | {
+        CDNEnable: boolean;
+        resolution?: undefined;
+        fps?: undefined;
+    };
 }
 
 /**
@@ -2183,6 +2226,11 @@ declare abstract class RCAbstractRoom {
      * 退出并销毁当前房间实例，退出后该房间的所有方法将不可用
      */
     __destroy(quitRoom: boolean): Promise<void>;
+    /**
+     * 退出房间之前禁用所有远端资源，避免退出动作耗时过长，
+     * 导致在未完全退出的过程中仍能听到房间内的声音问题
+     */
+    private _muteRemoteTracksBeforeQuit;
     private _leaveHandle;
     private _onLocalTrackDestroied;
     /**
@@ -2674,8 +2722,12 @@ declare class RCRTCClient {
     /**
      * 加入普通音视频房间
      * @param roomId
+     * @param joinType 多端处理方式
+     * @param outerUserDatas 业务层设置人员属性
+     * @param useMutilPeerC
+     * @param roomType 加入房间的类型 默认参数 RTCMode.RTC
      */
-    joinRTCRoom(roomId: string, joinType?: RTCJoinType): Promise<{
+    joinRTCRoom(roomId: string, joinType?: RTCJoinType, outerUserDatas?: unknown, useMutilPeerC?: boolean, roomType?: RTCMode): Promise<{
         room?: RCRTCRoom;
         code: RCRTCCode;
         userIds?: string[];
@@ -2810,6 +2862,10 @@ declare class RCRTCClient {
     joinLivingRoomAsAudience(roomId: string, livingType: RCLivingType): Promise<{
         room?: RCAudienceLivingRoom;
         code: RCRTCCode;
+        userIds?: string[];
+        RTCTracks?: RCRemoteTrack[];
+        MCUTracks?: RCRemoteTrack[];
+        CDNUris?: IJoinResCDNInfo;
     }>;
     /**
      * 观众退出并销毁当前房间实例，退出后该房间的所有方法将不可用
@@ -2832,6 +2888,10 @@ declare class RCRTCClient {
     downgradeToAudienceRoom(room: RCLivingRoom): Promise<{
         room?: RCAudienceLivingRoom;
         code: RCRTCCode;
+        userIds?: string[];
+        RTCTracks?: RCRemoteTrack[];
+        MCUTracks?: RCRemoteTrack[];
+        CDNUris?: IJoinResCDNInfo;
     }>;
     /**
      * 获取在房间内用户信息