@rongcloud/plugin-rtc 5.6.17 → 5.6.18

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import { EventEmitter, BasicLogger, INaviInfo, EnableLogL, RTCPluginContext, Codec, IPromiseResult, ErrorCode, KVString, IRuntime, IAsyncRes, RCConnectionStatus, ConversationType, ISendMsgOptions, IReceivedMessage, RTCMode as RTCMode$1, IPluginGenerator } from '@rongcloud/engine';
+import { EventEmitter, BasicLogger, INaviInfo, LogL, EnableLogL, RTCPluginContext, Codec, IPromiseResult, ErrorCode, KVString, IRuntime, IAsyncRes, RCConnectionStatus, ConversationType, ISendMsgOptions, IReceivedMessage, RTCMode as RTCMode$1, IPluginGenerator } from '@rongcloud/engine';
 
 /**
  * 错误码，与移动端对齐
@@ -240,6 +240,15 @@ declare abstract class RCTrack extends EventEmitter {
      */
     isOwnerMuted(): boolean;
     protected _element?: HTMLMediaElement;
+    private _validateVolume;
+    /**
+     * 播放前检测
+     */
+    private _validatePlayOptions;
+    /**
+     * 设置播放属性
+     */
+    private _setPlayAttrs;
     /**
      * 播放
      * @param element 用于承载媒体流的元素标签，音频流可传空
@@ -681,6 +690,12 @@ interface IRTCResponse {
      */
     'Request-Id': string;
 }
+interface IExchangeResSubscribeItem {
+    mediaType: RCMediaType.AUDIO_ONLY | RCMediaType.VIDEO_ONLY;
+    msid: string;
+    userId: string;
+    simulcast?: RCStreamType;
+}
 /**
  * /exchange 响应结果
  */
