@rongcloud/plugin-rtc 5.6.18-alpha.1 → 5.6.19

package/dist/index.d.ts

@@ -97,7 +97,13 @@ declare enum RCRTCCode {
      * @deprecated
      * 流状态为 ended
      */
-    TRACK_READYSTATE_IS_ENDED = 53035
+    TRACK_READYSTATE_IS_ENDED = 53035,
+    /**
+     * 应用 3A 降噪必须在 publish 之前
+     */
+    APPLY_3A_NOISE_WORKLET_BEFORE_PUBLISH = 53036,
+    /** 加载 3A 降噪模块失败 */
+    LOAD_3A_MODULE_FAILED = 53037
 }
 
 /**
@@ -122,8 +128,7 @@ declare enum RCFrameRate {
     FPS_10 = "FPS_10",
     FPS_15 = "FPS_15",
     FPS_24 = "FPS_24",
-    FPS_30 = "FPS_30",
-    FPS_60 = "FPS_60"
+    FPS_30 = "FPS_30"
 }
 
 declare enum RCResolution {
@@ -145,8 +150,6 @@ declare enum RCResolution {
     W960_H720 = "W960_H720",
     W1280_H720 = "W1280_H720",
     W1920_H1080 = "W1920_H1080",
-    W2560_H1440 = "W2560_H1440",
-    W3840_H2160 = "W3840_H2160",
     W144_H176 = "W144_H176",
     W144_H256 = "W144_H256",
     W180_H240 = "W180_H240",
@@ -159,9 +162,7 @@ declare enum RCResolution {
     W480_H848 = "W480_H848",
     W720_H1280 = "W720_H1280",
     W720_H960 = "W720_H960",
-    W1080_H1920 = "W1080_H1920",
-    W1440_H2560 = "W1440_H2560",
-    W2160_H3840 = "W2160_H3840"
+    W1080_H1920 = "W1080_H1920"
 }
 
 /**
@@ -245,6 +246,15 @@ declare abstract class RCTrack extends EventEmitter {
      */
     isOwnerMuted(): boolean;
     protected _element?: HTMLMediaElement;
+    private _validateVolume;
+    /**
+     * 播放前检测
+     */
+    private _validatePlayOptions;
+    /**
+     * 设置播放属性
+     */
+    private _setPlayAttrs;
     /**
      * 播放
      * @param element 用于承载媒体流的元素标签，音频流可传空
@@ -377,13 +387,6 @@ declare class RCLocalAudioTrack extends RCLocalTrack {
      * @param {number[]} args - [分钟，开始]
      */
     setBitrate(max: number, ...args: number[]): void;
