@rongcloud/plugin-rtc 5.3.0-rtc-roompk.1 → 5.3.0

package/dist/index.d.ts

@@ -1,10 +1,10 @@
 /*
- * RCRTC - v5.3.0-rtc-roompk.1
- * CommitId - 381b45b74bd1cee88cf1e6e79108809734bb17ea
- * Sat Dec 25 2021 01:21:26 GMT+0800 (China Standard Time)
+ * RCRTC - v5.3.0
+ * CommitId - 0fcc19dd9364cd4effa9d9ad18172b0519bb4419
+ * Fri Jan 07 2022 16:25:27 GMT+0800 (China Standard Time)
  * ©2020 RongCloud, Inc. All rights reserved.
  */
-import { EventEmitter, LogLevel, RTCMode, IRuntime, RTCPluginContext, IServerRTCRoomEntry, IReceivedMessage, IJoinRTCRoomData, KVString, RTCJoinType, IRTCJoinedInfo, IPluginGenerator } from '@rongcloud/engine';
+import { EventEmitter, LogLevel, RTCMode, IRuntime, RTCPluginContext, IServerRTCRoomEntry, IReceivedMessage, ErrorCode, IJoinRTCRoomData, KVString, RTCJoinType, IRTCJoinedInfo, IPluginGenerator } from '@rongcloud/engine';
 export { RTCJoinType } from '@rongcloud/engine';
 
 /**
@@ -912,7 +912,10 @@ interface IAudioLevelChangeHandler {
 declare type RoomData = {
     [userId: string]: IPublishedResource[];
 };
-interface IReqRoomPKOptions {
+/**
+ * 业务层发起连麦、响应连麦可选参数定义
+ */
+interface IReqResPKOptions {
     autoMix?: boolean;
     extra?: string;
 }
@@ -936,12 +939,18 @@ interface IPKInviteeBaseInfo {
      */
     inviteeUserId: string;
 }
+/**
+ * 业务层监听收到连麦邀请、取消连麦的字段
+ */
 interface IPKInviteInfo extends IPKInviterBaseInfo {
     /**
      * 邀请额外信息
      */
     extra?: string;
 }
+/**
+ * 业务层监听收到连麦应答的字段
+ */
 interface IPKInviteAnswerInfo extends IPKInviterBaseInfo, IPKInviteeBaseInfo {
     /**
      * 是否同意邀请
@@ -952,6 +961,9 @@ interface IPKInviteAnswerInfo extends IPKInviterBaseInfo, IPKInviteeBaseInfo {
      */
     extra?: string;
 }