@@ -722,12 +737,7 @@ interface IExchangeResponse extends IRTCResponse {
     /**
      * 订阅成功的资源
      */
-    subscribedList?: {
-        mediaType: RCMediaType.AUDIO_ONLY | RCMediaType.VIDEO_ONLY;
-        msid: string;
-        userId: string;
-        simulcast?: RCStreamType;
-    }[];
+    subscribedList?: IExchangeResSubscribeItem[];
 }
 interface IBroadcastSubReqBody {
     /**
@@ -1867,9 +1877,10 @@ interface IRCRTCInitOptions {
      * * 2 - WARN
      * * 1 - ERROR
      */
-    logLevel?: EnableLogL;
+    logLevel?: LogL.ERROR | LogL.WARN | LogL.INFO | LogL.DEBUG;
     /**
-     * 修改默认的 log 输出函数
+     * （已废弃）~修改默认的 log 输出函数~
+     * @deprecated 5.6.1
      */
     logStdout?: (logLevel: EnableLogL, content: string) => void;
     /**
@@ -2498,6 +2509,9 @@ declare class RTCContext {
     joinRTCRoom(roomId: string, mode: RTCMode, broadcastType?: number, joinType?: RTCJoinType, innerUserDatas?: IRTCUserData, outerUserDatas?: IRTCUserData, supportNtf?: boolean): IPromiseResult<IJoinRTCRoomData>;
     quitRTCRoom(roomId: string): Promise<ErrorCode>;
     getRTCRoomInfo(roomId: string): IPromiseResult<IRTCRoomInfo>;
+    /**
+     * 移动端用来获取副房间资源
+     */
     getRTCUserInfoList(roomId: string): IPromiseResult<IRTCUsers>;
     getRTCUserInfo(roomId: string): IPromiseResult<unknown>;
     removeRTCUserInfo(roomId: string, keys: string[]): Promise<ErrorCode>;
@@ -2681,6 +2695,14 @@ declare class RCMediaService {
      * ping1 ：ping 结果返回最快值
      */
     private setMediaServiceList;
+    /**
+     * 配置 gzip 请求头和请求体
+     */
+    private _openGzip;
+    /**
+     * 处理 request 成功的结果
+     */
+    private _dealRequestSuccessResult;
     /**
      * 发送请求，请求发送若失败，会继续尝试使用后续可用地址直到无地址可用，此时认为请求失败
      * @param path
@@ -2985,6 +3007,18 @@ declare class RCAudienceLivingRoom {
      * 计算新发布和取消发布的合流资源
      */
     private _diffRoomResource;
+    /**
+     * 处理主播资源的新增发布
+     */
+    private _dealPublished;
+    /**
+     * 处理主播资源的取消发布
+     */
+    private _dealUnpublished;
+    /**
+     * 处理主播资源的变更
+     */
+    private _dealModified;
     /**
      * 计算主播发布和取消发布的资源，以及资源的状态变更
     */
@@ -3018,6 +3052,12 @@ declare class RCAudienceLivingRoom {
     private _addPeerCEvent;
     private _getReqHeaders;
     private _exchangeHandle;
+    private _dealSubscribeResult;
+    /**
+     * 去重、转化参数格式为 ISubscribeAttr
+     */
+    private _getParams;
+    private _reportPubOrSubQualityData;
     private _updateSubListHandle;
     /**
      * 对比 cdn_uris 资源
@@ -3046,10 +3086,6 @@ declare class RCAudienceLivingRoom {
         code: RCRTCCode;
         failedList?: ISubscribeAttr[];
     }>;
-    addSubscribeTask(tracks: (RCRemoteTrack | ISubscribeAttr)[]): Promise<{
-        code: RCRTCCode;
-        failedList?: ISubscribeAttr[];
-    }>;
     private __unsubscribe;
     /**
      * 取消订阅资源
@@ -3059,10 +3095,6 @@ declare class RCAudienceLivingRoom {
         code: RCRTCCode;
         failedList?: ISubscribeAttr[];
     }>;
-    addUnsubscribeTask(tracks: RCRemoteTrack[]): Promise<{
-        code: RCRTCCode;
-        failedList?: ISubscribeAttr[];
-    }>;
     /**
      * 退出房间并销毁当前房间实例，退出后该房间的所有方法将不可用
      */
@@ -3180,7 +3212,30 @@ declare class PolarisReporter {
      * @param resourceId userId_11_1_tiny 改为 userId_11_tiny_video
      */
     private _getPolarisTrackId;
-    sendR3R4Data(data: IInnerRCRTCStateReport): Promise<RCSendCode>;
+    /**
+     * 上下行 track 包含的公共字段
+     */
+    private _getBaseData;
+    private _getAudioLevel;
+    private _getBitrate;
+    private _getPacketsLostRate;
+    private _getFrameRate;
+    private _getResolution;
+    private _getJitter;
+    private _getNackCount;
+    private _getPliCount;
+    private _getRTT;
+    private _getTrackState;
+    /**
+     * 发送上行音视频资源数据
+     * @param data peerConnection stats 解析出来业务所需的所有字段
+     */
+    sendR3Data(data: IInnerRCRTCStateReport): Promise<RCSendCode>;
+    /**
+     * 发送下行音视频资源数据
+     * @param data peerConnection stats 解析出来业务所需的所有字段
+     */
+    sendR4Data(data: IInnerRCRTCStateReport): Promise<RCSendCode>;
     /**
      * 加入房间
      */
@@ -3310,6 +3365,14 @@ declare class RCRTCPeerConnection extends EventEmitter {
      * @param listener
      */
     registerReportListener(listener: IRCRTCReportListener | null): void;
+    /**
+     * 组装上行质量报告数据
+     */
+    private _createSenderReport;
+    /**
+     * 组装下行质量报告数据
+     */
+    private _createReceiverReport;
     private _createRCRTCStateReport;
     /**
      * 获取 peerConnection stats 数据并格式化
@@ -3318,7 +3381,6 @@ declare class RCRTCPeerConnection extends EventEmitter {
     private _getStatsData;
     /**
      * 通知用户质量数据、peerConnection 北极星数据上报
-     * @todo
      */
     private _reportHandle;
     /**
@@ -3702,7 +3764,7 @@ declare class RCLivingPKHandler {
     /**
      * 加入 PK 房间回调
      */
-    _onJoinedPKRoom: (roomId: string, traceId: string) => void, _clientSessionId?: string | undefined);
+    _onJoinedPKRoom: (roomId: string, traceId: string) => Promise<void>, _clientSessionId?: string | undefined);
     private _callAppListener;
     /**
      * 收到连麦邀请
@@ -3889,7 +3951,7 @@ declare abstract class RCAbstractRoom extends EventEmitter {
     private _onTrackReady;
     protected _callAppListener(eventType: keyof IRoomEventListener, ...attrs: any[]): void;
     private _onTrackUnpublish;
-    __parseInnerMessage(message: IReceivedMessage, traceId: string): boolean;
+    __parseInnerMessage(message: IReceivedMessage, traceId: string): void;
     /**
      * 被踢出房间通知
      * @param byServer
@@ -4131,7 +4193,7 @@ declare abstract class RCAbstractRoom extends EventEmitter {
     /**
      * 退出 PK 房间
      */
-    protected _quitAllPKRoom(): void;
+    protected _quitAllPKRoom(): Promise<void>;
     getClientSessionId(): string;
 }
 
@@ -4331,19 +4393,6 @@ declare class RCMCUConfigBuilder {
    * @param uri
    */
     removePictureWaterMark(trackId: string, uri: string): RCMCUConfigBuilder;
-    /**
-     * 设置 MCU 混流配置
-     * @param videoList 视频输入混流列表，为 null 代表视频全混流，为空集合代表视频全不混流，否则按照输入列表进行混流
-     * @param audioList 音频输入混流列表，为 null 代表音频全混流，为空集合代表音频全不混流，否则按照输入列表进行混流
-     */
-    /**
-     * 设置 MCU 混流配置
-     * @param roomIds 混流房间列表
-     * @param mediaType 混流媒体类型
-     * @param isAppend 是否为增量混流
-     * * true 为增量混流
-     * * false 为全量覆盖混流
-     */
     /**
      * 重置所有合流配置
      * @since v5.3.7
@@ -4630,6 +4679,14 @@ declare class RCMediaStreamCapture {
         tracks?: (RCScreenVideoTrack | RCScreenAudioTrack)[];
     }>;
     private _createScreenTracks;
+    /**
+     * electron 中取屏幕共享资源
+     */
+    private _createElectronScreenStream;
+    /**
+     * web 浏览器中取屏幕共享资源
+     */
+    private _createWebScreenStream;
     /**
      * 创建 RCLocalAudioTrack 实例
      * @param tag
@@ -4650,6 +4707,7 @@ declare class RCMediaStreamCapture {
         code: RCRTCCode;
         track?: RCLocalVideoTrack;
     }>;
+    private _validateCreateLocalFileTracks;
     /**
      * 根据本地或网络媒体文件资源创建 `RCLocalFileTrack` 实例
      * @param tag 资源标识
@@ -4705,6 +4763,7 @@ declare class RCRTCClient extends RCMediaStreamCapture {
      */
     getCurrentId(): string;
     private _crtRoom;
+    private __joinRoom;
     /**
      * 加入普通音视频房间，加入成功后返回 room 实例、code、userIds、tracks
      * @param {string} roomId - 房间号