@rongcloud/engine 5.4.5 → 5.5.0

package/index.d.ts

@@ -239,22 +239,16 @@ declare class RongStreamWriter {
     getBytesArray(): Array<number>;
 }
 
-/**
- * @description
- * 与 Server 交互的信令封装
-*/
 /**
  * @description
  * 读数据处理基类
 */
 declare class BaseReader {
     readonly header: Header;
-    protected _name: string | null;
-    lengthSize: number;
     messageId: number;
     timestamp: number;
     syncMsg: boolean;
-    identifier: string;
+    protected identifier: string;
     constructor(header: Header);
     getIdentifier(): string | number;
     read(stream: RongStreamReader, length: number, protocolVer: ConnAckProtocolVer): void;
@@ -293,11 +287,9 @@ declare class RetryableReader extends BaseReader {
     };
 }
 declare class RetryableWriter extends BaseWriter {
-    messageId: number;
     writeMessage(stream: RongStreamWriter): void;
 }
 declare class PublishReader extends RetryableReader {
-    _name: string;
     topic: string;
     data: any;
     targetId: string;
@@ -314,7 +306,6 @@ declare class PublishReader extends RetryableReader {
  * 发消息使用
  */
 declare class PublishWriter extends RetryableWriter {
-    _name: string;
     topic: string;
     data: any;
     targetId: string;
@@ -329,7 +320,6 @@ declare class PublishWriter extends RetryableWriter {
  * 发消息, Server 给的 Ack 回执
  */
 declare class PubAckReader extends RetryableReader {
-    _name: string;
     status: number;
     date: number;
     data: any;
@@ -349,7 +339,6 @@ declare class PubAckReader extends RetryableReader {
  * Web 主动查询
  */
 declare class QueryWriter extends RetryableWriter {
-    name: string;
     topic: string;
     data: any;
     targetId: string;
@@ -1413,7 +1402,12 @@ declare enum LogTagId {
     L_GET_HISTORY_MSG_R = "L-get_history_msg-R",
     A_CALLBACK_O = "A-callback-O",
     A_CALLBACK_E = "A-callback-E",
-    L_CALLBACK_E = "L-callback-E"
+    L_CALLBACK_E = "L-callback-E",
+    /**
+     * PB 数据编码错误
+     */
+    L_PB_ENCODE_E = "L-pb-encode-E",
+    L_PB_DECODE_E = "L-pb-decode-E"
 }
 
 /**
@@ -1490,7 +1484,15 @@ declare enum RTCMode {
     /**
      * 直播模式
      */
-    LIVE = 2
+    LIVE = 2,
+    /**
+     * 跨应用多人房间
+     */
+    CROSS_MUTI = 7,
+    /**
+     * 跨应用直播
+     */
+    CROSS_LIVE = 8
 }
 /**
  * 直播类型
@@ -1593,6 +1595,11 @@ interface IChrmKVEntries {
     type?: number;
     isDeleted?: boolean;
 }
+interface IChrmKVPullData {
+    kvEntries: IChrmKVEntry[];
+    isFullUpdate?: boolean;
+    syncTime?: number;
+}
 interface IServerConversationStatus {
     conversationType: number;
     targetId: string;
@@ -3116,122 +3123,6 @@ interface IExtraMethod {
     updateMessageReceiptStatus(conersationType: ConversationType, targetId: string, timestamp: number, channelId?: string): Promise<IAsyncRes<boolean>>;
 }
 
-interface IReqRoomPKOptions {
-    /**
-     * 当前房间 ID
-     */
-    roomId: string;
-    /**
-     * 被邀请房间 ID
-     */
-    invitedRoomId: string;
-    /**
-     * 被邀请用户 ID
-     */
-    invitedUserId: string;
-    /**
-     * 本次邀请超时时间
-     */
-    inviteTimeout: number;
-    /**
-     * 本次邀请额外信息
-     */
-    inviteInfo: string;
-    /**
-     * 本次邀请唯一 ID
-     */
-    inviteSessionId: string;
-}
-interface ICancelRoomPKOptions {
-    /**
-     * 当前房间 ID
-     */
-    roomId: string;
-    /**
-     * 被邀请房间 ID
-     */
-    invitedRoomId: string;
-    /**
-     * 被邀请用户 ID
-     */
-    invitedUserId: string;
-    /**
-     * 本次邀请额外信息
-     */
-    inviteInfo: string;
-    /**
-     * 本次邀请唯一 ID
-     */
-    inviteSessionId: string;
-}
-interface IResRoomPKOptions {
-    /**
-     * 当前房间 ID
-     */
-    roomId: string;
-    /**
-     * 邀请者 ID
-     */
-    inviteUserId: string;
-    /**
-     * 邀请者房间 ID
-     */
-    inviteRoomId: string;
-    /**
-     * 邀请的 session ID
-     */
-    inviteSessionId: string;
-    /**
-     * 需要转发的信息
-     */
-    content: string;
-    /**
-     * 同意邀请时要设置的 key, 放在room级别的k和v,新加入房间的能拉取到
-     */
-    key: string;
-    /**
-     * 同意邀请时要设置的 value, 放在room级别的k和v,新加入房间的能拉取到
-     */
-    value: string;
-    /**
-     * 是否同意邀请
-     */
-    agree: boolean;
-}
-interface IEndRoomPKOptions {
-    /**
-     * 当前房间 ID
-     */
-    roomId: string;
-    /**
-     * 需要结束的连麦房间 ID
-     */
-    endRoomId: string;
-    /**
-     * 需要结束连麦的 sessionID
-     */
-    sessionId: string;
-    /**
-     * 结束连麦的信息
-     */
-    content: string;
-    /**
-     * 需要删除连麦的信息的 keys
-     */
-    keys: string[];
-}
-
-interface IRTCRoomBindOption {
-    /**
-     * 聊天室 ID
-     */
-    chatRoomId: string;
-    /**
-     * RTC房间 ID
-     */
-    rtcRoomId: string;
-}
-
 /**
  * engine 基本接口定义，用于约束 Electron 下主进程、渲染进程、JSEngine 的编码一致性
  */
@@ -3735,45 +3626,11 @@ interface IEngine {
      */
     getAllUnreadMentionedCount(): Promise<IAsyncRes<number>>;
     clearData(): Promise<IAsyncRes<boolean>>;
-    joinRTCRoom(roomId: string, mode: RTCMode, broadcastType?: number, joinType?: RTCJoinType, innerUserDatas?: IRTCUserData, outerUserDatas?: IRTCUserData): IPromiseResult<IJoinRTCRoomData>;
-    quitRTCRoom(roomId: string): Promise<ErrorCode>;
     rtcPing(roomId: string, mode: number, broadcastType?: number): Promise<ErrorCode>;
-    getRTCRoomInfo(roomId: string): IPromiseResult<IRTCRoomInfo>;
-    getRTCUserInfoList(roomId: string): IPromiseResult<IRTCUsers>;
-    getRTCUserInfo(roomId: string): IPromiseResult<unknown>;
-    setRTCUserInfo(roomId: string, key: string, value: string): Promise<ErrorCode>;
-    removeRTCUserInfo(roomId: string, keys: string[]): Promise<ErrorCode>;
-    setRTCData(roomId: string, key: string, value: string, isInner: boolean, apiType: RTCApiType, message?: {
-        name: string;
-        content: string;
-    }): Promise<ErrorCode>;
-    /**
-     * 全量订阅资源修改
-     * @param roomId 房间 Id
-     * @param message 向前兼容的消息内容
-     * @param valueInfo 全量资源数据
-     * @param objectName 全量 URI 消息名
-     */
-    setRTCTotalRes(roomId: string, message: {
-        name: string;
-        content: string;
-    }, valueInfo: string, objectName: string, mcuValInfo: string): Promise<ErrorCode>;
-    getRTCData(roomId: string, keys: string[], isInner: boolean, apiType: RTCApiType): IPromiseResult<KVString>;
-    removeRTCData(roomId: string, keys: string[], isInner: boolean, apiType: RTCApiType, message?: {
-        name: string;
-        content: string;
-    }): Promise<ErrorCode>;
-    setRTCOutData(roomId: string, rtcData: unknown, type: number, message: unknown): Promise<ErrorCode>;
-    getRTCOutData(roomId: string, userIds: string[]): IPromiseResult<unknown>;
-    getRTCToken(roomId: string, mode: number, broadcastType?: number): IPromiseResult<IRtcTokenData>;
-    setRTCState(roomId: string, reportId: string): Promise<ErrorCode>;
-    getRTCUserList(roomId: string): IPromiseResult<IRTCUsers>;
-    setRTCCDNUris(roomId: string, objectName: string, CDNUris: string): Promise<ErrorCode>;
-    requestRoomPK(options: IReqRoomPKOptions): Promise<ErrorCode>;
-    cancelRoomPK(options: ICancelRoomPKOptions): Promise<ErrorCode>;
-    responseRoomPK(options: IResRoomPKOptions): Promise<ErrorCode>;
-    endRoomPK(options: IEndRoomPKOptions): Promise<ErrorCode>;
-    bindRTCRoomForChatroom(options: IRTCRoomBindOption): Promise<ErrorCode>;
+    rtcSignaling(roomId: string, method: string, isQuery: boolean, sourceData: any): Promise<{
+        code: ErrorCode;
+        buffer?: any;
+    }>;
 }
 
 interface IExpansionMsgContent {
@@ -3815,6 +3672,17 @@ interface IRTCJoinedInfo {
     joinTime: number;
 }
 
+interface IRTCRoomBindOption {
+    /**
+     * 聊天室 ID
+     */
+    chatRoomId: string;
+    /**
+     * RTC房间 ID
+     */
+    rtcRoomId: string;
+}
+
 interface IUpdatedExpansion {
     expansion: {
         [key: string]: any;
@@ -3868,6 +3736,111 @@ interface ITypingMessage {
     list: Array<ITypingUser>;
 }
 
+interface IReqRoomPKOptions {
+    /**
+     * 当前房间 ID
+     */
+    roomId: string;
+    /**
+     * 被邀请房间 ID
+     */
+    invitedRoomId: string;
+    /**
+     * 被邀请用户 ID
+     */
+    invitedUserId: string;
+    /**
+     * 本次邀请超时时间
+     */
+    inviteTimeout: number;
+    /**
+     * 本次邀请额外信息
+     */
+    inviteInfo: string;
+    /**
+     * 本次邀请唯一 ID
+     */
+    inviteSessionId: string;
+}
+interface ICancelRoomPKOptions {
+    /**
+     * 当前房间 ID
+     */
+    roomId: string;
+    /**
+     * 被邀请房间 ID
+     */
+    invitedRoomId: string;
+    /**
+     * 被邀请用户 ID
+     */
+    invitedUserId: string;
+    /**
+     * 本次邀请额外信息
+     */
+    inviteInfo: string;
+    /**
+     * 本次邀请唯一 ID
+     */
+    inviteSessionId: string;
+}
+interface IResRoomPKOptions {
+    /**
+     * 当前房间 ID
+     */
+    roomId: string;
+    /**
+     * 邀请者 ID
+     */
+    inviteUserId: string;
+    /**
+     * 邀请者房间 ID
+     */
+    inviteRoomId: string;
+    /**
+     * 邀请的 session ID
+     */
+    inviteSessionId: string;
+    /**
+     * 需要转发的信息
+     */
+    content: string;
+    /**
+     * 同意邀请时要设置的 key, 放在room级别的k和v,新加入房间的能拉取到
+     */
+    key: string;
+    /**
+     * 同意邀请时要设置的 value, 放在room级别的k和v,新加入房间的能拉取到
+     */
+    value: string;
+    /**
+     * 是否同意邀请
+     */
+    agree: boolean;
+}
+interface IEndRoomPKOptions {
+    /**
+     * 当前房间 ID
+     */
+    roomId: string;
+    /**
+     * 需要结束的连麦房间 ID
+     */
+    endRoomId: string;
+    /**
+     * 需要结束连麦的 sessionID
+     */
+    sessionId: string;
+    /**
+     * 结束连麦的信息
+     */
+    content: string;
+    /**
+     * 需要删除连麦的信息的 keys
+     */
+    keys: string[];
+}
+
 /**
  * IndexDB中存储的log数据
  */
@@ -3984,18 +3957,6 @@ declare class DataCodec {
      * 格式化 会话状态 置顶、免打扰
     */
     private _formatConversationStatus;
-    /**
-     * 格式化 RTC 用户列表
-    */
-    private _formatRTCUserList;
-    /**
-      * 格式化 RTC 数据
-    */
-    private _formatRTCData;
-    /**
-      * 格式化 RTC 房间信息
-    */
-    private _formatRTCRoomInfo;
     /**
       * 格式化 获取已读列表
     */
@@ -4004,18 +3965,10 @@ declare class DataCodec {
      * 格式化用户配置通知
      */
     private _formatUserSettingNotification;
-    /**
-     * 格式化 RTC 用户加入房间后通知拉取的数据（房间内主播全量列表、房间全量资源）
-     */
-    private _formatRTCRoomKVList;
     /**
      * 拉取聊天室 kv 存储时的最新时间戳
      */
     private _formatChrmKVVersion;
-    /**
-     * 格式化观众加房间后返回数据
-     */
-    private _formatRTCAuidenceJoinRoomData;
     /**
      * 格式化加入 RTC 房间的用户信息
      */
@@ -4187,91 +4140,6 @@ declare class DataCodec {
      * 序列号超级群获取会话参数
      */
     encodeUltraGroup(syncTime: number, isEraseMsgContent: boolean): any;
-    /**
-     * ============ 以下为 RTC 相关 ============
-     */
-    /**
-     * 加入 RTC 房间
-     */
-    encodeJoinRTCRoom(mode: RTCMode, broadcastType?: number, joinType?: RTCJoinType, innerUserDatas?: IRTCUserData, outerUserDatas?: IRTCUserData): any[];
-    /**
-     * 退出 RTC 房间
-     */
-    encodeQuitRTCRoom(): any[];
-    /**
-     * 用户属性设置，及消息通知
-     */
-    encodeSetRTCData(key: string, value: string, isInner: boolean, apiType: RTCApiType, message?: {
-        name: string;
-        content: string;
-    }): any;
-    /**
-     * 全量 URI
-     */
-    encodeUserSetRTCData(message: any, valueInfo: string, objectName: string, mcuValInfo: string): any;
-    encodeUserSetRTCCDNUris(objectName: string, CDNUris: string): any;
-    /**
-     * 用户属性获取
-    */
-    encodeGetRTCData(keys: Array<string>, isInner: boolean, apiType: RTCApiType): any;
-    /**
-     * 用户属性删除
-    */
-    encodeRemoveRTCData(keys: Array<string>, isInner: boolean, apiType: RTCApiType, message: any): any;
-    /**
-     * 待完善注释
-     * @deprecated
-    */
-    encodeSetRTCOutData(data: any, type: number, message: any): any;
-    /**
-     * 待完善注释
-     * @deprecated
-    */
-    ecnodeGetRTCOutData(userIds: string[]): any;
-    /**
-     * rtc 北极星数据上传
-     */
-    encodeSetRTCState(report: string): any;
-    /**
-     * 获取房间用户资源
-    */
-    encodeGetRTCRoomInfo(): any;
-    /**
-     * 设置用户资源
-    */
-    encodeSetRTCUserInfo(key: string, value: string): any;
-    /**
-     * 删除用户及资源
-    */
-    encodeRemoveRTCUserInfo(keys: string[]): any;
-    /**
-     * RTC 直播房间身份切换
-    */
-    encodeIdentityChangeInfo(changeType: RTCIdentityChangeType, broadcastType?: number, needSyncChrm?: boolean): any;
-    /**
-     * RTC 直播观众拉取房间内 KV
-    */
-    encodePullRTCRoomKV(roomId: string, timestamp: number): any;
-    /**
-     * RTC 查询在房间内用户的信息
-     */
-    encodeQueryUserJoinedInfo(userId: string): any;
-    /**
-     * 连麦 PK 请求
-     */
-    encodeRequestRoomPK(options: IReqRoomPKOptions): any;
-    /**
-     * 取消连麦 PK 请求
-     */
-    encodeCancelRoomPK(options: ICancelRoomPKOptions): any;
-    /**
-     * 响应连麦 PK 请求
-     */
-    encodeResponseRoomPK(options: IResRoomPKOptions): any;
-    /**
-     * 结束连麦 PK
-     */
-    encodeEndRoomPK(options: IEndRoomPKOptions): any;
     /**
      * 设置聊天室关联的rtc房间
     */
@@ -4567,6 +4435,45 @@ interface IPluginGenerator<API, InitOption> {
     setup(context: PluginContext, runtime: IRuntime, options: InitOption): API;
 }
 
+declare type CodecPBMaps = {
+    readonly [pbname: string]: readonly string[];
+};
+declare type KeyType<T> = T[keyof T & number] & string;
+declare type ModuleType<T> = {
+    [key in KeyType<T>]?: any;
+};
+declare abstract class AbsCodec<T> {
+    /**
+     * Key 对应的 Value 结构映射表，用于不同 Key 数据的编解码
+     */
+    protected pbmaps: T;
+    constructor(
+    /**
+     * Key 对应的 Value 结构映射表，用于不同 Key 数据的编解码
+     */
+    pbmaps: T);
+    /**
+     * 数据反序列化，反序列化的结果为未加工的原始数据，decode 函数本身不处理 format 过程
+     * @param pbname 待解码数据的 PB 名
+     * @param data 待解码数据
+     */
+    abstract decode(pbname: string, data: Uint8Array | string): any;
+    /**
+     * 数据序列化
+     * @param pbname 待编码数据的 PB 名
+     * @param params 待编码参数
+     * @param returnSourceModule 当嵌套 PB 结构时，value 值需要使用原 module 模块而非 Uint8Array 数据
+     * @example 对于嵌套型数据，需要由业务来进行数据组织，以 pb2 结构嵌套 pb1 举例，编码过程如下：
+     * ```
+     * // 对 pb1 结构进行编码
+     * const buffer = codec.encode('pb1', { ...attrs })
+     * // 再对 pb2 编码，pb1 作为编码用到的参数直接传入指定 key
+     * const data = codec.encode('pb2', { key: buffer })
+     * ```
+     */
+    abstract encode<K extends string & keyof T>(pbname: K, params?: ModuleType<T[K]>, returnSourceModule?: boolean): ArrayBuffer | ModuleType<T[K]>;
+}
+
 declare class APIContext {
     private _runtime;
     private static _context?;
@@ -4596,7 +4503,13 @@ declare class APIContext {
      * 内部连接状态标识，为 ture 时不允许调用 reconnect 方法
      */
     private _isInternalConnected;
+    /**
+     * RTC 相关的编解码模块，用于向前兼容 RTC 旧版本的编解码，
+     * 包括向 CppEngine 提供 RTC 业务编解码能力
+     */
+    private readonly _rtcCodec;
     constructor(_runtime: IRuntime, options: IAPIContextOption);
+    createCodec<T extends CodecPBMaps>(keymaps: T, pbDesc: string): AbsCodec<T>;
     /**
      * 安装使用插件，并初始化插件实例
      * @param plugin
@@ -4718,6 +4631,11 @@ declare class APIContext {
      * @param isStatusMessage 是否是状态消息
      */
     registerMessageType(objectName: string, isPersited: boolean, isCounted: boolean, searchProps?: string[], isStatusMessage?: boolean): void;
+    /**
+     * 注册 RTC KV 通知监听器
+     * @param listener
+     */
+    registerRTCSignalingListener(listener?: (buffer: Uint8Array) => void): void;
     /**
      * 发送消息
      * @param conversationType
@@ -5235,6 +5153,10 @@ declare class APIContext {
     getConversationListWithAllChannel(): Promise<IAsyncRes<IReceivedConversation[]>>;
     getConversationListWithAllChannelByPage(index: number, limit: number): Promise<IAsyncRes<IReceivedConversation[]>>;
     clearData(): Promise<IAsyncRes<boolean>>;
+    rtcSignaling(roomId: string, method: string, isQuery: boolean, sourceData: any): Promise<{
+        code: ErrorCode;
+        buffer?: Uint8Array | string;
+    }>;
     /**
      * 加入房间
      * @param roomId
@@ -5316,6 +5238,7 @@ declare class PluginContext {
      * 获取 context
      */
     __getContext(): APIContext;
+    createCodec<T extends CodecPBMaps>(keymaps: T, pbDesc: string): AbsCodec<T>;
     /**
      * 获取当前的导航数据
      */
@@ -5339,14 +5262,6 @@ declare class PluginContext {
      * IM 客户端销毁通知
      */
     ondestroy?(): void;
-    /**
-     * RTC 数据通知
-     * @param roomdId 数据对应的房间 Id
-     * @param data 通知数据为 key:value 方式
-     * @description
-     * 目前仅通知：主播加入、退出房间的人员列表变更，发布、取消发布资源列表变更
-    */
-    onrtcdatachange?(data: IServerRTCRoomEntry[], roomdId?: string): void;
     /**
      * 获取 `@rongcloud/engine` 包版本
      */
@@ -5386,10 +5301,6 @@ declare class PluginContext {
      * 获取服务时间
      */
     getServerTime(): number;
-    /**
-     * 获取加入 RTC 房间的用户信息（当前仅能查自己的）
-     */
-    getRTCJoinedUserInfo(userId: string): IPromiseResult<IRTCJoinedInfo[]>;
 }
 
 declare class RTCPluginContext extends PluginContext {
@@ -5399,6 +5310,7 @@ declare class RTCPluginContext extends PluginContext {
     getNaviInfo(): INaviInfo | null;
     /**
      * 加入 RTC 房间
+     * @deprecated
      * @todo 需确认 `broadcastType` 参数的作用与有效值
      * @param roomId
      * @param mode 房间模式：直播 or 会议
@@ -5406,15 +5318,40 @@ declare class RTCPluginContext extends PluginContext {
      * @param innerUserData 加副房间时的主房间 Id
      */
     joinRTCRoom(roomId: string, mode: RTCMode, broadcastType?: number, joinType?: RTCJoinType, innerUserDatas?: IRTCUserData, outerUserDatas?: IRTCUserData): IPromiseResult<IJoinRTCRoomData>;
+    /**
+     * @deprecated
+     */
     quitRTCRoom(roomId: string): Promise<ErrorCode>;
+    /**
+     * rtc 房间保活
+     */
     rtcPing(roomId: string, mode: number, broadcastType?: number): Promise<ErrorCode>;
+    /**
+     * @deprecated
+     */
     getRTCRoomInfo(roomId: string): IPromiseResult<IRTCRoomInfo>;
+    /**
+     * @deprecated
+     */
     getRTCUserInfoList(roomId: string): IPromiseResult<IRTCUsers>;
+    /**
+     * @deprecated
+     */
     getRTCUserInfo(roomId: string): IPromiseResult<unknown>;
+    /**
+     * @deprecated
+     */
     setRTCUserInfo(roomId: string, key: string, value: string): Promise<ErrorCode>;
+    /**
+     * @deprecated
+     */
     removeRTCUserInfo(roomId: string, keys: string[]): Promise<ErrorCode>;
+    /**
+     * @deprecated
+     */
     setRTCData(roomId: string, key: string, value: string, isInner: boolean, apiType: RTCApiType, message?: any): Promise<ErrorCode>;
     /**
+     * @deprecated
      * @param - roomId
      * @param - message 向前兼容的消息数据，以兼容旧版本 SDK，即增量数据，如：
      * ```
@@ -5447,6 +5384,7 @@ declare class RTCPluginContext extends PluginContext {
     mcuValInfo?: string): Promise<ErrorCode>;
     /**
      * 设置 cdn_uris 扩散
+     * @deprecated
      * @param objectName 全量 URI 消息名，即 `RCRTC:TotalContentResources`
      * @param CDNUris cdn_uris 扩散字段
      * {
@@ -5461,18 +5399,40 @@ declare class RTCPluginContext extends PluginContext {
       }[]
      */
     setRTCCDNUris(roomId: string, objectName: string, CDNUris: string): Promise<ErrorCode>;
+    /**
+     * @deprecated
+     */
     getRTCData(roomId: string, keys: string[], isInner: boolean, apiType: RTCApiType): IPromiseResult<KVString>;
+    /**
+     * @deprecated
+     */
     removeRTCData(roomId: string, keys: string[], isInner: boolean, apiType: RTCApiType, message?: {
         name: string;
         content: string;
     }): Promise<ErrorCode>;
+    /**
+     * @deprecated
+     */
     setRTCOutData(roomId: string, rtcData: unknown, type: number, message: unknown): Promise<ErrorCode>;
+    /**
+     * @deprecated
+     */
     getRTCOutData(roomId: string, userIds: string[]): IPromiseResult<unknown>;
+    /**
+     * @deprecated
+     */
     getRTCToken(roomId: string, mode: number, broadcastType?: number): IPromiseResult<IRtcTokenData>;
+    /**
+     * @deprecated
+     */
     setRTCState(roomId: string, report: string): Promise<ErrorCode>;
+    /**
+     * @deprecated
+     */
     getRTCUserList(roomId: string): IPromiseResult<IRTCUsers>;
     /**
      * 直播观众加房间
+     * @deprecated
      */
     joinLivingRoomAsAudience(roomId: string, mode: RTCMode, broadcastType?: number): IPromiseResult<{
         token: string;
@@ -5480,30 +5440,95 @@ declare class RTCPluginContext extends PluginContext {
     }>;
     /**
      * 直播观众退出房间
+     * @deprecated
      */
     quitLivingRoomAsAudience(roomId: string): Promise<ErrorCode>;
     /**
      * 直播身份切换
+     * @deprecated
      */
     rtcIdentityChange(roomId: string, changeType: RTCIdentityChangeType, broadcastType?: number): IPromiseResult<IJoinRTCRoomData>;
     /**
      * 连麦 PK 请求
+     * @deprecated
      */
     requestRoomPK(options: IReqRoomPKOptions): Promise<ErrorCode>;
     /**
      * 取消连麦 PK 请求
+     * @deprecated
      */
     cancelRoomPK(options: ICancelRoomPKOptions): Promise<ErrorCode>;
     /**
      * 响应连麦 PK 请求
+     * @deprecated
      */
     responseRoomPK(options: IResRoomPKOptions): Promise<ErrorCode>;
     /**
      * 结束连麦 PK
+     * @deprecated
      */
     endRoomPK(options: IEndRoomPKOptions): Promise<ErrorCode>;
+    /**
+     * 监听 RTC KV 变更通知，在监听到通知后续解码数据并重新拉取 KV
+     * @param listener
+     */
+    registerRTCSignalListener(listener?: (buffer: Uint8Array) => void): void;
+    /**
+     * RTC 调用 signal 服务的通用接口
+     * @param roomId 房间 ID
+     * @param method signal 服务接口名
+     * @param isQuery qry or pub
+     * @param sourceData 待发送的编码数据
+     */
+    rtcSignaling(roomId: string, method: string, isQuery: boolean, sourceData: any): Promise<{
+        code: ErrorCode;
+        buffer?: Uint8Array | string;
+    }>;
+    /**
+     * RTC KV 数据通知
+     * @deprecated
+     * @param roomdId 数据对应的房间 Id
+     * @param data 通知数据为 key:value 方式
+     * @description
+     * 目前仅通知：主播加入、退出房间的人员列表变更，发布、取消发布资源列表变更
+    */
+    onrtcdatachange?(data: IServerRTCRoomEntry[], roomdId?: string): void;
+    /**
+     * 获取加入 RTC 房间的用户信息（当前仅能查自己的）
+     * @deprecated
+     */
+    getRTCJoinedUserInfo(userId: string): IPromiseResult<IRTCJoinedInfo[]>;
 }
 
+declare const keymaps: {
+    readonly RtcInput: readonly ["roomType", "broadcastType", "extraInnerData", "needSysChatroom", "identityChangeType", "joinType", "innerDatas", "outerDatas"];
+    readonly RtcUserListOutput: readonly ["users", "token", "sessionId", "roomInfo"];
+    readonly SetUserStatusInput: readonly ["status"];
+    readonly RtcSetDataInput: readonly ["interior", "target", "key", "value", "objectName", "content"];
+    readonly RtcUserSetDataInput: readonly ["valueInfo", "objectName", "content"];
+    readonly RtcDataInput: readonly ["interior", "target", "key", "objectName", "content"];
+    readonly RtcSetOutDataInput: readonly ["target", "valueInfo", "objectName", "content"];
+    readonly MCFollowInput: readonly ["state"];
+    readonly RtcTokenOutput: readonly ["rtcToken"];
+    readonly RtcQryOutput: readonly ["outInfo"];
+    readonly RtcQryUserOutDataInput: readonly ["userId"];
+    readonly RtcUserOutDataOutput: readonly ["user"];
+    readonly RtcQueryListInput: readonly ["order"];
+    readonly RtcRoomInfoOutput: readonly ["roomId", "roomData", "userCount", "list"];
+    readonly RtcValueInfo: readonly ["key", "value"];
+    readonly RtcKeyDeleteInput: readonly ["key"];
+    readonly RtcNotifyMsg: readonly ["type", "time", "roomId"];
+    readonly RtcPullKV: readonly ["timestamp", "roomId"];
+    readonly RtcKVOutput: readonly ["entries", "bFullUpdate", "syncTime"];
+    readonly RtcQueryUserJoinedInput: readonly ["userId"];
+    readonly RtcQueryUserJoinedOutput: readonly ["info"];
+    readonly RtcInviteInput: readonly ["invitedUserId", "timeoutTime", "invitedRoomId", "inviteInfo", "inviteSessionId"];
+    readonly RtcCancelInviteInput: readonly ["invitedUserId", "invitedRoomId", "inviteInfo", "inviteSessionId"];
+    readonly RtcInviteAnswerInput: readonly ["inviteUserId", "answerCode", "inviteRoomId", "inviteSessionId", "content", "key", "value"];
+    readonly RtcEndInviteInput: readonly ["inviteRoomId", "inviteSessionId", "inviteContent", "inviteRoomKeys"];
+};
+declare type RTCKeyMaps = typeof keymaps;
+
 interface IEngineWatcher {
     /**
      * @param message 消息
@@ -5536,6 +5561,7 @@ interface IEngineWatcher {
  */
 declare abstract class AEngine implements IEngine {
     readonly runtime: IRuntime;
+    readonly rtcCodec: AbsCodec<RTCKeyMaps>;
     protected readonly _watcher: IEngineWatcher;
     protected readonly _options: IAPIContextOption;
     /**
@@ -5545,11 +5571,18 @@ declare abstract class AEngine implements IEngine {
     protected readonly _appkey: string;
     protected readonly _apiVer: string;
     protected readonly _apiVersion: string;
+    private _rtcKVManager;
     /**
      * 引擎初始化
      * @param _appkey
      */
-    constructor(runtime: IRuntime, _watcher: IEngineWatcher, _options: IAPIContextOption);
+    constructor(runtime: IRuntime, rtcCodec: AbsCodec<RTCKeyMaps>, _watcher: IEngineWatcher, _options: IAPIContextOption);
+    protected _rtcSignalingListener?: (buffer: Uint8Array) => void;
+    /**
+     * 注册 RTC KV 变更监听器
+     * @param listener
+     */
+    registerRTCSignalingListener(listener: ((buffer: Uint8Array) => void) | undefined): void;
     abstract requestNaviInfo(uris: string[], appkey: string, token: string, checkCA?: boolean): Promise<INaviInfo | null>;
     /**
      * 获取导航数据
@@ -6175,15 +6208,27 @@ declare abstract class AEngine implements IEngine {
      */
     abstract getAllConversationState(): Promise<IAsyncRes<IConversationState[]>>;
     abstract clearData(): Promise<IAsyncRes<boolean>>;
-    abstract joinRTCRoom(roomId: string, mode: RTCMode, broadcastType?: number, joinType?: RTCJoinType, innerUserDatas?: IRTCUserData, outerUserDatas?: IRTCUserData): IPromiseResult<IJoinRTCRoomData>;
-    abstract quitRTCRoom(roomId: string): Promise<ErrorCode>;
+    /**
+     * RTC 通用调用接口
+     * 在非 Comet 协议下，入参 sourceData 应为 ArrayBuffer 数据，返回结果为 Uint8Array 数据
+     * @param roomId 房间 ID
+     * @param method CMP 接口方法名
+     * @param isQuery 使用 `qry` or `pub` 进行请求，按服务要求传递
+     * @param sourceData PB 数据
+     */
+    abstract rtcSignaling(roomId: string, method: string, isQuery: boolean, sourceData: ArrayBuffer | object): Promise<{
+        code: ErrorCode;
+        buffer?: Uint8Array | string;
+    }>;
     abstract rtcPing(roomId: string, mode: number, broadcastType?: number): Promise<ErrorCode>;
-    abstract getRTCRoomInfo(roomId: string): IPromiseResult<IRTCRoomInfo>;
-    abstract getRTCUserInfoList(roomId: string): IPromiseResult<IRTCUsers>;
-    abstract getRTCUserInfo(roomId: string): IPromiseResult<unknown>;
-    abstract setRTCUserInfo(roomId: string, key: string, value: string): Promise<ErrorCode>;
-    abstract removeRTCUserInfo(roomId: string, keys: string[]): Promise<ErrorCode>;
-    abstract setRTCData(roomId: string, key: string, value: string, isInner: boolean, apiType: RTCApiType, message?: {
+    joinRTCRoom(roomId: string, mode: RTCMode, broadcastType?: number, joinType?: RTCJoinType, innerUserDatas?: IRTCUserData, outerUserDatas?: IRTCUserData): IPromiseResult<IJoinRTCRoomData>;
+    quitRTCRoom(roomId: string): Promise<ErrorCode>;
+    getRTCRoomInfo(roomId: string): IPromiseResult<IRTCRoomInfo>;
+    getRTCUserInfoList(roomId: string): IPromiseResult<IRTCUsers>;
+    getRTCUserInfo(roomId: string): IPromiseResult<unknown>;
+    setRTCUserInfo(roomId: string, key: string, value: string): Promise<ErrorCode>;
+    removeRTCUserInfo(roomId: string, keys: string[]): Promise<ErrorCode>;
+    setRTCData(roomId: string, key: string, value: string, isInner: boolean, apiType: RTCApiType, message?: {
         name: string;
         content: string;
     }): Promise<ErrorCode>;
@@ -6194,33 +6239,41 @@ declare abstract class AEngine implements IEngine {
      * @param valueInfo 全量资源数据
      * @param objectName 全量 URI 消息名
      */
-    abstract setRTCTotalRes(roomId: string, message: {
+    setRTCTotalRes(roomId: string, message: {
         name: string;
         content: string;
     }, valueInfo: string, objectName: string, mcuValInfo: string): Promise<ErrorCode>;
-    abstract getRTCData(roomId: string, keys: string[], isInner: boolean, apiType: RTCApiType): IPromiseResult<KVString>;
-    abstract removeRTCData(roomId: string, keys: string[], isInner: boolean, apiType: RTCApiType, message?: {
+    getRTCData(roomId: string, keys: string[], isInner: boolean, apiType: RTCApiType): IPromiseResult<KVString>;
+    removeRTCData(roomId: string, keys: string[], isInner: boolean, apiType: RTCApiType, message?: {
         name: string;
         content: string;
     }): Promise<ErrorCode>;
-    abstract setRTCOutData(roomId: string, rtcData: unknown, type: number, message: unknown): Promise<ErrorCode>;
-    abstract getRTCOutData(roomId: string, userIds: string[]): IPromiseResult<unknown>;
-    abstract getRTCToken(roomId: string, mode: number, broadcastType?: number): IPromiseResult<IRtcTokenData>;
-    abstract setRTCState(roomId: string, reportId: string): Promise<ErrorCode>;
-    abstract getRTCUserList(roomId: string): IPromiseResult<IRTCUsers>;
-    abstract joinLivingRoomAsAudience(roomId: string, mode: RTCMode, broadcastType?: number): Promise<IAsyncRes<{
+    setRTCOutData(roomId: string, rtcData: unknown, type: number, message: unknown): Promise<ErrorCode>;
+    getRTCOutData(roomId: string, userIds: string[]): IPromiseResult<unknown>;
+    getRTCToken(roomId: string, mode: number, broadcastType?: number): IPromiseResult<IRtcTokenData>;
+    setRTCState(roomId: string, report: string): Promise<ErrorCode>;
+    getRTCUserList(roomId: string): IPromiseResult<IRTCUsers>;
+    joinLivingRoomAsAudience(roomId: string, mode: RTCMode, broadcastType?: number): Promise<IAsyncRes<{
         token: string;
         kvEntries: IServerRTCRoomEntry[];
     }>>;
-    abstract quitLivingRoomAsAudience(roomId: string): Promise<ErrorCode>;
-    abstract rtcIdentityChange(roomId: string, changeType: RTCIdentityChangeType, broadcastType?: number): Promise<IAsyncRes<IJoinRTCRoomData>>;
-    abstract getRTCJoinedUserInfo(userId: string): Promise<IAsyncRes<IRTCJoinedInfo[]>>;
-    abstract setRTCCDNUris(roomId: string, objectName: string, CDNUris: string): Promise<ErrorCode>;
-    abstract requestRoomPK(options: IReqRoomPKOptions): Promise<ErrorCode>;
-    abstract cancelRoomPK(options: ICancelRoomPKOptions): Promise<ErrorCode>;
-    abstract responseRoomPK(options: IResRoomPKOptions): Promise<ErrorCode>;
-    abstract endRoomPK(options: IEndRoomPKOptions): Promise<ErrorCode>;
+    pullRTCRoomEntry(roomId: string, _timestamp: number): Promise<IAsyncRes<IChrmKVPullData>>;
+    quitLivingRoomAsAudience(roomId: string): Promise<ErrorCode>;
+    rtcIdentityChange(roomId: string, changeType: RTCIdentityChangeType, broadcastType?: number): Promise<IAsyncRes<IJoinRTCRoomData>>;
+    getRTCJoinedUserInfo(userId: string): Promise<IAsyncRes<IRTCJoinedInfo[]>>;
+    setRTCCDNUris(roomId: string, objectName: string, CDNUris: string): Promise<ErrorCode>;
+    requestRoomPK(options: IReqRoomPKOptions): Promise<ErrorCode>;
+    cancelRoomPK(options: ICancelRoomPKOptions): Promise<ErrorCode>;
+    responseRoomPK(options: IResRoomPKOptions): Promise<ErrorCode>;
+    endRoomPK(options: IEndRoomPKOptions): Promise<ErrorCode>;
+    /**
+     * 设置聊天室关联的rtc房间
+     */
     abstract bindRTCRoomForChatroom(options: IRTCRoomBindOption): Promise<ErrorCode>;
+    /**
+     * 接收 rtc 资源变更
+     */
+    protected _receiveRtcKv(buffer: Uint8Array): void;
 }
 
 declare class AppStorage {
@@ -6764,4 +6817,4 @@ declare const ONE_LOG_SIZE_MAX = 1000;
  */
 declare const version: string;
 
-export { AEngine, APIContext, AppStorage, AssertRules, CONNECTION_TYPE, CPP_PROTOCAL_MSGTYPE_OPTION, CallLibMsgType, ChatroomEntryType, ChatroomUserChangeType, CometChannel, ConnectResultCode, ConnectionStatus, ConversationType, DB_LOG_FLUSH_FREQUENCY, DB_LOG_MAX_SIZE, DelayTimer, ErrorCode, EventEmitter, FileType, HttpMethod, IAPIContextOption, IAndroidPushConfig, IAsyncRes, IBaseConversationInfo, IBlockedMessageInfo, ICancelRoomPKOptions, IChatRoomEntries, IChatRoomEntry, IChatroomEntries, IChatroomEntry, IChatroomEntryListenerData, IChatroomInfo, IChatroomListener, IChatroomListenerData, IChatroomRejoinedFailed, IChatroomRejoinedInfo, IChatroomRejoinedSuccessed, IChatroomUser, IChatroomUserChangeInfo, IChrmKVEntries, IChrmKVEntry, IConnectResult, IConnectionStatusListener, IConversationOption, IConversationState, IConversationStateListener, IConversationTag, IConversationTagListener, IDataChannelWatcher, IDeletedExpansion, IEndRoomPKOptions, IEngine, IEngineWatcher, IEventListener, IExpansionListener, IExpansionListenerData, IExpansionMsgContent, IExtraMethod, IGetMsgOption, IGetUltraGroupListOption, IGooglePushConfig, IInsertMsgOptions, IIsValidExpansion, IJoinRTCRoomData, ILocalReadReceiptInfo, ILocalTagStatus, ILogExtensions, ILogInfo, ILogInit, IM_CHATROOM_PULL_INTERVAL_TIME, IM_COMET_PULLMSG_TIMEOUT, IM_PING_INTERVAL_TIME, IM_PING_MIN_TIMEOUT, IM_PING_TIMEOUT, IM_SIGNAL_TIMEOUT, IMessageListnenr, IMessageReader, IMessageReaderResponse, IMetionedData, INaviInfo, IPluginGenerator, IPromiseResult, IPushConfig, IRTCInnerListener, IRTCJoinedInfo, IRTCRoomBindOption, IRTCRoomInfo, IRTCUserData, IRTCUsers, IReadReceiptInfo, IRealTimeLog, IRecallMsgContent, IRecallMsgOptions, IReceivedConversation, IReceivedConversationByTag, IReceivedMessage, IRemoveChatRoomEntries, IRemoveChatRoomEntry, IRemoveChatroomEntries, IRemoveChatroomEntry, IReqRoomPKOptions, IRequest, IResRoomPKOptions, IResponse, IRtcTokenData, IRuntime, ISendExMsgOptions, ISendMsgOptions, IServerConversationStatus, IServerRTCRoomEntry, IServerUserSetting, ISetConversationStatusOptions, IStorage, ITagInfo, ITagListener, ITagParam, ITagStatus, ITypingInfo, ITypingMessage, ITypingUser, IUltraExMsgOptions, IUltraGroupConversation, IUltraGroupOption, IUltraModifyMsgOptions, IUltraMsgQueryOptions, IUpdatedConversation, IUpdatedExpansion, IUploadAuth, IUserProfile, IWatcher, IWebSocket, IiOSPushConfig, ItypingStateListener, KVString, LiveRole, LiveType, LogLevel, LogSource, LogTagId, Logger, MAX_MESSAGE_CONTENT_BYTES, MAX_MESSAGE_EXPANSION_KEY_LENGTH, MAX_MESSAGE_EXPANSION_VAL_LENGTH, MINI_COMET_CONNECT_URIS, MINI_SOCKET_CONNECT_URIS, MentionedType, MessageBlockSourceType, MessageBlockType, MessageDirection, MessageType, NAVI_CACHE_DURATION, NAVI_REQ_TIMEOUT, NetworkType, NotificationLevel, NotificationStatus, ONE_LOG_SIZE_MAX, OperateStatus, PING_REQ_TIMEOUT, PUBLIC_CLOUD_NAVI_URIS, PluginContext, RCAssertError, REAT_TIME_LOG_SIZE, RTCApiType, RTCIdentityChangeType, RTCJoinType, RTCMode, RTCPluginContext, ReceivedStatus, SEND_MESSAGE_TYPE_OPTION, STATUS_MESSAGE, STORAGE_ROOT_KEY, TagChangeType, UltraGroupChannelChangeType, UltraGroupChannelType, UltraMsgChangeType, UltraMsgSubChangeType, UploadMethod, VersionManage, WEB_SOCKET_TIMEOUT, WebSocketChannel, appendUrl, assert, clone, cloneByJSON, _default as engineLogger, forEach, formatConnectResponseCode, getBrowser, getMimeKey, getUUID, getUUID22, getUploadFileName, indexOf, isArray, isArrayBuffer, isBoolean, isFunction, isHttpUrl, isInObject, isInclude, isNull, isNumber, isObject, isString, isUndefined, isValidChannelId, isValidChrmEntryKey, isValidChrmEntryValue, isValidConversationType, isValidExpansion, isValidFileType, base as logger, map, notEmptyArray, notEmptyObject, notEmptyString, pushConfigsToJSON, pushJSONToConfigs, randomNum, todo, usingCppEngine, validate, version };
+export { AEngine, APIContext, AbsCodec, AppStorage, AssertRules, CONNECTION_TYPE, CPP_PROTOCAL_MSGTYPE_OPTION, CallLibMsgType, ChatroomEntryType, ChatroomUserChangeType, CometChannel, ConnectResultCode, ConnectionStatus, ConversationType, DB_LOG_FLUSH_FREQUENCY, DB_LOG_MAX_SIZE, DelayTimer, ErrorCode, EventEmitter, FileType, HttpMethod, IAPIContextOption, IAndroidPushConfig, IAsyncRes, IBaseConversationInfo, IBlockedMessageInfo, ICancelRoomPKOptions, IChatRoomEntries, IChatRoomEntry, IChatroomEntries, IChatroomEntry, IChatroomEntryListenerData, IChatroomInfo, IChatroomListener, IChatroomListenerData, IChatroomRejoinedFailed, IChatroomRejoinedInfo, IChatroomRejoinedSuccessed, IChatroomUser, IChatroomUserChangeInfo, IChrmKVEntries, IChrmKVEntry, IConnectResult, IConnectionStatusListener, IConversationOption, IConversationState, IConversationStateListener, IConversationTag, IConversationTagListener, IDataChannelWatcher, IDeletedExpansion, IEndRoomPKOptions, IEngine, IEngineWatcher, IEventListener, IExpansionListener, IExpansionListenerData, IExpansionMsgContent, IExtraMethod, IGetMsgOption, IGetUltraGroupListOption, IGooglePushConfig, IInsertMsgOptions, IIsValidExpansion, IJoinRTCRoomData, ILocalReadReceiptInfo, ILocalTagStatus, ILogExtensions, ILogInfo, ILogInit, IM_CHATROOM_PULL_INTERVAL_TIME, IM_COMET_PULLMSG_TIMEOUT, IM_PING_INTERVAL_TIME, IM_PING_MIN_TIMEOUT, IM_PING_TIMEOUT, IM_SIGNAL_TIMEOUT, IMessageListnenr, IMessageReader, IMessageReaderResponse, IMetionedData, INaviInfo, IPluginGenerator, IPromiseResult, IPushConfig, IRTCInnerListener, IRTCJoinedInfo, IRTCRoomBindOption, IRTCRoomInfo, IRTCUserData, IRTCUsers, IReadReceiptInfo, IRealTimeLog, IRecallMsgContent, IRecallMsgOptions, IReceivedConversation, IReceivedConversationByTag, IReceivedMessage, IRemoveChatRoomEntries, IRemoveChatRoomEntry, IRemoveChatroomEntries, IRemoveChatroomEntry, IReqRoomPKOptions, IRequest, IResRoomPKOptions, IResponse, IRtcTokenData, IRuntime, ISendExMsgOptions, ISendMsgOptions, IServerConversationStatus, IServerRTCRoomEntry, IServerUserSetting, ISetConversationStatusOptions, IStorage, ITagInfo, ITagListener, ITagParam, ITagStatus, ITypingInfo, ITypingMessage, ITypingUser, IUltraExMsgOptions, IUltraGroupConversation, IUltraGroupOption, IUltraModifyMsgOptions, IUltraMsgQueryOptions, IUpdatedConversation, IUpdatedExpansion, IUploadAuth, IUserProfile, IWatcher, IWebSocket, IiOSPushConfig, ItypingStateListener, KVString, LiveRole, LiveType, LogLevel, LogSource, LogTagId, Logger, MAX_MESSAGE_CONTENT_BYTES, MAX_MESSAGE_EXPANSION_KEY_LENGTH, MAX_MESSAGE_EXPANSION_VAL_LENGTH, MINI_COMET_CONNECT_URIS, MINI_SOCKET_CONNECT_URIS, MentionedType, MessageBlockSourceType, MessageBlockType, MessageDirection, MessageType, NAVI_CACHE_DURATION, NAVI_REQ_TIMEOUT, NetworkType, NotificationLevel, NotificationStatus, ONE_LOG_SIZE_MAX, OperateStatus, PING_REQ_TIMEOUT, PUBLIC_CLOUD_NAVI_URIS, PluginContext, RCAssertError, REAT_TIME_LOG_SIZE, RTCApiType, RTCIdentityChangeType, RTCJoinType, RTCKeyMaps, RTCMode, RTCPluginContext, ReceivedStatus, SEND_MESSAGE_TYPE_OPTION, STATUS_MESSAGE, STORAGE_ROOT_KEY, TagChangeType, UltraGroupChannelChangeType, UltraGroupChannelType, UltraMsgChangeType, UltraMsgSubChangeType, UploadMethod, VersionManage, WEB_SOCKET_TIMEOUT, WebSocketChannel, appendUrl, assert, clone, cloneByJSON, _default as engineLogger, forEach, formatConnectResponseCode, getBrowser, getMimeKey, getUUID, getUUID22, getUploadFileName, indexOf, isArray, isArrayBuffer, isBoolean, isFunction, isHttpUrl, isInObject, isInclude, isNull, isNumber, isObject, isString, isUndefined, isValidChannelId, isValidChrmEntryKey, isValidChrmEntryValue, isValidConversationType, isValidExpansion, isValidFileType, base as logger, map, notEmptyArray, notEmptyObject, notEmptyString, pushConfigsToJSON, pushJSONToConfigs, randomNum, todo, usingCppEngine, validate, version };