@rongcloud/plugin-rtc 5.5.4-alpha.3 → 5.5.5-beem-alpha.1

package/dist/index.d.ts

@@ -1,7 +1,7 @@
 /*
- * RCRTC - v5.5.4-alpha.3
- * CommitId - 3f61ac223f73eedac265c308f3a0f311af3985a7
- * Sun Oct 09 2022 21:12:19 GMT+0800 (China Standard Time)
+ * RCRTC - v5.5.5-beem-alpha.1
+ * CommitId - 4807d9272db7b224e762a75df11762453a730f9e
+ * Thu Oct 13 2022 21:01:14 GMT+0800 (China Standard Time)
  * ©2020 RongCloud, Inc. All rights reserved.
  */
 import { EventEmitter, BasicLogger, INaviInfo, RTCPluginContext, AbsCodec, IPromiseResult, ErrorCode, KVString, IRuntime, IAsyncRes, ConnectionStatus, ConversationType, ISendMsgOptions, IReceivedMessage, EnableLogL, IPluginGenerator } from '@rongcloud/engine';
@@ -540,11 +540,11 @@ declare enum RCRTCPingResult {
  */
 declare enum RCRTCLiveRole {
     /**
-     * 主播
+     * 主播降级
      */
     ANCHOR = 1,
     /**
-     * 观众
+     * 观众升级
      */
     AUDIENCE = 2
 }
@@ -1255,8 +1255,9 @@ declare enum RTCIdentityChangeType {
 }
 
 declare const keymaps: {
-    readonly RtcInput: readonly ["roomType", "broadcastType", "extraInnerData", "needSysChatroom", "identityChangeType", "joinType", "innerDatas", "outerDatas"];
-    readonly RtcUserListOutput: readonly ["users", "token", "sessionId", "roomInfo"];
+    readonly RtcInput: readonly ["roomType", "broadcastType", "extraInnerData", "needSysChatroom", "identityChangeType", "joinType", "innerDatas", "outerDatas", "supportNtf"];
+    readonly RtcOutput: readonly ["version"];
+    readonly RtcUserListOutput: readonly ["users", "token", "sessionId", "roomInfo", "version"];
     readonly SetUserStatusInput: readonly ["status"];
     readonly RtcSetDataInput: readonly ["interior", "target", "key", "value", "objectName", "content"];
     readonly RtcUserSetDataInput: readonly ["valueInfo", "objectName", "content"];
@@ -1280,13 +1281,15 @@ declare const keymaps: {
     readonly RtcCancelInviteInput: readonly ["invitedUserId", "invitedRoomId", "inviteInfo", "inviteSessionId"];
     readonly RtcInviteAnswerInput: readonly ["inviteUserId", "answerCode", "inviteRoomId", "inviteSessionId", "content", "key", "value"];
     readonly RtcEndInviteInput: readonly ["inviteRoomId", "inviteSessionId", "inviteContent", "inviteRoomKeys"];
+    readonly RtcRoomStatusInput: readonly ["version"];
+    readonly RtcRoomStatusOutput: readonly ["bFullStatus", "version", "usersData", "roomStatus"];
     readonly RtcReportSDKInput: readonly ["sdkInfo"];
     readonly RCRTCPBPolaris: readonly ["type", "appKey", "sessionId", "roomId", "roomCreateTime", "userId", "userRole", "joinTime", "signalDataCenter", "r1Info", "r2Info", "r3Info", "r4Info"];
     readonly RCRTCPBR1Info: readonly ["joinTime", "rtcVersion", "imVersion", "platform", "device", "os", "browserName", "browserVersion"];
     readonly RCRTCPBR2Info: readonly ["joinTime", "sendTime", "rtcActionType", "rtcActionStatus", "trackId"];
     readonly RCRTCPBR3Info: readonly ["info"];
     readonly RCRTCPBR4Info: readonly ["info"];
-    readonly RCRTCPBStatusInfo: readonly ["joinTime", "totalBitRate", "appCPUUsage", "systemCPUUsage", "systemCPUFrequency", "networkStatus", "googleRTTNetwork", "ipAddress", "useReceiveBroadBand", "useSendBroadBand", "packetLossCount", "streams"];
+    readonly RCRTCPBStatusInfo: readonly ["joinTime", "receiveTime", "totalBitRate", "appCPUUsage", "systemCPUUsage", "systemCPUFrequency", "networkStatus", "googleRTTNetwork", "ipAddress", "useReceiveBroadBand", "useSendBroadBand", "packetLossCount", "streams"];
     readonly RCRTCPBStreamInfo: readonly ["trackId", "codeName", "volume", "samplingRate", "bitRate", "packetLossRate", "frameRate", "resolution", "blockTime", "jitterData", "nAckCount", "pliCount", "googleRTTTotalTime", "isReceiveFirstFrameRate", "codeType", "isEnabled"];
 };
 declare type RTCKeyMaps = typeof keymaps;
@@ -1356,6 +1359,7 @@ interface IJoinRTCRoomData extends IRTCUsers {
     codeFormat?: string;
     roomCreateTime?: number;
     userJoinTime?: number;
+    version: number;
 }
 interface IReqRoomPKOptions {
     /**
@@ -1545,6 +1549,15 @@ declare class RTCContext {
     endRoomPK(options: IEndRoomPKOptions): Promise<ErrorCode>;
     getRTCJoinedUserInfo(userId: string): Promise<IAsyncRes<IRTCJoinedInfo[]>>;
     pullRTCRoomEntry(roomId: string): Promise<IAsyncRes<IChrmKVPullData>>;
+    /**
+     * 通知拉取房间数据
+     * @param roomId 房间 id
+     * @param version 本地最大得房间数据版本号
+     */
+    pullRTCRoomStatus(roomId: string, version: number): Promise<{
+        code: ErrorCode;
+        data?: IPullRTCRoomStatus;
+    }>;
     decodeRtcNotify(buffer: Uint8Array): {
         time: number;
         type: any;
@@ -1554,7 +1567,23 @@ declare class RTCContext {
     getNaviInfo(): IRTCNaviInfo | null;
     getConnectionStatus(): ConnectionStatus;
     getAppkey(): string;
-    rtcPing(roomId: string, roomMode: number, broadcastType?: number): Promise<ErrorCode>;
+    /** web 端发 rtcPing */
+    webRtcPing(roomId: string, roomMode: RTCMode, broadcastType?: number): Promise<{
+        code: ErrorCode;
+        data?: {
+            version: number;
+        };
+    }>;
+    /**
+     * 协议栈 rtcping 依赖 imlib 编解码数据
+     * web 单独走 imlib 提供的 rtcSignaling 方法，减少对 imlib 的依赖
+     */
+    rtcPing(roomId: string, roomMode: RTCMode, broadcastType?: number): Promise<{
+        code: ErrorCode;
+        data?: {
+            version: number;
+        } | undefined;
+    }> | Promise<IAsyncRes<any>>;
     sendMessage(conversationType: ConversationType, targetId: string, options: ISendMsgOptions): IPromiseResult<IReceivedMessage>;
     registerRTCSignalListener(listener?: ((buffer: Uint8Array) => void) | undefined): void;
     registerConnectionStateChangeListener(listener: (status: ConnectionStatus) => void): void;
@@ -1907,6 +1936,7 @@ declare abstract class ReadableStore {
     protected _CDNUris: ICDNUris | null;
     protected _CDNEnable: boolean;
     protected _destroyed: boolean;
+    protected _roomStatusVersion: number;
     constructor(context: RTCContext, service: RCMediaService, peerMgr: RCRTCPeerCManager, roomId: string, crtUserId: string, roomMode: RTCMode, polarisReport: PolarisHttpReporter, isUpgrade?: boolean | undefined, isMainRoom?: boolean | undefined);
     get useMutilPeerC(): boolean;
     getResourcesByUserId(userId: string): IPublishedResource[] | undefined;
@@ -1927,6 +1957,7 @@ declare abstract class ReadableStore {
     getTrackState(trackId: string): 0 | 1;
     getCDNEnable(): boolean;
     getCDNUris(): ICDNUris | null;
+    getRoomStatusVersion(): number;
 }
 declare class Store extends ReadableStore {
     private _initRemoteTracks;
@@ -1941,6 +1972,7 @@ declare class Store extends ReadableStore {
     setCDNUris(uris: ICDNUris | null): void;
     resetSubscribedList(subscribeList: ISubscribeAttr[]): void;
     resetCollectSubscribeList(collectSubscribeList: ISubscribeAttr[]): void;
+    setRoomStatusVersion(version: number): void;
 }
 
 declare enum CommandPriority {
@@ -2228,6 +2260,11 @@ declare abstract class RCAbstractRoom extends EventEmitter {
      * 是否使用多 peerConnection
      */
     _useMutilPeerC?: boolean | undefined, _clientSessionId?: string);
+    /**
+     * 拉取房间数据
+     * @param roomId 房间 id
+     */
+    private _startPullRTCRoomStatus;
     __innerInit(mode: RTCMode, joinType?: RTCJoinType, livingType?: RCLivingType, innerUserDatas?: IRTCUserData, outerUserDatas?: IRTCUserData): Promise<{
         code: RCRTCCode | ErrorCode;
         data?: IJoinRTCRoomData;
@@ -3048,6 +3085,28 @@ declare class RCRTCPeerConnection extends EventEmitter {
     isDestroyed(): boolean;
 }
 
+/**
+ * 通知拉取到的房间增量数据列表中每一项数据的动作
+ */
+declare enum PullRoomStatusEvent {
+    /**
+     * 人员加入
+     */
+    JOIN = 0,
+    /**
+     * 人员离开
+     */
+    LEAVE = 1,
+    /**
+     * 人员离线
+     */
+    OFFLINE = 2,
+    /**
+     * 资源变动
+     */
+    RESOURCECHANGE = 3
+}
+
 interface IRCTrackBitrate {
     /**
      * 最大码率
@@ -3441,6 +3500,10 @@ interface IR3R4CommonInfo {
      * 用户加入房间的时间
     */
     joinTime?: number;
+    /**
+     * 用户发布数据流的时间（毫秒），暂时由客户端生成，后期如果有问题服务端做兜底处理
+    */
+    receiveTime?: number;
     /**
      * 总码率
     */
@@ -3705,6 +3768,7 @@ interface IRCRTCInitOptions {
      * 观众拉内置 CDN 资源时是否使用 https，默认为 RCInnerCDNPullIsHttps.HTTPS
      */
     pullInnerCDNUseHttps?: RCInnerCDNPullIsHttps;
+    signalRetryTime?: number;
     /**
      * 音频降噪处理
      * - workletModule 默认值为 https://cdn.ronghub.com/plugin-rtc/wasm/5.0.0-alpha.1/process-worklet.js
@@ -3864,6 +3928,79 @@ interface IChrmKVPullData {
     isFullUpdate?: boolean;
     syncTime?: number;
 }
+/**
+ * 通知拉取到的房间数据
+ */
+interface IPullRTCRoomStatus {
+    /**
+     * 是否是全量数据
+     */
+    bFullStatus: boolean;
+    /**
+     * 当前房间的最大版本号
+     */
+    version: number;
+    /**
+     * 如果是全量数据，usersData 不为空,给的是房间全部的人以及发布的资源
+     */
+    usersData: IPullRTCRoomUsersData[];
+    /**
+     * 房间增量数据
+     */
+    roomStatus: IRoomStatus[];
+}
+/**
+ * 通知拉取到的房间增量数据
+ */
+interface IRoomStatus {
+    /**
+     * 用户 id
+     */
+    userId: string;
+    /**
+     * 本次变更的动作类型
+     */
+    event: PullRoomStatusEvent;
+    /**
+     * 本次变更的版本号
+     */
+    time: number;
+    /**
+     * 用户变更的资源，event 为人员加入或资源变动时有值
+     * key 包含 uris、cdn_uris、mcu_uris
+     * value 为字符串数组
+     */
+    userData: {
+        key: string;
+        value: string;
+    }[];
+    /**
+     * 切换角色，0 代表非切换身份发生的加入、退出房间行为
+     */
+    switchRoleType: RCRTCLiveRole | 0;
+    /**
+     * 额外的信息
+     */
+    extra: string;
+}
+/**
+ * 通知拉取到的房间全量数据
+ */
+interface IPullRTCRoomUsersData {
+    /**
+     * 用户 id
+     */
+    userId: string;
+    /**
+     * 房间内所有资源数据
+     * key 包含 uris、cdn_uris、mcu_uris
+     * value 为字符串数组
+     */
+    userData: {
+        key: string;
+        value: string;
+    }[];
+}
 
 /**
  * 自定义合流布局时，背景图片填充方式
@@ -4399,7 +4536,7 @@ declare class RCMediaStreamCapture {
 declare class RCRTCClient extends RCMediaStreamCapture {
     protected readonly _context: RTCContext;
     private readonly _runtime;
-    private readonly _options;
+    private _options;
     private readonly _service;
     constructor(_context: RTCContext, _runtime: IRuntime, _options: IRCRTCInitOptions);
     private _handleMessage;
@@ -4418,14 +4555,15 @@ declare class RCRTCClient extends RCMediaStreamCapture {
     getCurrentId(): string;
     private _crtRoom;
     /**
-     * 加入普通音视频房间
-     * @param roomId
-     * @param joinType 多端处理方式
-     * @param outerUserDatas 业务层设置人员属性
-     * @param useMutilPeerC 是否使用多 peerConnection 发布资源
-     * @param roomType 加入房间的类型 默认参数 RTCMode.RTC
+     * > 加入普通音视频房间，返回房间对象、code、userIds、tracks
+     * @param {string} roomId - 房间号
+     * @param {RTCJoinType} [joinType] - 要加入的房间类型。
+     * @param {IRTCUserData} [outerUserDatas] - 加入房间的用户的用户数据。
+     * @param {boolean} [useMutilPeerC] - 是否使用多点连接，默认为false，即使用单点连接。
+     * @param {RTCMode} roomType - RTCMode = RTCMode.RTC,
+     * @param {number} signalRetryTime - 重新连接信令服务器的时间间隔。
      */
-    joinRTCRoom(roomId: string, joinType?: RTCJoinType, outerUserDatas?: IRTCUserData, useMutilPeerC?: boolean, roomType?: RTCMode): Promise<{
+    joinRTCRoom(roomId: string, joinType?: RTCJoinType, outerUserDatas?: IRTCUserData, useMutilPeerC?: boolean, roomType?: RTCMode, signalRetryTime?: number): Promise<{
         room?: RCRTCRoom;
         code: RCRTCCode;
         userIds?: string[];