@rongcloud/plugin-rtc 5.4.0 → 5.4.1-alpha.1

package/dist/index.d.ts

@@ -1,7 +1,7 @@
 /*
- * RCRTC - v5.4.0
- * CommitId - 562068f2adb928d8219691b74b411d02855494db
- * Mon May 09 2022 17:05:01 GMT+0800 (China Standard Time)
+ * RCRTC - v5.4.1-alpha.1
+ * CommitId - ef361465533e3461fd5625b413b1b5053e2fa20e
+ * Mon Jun 06 2022 15:31:43 GMT+0800 (China Standard Time)
  * ©2020 RongCloud, Inc. All rights reserved.
  */
 import { EventEmitter, IReceivedMessage, RTCPluginContext, IRuntime, ErrorCode, RTCMode, IJoinRTCRoomData, KVString, IServerRTCRoomEntry, LogLevel, RTCJoinType, IRTCUserData, IRTCJoinedInfo, IPluginGenerator } from '@rongcloud/engine';
@@ -493,6 +493,7 @@ declare class RCLivingPKHandler {
      * 退出 PK 房间回调
      */
     private readonly _onLeavePKRoom;
+    protected readonly _clientSessionId?: string | undefined;
     /**
      * PK 邀请超时时间，默认 30s
      */
@@ -518,7 +519,7 @@ declare class RCLivingPKHandler {
     /**
      * 退出 PK 房间回调
      */
-    _onLeavePKRoom: (roomId: string) => void);
+    _onLeavePKRoom: (roomId: string) => void, _clientSessionId?: string | undefined);
     private _callAppListener;
     /**
      * 收到连麦邀请
@@ -609,7 +610,10 @@ declare class RCLivingPKHandler {
         inviteSessionId: string;
         inviterRoomId: string;
         inviterUserId: string;
-        inviterUserAutoMix?: boolean | undefined;
+        inviterUserAutoMix?: boolean | undefined; /**
+         * 加入副直播房间
+         * @roomId 副房间的 roomId
+         */
         inviteeRoomId: string;
         inviteeUserAutoMix?: boolean | undefined;
     };