+/**
+ * 业务层监听收到连麦结束的字段
+ */
 interface IPKEndInfo {
     /**
      * 发起结束的房间 ID
@@ -963,18 +975,12 @@ interface IPKEndInfo {
     endUserId: string;
 }
 /**
- * 观众加房间返回给客户的数据
+ * 观众加房间返回给客户的 CDN 信息
  */
-interface IAudienceJoinRoomResInfo {
-    remoteUserIds: string[];
-    remoteRTCTracks: RCRemoteTrack[];
-    remoteMCUTracks: RCRemoteTrack[];
-    remoteTracks: RCRemoteTrack[];
-    CDNUris: {
-        resolution?: RCResolution;
-        fps?: RCFrameRate;
-        CDNEnable?: boolean;
-    };
+interface IJoinResCDNInfo {
+    resolution?: RCResolution;
+    fps?: RCFrameRate;
+    CDNEnable?: boolean;
 }
 
 declare enum RCInnerCDNPushMode {
@@ -2088,11 +2094,11 @@ declare class RCRTCPeerConnection extends EventEmitter {
 declare type IOnRecvPKMsg = (msg: IReceivedMessage) => void;
 interface IRoomPKEventListener {
     /**
-     * 收到连麦 PK 邀请
+     * 收到连麦邀请
      */
     onRequestJoinOtherRoom: (info: IPKInviteInfo) => {};
     /**
-     * 收到连麦 PK 邀请取消
+     * 收到取消连麦邀请
      */
     onCancelRequestOtherRoom: (info: IPKInviteInfo) => {};
     /**
@@ -2150,50 +2156,70 @@ declare class RCLivingPKHandler {
      */
     _onLeavePKRoom: (roomId: string) => void);
     private _callAppListener;
+    /**
+     * 收到连麦邀请
+     */
     private _onInvite;
+    /**
+     * 收到取消连麦
+     */
     private _onCancelInvite;
     private _onInviteTimeout;
+    /**
+     * 收到响应连麦
+     */
     private _onInviteAnswer;
+    /**
+     * 收到连麦结束
+     */
     private _onPKEnd;
     /**
      * 处理跨房间连麦相关消息
      */
     private _onRecvPKMsg;
     /**
-     * 跨房间连麦 PK 事件注册
+     * 注册跨房间连麦监听事件
      */
     registerRoomPKEventListener(listener: IRoomPKEventListener): void;
     /**
      * 发起跨房间连麦请求
-     * @param inviteeRoomId 被邀请者所处的房间 ID
-     * @param inviteeUserId 被邀请者 ID
-     * @param options.autoMix 被邀请者的发布的资源在服务侧是否自动合流
-     * @param options.extra 拓展字段，用于邀请数据透传
+     * @param inviteeRoomId 被邀请者所处的房间 roomId
+     * @param inviteeUserId 被邀请者 userId
+     * @param options.autoMix 是否要把邀请者发布的资源，合并到被邀请者房间内的 MCU 流中
+     * @param options.extra 拓展字段，可随邀请连麦消息透传给被邀请者
      */
-    requestJoinOtherRoom(inviteeRoomId: string, inviteeUserId: string, options?: IReqRoomPKOptions): Promise<{
-        code: RCRTCCode;
+    requestJoinOtherRoom(inviteeRoomId: string, inviteeUserId: string, options?: IReqResPKOptions): Promise<{
+        code: RCRTCCode | ErrorCode;
     }>;
     /**
-     * 取消跨房间连麦 PK 请求
+     * 取消跨房间连麦请求
+     * @param inviteeRoomId 被邀请者所处的房间 roomId
+     * @param inviteeUserId 被邀请者 userId
+     * @param extra 附加信息，可随取消邀请连麦消息透传给被邀请者
      */
     cancelRequestJoinOtherRoom(inviteeRoomId: string, inviteeUserId: string, extra?: string): Promise<{
-        code: RCRTCCode;
+        code: RCRTCCode | ErrorCode;
     }>;
     /**
-     * 跨房间连麦 PK 响应
+     * 响应跨房间连麦请求
+     * @param inviterRoomId 邀请者所处的房间 roomId
+     * @param inviterUserId 邀请者 userId
+     * @param agree 是否同意连麦
+     * @param options.autoMix 是否要把被邀请者发布的资源，合并到邀请者房间内的 MCU 流中
+     * @param options.extra 附加信息，可随响应连麦消息透传给邀请者
      */
-    responseJoinOtherRoom(inviterRoomId: string, inviterUserId: string, agree: boolean, options?: IReqRoomPKOptions): Promise<{
-        code: RCRTCCode;
+    responseJoinOtherRoom(inviterRoomId: string, inviterUserId: string, agree: boolean, options?: IReqResPKOptions): Promise<{
+        code: RCRTCCode | ErrorCode;
     }>;
     /**
-     * 结束跨房间连麦 PK
-     * @param roomId 需要退出 PK 的房间 ID
+     * 结束跨房间连麦
+     * @param roomId 需要结束连麦的房间 roomId
      */
     private _quitRoomPK;
     private _relaseCrtRoom;
     /**
-     * 加入 PK 直播房间
-     * @roomId PK 房间 ID
+     * 加入副直播房间
+     * @roomId 副房间的 roomId
      */
     joinOtherRoom(roomId: string): Promise<{
         code: RCRTCCode;
@@ -2203,14 +2229,16 @@ declare class RCLivingPKHandler {
         CDNEnable?: boolean;
     }>;
     /**
-     * 退出 PK 直播房间房间
-     * @param room 要离开的 PK 房间 room 实例
+     * 退出副房间
+     * @param room 要退出的副房间的 room 实例
+     * @param isQuitPK 是否要结束连麦
      */
     leaveOtherRoom(room: RCLivingRoom, isQuitPK?: boolean): Promise<{
         code: RCRTCCode;
     }>;
     /**
-     * 获取 _PKInfo
+     * 获取连麦信息
+     * @param roomId 连麦房间的 roomId
      */
     getPKInfo(roomId: string): {
         inviteSessionId: string;
@@ -2221,7 +2249,7 @@ declare class RCLivingPKHandler {
         inviteeUserAutoMix?: boolean | undefined;
     };
     /**
-     * 获取已加入的 PK 房间
+     * 获取已加入的副房间
      */
     getJoinedPKRooms(): {
         [roomId: string]: RCLivingRoom;
@@ -2453,6 +2481,14 @@ declare abstract class RCAbstractRoom {
         liveUrl?: string;
     }>;
     private __publish;
+    /**
+     * 获取跨房间连麦需携带参数 pushOtherRooms 的值
+     */
+    protected _getPushOtherRoomsParams(): {
+        roomId: string;
+        sessionId: string;
+        autoMix: boolean;
+    }[] | undefined;
     /**
      * ice 断线后，尝试重新走 exchange
      */
@@ -2569,15 +2605,18 @@ declare abstract class RCAbstractRoom {
      * 销毁远端资源
      */
     private _removeRemoteTracks;
+    /**
+     * 存储连麦监听事件
+     */
     private _onRecvPKMsg;
     /**
      * 注册 PK 业务监听方法
      */
-    protected _registerPKMsgListener(listener: IOnRecvPKMsg): void;
+    protected _registerPKMsgListener(listener: IOnRecvPKMsg | null): void;
     /**
      * 退出 PK 房间
      */
-    protected _quitPKRoom(): void;
+    protected _quitAllPKRoom(): void;
 }
 
 /**
@@ -2778,7 +2817,9 @@ declare class RCLivingRoom extends RCAbstractRoom {
     /**
      * 获取 MCU 配置构建对象
      */
-    getMCUConfigBuilder(): RCMCUConfigBuilder;
+    getMCUConfigBuilder(): RCMCUConfigBuilder | {
+        code: RCRTCCode;
+    };
     /**
      * 接收 MCU 配置并向 MediaServer 提交
      * @param data
@@ -2849,23 +2890,26 @@ declare class RCLivingRoom extends RCAbstractRoom {
      * 加入 PK 房间回调
      */
     private _onJoinedPKRoom;
+    /**
+     * 离开 PK 房间后，如果参与过连麦，pushOtherRooms 需去掉退出的连麦房间配置，重新和 mediaServer 交互
+     */
     private _onLeavePKRoom;
     /**
      * 携带 pushOtherRooms 与 mediaServer 重新交互
-     * @param roomId 副房间 roomId
      */
     private _exchangeWithPushOtherRoom;
     /**
      * 获取 PK 业务处理器
+     * @since version 5.3.0
      */
     getRoomPKHandler(): {
         code: RCRTCCode;
         roomPKHandler?: RCLivingPKHandler;
     };
     /**
-     * 退出 PK 房间
+     * 退出所有连麦房间
      */
-    protected _quitPKRoom(): void;
+    protected _quitAllPKRoom(): void;
 }
 
 /**
@@ -2952,6 +2996,10 @@ declare class RCRTCClient {
     private readonly _service;
     constructor(_context: RTCPluginContext, _runtime: IRuntime, _options: IRCRTCInitOptions);
     private _handleMessage;
+    /**
+     * 获取加入的连麦房间
+     */
+    private _getJoinedPKRoomList;
     /**
      * 获取当前用户 Id，若 IM 未连接，这返回 `''`
      * @returns
@@ -2987,7 +3035,6 @@ declare class RCRTCClient {
      * 获取直播观众客户端
      */
     getAudienceClient(): RCAudienceClient;
-    private _getJoinedPKRooms;
     private _onIMStatusChange;
     private _onIMDisconnect;
     private _onIMUninit;
@@ -3098,7 +3145,10 @@ declare class RCRTCClient {
     joinLivingRoomAsAudience(roomId: string, livingType: RCLivingType): Promise<{
         room?: RCAudienceLivingRoom;
         code: RCRTCCode;
-        remoteInfo?: IAudienceJoinRoomResInfo;
+        userIds?: string[];
+        RTCTracks?: RCRemoteTrack[];
+        MCUTracks?: RCRemoteTrack[];
+        CDNUris?: IJoinResCDNInfo;
     }>;
     /**
      * 观众退出并销毁当前房间实例，退出后该房间的所有方法将不可用
@@ -3113,6 +3163,8 @@ declare class RCRTCClient {
     upgradeToAnchorRoom(room: RCAudienceLivingRoom): Promise<{
         room?: RCLivingRoom;
         code: RCRTCCode;
+        userIds?: string[];
+        tracks?: RCRemoteTrack[];
     }>;
     /**
      * 降级为观众房间
@@ -3121,7 +3173,10 @@ declare class RCRTCClient {
     downgradeToAudienceRoom(room: RCLivingRoom): Promise<{
         room?: RCAudienceLivingRoom;
         code: RCRTCCode;
-        remoteInfo?: IAudienceJoinRoomResInfo;
+        userIds?: string[];
+        RTCTracks?: RCRemoteTrack[];
+        MCUTracks?: RCRemoteTrack[];
+        CDNUris?: IJoinResCDNInfo;
     }>;
     /**
      * 获取在房间内用户信息
@@ -3180,4 +3235,4 @@ declare const helper: {
     ifSupportScreenShare: typeof ifSupportScreenShare;
 };
 
-export { BackgroundPictureFillMode, ICameraVideoProfile, IMCUOutputConfig, IMCUOutputVideoConfig, IMicphoneAudioProfile, IPKEndInfo, IPKInviteAnswerInfo, IPKInviteInfo, IPublishAttrs, IPublishedResource, IRCCandidatePairStat, IRCRTCInitOptions, IRCRTCReportListener, IRCRTCStateReport, IRCTrackStat, IRoomEventListener, IRoomPKEventListener, ISubscribeAttr, IVideoProfile, MixLayoutMode, MixVideoRenderMode, RCAbstractRoom, RCAudienceClient, RCAudienceLivingRoom, RCCameraVideoTrack, RCFrameRate, RCInnerCDNPullIsHttps, RCInnerCDNPullKind, RCKickReason, RCLivingRoom, RCLivingType, RCLocalAudioTrack, RCLocalFileAudioTrack, RCLocalFileTrack, RCLocalFileVideoTrack, RCLocalTrack, RCLocalVideoTrack, RCMCUConfigBuilder, RCMediaType, RCMicphoneAudioTrack, RCRTCClient, RCRTCCode, RCRTCLiveRole, RCRTCPingResult, RCRTCRoom, RCRemoteAudioTrack, RCRemoteTrack, RCRemoteVideoTrack, RCResolution, RCScreenVideoTrack, RCTag, RCTrack, device, helper, installer };
+export { BackgroundPictureFillMode, ICameraVideoProfile, IMCUOutputConfig, IMCUOutputVideoConfig, IMicphoneAudioProfile, IPKEndInfo, IPKInviteAnswerInfo, IPKInviteInfo, IPublishAttrs, IPublishedResource, IRCCandidatePairStat, IRCRTCInitOptions, IRCRTCReportListener, IRCRTCStateReport, IRCTrackStat, IReqResPKOptions, IRoomEventListener, IRoomPKEventListener, ISubscribeAttr, IVideoProfile, MixLayoutMode, MixVideoRenderMode, RCAbstractRoom, RCAudienceClient, RCAudienceLivingRoom, RCCameraVideoTrack, RCFrameRate, RCInnerCDNPullIsHttps, RCInnerCDNPullKind, RCKickReason, RCLivingRoom, RCLivingType, RCLocalAudioTrack, RCLocalFileAudioTrack, RCLocalFileTrack, RCLocalFileVideoTrack, RCLocalTrack, RCLocalVideoTrack, RCMCUConfigBuilder, RCMediaType, RCMicphoneAudioTrack, RCRTCClient, RCRTCCode, RCRTCLiveRole, RCRTCPingResult, RCRTCRoom, RCRemoteAudioTrack, RCRemoteTrack, RCRemoteVideoTrack, RCResolution, RCScreenVideoTrack, RCTag, RCTrack, device, helper, installer };