@rongcloud/plugin-rtc 5.6.18 → 5.6.20

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
 }
 
 /**
@@ -198,6 +204,9 @@ declare abstract class RCTrack extends EventEmitter {
      * 当 isMCUTrack 为 true 时，返回空字符串
      */
     getUserId(): string;
+    /**
+     * @private
+     */
     __innerGetMediaStreamTrack(): MediaStreamTrack | undefined;
     /**
      * 它返回 MediaStreamTrack 对象。
@@ -217,6 +226,10 @@ declare abstract class RCTrack extends EventEmitter {
      * @returns
      */
     isReady(): boolean;
+    /**
+     * @private
+     * @param track
+     */
     __innerSetMediaStreamTrack(track: MediaStreamTrack | undefined): void;
     protected _setLocalMuted(bool: boolean): Promise<RCRTCCode>;
     /**
@@ -260,9 +273,13 @@ declare abstract class RCTrack extends EventEmitter {
     }): Promise<{
         code: RCRTCCode;
     }>;
+    /**
+     * @private
+     */
     __innerDestroy(): void;
     /**
      * 释放内存中的 video、audio 标签
+     * @private
      */
     __releaseMediaElement(): void;
     /**
@@ -270,7 +287,7 @@ declare abstract class RCTrack extends EventEmitter {
      * @param {any} element - 您要检查的元素是否为视频元素。
      * @returns 一个布尔值。
      */