@@ -643,7 +647,7 @@ declare class RCRTCPeerCManager {
      */
     private readonly _polarisReport?;
     /**
-     * 存储创建的所有 peerC，key 为 pcName
+     * 存储创建的所有 peerC，key 为 pcName，/exchange 请求中 request header 中的 Peer-Connection-Id 值
      */
     private _mutilPeerC;
     constructor(
@@ -709,10 +713,6 @@ declare class RCRTCPeerCManager {
      * 获取某一个 peerC
      */
     getPCItemByPCName(pcName: string): {
-        /**
-         * /exchange 请求中 request header 中的 Peer-Connection-Id 值
-         */
-        pcId: string;
         /**
          * RCRTCPeerConnection 对象
          */
@@ -747,10 +747,6 @@ declare class RCRTCPeerCManager {
      */
     getMutilPeerCData(): {
         [key: string]: {
-            /**
-             * /exchange 请求中 request header 中的 Peer-Connection-Id 值
-             */
-            pcId: string;
             /**
              * RCRTCPeerConnection 对象
              */
@@ -804,6 +800,7 @@ declare abstract class RCAbstractRoom {
      * 是否使用多 peerConnection
      */
     protected readonly _useMutilPeerC?: boolean | undefined;
+    protected readonly _clientSessionId?: string | undefined;
     /**
      * 房间资源数据
      */
@@ -848,7 +845,7 @@ declare abstract class RCAbstractRoom {
     /**
      * 是否使用多 peerConnection
      */
-    _useMutilPeerC?: boolean | undefined);
+    _useMutilPeerC?: boolean | undefined, _clientSessionId?: string | undefined);
     private _initRemoteTracks;
     private _handlePingResult;
     /**
@@ -999,6 +996,11 @@ declare abstract class RCAbstractRoom {
      * 退出并销毁当前房间实例，退出后该房间的所有方法将不可用
      */
     __destroy(quitRoom: boolean): Promise<void>;
+    /**
+     * 退出房间之前禁用所有远端资源，避免退出动作耗时过长，
+     * 导致在未完全退出的过程中仍能听到房间内的声音问题
+     */
+    private _muteRemoteTracksBeforeQuit;
     private _leaveHandle;
     /**
      * 释放 PCManager 上的资源
@@ -1034,11 +1036,11 @@ declare abstract class RCAbstractRoom {
      * ice 断线后，尝试重新走 exchange
      */
     protected _reTryExchange(pcName: string, isPub: boolean): Promise<void>;
-    protected _exchangeHandle(body: IExchangeReqBody, pcId: string): Promise<{
+    protected _exchangeHandle(body: IExchangeReqBody, pcName: string): Promise<{
         code: RCRTCCode;
         data?: IExchangeResponse | undefined;
     }>;
-    protected _getRTCReqestHeaders(pcId?: string): IRTCReqHeader;
+    protected _getRTCReqestHeaders(pcName: string): IRTCReqHeader;
     /**
      * 获取 exchange 接口的请求体数据
      * @param subscribeList 订阅清单
@@ -1158,6 +1160,7 @@ declare abstract class RCAbstractRoom {
      * 退出 PK 房间
      */
     protected _quitAllPKRoom(): void;
+    getClientSessionId(): string | undefined;
 }
 
 declare class RCLocalMediaStream {
@@ -1247,6 +1250,7 @@ declare class RCAudienceLivingRoom {
     private readonly _joinResData;
     readonly _livingType: RCLivingType;
     private _useMutilPeerC?;
+    protected readonly _clientSessionId?: string | undefined;
     private readonly _service;
     /**
      * 主播列表
@@ -1284,7 +1288,7 @@ declare class RCAudienceLivingRoom {
     /**
      * 使用的 peerConnection 对应 id
      */
-    private _pcId;
+    private _pcName;
     /**
      * peerConnection 管理类
     */
@@ -1292,7 +1296,7 @@ declare class RCAudienceLivingRoom {
     constructor(_context: RTCPluginContext, _runtime: IRuntime, _initOptions: IRCRTCInitOptions, _roomId: string, _joinResData: {
         token: string;
         kvEntries: IServerRTCRoomEntry[];
-    }, _livingType: RCLivingType, _useMutilPeerC?: boolean | undefined);
+    }, _livingType: RCLivingType, _useMutilPeerC?: boolean | undefined, _clientSessionId?: string | undefined);
     /**
      * 解析服务端返回的 KV 数据，赋值 room 内数据
      */
@@ -1474,6 +1478,7 @@ declare class RCAudienceLivingRoom {
         resolution?: undefined;
         fps?: undefined;
     };
+    getClientSessionId(): string | undefined;
 }
 
 /**
@@ -1508,7 +1513,7 @@ declare class PolarisReporter {
      * @param resourceId userId_11_1_tiny 改为 userId_11_tiny_video
      */
     private _getPolarisTrackId;
-    sendR3R4Data(data: IInnerRCRTCStateReport): void;
+    sendR3R4Data(data: IInnerRCRTCStateReport): Promise<boolean>;
     /**
      * 加入房间
      */
@@ -1543,6 +1548,7 @@ declare class RCRTCPeerConnection extends EventEmitter {
     private pubLocalTracks;
     private _reTryExchangeTimer;
     private _reportStatsTimer;
+    private _reportR3R4ToPolarisTimer;
     constructor(
     /**
      * peerConnection 对应名称
@@ -1597,6 +1603,14 @@ declare class RCRTCPeerConnection extends EventEmitter {
      * @todo
      */
     private _reportHandle;
+    /**
+     * 北极星上报 R3、R4 数据
+     */
+    private _sendR3R4Data;
+    /**
+     * 2s 给北极星上报一次 R3、R4
+     */
+    __reportR3R4ToPolaris(): Promise<void>;
     getRTCPeerConn(): RTCPeerConnection;
     destroy(): void;
     clearReTryExchangeTimer(): void;
@@ -2085,13 +2099,9 @@ declare type TrackParam = RCLocalTrack | IPublishAttrs | RCRemoteTrack | ISubscr
  */
 interface IMutilPeerC {
     /**
-     * pcName
+     * pcName，/exchange 请求中 request header 中的 Peer-Connection-Id 值
      */
     pcName: string;
-    /**
-     * /exchange 请求中 request header 中的 Peer-Connection-Id 值
-     */
-    pcId: string;
     /**
      * RCRTCPeerConnection 对象
      */
@@ -2225,6 +2235,10 @@ interface IRTCReqHeader {
      * peerConnection Id
      */
     'Peer-Connection-Id'?: string;
+    /**
+     * client-session-id 标识一个端用户进入房间后的唯一标识
+     */
+    'Client-Session-Id'?: string;
 }
 interface IMCUReqHeaders {
     'App-Key': string;
@@ -3156,7 +3170,7 @@ declare class RCLivingRoom extends RCAbstractRoom {
     /**
      * 是否使用多 peerConnection
      */
-    useMutilPeerC?: boolean);
+    useMutilPeerC?: boolean, _clientSessionId?: string);
     /**
      * resourceId 有效性验证
      * @param resourceId
@@ -3217,7 +3231,7 @@ declare class RCLivingRoom extends RCAbstractRoom {
     /**
      * 重写父类 _exchangeHandle 方法
      */
-    protected _exchangeHandle(body: IExchangeReqBody, pcId: string): Promise<{
+    protected _exchangeHandle(body: IExchangeReqBody, pcName: string): Promise<{
         code: RCRTCCode;
         data?: IExchangeResponse | undefined;
     }>;
@@ -3277,7 +3291,7 @@ declare class RCRTCRoom extends RCAbstractRoom {
     /**
      * 是否使用多 peerConnection
      */
-    useMutilPeerC?: boolean);
+    useMutilPeerC?: boolean, _clientSessionId?: string);
 }
 
 /**
@@ -3289,6 +3303,7 @@ declare class RCAudienceClient {
      * 是否使用多 peerConnection
      */
     private readonly _useMutilPeerC?;
+    private readonly _clientSessionId?;
     private _pc;
     private _service;
     /**
@@ -3310,7 +3325,7 @@ declare class RCAudienceClient {
     /**
      * 使用的 peerConnection 对应 id
      */
-    private _pcId;
+    private _pcName;
     /**
      * peerConnection 管理类
      */
@@ -3319,7 +3334,7 @@ declare class RCAudienceClient {
     /**
      * 是否使用多 peerConnection
      */
-    _useMutilPeerC?: boolean | undefined);
+    _useMutilPeerC?: boolean | undefined, _clientSessionId?: string | undefined);
     private _getReqHeaders;
     private _clearSubscribeInfo;
     private _livingType;