-    protected _stopProcess: Function;
-    /**
-     * @override __innerSetMediaStreamTrack
-     * @params {track} MediaStreamTrack 添加音频流
-     * @params {track} undefined        销毁音频流
-     */
-    __innerSetMediaStreamTrack(track: MediaStreamTrack | undefined): void;
 }
 declare class RCLocalVideoTrack extends RCLocalTrack {
     private _isTiny;
@@ -432,16 +435,17 @@ declare class RCLocalFileAudioTrack extends RCLocalFileTrack {
     play(): Promise<{
         code: RCRTCCode;
     }>;
-    protected _stopProcess: Function;
+}
+declare class RCMicphoneAudioTrack extends RCLocalAudioTrack {
+    private _originTrack;
     /**
-     * @override __innerSetMediaStreamTrack
-     * @params {track} MediaStreamTrack 添加音频流
-     * @params {track} undefined        销毁音频流
+     * 应用 3A 降噪模块对麦克风音频流进行处理
      */
+    apply3ANoiseWorklet(): Promise<{
+        code: RCRTCCode;
+    }>;
     __innerSetMediaStreamTrack(track: MediaStreamTrack | undefined): void;
 }
-declare class RCMicphoneAudioTrack extends RCLocalAudioTrack {
-}
 declare class RCCameraVideoTrack extends RCLocalVideoTrack {
 }
 declare class RCScreenVideoTrack extends RCLocalVideoTrack {
@@ -686,6 +690,12 @@ interface IRTCResponse {
      */
     'Request-Id': string;
 }
+interface IExchangeResSubscribeItem {
+    mediaType: RCMediaType.AUDIO_ONLY | RCMediaType.VIDEO_ONLY;
+    msid: string;
+    userId: string;
+    simulcast?: RCStreamType;
+}
 /**
  * /exchange 响应结果
  */
@@ -727,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 {
     /**
@@ -1874,7 +1879,7 @@ interface IRCRTCInitOptions {
      */
     logLevel?: LogL.ERROR | LogL.WARN | LogL.INFO | LogL.DEBUG;
     /**
-     * （已废弃）~修改默认的 log 输出函数~
+     * （已废弃）
      * @deprecated 5.6.1
      */
     logStdout?: (logLevel: EnableLogL, content: string) => void;
@@ -1901,16 +1906,19 @@ interface IRCRTCInitOptions {
      */
     pullInnerCDNUseHttps?: RCInnerCDNPullIsHttps;
     /**
-     * 音频降噪处理
-     * - workletModule 默认值为 https://cdn.ronghub.com/plugin-rtc/wasm/5.0.0-alpha.1/process-worklet.js
-     * - workletWasm 默认值为 https://cdn.ronghub.com/plugin-rtc/wasm/5.0.0-alpha.1/AudioProcessing.wasm
-     * - isOpen 默认值为 false
+     * 3A 模块资源路径配置
+     * @description 建议将资源下载到业务代码工程中，以静态资源形式与页面共同部署，以避免受同源策略或用户网络防火墙策略限制，导致资源获取失败。
+     * * wasmUrl 资源下载地址 `https://cdn.ronghub.com/plugin-rtc/wasm/5.0.0-alpha.2/AudioProcessing.wasm`
+     * * scriptUrl 资源下载默认使用 `https://cdn.ronghub.com/plugin-rtc/wasm/5.0.0-alpha.2/process-worklet.js`
      */
-    audio?: {
-        workletModule?: string;
-        workletWasm?: string;
-        isOpen?: boolean;
+    AAAWorklet?: {
+        wasmUrl: string;
+        scriptUrl: string;
     };
+    /**
+     * @deprecated
+     */
+    audio?: any;
 }
 interface ICameraVideoProfile extends IVideoProfile {
     cameraId?: string;
@@ -2504,6 +2512,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>;
@@ -2687,6 +2698,14 @@ declare class RCMediaService {
      * ping1 ：ping 结果返回最快值
      */
     private setMediaServiceList;
+    /**
+     * 配置 gzip 请求头和请求体
+     */
+    private _openGzip;
+    /**
+     * 处理 request 成功的结果
+     */
+    private _dealRequestSuccessResult;
     /**
      * 发送请求，请求发送若失败，会继续尝试使用后续可用地址直到无地址可用，此时认为请求失败
      * @param path
@@ -2991,6 +3010,18 @@ declare class RCAudienceLivingRoom {
      * 计算新发布和取消发布的合流资源
      */
     private _diffRoomResource;
+    /**
+     * 处理主播资源的新增发布
+     */
+    private _dealPublished;
+    /**
+     * 处理主播资源的取消发布
+     */
+    private _dealUnpublished;
+    /**
+     * 处理主播资源的变更
+     */
+    private _dealModified;
     /**
      * 计算主播发布和取消发布的资源，以及资源的状态变更
     */
@@ -3024,6 +3055,12 @@ declare class RCAudienceLivingRoom {
     private _addPeerCEvent;
     private _getReqHeaders;
     private _exchangeHandle;
+    private _dealSubscribeResult;
+    /**
+     * 去重、转化参数格式为 ISubscribeAttr
+     */
+    private _getParams;
+    private _reportPubOrSubQualityData;
     private _updateSubListHandle;
     /**
      * 对比 cdn_uris 资源
@@ -3178,7 +3215,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>;
     /**
      * 加入房间
      */
@@ -3308,6 +3368,14 @@ declare class RCRTCPeerConnection extends EventEmitter {
      * @param listener
      */
     registerReportListener(listener: IRCRTCReportListener | null): void;
+    /**
+     * 组装上行质量报告数据
+     */
+    private _createSenderReport;
+    /**
+     * 组装下行质量报告数据
+     */
+    private _createReceiverReport;
     private _createRCRTCStateReport;
     /**
      * 获取 peerConnection stats 数据并格式化
@@ -3316,7 +3384,6 @@ declare class RCRTCPeerConnection extends EventEmitter {
     private _getStatsData;
     /**
      * 通知用户质量数据、peerConnection 北极星数据上报
-     * @todo
      */
     private _reportHandle;
     /**
@@ -3700,7 +3767,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;
     /**
      * 收到连麦邀请
@@ -3887,7 +3954,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
@@ -4129,7 +4196,7 @@ declare abstract class RCAbstractRoom extends EventEmitter {
     /**
      * 退出 PK 房间
      */
-    protected _quitAllPKRoom(): void;
+    protected _quitAllPKRoom(): Promise<void>;
     getClientSessionId(): string;
 }
 
@@ -4329,19 +4396,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
@@ -4628,6 +4682,14 @@ declare class RCMediaStreamCapture {
         tracks?: (RCScreenVideoTrack | RCScreenAudioTrack)[];
     }>;
     private _createScreenTracks;
+    /**
+     * electron 中取屏幕共享资源
+     */
+    private _createElectronScreenStream;
+    /**
+     * web 浏览器中取屏幕共享资源
+     */
+    private _createWebScreenStream;
     /**
      * 创建 RCLocalAudioTrack 实例
      * @param tag
@@ -4648,6 +4710,7 @@ declare class RCMediaStreamCapture {
         code: RCRTCCode;
         track?: RCLocalVideoTrack;
     }>;
+    private _validateCreateLocalFileTracks;
     /**
      * 根据本地或网络媒体文件资源创建 `RCLocalFileTrack` 实例
      * @param tag 资源标识
@@ -4703,6 +4766,7 @@ declare class RCRTCClient extends RCMediaStreamCapture {
      */
     getCurrentId(): string;
     private _crtRoom;
+    private __joinRoom;
     /**
      * 加入普通音视频房间，加入成功后返回 room 实例、code、userIds、tracks
      * @param {string} roomId - 房间号
@@ -4868,4 +4932,4 @@ declare const helper: {
     ifSupportScreenShare: typeof ifSupportScreenShare;
 };
 
-export { BackgroundPictureFillMode, IAudienceRoomEventListener, IAudioLevelChangeHandler, ICameraVideoProfile, ICreateLocalTrackOptions, IJoinResCDNInfo, ILiveAudioState, IMCUOutputConfig, IMCUOutputVideoConfig, IMicphoneAudioProfile, IPKEndInfo, IPKInviteAnswerInfo, IPKInviteInfo, IPubSuccessRes, IPublishAttrs, IPublishedResource, IRCCandidatePairStat, IRCRTCInitOptions, IRCRTCReportListener, IRCRTCStateReport, IRCTrackStat, IRTCUserData, IReqResPKOptions, IRoomEventListener, IRoomPKEventListener, ISubscribeAttr, IVideoProfile, MixLayoutMode, MixVideoRenderMode, RCAbstractRoom, RCAudienceClient, RCAudienceLivingRoom, RCAudioBitrate, RCCameraVideoTrack, RCFrameRate, RCInnerCDNPullIsHttps, RCInnerCDNPullKind, RCKickReason, RCLivingRoom, RCLivingType, RCLocalAudioTrack, RCLocalFileAudioTrack, RCLocalFileTrack, RCLocalFileVideoTrack, RCLocalTrack, RCLocalVideoTrack, RCMCUConfigBuilder, RCMediaStreamCapture, RCMediaType, RCMicphoneAudioTrack, RCRTCClient, RCRTCCode, RCRTCLiveRole, RCRTCPingResult, RCRTCRoom, RCRemoteAudioTrack, RCRemoteTrack, RCRemoteVideoTrack, RCResolution, RCScreenAudioTrack, RCScreenVideoTrack, RCTag, RCTrack, RCVideoBitrate, RTCJoinType, device, helper, installer };
+export { BackgroundPictureFillMode, IAudienceRoomEventListener, IAudioLevelChangeHandler, ICameraVideoProfile, ICreateLocalTrackOptions, IJoinResCDNInfo, ILiveAudioState, IMCUOutputConfig, IMCUOutputVideoConfig, IMicphoneAudioProfile, IPKEndInfo, IPKInviteAnswerInfo, IPKInviteInfo, IPubSuccessRes, IPublishAttrs, IPublishedResource, IRCCandidatePairStat, IRCRTCInitOptions, IRCRTCReportListener, IRCRTCStateReport, IRCTrackStat, IRTCUserData, IReqResPKOptions, IRoomEventListener, IRoomPKEventListener, IScreenVideoProfile, ISubscribeAttr, IVideoProfile, MixLayoutMode, MixVideoRenderMode, RCAbstractRoom, RCAudienceClient, RCAudienceLivingRoom, RCAudioBitrate, RCCameraVideoTrack, RCFrameRate, RCInnerCDNPullIsHttps, RCInnerCDNPullKind, RCKickReason, RCLivingRoom, RCLivingType, RCLocalAudioTrack, RCLocalFileAudioTrack, RCLocalFileTrack, RCLocalFileVideoTrack, RCLocalTrack, RCLocalVideoTrack, RCMCUConfigBuilder, RCMediaStreamCapture, RCMediaType, RCMicphoneAudioTrack, RCRTCClient, RCRTCCode, RCRTCLiveRole, RCRTCPingResult, RCRTCRoom, RCRemoteAudioTrack, RCRemoteTrack, RCRemoteVideoTrack, RCResolution, RCScreenAudioTrack, RCScreenVideoTrack, RCTag, RCTrack, RCVideoBitrate, RTCJoinType, device, helper, installer };