@rongcloud/plugin-rtc 5.4.4-alpha.2 → 5.4.4

package/dist/core/tracks/RCLocalTrack.d.ts

@@ -61,6 +61,13 @@ export 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;
 }
 export declare class RCLocalVideoTrack extends RCLocalTrack {
     private _isTiny;
@@ -109,6 +116,13 @@ export declare class RCLocalFileAudioTrack extends RCLocalFileTrack {
     play(): Promise<{
         code: RCRTCCode;
     }>;
+    protected _stopProcess: Function;
+    /**
+     * @override __innerSetMediaStreamTrack
+     * @params {track} MediaStreamTrack 添加音频流
+     * @params {track} undefined        销毁音频流
+     */
+    __innerSetMediaStreamTrack(track: MediaStreamTrack | undefined): void;
 }
 export declare class RCMicphoneAudioTrack extends RCLocalAudioTrack {
 }

package/dist/core/tracks/RCTrack.d.ts

@@ -28,6 +28,11 @@ export declare abstract class RCTrack extends EventEmitter {
      */
     getUserId(): string;
     __innerGetMediaStreamTrack(): MediaStreamTrack | undefined;
+    /**
+     * 它返回 MediaStreamTrack 对象。
+     * @returns 表示媒体源的 MediaStreamTrack 对象。
+     */
+    get streamTrack(): (MediaStreamTrack | undefined);
     /**
      * 获取数据标识
      * @returns

package/dist/core/webrtc/RCRTCPeerCManager.d.ts

@@ -74,6 +74,8 @@ export default class RCRTCPeerCManager {
     private _createOnePeerCItem;
     /**
      * 创建一组 peerC
+     * 为了适应多 peerConnection 的场景做出的冗余设计，对单 peerConnection 进行数组进行封装
+     * 提示：useMutilPeerC 用户自定义的，没有明确场景，必须使用多 peerConnection
      * @param pcName
      * @returns
      */

package/dist/index.d.ts

@@ -1,7 +1,7 @@
 /*
- * RCRTC - v5.4.4-alpha.2
- * CommitId - d4522cc8f360c18bd7c52c4ee73731d9845ffb89
- * Wed Aug 03 2022 17:46:00 GMT+0800 (China Standard Time)
+ * RCRTC - v5.4.4
+ * CommitId - bc1f8f530851278c199d53868ad7c199d465f45e
+ * Tue Aug 09 2022 15:25:48 GMT+0800 (China Standard Time)
  * ©2020 RongCloud, Inc. All rights reserved.
  */
 import { EventEmitter, RTCMode, IRuntime, RTCPluginContext, IJoinRTCRoomData, IReceivedMessage, ErrorCode, RTCJoinType, IRTCUserData, KVString, IServerRTCRoomEntry, LogLevel, IRTCJoinedInfo, IPluginGenerator } from '@rongcloud/engine';
@@ -174,6 +174,11 @@ declare abstract class RCTrack extends EventEmitter {
      */
     getUserId(): string;
     __innerGetMediaStreamTrack(): MediaStreamTrack | undefined;
+    /**
+     * 它返回 MediaStreamTrack 对象。
+     * @returns 表示媒体源的 MediaStreamTrack 对象。
+     */
+    get streamTrack(): (MediaStreamTrack | undefined);
     /**
      * 获取数据标识
      * @returns
@@ -334,6 +339,13 @@ 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;
@@ -382,6 +394,13 @@ declare class RCLocalFileAudioTrack extends RCLocalFileTrack {
     play(): Promise<{
         code: RCRTCCode;
     }>;
+    protected _stopProcess: Function;
+    /**
+     * @override __innerSetMediaStreamTrack
+     * @params {track} MediaStreamTrack 添加音频流
+     * @params {track} undefined        销毁音频流
+     */
+    __innerSetMediaStreamTrack(track: MediaStreamTrack | undefined): void;
 }
 declare class RCMicphoneAudioTrack extends RCLocalAudioTrack {
 }
@@ -573,7 +592,11 @@ declare enum RCRTCMessageType {
     /**
      * 连麦的房间不再了或离线了，主直播房间会收到的消息通知
      */
-    OTHER_ROOM_OFFLINE = "RCRTC:otherRoomOffline"
+    OTHER_ROOM_OFFLINE = "RCRTC:otherRoomOffline",
+    /**
+     * 订阅、取消订阅动作成功
+     */
+    ROOM_TASK_FINISH = "RCRTC:roomTaskFinish"
 }
 
 declare enum RCInnerCDNPushMode {
@@ -1255,6 +1278,18 @@ declare enum RCLivingType {
     AUDIO = 1
 }
 
+declare enum RCCommandKind {
+    Unknow = 0,
+    Publish = 1,
+    UnPublish = 2,
+    JoinRoom = 3,
+    LeaveRoom = 4,
+    UpdateSubscribeTask = 5,
+    SubscribedTask = 6,
+    UnSubscribedTask = 7,
+    AsyncCommand = "AsyncCommand"
+}
+
 declare class RCRTCPeerCManager {
     /**
      * 是否使用多 peerConnection
@@ -1328,6 +1363,8 @@ declare class RCRTCPeerCManager {
     private _createOnePeerCItem;
     /**
      * 创建一组 peerC
+     * 为了适应多 peerConnection 的场景做出的冗余设计，对单 peerConnection 进行数组进行封装
+     * 提示：useMutilPeerC 用户自定义的，没有明确场景，必须使用多 peerConnection
      * @param pcName
      * @returns
      */
@@ -1434,7 +1471,8 @@ declare abstract class ReadableStore {
     /**
      * 已订阅参数
      */
-    protected readonly _subscribedList: ISubscribeAttr[];
+    protected _subscribedList: ISubscribeAttr[];
+    protected _collectSubscribeList: ISubscribeAttr[];
     /**
      * 与 MediaServer 交互需要的 token 信息
      */
@@ -1461,6 +1499,7 @@ declare abstract class ReadableStore {
     getAllUserIds(): string[];
     getRemoteUserIds(): string[];
     getSubscribedList(): ISubscribeAttr[];
+    getCollectSubscribeList(): ISubscribeAttr[];
     getPublishedResourceByTrackId(trackId: string): IPublishedResource | undefined;
     getToken(): string;
     getLocalTrack(trackId: string): RCLocalTrack | null;
@@ -1480,6 +1519,8 @@ declare class Store extends ReadableStore {
     removeRemoteTracks(): void;
     setCDNEnabel(bool: boolean): void;
     setCDNUris(uris: ICDNUris | null): void;
+    resetSubscribedList(subscribeList: ISubscribeAttr[]): void;
+    resetCollectSubscribeList(collectSubscribeList: ISubscribeAttr[]): void;
 }
 
 declare enum CommandPriority {
@@ -1500,6 +1541,11 @@ declare abstract class BaseCommand<RES, STORE = Store> {
      * 获取指令优先级，必要时可 override 此函数
      */
     get priority(): CommandPriority;
+    /**
+     * 它返回命令的种类。
+     * @returns 命令的种类。
+     */
+    get kind(): RCCommandKind;
 }
 
 declare class BaseInvoker<STORE> {
@@ -1526,6 +1572,14 @@ declare class BaseInvoker<STORE> {
     private _execute;
     push<R>(command: BaseCommand<R, STORE>): Promise<R>;
     private _isDestroyed;
+    /**
+     * 查找出 RCCommandKind.AsyncCommand 类型的 Command，并将其从队列中删除
+     * 并使用最新的一次 Command 接管它的 resolve & reject
+     * @param resolve
+     * @param reject
+     * @returns 具有两个属性的对象，resolve 和 reject。
+     */
+    private commandOffset;
     isDestroyed(): boolean;
     destroy(): void;
 }
@@ -1951,6 +2005,12 @@ declare abstract class RCAbstractRoom extends EventEmitter {
         code: RCRTCCode;
         failedList?: ISubscribeAttr[];
     }>;
+    /**
+     * 它将订阅任务添加到队列中。
+     * @param {(RCRemoteTrack | ISubscribeAttr)[]} tracks - (RCRemoteTrack | ISubscribeAttr)[]
+     * @returns 一个用代码和失败列表解析为对象的承诺。
+     */
+    addSubscribeTask(tracks: (RCRemoteTrack | ISubscribeAttr)[]): void;
     /**
      * 取消订阅资源
      * @param tracks 预取消远端资源
@@ -1959,6 +2019,27 @@ declare abstract class RCAbstractRoom extends EventEmitter {
         code: RCRTCCode;
         failedList?: ISubscribeAttr[];
     }>;
+    /**
+     * 它将取消订阅任务添加到队列中。
+     * @param {RCRemoteTrack[]} tracks - 要取消订阅的曲目。
+     * @returns 一个用代码和失败列表解析为对象的承诺。
+     */
+    addUnsubscribeTask(tracks: RCRemoteTrack[]): void;
+    /**
+     * 强制修改订阅列表，仅订阅数组中的资源，取消订阅其他已订阅资源。
+     * 当参数为 `[]` 时，意味着不再订阅任何资源
+     * @param tracks 变更的资源列表
+     */
+    updateSubList(tracks: (RCRemoteTrack | ISubscribeAttr)[]): Promise<{
+        code: RCRTCCode;
+        failedList?: ISubscribeAttr[];
+    }>;
+    /**
+     * 将任务添加到任务队列的函数。
+     * @param {(RCRemoteTrack | ISubscribeAttr)[]} tracks - (RCRemoteTrack | ISubscribeAttr)[]
+     */
+    addUpdateSubscribeListTask(tracks: (RCRemoteTrack | ISubscribeAttr)[]): void;
+    private _onTaskCompleted;
     /**
      * 获取已发布的本地资源
      * @param trackId
@@ -1976,14 +2057,10 @@ declare abstract class RCAbstractRoom extends EventEmitter {
      */
     getRemoteTrack(trackId: string): RCRemoteTrack | null;
     /**
-     * 强制修改订阅列表，仅订阅数组中的资源，取消订阅其他已订阅资源。
-     * 当参数为 `[]` 时，意味着不再订阅任何资源
-     * @param tracks 变更的资源列表
+     * 获取当前已经订阅的全量资源
+     * returns subscribedTracks ISubscribeAttr[]
      */
-    updateSubList(tracks: (RCRemoteTrack | ISubscribeAttr)[]): Promise<{
-        code: RCRTCCode;
-        failedList?: ISubscribeAttr[];
-    }>;
+    get subscribedTracks(): ISubscribeAttr[];
     private _appListener;
     /**
      * 注册事件监听器，多次注册会导致后者覆盖前者，可以通过使用 `registerRoomEventListener(null)` 取消注册
@@ -2246,6 +2323,10 @@ declare class RCAudienceLivingRoom {
         code: RCRTCCode;
         failedList?: ISubscribeAttr[];
     }>;
+    addSubscribeTask(tracks: (RCRemoteTrack | ISubscribeAttr)[]): Promise<{
+        code: RCRTCCode;
+        failedList?: ISubscribeAttr[];
+    }>;
     private __unsubscribe;
     /**
      * 取消订阅资源
@@ -2255,6 +2336,10 @@ declare class RCAudienceLivingRoom {
         code: RCRTCCode;
         failedList?: ISubscribeAttr[];
     }>;
+    addUnsubscribeTask(tracks: RCRemoteTrack[]): Promise<{
+        code: RCRTCCode;
+        failedList?: ISubscribeAttr[];
+    }>;
     /**
      * 退出房间并销毁当前房间实例，退出后该房间的所有方法将不可用
      */
@@ -2888,6 +2973,14 @@ interface IRoomEventListener extends IRCRTCTrackEventListener {
      * 主播和观众切换身份通知
      */
     onSwitchRole?(userId: string, role: RCRTCLiveRole): void;
+    /**
+     * 房间任务完成时调用的函数。
+     * @param code 任务完成后的状态
+     * @param subscribe 订阅成功的列表
+     * @param unsubscribe 取消订阅成功的列表
+     * @param failedList 订阅失败的列表
+     */
+    onTaskCompleted?(code: RCRTCCode, subscribe: ISubscribeAttr[], unsubscribe: ISubscribeAttr[], failedList: ISubscribeAttr[]): void;
 }
 /**
  * RTCClient 初始化配置
@@ -2935,6 +3028,17 @@ interface IRCRTCInitOptions {
      * 观众拉内置 CDN 资源时是否使用 https，默认为 RCInnerCDNPullIsHttps.HTTPS
      */
     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
+     */
+    audio?: {
+        workletModule?: string;
+        workletWasm?: string;
+        isOpen?: boolean;
+    };
 }
 interface ICameraVideoProfile extends IVideoProfile {
     cameraId?: string;