-    private __validateVideoNodeName;
+    private _validateVideoNodeName;
 }
 
 declare enum RCAudioBitrate {
@@ -322,10 +339,12 @@ declare abstract class RCLocalTrack extends RCTrack {
      */
     static EVENT_LOCAL_TRACK_END: string;
     /**
+     * @private
      * muted 状态变更通知常量定义
      */
     static __INNER_EVENT_MUTED_CHANGE__: string;
     /**
+     * @private
      * 本地流已销毁
      */
     static __INNER_EVENT_DESTROY__: string;
@@ -334,12 +353,16 @@ declare abstract class RCLocalTrack extends RCTrack {
      */
     private _isDestroyed;
     constructor(logger: BasicLogger, tag: string, userId: string, kind: 'audio' | 'video', track: MediaStreamTrack);
+    protected _onTrackEnded(): void;
     /**
      * @override 重写 RCTrack 父类方法
      * @param bool
      */
     _setLocalMuted(bool: boolean): Promise<RCRTCCode>;
     private _isPublished;
+    /**
+     * @private
+     */
     __innerSetPublished(bool: boolean): void;
     /**
      * 检测本地资源是否已发布
@@ -381,17 +404,14 @@ 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;
     constructor(logger: BasicLogger, tag: string, userId: string, track: MediaStreamTrack, _isTiny?: boolean);
+    /**
+     * @private
+     * @returns
+     */
     __isTiny(): boolean;
     getStreamId(): string;
     getTrackId(): string;
@@ -418,8 +438,8 @@ declare abstract class RCLocalFileTrack extends RCLocalTrack {
      * @param trackId
      * @param video
      */
-    private static __innerSetMapping;
-    private static __innerRemoveMapping;
+    private static _innerSetMapping;
+    private static _innerRemoveMapping;
     constructor(logger: BasicLogger, tag: string, userId: string, kind: 'audio' | 'video', track: MediaStreamTrack, 
     /**
      * 自定义文件流的播放宿主原生，该类型流所持有的 MediaStreamTrack 实例是由该宿主元素 `captureStream` 获取
@@ -436,21 +456,28 @@ declare class RCLocalFileAudioTrack extends RCLocalFileTrack {
     play(): Promise<{
         code: RCRTCCode;
     }>;
-    protected _stopProcess: Function;
+}
+declare class RCMicphoneAudioTrack extends RCLocalAudioTrack {
+    private _originTrack;
+    /**
+     * 应用 3A 降噪模块对麦克风音频流进行处理
+     */
+    apply3ANoiseWorklet(): Promise<{
+        code: RCRTCCode;
+    }>;
     /**
-     * @override __innerSetMediaStreamTrack
-     * @params {track} MediaStreamTrack 添加音频流
-     * @params {track} undefined        销毁音频流
+     * @private
+     * @param track
      */
     __innerSetMediaStreamTrack(track: MediaStreamTrack | undefined): void;
 }
-declare class RCMicphoneAudioTrack extends RCLocalAudioTrack {
-}
 declare class RCCameraVideoTrack extends RCLocalVideoTrack {
 }
 declare class RCScreenVideoTrack extends RCLocalVideoTrack {
+    protected _onTrackEnded(): void;
 }
 declare class RCScreenAudioTrack extends RCLocalAudioTrack {
+    protected _onTrackEnded(): void;
 }
 
 declare abstract class RCRemoteTrack extends RCTrack {
@@ -458,9 +485,14 @@ declare abstract class RCRemoteTrack extends RCTrack {
     /**
      * 根据房间数据更新状态
      * @param value
+     * @private
      */
     __innerSetRemoteMuted(bool: boolean): void;
     private _isSubscribed;
+    /**
+     * @param bool
+     * @private
+     */
     __innerSetSubscribed(bool: boolean): void;
     /**
      * 查看是否已订阅了该远端资源
@@ -480,6 +512,10 @@ declare class RCRemoteAudioTrack extends RCRemoteTrack {
 declare class RCRemoteVideoTrack extends RCRemoteTrack {
     constructor(logger: BasicLogger, tag: string, userId: string, roomId?: string);
     private _isSubTiny;
+    /**
+     * @private
+     * @param bool
+     */
     __innerSetIsTinyTrack(bool: boolean): void;
     /**
      * 是否订阅的小流
@@ -516,12 +552,6 @@ interface IStatParser {
     formatRCRTCStateReport(stats: {
         [key: string]: any;
     }): IInnerRCRTCStateReport;
-    getAudioLevelList(stats: {
-        [key: string]: any;
-    }): {
-        trackId: string;
-        audioLevel: number | null;
-    }[];
 }
 
 declare enum RCInnerCDNPushMode {
@@ -556,7 +586,7 @@ declare enum RTCMode {
     SIP = 4,
     /**
      * 内部 Callplus 呼叫房间类型，请勿使用
-     * @hidden
+     * @private
      */
     CALL = 5
 }
@@ -1879,7 +1909,7 @@ interface IRCRTCInitOptions {
      */
     logLevel?: LogL.ERROR | LogL.WARN | LogL.INFO | LogL.DEBUG;
     /**
-     * （已废弃）~修改默认的 log 输出函数~
+     * （已废弃）
      * @deprecated 5.6.1
      */
     logStdout?: (logLevel: EnableLogL, content: string) => void;
@@ -1906,16 +1936,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;
@@ -3097,6 +3130,7 @@ declare class RCAudienceLivingRoom {
     }>;
     /**
      * 退出房间并销毁当前房间实例，退出后该房间的所有方法将不可用
+     * @private
      */
     __destroy(quitRoom: boolean): Promise<void>;
     /**
@@ -3111,6 +3145,7 @@ declare class RCAudienceLivingRoom {
     getLocalTrack(trackId: string): RCRemoteTrack;
     /**
      * 断线重连后处理逻辑, SDK 内部处理调用
+     * @private
      */
     __onReconnected(): Promise<void>;
     /**
@@ -3931,6 +3966,9 @@ declare abstract class RCAbstractRoom extends EventEmitter {
      * @param roomId 房间 id
      */
     private _startPullRTCRoomStatus;
+    /**
+     * @private
+     */
     __innerInit(mode: RTCMode, joinType?: RTCJoinType, livingType?: RCLivingType, innerUserDatas?: IRTCUserData, outerUserDatas?: IRTCUserData, traceId?: string): Promise<{
         code: RCRTCCode | ErrorCode;
         data?: IJoinRTCRoomData;
@@ -3951,12 +3989,16 @@ declare abstract class RCAbstractRoom extends EventEmitter {
     private _onTrackReady;
     protected _callAppListener(eventType: keyof IRoomEventListener, ...attrs: any[]): void;
     private _onTrackUnpublish;
+    /**
+     * @private
+     */
     __parseInnerMessage(message: IReceivedMessage, traceId: string): void;
     /**
      * 被踢出房间通知
      * @param byServer
      * * 当值为 false 时，说明本端 rtcPing 超时
      * * 当值为 true 时，说明本端收到被踢出房间通知
+     * @private
      */
     __kickoff(byServer: boolean, content?: IRCRTCKickContent): Promise<void>;
     private _rtcpeerClosed;
@@ -4070,6 +4112,7 @@ declare abstract class RCAbstractRoom extends EventEmitter {
     isDestroyed(): boolean;
     /**
      * 退出并销毁当前房间实例，退出后该房间的所有方法将不可用
+     * @private
      */
     __destroy(quitRoom: boolean): Promise<void>;
     /**
@@ -4179,6 +4222,10 @@ declare abstract class RCAbstractRoom extends EventEmitter {
     /**
      * 断线重连后尝试补发断线过程中的通知信息
      */
+    /**
+     * @private
+     * @param livingType
+     */
     __onReconnected(livingType?: RCLivingType): void;
     private _onAudioMuteChange;
     private _onVideoMuteChange;
@@ -4407,6 +4454,9 @@ declare class RCMCUConfigBuilder {
     flush(reset?: boolean): Promise<{
         code: RCRTCCode;
     }>;
+    /**
+     * @private
+     */
     __innerGetValues(): IMCUConfig;
 }
 
@@ -4435,12 +4485,15 @@ declare class RCLivingRoom extends RCAbstractRoom {
     constructor(context: RTCContext, runtime: IRuntime, roomId: string, service: RCMediaService, initOptions: IRCRTCInitOptions, _livingType: RCLivingType, isUpgrade?: boolean, isMainRoom?: boolean, _clientSessionId?: string);
     private _initRoomPKHandler;
     /**
-     * @override
+     * @private
      */
     __innerInit(mode: RTCMode, joinType?: RTCJoinType, livingType?: RCLivingType, innerUserDatas?: IRTCUserData, outerUserDatas?: IRTCUserData, traceId?: string): Promise<{
         code: RCRTCCode | ErrorCode;
         data?: IJoinRTCRoomData;
     }>;
+    /**
+     * @private
+     */
     __innerInitByIdentityChange(traceId: string): Promise<ErrorCode>;
     /**
      * 增量发布资源，若发布的资源 tag 及媒体类型重复，后者将覆盖前者进行发布。
@@ -4477,10 +4530,12 @@ declare class RCLivingRoom extends RCAbstractRoom {
     /**
      * 返回 CDN 是否可用
      * @returns boolean
+     * @private
      */
     __getCDNEnable(): boolean;
     /**
      * 返回 CDN 推送模式: 自动 or 手动
+     * @private
      */
     __getCDNPushMode(): RCInnerCDNPushMode | undefined;
     /**
@@ -4929,4 +4984,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 };