@rongcloud/plugin-rtc 5.5.5-beem.3 → 5.5.5-beem.4

package/dist/index.d.ts

@@ -1,7 +1,7 @@
 /*
- * RCRTC - v5.5.5-beem.3
- * CommitId - b639b89eb82e0b55da6285514427d887456ecbd2
- * Mon Oct 31 2022 13:25:42 GMT+0800 (China Standard Time)
+ * RCRTC - v5.5.5-beem.4
+ * CommitId - 1c464fa58c20897be94d3d50ee25c52729284323
+ * Tue Nov 08 2022 19:35:07 GMT+0800 (China Standard Time)
  * ©2020 RongCloud, Inc. All rights reserved.
  */
 import { EventEmitter, BasicLogger, INaviInfo, RTCPluginContext, AbsCodec, IPromiseResult, ErrorCode, KVString, IRuntime, IAsyncRes, ConnectionStatus, ConversationType, ISendMsgOptions, IReceivedMessage, EnableLogL, IPluginGenerator } from '@rongcloud/engine';
@@ -1522,7 +1522,7 @@ declare class RTCContext {
     setRTCTotalRes(roomId: string, message: {
         name: string;
         content: string;
-    }, valueInfo: string, objectName: string, mcuValInfo?: string): Promise<ErrorCode>;
+    }, valueInfo: string, objectName: string, mcuValInfo?: string, cdnValInfo?: string): Promise<ErrorCode>;
     setRTCCDNUris(roomId: string, objectName: string, CDNUris: string): Promise<ErrorCode>;
     getRTCData(roomId: string, keys: string[], isInner: boolean, apiType: RTCApiType): IPromiseResult<KVString>;
     removeRTCData(roomId: string, keys: string[], isInner: boolean, apiType: RTCApiType, message?: {
@@ -1761,6 +1761,10 @@ declare class RCRTCPeerCManager {
      * 北极星上报模块
      */
     private readonly _polarisReport?;
+    /**
+     * context
+     */
+    protected readonly _initOptions?: IRCRTCInitOptions | undefined;
     /**
      * 存储创建的所有 peerC，key 为 pcName，/exchange 请求中 request header 中的 Peer-Connection-Id 值
      */
@@ -1786,7 +1790,11 @@ declare class RCRTCPeerCManager {
     /**
      * 北极星上报模块
      */
-    _polarisReport?: PolarisHttpReporter | undefined);
+    _polarisReport?: PolarisHttpReporter | undefined, 
+    /**
+     * context
+     */
+    _initOptions?: IRCRTCInitOptions | undefined);
     get useMutilPeerC(): boolean;
     /**
      * 根据 track 判断是否为上行
@@ -2239,6 +2247,7 @@ declare abstract class RCAbstractRoom extends EventEmitter {
      */
     protected readonly _useMutilPeerC?: boolean | undefined;
     protected readonly _clientSessionId: string;
+    protected readonly signalRetryTime: number;
     /**
      * 房间保活 rtcPing
      */
@@ -2257,11 +2266,25 @@ declare abstract class RCAbstractRoom extends EventEmitter {
     protected _peerCManager: RCRTCPeerCManager | null;
     protected readonly _invoker: Invoker;
     protected readonly _store: ReadableStore;
+    /**
+     * RCRTCRoom 类的构造函数。
+     * @param {RTCContext} _context - RTC上下文，
+     * @param {IRuntime} _runtime - 运行时
+     * @param {string} _roomId - 房间号
+     * @param {RTCMode} _roomMode - RTC模式，
+     * @param {RCMediaService} _service - RCMediaService
+     * @param {IRCRTCInitOptions} _initOptions - IRCRTCInitOptions
+     * @param {boolean} [isUpgrade] - 是否是升级，如果是升级则不会创建新的peerConnection
+     * @param {boolean} [isMainRoom] - 无论是主房间，主房间都是用户创建的房间，子房间是用户创建的房间。
+     * @param {boolean} [_useMutilPeerC] - 是否使用多个 peerConnections
+     * @param {string} _clientSessionId - 客户端会话 ID，用于标识客户端。
+     * @param {number} signalRetryTime - 发送信号的时间间隔。
+     */
     constructor(_context: RTCContext, _runtime: IRuntime, _roomId: string, _roomMode: RTCMode, _service: RCMediaService, _initOptions: IRCRTCInitOptions, isUpgrade?: boolean, isMainRoom?: boolean, 
     /**
      * 是否使用多 peerConnection
      */
-    _useMutilPeerC?: boolean | undefined, _clientSessionId?: string);
+    _useMutilPeerC?: boolean | undefined, _clientSessionId?: string, signalRetryTime?: number);
     /**
      * 拉取房间数据
      * @param roomId 房间 id
@@ -3005,7 +3028,9 @@ declare class RCRTCPeerConnection extends EventEmitter {
      */
     private readonly _polarisReport?;
     private readonly onTrackTrouble?;
+    protected readonly _initOptions?: IRCRTCInitOptions | undefined;
     static __INNER_EVENT_TRACK_READY__: string;
+    private readonly senderAndReciveSize;
     private readonly _rtcPeerConn;
     private readonly _sdpStrategy;
     reportParser: IStatParser | null;
@@ -3033,7 +3058,7 @@ declare class RCRTCPeerConnection extends EventEmitter {
     /**
      * 北极星上传实例
      */
-    _polarisReport?: PolarisHttpReporter | undefined, onTrackTrouble?: Function | undefined);
+    _polarisReport?: PolarisHttpReporter | undefined, onTrackTrouble?: Function | undefined, _initOptions?: IRCRTCInitOptions | undefined);
     getName(): string;
     getLocalTracks(): RCLocalTrack[];
     private _onConnectionStateChange;
@@ -3046,12 +3071,35 @@ declare class RCRTCPeerConnection extends EventEmitter {
      * @deprecated use RCLocalTrack.setBitrate instead of setBitrate
      */
     setBitrate(max: number, min: number, start?: number): Promise<void>;
+    /**
+     * `createOffer` 是一个创建报价并记录报价 SDP 和 SDP 语义的函数
+     * @param {boolean} iceRestart - 布尔值
+     * @returns 具有两个属性的对象：
+     *   - sdp：SDP 字符串
+     *   - 语义：SDP 语义
+     */
     createOffer(iceRestart: boolean): Promise<IOfferInfo>;
     setRemoteAnswer(answer: string): Promise<RCRTCCode>;
     getLocalTrack(trackId: string): RCLocalTrack | null;
+    /**
+     * 它将本地轨道添加到对等连接。
+     * @param {RCLocalTrack} track - 要添加的本地轨道。
+     */
     addLocalTrack(track: RCLocalTrack): void;
+    /**
+     * 按 ID 删除本地轨道
+     * @param {string} trackId - 要移除的轨道的 ID。
+     * @returns 正在删除的轨道。
+     */
     removeLocalTrackById(trackId: string): void;
+    /**
+     * 它会删除所有本地Track。
+     */
     removeAllLocalTrack(): void;
+    /**
+     * 从对等连接中删除本地轨道。
+     * @param {RCLocalTrack} track - 要删除的本地轨道。
+     */
     removeLocalTrack(track: RCLocalTrack): void;
     private _updateRecvTransceiverMap;
     updateSubRemoteTracks(remoteTracks: RCRemoteTrack[]): void;
@@ -3085,7 +3133,7 @@ declare class RCRTCPeerConnection extends EventEmitter {
     /**
      * 获取缓存的本地质量数据
      */
-    _getCacheStatsData(): IInnerRCRTCStateReport | null | undefined;
+    _getCacheStatsData(): Promise<IInnerRCRTCStateReport | undefined>;
     /**
      * 北极星上报 R3、R4 数据
      */
@@ -3345,6 +3393,7 @@ interface IInnerIcePair extends IRCCandidatePairStat {
      * 上、下行总丢包率
      */
     totalPacketsLost?: number;
+    [key: string]: any;
 }
 /**
  * send track 所有字段
@@ -3812,7 +3861,6 @@ interface IRCRTCInitOptions {
      * 观众拉内置 CDN 资源时是否使用 https，默认为 RCInnerCDNPullIsHttps.HTTPS
      */
     pullInnerCDNUseHttps?: RCInnerCDNPullIsHttps;
-    signalRetryTime?: number;
     /**
      * 音频降噪处理
      * - workletModule 默认值为 https://cdn.ronghub.com/plugin-rtc/wasm/5.0.0-alpha.1/process-worklet.js
@@ -3824,6 +3872,10 @@ interface IRCRTCInitOptions {
         workletWasm?: string;
         isOpen?: boolean;
     };
+    /**
+     * 大会议场景下的北极星节流阀
+     */
+    polarisThrottle?: boolean;
 }
 interface ICameraVideoProfile extends IVideoProfile {
     cameraId?: string;
@@ -4273,6 +4325,19 @@ declare class RCLivingRoom extends RCAbstractRoom {
      * 跨房间连麦管理器
      */
     private _roomPKHandler;
+    /**
+     * 一个构造函数。
+     * @param {RTCContext} context - RTC上下文，
+     * @param {IRuntime} runtime - 运行时
+     * @param {string} roomId - 房间号
+     * @param {RCMediaService} service - RCMediaService
+     * @param {IRCRTCInitOptions} initOptions - IRCRTCInitOptions
+     * @param {RCLivingType} _livingType - RCLivingType.LIVE_ROOM,
+     * @param {boolean} [isUpgrade] - 是否升级房间，如果为真，则表示房间从会议室升级到直播间，会议室关闭。
+     * @param {boolean} [isMainRoom] - 无论是主房间，主房间都是发起呼叫的房间，子房间是接收呼叫的房间。
+     * @param {boolean} [useMutilPeerC] - 是否使用多个 peerConnections
+     * @param {string} [_clientSessionId] - 当前用户的会话 ID。
+     */
     constructor(context: RTCContext, runtime: IRuntime, roomId: string, service: RCMediaService, initOptions: IRCRTCInitOptions, _livingType: RCLivingType, isUpgrade?: boolean, isMainRoom?: boolean, 
     /**
      * 是否使用多 peerConnection
@@ -4363,11 +4428,25 @@ declare class RCLivingRoom extends RCAbstractRoom {
  * 普通音视频房间
  */
 declare class RCRTCRoom extends RCAbstractRoom {
+    /**
+     * 类的构造函数。
+     * @param {RTCContext} context - RTC上下文
+     * @param {IRuntime} runtime - 运行时
+     * @param {string} roomId - 房间号
+     * @param {RCMediaService} service - RCMediaService
+     * @param {IRCRTCInitOptions} initOptions - IRCRTCInitOptions
+     * @param {boolean} [isUpgrade] - 是否升级房间，默认为false
+     * @param {boolean} [isMainRoom] - 无论是主房间，主房间是用户进入的房间，子房间是用户进入主房间后进入的房间。
+     * @param {boolean} [useMutilPeerC] - 是否使用多个 peerConnections
+     * @param {string} [_clientSessionId] - 当前房间的clientSessionId，用于区分当前房间和其他房间。
+     * @param {RTCMode} roomType - RTCMode = RTCMode.RTC,
+     * @param {number} signalRetryTime - 重新连接信令服务器的时间间隔。
+     */
     constructor(context: RTCContext, runtime: IRuntime, roomId: string, service: RCMediaService, initOptions: IRCRTCInitOptions, isUpgrade?: boolean, isMainRoom?: boolean, 
     /**
      * 是否使用多 peerConnection
      */
-    useMutilPeerC?: boolean, _clientSessionId?: string, roomType?: RTCMode);
+    useMutilPeerC?: boolean, _clientSessionId?: string, roomType?: RTCMode, signalRetryTime?: number);
 }
 
 /**