@rongcloud/plugin-rtc 5.6.6 → 5.6.8

package/dist/index.d.ts

@@ -1,7 +1,7 @@
 /*
- * RCRTC - v5.6.6
- * CommitId - fc1865a049a26e89d0eb7e4cc4c2cbed81c19a38
- * Tue Dec 20 2022 17:25:33 GMT+0800 (China Standard Time)
+ * RCRTC - v5.6.8
+ * CommitId - 5b57db6e6132740cd12ae9f67466cab1090ce82c
+ * Fri Jan 06 2023 15:07:57 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';
@@ -1558,6 +1558,16 @@ declare class RTCContext {
     }): void;
 }
 
+/**
+ * mediaServer 交互数据
+ */
+interface IMediaServerQualityData {
+    rsid: string;
+    rsdur: number;
+    msa: string;
+    rscod: number;
+}
+
 declare class RCMediaService {
     private readonly _runtime;
     private readonly _context;
@@ -1601,6 +1611,7 @@ declare class RCMediaService {
     private static detectValidMinute;
     static jwtToken: string;
     private _msList;
+    private _qualityMsList;
     constructor(_runtime: IRuntime, _context: RTCContext, 
     /**
      * 自定义 MediaServer 地址，当有值时，不再使用导航内的地址
@@ -1640,6 +1651,7 @@ declare class RCMediaService {
     exchange(headers: IRTCReqHeader, body: IExchangeReqBody, traceId: string, isNeedUpdateMsas?: boolean): Promise<{
         code: RCRTCCode;
         data?: IExchangeResponse | undefined;
+        qualityMsList?: IMediaServerQualityData[] | undefined;
     }>;
     /**
      * 退出房间
@@ -1651,6 +1663,7 @@ declare class RCMediaService {
     broadcastSubscribe(headers: IRTCReqHeader, body: IBroadcastSubReqBody): Promise<{
         code: RCRTCCode;
         data?: IBroadcastSubRespBody | undefined;
+        qualityMsList?: IMediaServerQualityData[] | undefined;
     }>;
     /**
      * 观众端退出订阅
@@ -1712,6 +1725,8 @@ declare class RCRTCPeerConnection extends EventEmitter {
     protected readonly _initOptions?: IRCRTCInitOptions | undefined;
     static __INNER_EVENT_TRACK_READY__: string;
     static __INNER_AUDIOLEVEL_CHANGE__: string;
+    static __INNER_ICE_STATE_CHANGE__: string;
+    static __INNER_ICE_CONNECTED__: string;
     private readonly senderAndReciveSize;
     private readonly _rtcPeerConn;
     private readonly _sdpStrategy;
@@ -2366,6 +2381,17 @@ declare class RCLivingPKHandler {
     };
 }
 
+declare enum RCKickReason {
+    /**
+     * Server 主动踢（掉 Server API 踢出）
+     */
+    SERVER_KICK = 1,
+    /**
+     * 其他设备登陆后，本端被踢
+     */
+    OTHER_KICK = 2
+}
+
 type ResourceMsgContent = {
     /**
      * 旧版本兼容参数，当收到非 `RTCMessageName.TOTAL_CONTENT_RESOURCE` 时：
@@ -2413,6 +2439,7 @@ declare abstract class RCAbstractRoom extends EventEmitter {
     protected _peerCManager: RCRTCPeerCManager | null;
     protected readonly _invoker: Invoker;
     protected readonly _store: ReadableStore;
+    private readonly _reportMediaActionLogger;
     /**
      * RCRTCRoom 类的构造函数。
      * @param {RTCContext} _context - RTC上下文，
@@ -2473,7 +2500,7 @@ declare abstract class RCAbstractRoom extends EventEmitter {
      * @param messageType 消息类型
      * @param userId 消息发送者
      */
-    protected _resourceHandle(content: ResourceMsgContent, messageType: RCRTCMessageType.PUBLISH | RCRTCMessageType.UNPUBLISH | RCRTCMessageType.MODIFY | RCRTCMessageType.TOTAL_CONTENT_RESOURCE, userId: string, traceId: string): Promise<void>;
+    protected _resourceHandle(content: ResourceMsgContent, messageType: RCRTCMessageType.PUBLISH | RCRTCMessageType.UNPUBLISH | RCRTCMessageType.MODIFY | RCRTCMessageType.TOTAL_CONTENT_RESOURCE, userId: string, sentTime: number, traceId: string): Promise<void>;
     private _onTrackPublish;
     /**
      * 处理 `RCRTCMessageType.STATE` 消息
@@ -2871,6 +2898,15 @@ declare class RCAudienceLivingRoom {
     private _pullTime;
     private _store;
     private _crtUserId;
+    private readonly _reportMediaActionLogger;
+    /**
+     * 行为开始时间
+     */
+    private _actionStartTime;
+    /**
+     * track 对应的 mediaServer 信息
+     */
+    private _trackMediaMap;
     constructor(_context: RTCContext, _runtime: IRuntime, _initOptions: IRCRTCInitOptions, _roomId: string, _joinResData: {
         token: string;
         kvEntries: IServerRTCRoomEntry[];
@@ -3262,17 +3298,6 @@ declare enum RCInnerCDNPullIsHttps {
     HTTPS = 1
 }
 
-declare enum RCKickReason {
-    /**
-     * Server 主动踢（掉 Server API 踢出）
-     */
-    SERVER_KICK = 1,
-    /**
-     * 其他设备登陆后，本端被踢
-     */
-    OTHER_KICK = 2
-}
-
 declare enum RCRTCPingResult {
     SUCCESS = "Success",
     FAIL = "Fail"
@@ -4031,8 +4056,26 @@ interface ICameraVideoProfile extends IVideoProfile {
     faceMode?: 'user' | 'environment';
 }
 interface IMicphoneAudioProfile {
+    /**
+     * 指定采录的 AudioInputDevice
+     */
     micphoneId?: string;
+    /**
+     * 音频采样率
+     */
     sampleRate?: number;
+    /**
+     * 噪声抑制开关，未配置时以浏览器默认行为为准
+     */
+    noiseSuppression?: boolean;
+    /**
+     * 回声消除开关，未配置时以浏览器默认行为为准
+     */
+    echoCancellation?: boolean;
+    /**
+     * 自动增益开关，未配置时以浏览器默认行为为准
+     */
+    autoGainControl?: boolean;
 }
 interface ICreateLocalTrackOptions {
     /**
@@ -4492,7 +4535,7 @@ declare class RCLivingRoom extends RCAbstractRoom {
      * 是否使用多 peerConnection
      */
     useMutilPeerC?: boolean, _clientSessionId?: string);
-    private _initAfterCatchRoomData;
+    private _initRoomPKHandler;
     /**
      * @override
      */
@@ -4532,11 +4575,7 @@ declare class RCLivingRoom extends RCAbstractRoom {
      */
     protected _resourceHandle(content: ResourceMsgContent & {
         cdn_uris?: ICDNUris[];
-    }, messageType: RCRTCMessageType.PUBLISH | RCRTCMessageType.UNPUBLISH | RCRTCMessageType.MODIFY | RCRTCMessageType.TOTAL_CONTENT_RESOURCE, userId: string, traceId: string): Promise<void>;
-    /**
-     * 观众切换为主播后直接处理人员变更及资源变更
-     */
-    protected _afterChangedRole(data: IJoinRTCRoomData, traceId: string): void;
+    }, messageType: RCRTCMessageType.PUBLISH | RCRTCMessageType.UNPUBLISH | RCRTCMessageType.MODIFY | RCRTCMessageType.TOTAL_CONTENT_RESOURCE, userId: string, sentTime: number, traceId: string): Promise<void>;
     /**
      * 返回 CDN 是否可用
      * @returns boolean
@@ -4929,6 +4968,7 @@ declare class RCRTCClient extends RCMediaStreamCapture {
         code: RCRTCCode;
         userIds?: string[];
         tracks?: RCRemoteTrack[];
+        CDNEnable?: boolean;
     }>;
     /**
      * 降级为观众房间