@tencentcloud/tuiroom-engine-electron 3.0.6-beta.0 → 3.2.0

package/index.d.ts

@@ -212,7 +212,10 @@ declare enum TUIChangeReason {
 declare enum TUIKickedOutOfRoomReason {
     kKickedByAdmin = 0,
     kKickedByLoggedOnOtherDevice = 1,
-    kKickedByServer = 2
+    kKickedByServer = 2,
+    kNetworkDisconnected = 3,
+    kJoinRoomStatusInvalidDuringOffline = 4,
+    kCountOfJoinedRoomsExceedLimit = 5
 }
 declare enum TUIRequestAction {
     kInvalidAction = 0,
@@ -262,7 +265,7 @@ type TUISeatInfo = {
     userName: string;
     nameCard: string;
     avatarUrl: string;
-    locked: boolean;
+    isLocked: boolean;
     isVideoLocked: boolean;
     isAudioLocked: boolean;
 };
@@ -745,32 +748,40 @@ declare enum TUIRoomEvents {
      */
     onRequestProcessed = "onRequestProcessed",
     /**
+     * @since v3.1.0
      * @description 接收文本消息事件
-     * @deprecated 该接口自 v2.0.0 版本废弃，请使用 tim 实例监听收消息事件
      * @default 'onReceiveTextMessage'
      * @event TUIRoomEvents#onReceiveTextMessage
-     * @param {object} options
+     * @param {object} options 接收的文本消息
      * @param {string} options.roomId 房间Id
-     * @param {TUIMessage} options.message 接收的文本消息
+     * @param {string} options.textContent 文本消息内容
+     * @param {TUIUserInfo} options.sender 发送者信息
+     * @param {number} options.sequence 消息序号
+     * @param {object} options.extensionInfo 扩展信息
+     * @param {string} options.timestampInSecond 时间戳
      * @example
      * const roomEngine = new TUIRoomEngine();
-     * roomEngine.on(TUIRoomEvents.onReceiveTextMessage, ({ roomId, message }) => {
-     *   console.log('roomEngine.onReceiveTextMessage', roomId, message);
+     * roomEngine.on(TUIRoomEvents.onReceiveTextMessage, (message) => {
+     *   console.log('roomEngine.onReceiveTextMessage', message);
      * });
      */
     onReceiveTextMessage = "onReceiveTextMessage",
     /**
+     * @since v3.1.0
      * @description 接收自定义消息事件
-     * @deprecated 该接口自 v2.0.0 版本废弃，请使用 tim 实例监听收消息事件
      * @default 'onReceiveCustomMessage'
      * @event TUIRoomEvents#onReceiveCustomMessage
-     * @param {object} options
+     * @param {object} options 接收的自定义消息
      * @param {string} options.roomId 房间Id
-     * @param {TUIMessage} options.message 接收的自定义消息
+     * @param {string} options.businessId 业务Id
+     * @param {string} options.data 自定义消息内容
+     * @param {TUIUserInfo} options.sender 发送者信息
+     * @param {number} options.sequence 消息序号
+     * @param {string} options.timestampInSecond 时间戳
      * @example
      * const roomEngine = new TUIRoomEngine();
-     * roomEngine.on(TUIRoomEvents.onReceiveCustomMessage, ({ roomId, message }) => {
-     *   console.log('roomEngine.onReceiveCustomMessage', roomId, message);
+     * roomEngine.on(TUIRoomEvents.onReceiveCustomMessage, (message) => {
+     *   console.log('roomEngine.onReceiveCustomMessage', message);
      * });
      */
     onReceiveCustomMessage = "onReceiveCustomMessage",
@@ -799,7 +810,29 @@ declare enum TUIRoomEvents {
      *   console.log('roomEngine.onUserScreenCaptureStopped');
      * });
      */
-    onUserScreenCaptureStopped = "onUserScreenCaptureStopped"
+    onUserScreenCaptureStopped = "onUserScreenCaptureStopped",
+    /**
+     * @description 自动播放失败的事件，监听到该事件后可以引导用户与页面进行交互
+     * @default 'onAutoPlayFailed'
+     * @event TUIRoomEvents#onAutoPlayFailed
+     * @example
+     * const roomEngine = new TUIRoomEngine();
+     * roomEngine.on(TUIRoomEvents.onAutoPlayFailed, ({userId, resume}) => {
+     *   // 自动播放失败，引导用户与页面进行交互
+     * });
+     */
+    onAutoPlayFailed = "onAutoPlayFailed",
+    /**
+     * @description 房间自定义信息改变的事件
+     * @default 'onRoomMetadataChanged'
+     * @event TUIRoomEvents#onRoomMetadataChanged
+     * @example
+     * const roomEngine = new TUIRoomEngine();
+     * roomEngine.on(TUIRoomEvents.onRoomMetadataChanged, ({key, value}) => {
+     *   console.log(key, value);
+     * });
+     */
+    onRoomMetadataChanged = "onRoomMetadataChanged"
 }
 declare enum TUIRoomDeviceMangerEvents {
     /**
@@ -1157,7 +1190,7 @@ declare enum TUILiveModifyFlag {
 }
 type TUILiveListResult = {
     cursor: string;
-    listInfoList: Array<TUILiveInfo>;
+    liveInfoList: Array<TUILiveInfo>;
 };
 /**
  * @since v2.9.0
@@ -1181,6 +1214,17 @@ declare enum TUILiveListManagerEvents {
      */
     onLiveInfoChanged = "onLiveInfoChanged"
 }
+declare enum TUILiveLayoutManagerEvents {
+    /**
+     * const roomEngine = new TUIRoomEngine();
+     * const liveLayoutManager = roomEngine.getLiveLayoutManager();
+     * const callback = (roomId, layoutInfo) => {
+     *   console.log('liveLayoutManager.onLiveVideoLayoutListChanged', roomId, layoutInfo);
+     * };
+     * liveLayoutManager.on(TUILiveLayoutManagerEvents.onLiveVideoLayoutListChanged, callback);
+     */
+    onLiveVideoLayoutListChanged = "onLiveVideoLayoutListChanged"
+}
 declare enum TUILiveLayoutManagerEvents {
     /**
      * const roomEngine = new TUIRoomEngine();
@@ -1191,6 +1235,130 @@ declare enum TUILiveLayoutManagerEvents {
      * liveLayoutManager.on(TUILiveLayoutManagerEvents.onLiveVideoLayoutChanged, callback);
      */
     onLiveVideoLayoutChanged = "onLiveVideoLayoutChanged"
+}
+/**
+ * @since v3.0.5
+ * **TUILiveConnectionManager** 事件列表<br>
+ */
+declare enum TUILiveConnectionManagerEvents {
+    /**
+     * @description 接收到连线请求的监听事件
+     * @default 'onConnectionRequestReceived'
+     * @event TUILiveConnectionManagerEvents#onConnectionRequestReceived
+     * @param {inviter} options 连线请求发起者
+     * @param {avatarUrl} options.avatarUrl 头像
+     * @param {joinConnectionTime} options.joinConnectionTime 加入连线时间
+     * @param {roomId} options.roomId 房间号
+     * @param {userId} options.userId ID
+     * @param {userName} options.userName 用户名
+     *
+     * @example
+     * const roomEngine = new TUIRoomEngine();
+     * const liveConnectionManager = roomEngine.getLiveConnectionManager();
+     * liveConnectionManager.on(TUILiveConnectionManagerEvents.onConnectionRequestReceived, ({ avatarUrl, joinConnectionTime, roomId, userId, userName }) => {
+     *   console.log('liveConnectionManager.onConnectionRequestReceived', avatarUrl, joinConnectionTime, roomId, userId, userName);
+     * });
+     */
+    onConnectionRequestReceived = "onConnectionRequestReceived",
+    /**
+     * @description 连线房间主播人数变更的监听事件
+     * @default 'onConnectionUserListChanged'
+     * @event TUILiveConnectionManagerEvents#onConnectionUserListChanged
+     * @param {object} options
+     * @param {connectedList} options.connectedList 包含连线房间所有主播列表
+     * @param {joinedList} options.joinedList 本次事件变更加入连线房间的主播列表
+     * @param {leavedList} options.leavedList 本次事件变更离开连线房间的主播列表
+     *
+     * @example
+     * const roomEngine = new TUIRoomEngine();
+     * const liveConnectionManager = roomEngine.getLiveConnectionManager();
+     * liveConnectionManager.on(TUILiveConnectionManagerEvents.onConnectionUserListChanged, ({ connectedList, joinedList, leavedList }) => {
+     *   console.log('liveConnectionManager.onConnectionUserListChanged', connectedList, joinedList, leavedList);
+     * });
+     */
+    onConnectionUserListChanged = "onConnectionUserListChanged",
+    /**
+     * @description 连线请求被取消的监听事件
+     * @default 'onConnectionRequestCancelled'
+     * @event TUILiveConnectionManagerEvents#onConnectionRequestCancelled
+     * @param {invitee} options 连线请求被邀请者
+     * @param {avatarUrl} options.avatarUrl 头像
+     * @param {joinConnectionTime} options.joinConnectionTime 加入连线时间
+     * @param {roomId} options.roomId 房间号
+     * @param {userId} options.userId ID
+     * @param {userName} options.userName 用户名
+     *
+     * @example
+     * const roomEngine = new TUIRoomEngine();
+     * const liveConnectionManager = roomEngine.getLiveConnectionManager();
+     * liveConnectionManager.on(TUILiveConnectionManagerEvents.onConnectionRequestCancelled, ({ avatarUrl, joinConnectionTime, roomId, userId, userName }) => {
+     *   console.log('liveConnectionManager.onConnectionRequestCancelled', avatarUrl, joinConnectionTime, roomId, userId, userName);
+     * });
+     */
+    onConnectionRequestCancelled = "onConnectionRequestCancelled",
+    /**
+     * @description 连线请求被同意的监听事件
+     * @default 'onConnectionRequestAccept'
+     * @event TUILiveConnectionManagerEvents#onConnectionRequestAccept
+     * @param {invitee} options 连线请求被邀请者
+     * @param {avatarUrl} options.avatarUrl 头像
+     * @param {joinConnectionTime} options.joinConnectionTime 加入连线时间
+     * @param {roomId} options.roomId 房间号
+     * @param {userId} options.userId ID
+     * @param {userName} options.userName 用户名
+     *
+     * @example
+     * const roomEngine = new TUIRoomEngine();
+     * const liveConnectionManager = roomEngine.getLiveConnectionManager();
+     * liveConnectionManager.on(TUILiveConnectionManagerEvents.onConnectionRequestAccept, ({ avatarUrl, joinConnectionTime, roomId, userId, userName }) => {
+     *   console.log('liveConnectionManager.onConnectionRequestAccept', avatarUrl, joinConnectionTime, roomId, userId, userName);
+     * });
+     */
+    onConnectionRequestAccept = "onConnectionRequestAccept",
+    /**
+     * @description 连线请求被拒绝的监听事件
+     * @default 'onConnectionRequestReject'
+     * @event TUILiveConnectionManagerEvents#onConnectionRequestReject
+     * @param {invitee} options 连线请求被邀请者
+     * @param {avatarUrl} options.avatarUrl 头像
+     * @param {joinConnectionTime} options.joinConnectionTime 加入连线时间
+     * @param {roomId} options.roomId 房间号
+     * @param {userId} options.userId ID
+     * @param {userName} options.userName 用户名
+     *
+     * @example
+     * const roomEngine = new TUIRoomEngine();
+     * const liveConnectionManager = roomEngine.getLiveConnectionManager();
+     * liveConnectionManager.on(TUILiveConnectionManagerEvents.onConnectionRequestReject, ({ avatarUrl, joinConnectionTime, roomId, userId, userName }) => {
+     *   console.log('liveConnectionManager.onConnectionRequestReject', avatarUrl, joinConnectionTime, roomId, userId, userName);
+     * });
+     */
+    onConnectionRequestReject = "onConnectionRequestReject",
+    /**
+     * @description 邀请超时的监听事件
+     * @default 'onConnectionRequestTimeout'
+     * @event TUILiveConnectionManagerEvents#onConnectionRequestTimeout
+     * @param {invitee} invitee 连线请求被邀请者
+     * @param {avatarUrl} invitee.avatarUrl 头像
+     * @param {joinConnectionTime} invitee.joinConnectionTime 加入连线时间
+     * @param {roomId} invitee.roomId 房间号
+     * @param {userId} invitee.userId ID
+     * @param {userName} invitee.userName 用户名
+     * @param {inviter} inviter 连线请求邀请者
+     * @param {avatarUrl} inviter.avatarUrl 头像
+     * @param {joinConnectionTime} inviter.joinConnectionTime 加入连线时间
+     * @param {roomId} inviter.roomId 房间号
+     * @param {userId} inviter.userId ID
+     * @param {userName} inviter.userName 用户名
+     *
+     * @example
+     * const roomEngine = new TUIRoomEngine();
+     * const liveConnectionManager = roomEngine.getLiveConnectionManager();
+     * liveConnectionManager.on(TUILiveConnectionManagerEvents.onConnectionRequestTimeout, (invitee, inviter) => {
+     *   console.log('liveConnectionManager.onConnectionRequestTimeout', invitee, inviter);
+     * });
+     */
+    onConnectionRequestTimeout = "onConnectionRequestTimeout"
 }
 
 declare class Logger {
@@ -1894,6 +2062,209 @@ declare class TUILiveListManager {
     private handleLiveInfoChangeEvent;
 }
 
+/**
+ * 直播自定义布局插件
+ * @class TUILiveLayoutManager
+ */
+declare class TUILiveLayoutManager {
+    private liveLayoutManagerWASM;
+    private logger;
+    private static liveLayoutManager;
+    constructor(options: {
+        Module: any;
+        logger: Logger;
+        roomEngineWASM: any;
+    });
+    private observerFunction;
+    private handleLiveLayoutChangeEvent;
+    private JSCallNativeFunctionPromise;
+    /**
+     * 监听 TUILiveLayoutManager 事件
+     * @param {TUILiveLayoutManagerEvents} event 事件名
+     * @param func 事件回调函数
+     *
+     * @example
+     * const roomEngine = new TUIRoomEngine();
+     * const liveLayoutManager = roomEngine.getLiveLayoutManager();
+     * const callback = (roomId, layoutInfo) => {
+     *   console.log('liveLayoutManager.onLiveVideoLayoutChanged', roomId, layoutInfo);
+     * };
+     * liveLayoutManager.on(TUILiveLayoutManagerEvents.onLiveVideoLayoutChanged, callback);
+     */
+    on(event: TUILiveLayoutManagerEvents, func: (...args: any[]) => void): void;
+    /**
+     * 取消 TUILiveLayoutManager 事件监听
+     * @param {TUILiveLayoutManagerEvents} event 事件名
+     * @param {Function} func 事件回调函数
+     *
+     * @example
+     * const roomEngine = new TUIRoomEngine();
+     * const liveLayoutManager = roomEngine.getLiveLayoutManager();
+     * const callback = (roomId, layoutInfo) => {
+     *   console.log('liveLayoutManager.onLiveVideoLayoutChanged', roomId, layoutInfo);
+     * };
+     * liveLayoutManager.off(TUILiveLayoutManagerEvents.onLiveVideoLayoutChanged, callback);
+     */
+    off(event: TUILiveLayoutManagerEvents, func: (...args: any[]) => void): void;
+    /**
+     * 设置自定义布局信息
+     *
+     * @param {string} roomId 直播房间 ID
+     * @param {string} layoutInfo 自定义布局信息, 格式为 JSON 字符串
+     * @returns {Promise<void>}
+     *
+     * @example
+     * const roomEngine = new TUIRoomEngine();
+     * const liveLayoutManager = roomEngine.getLiveLayoutManager();
+     * liveLayoutManager.setLiveStreamLayoutInfo('roomId', '{
+     *   // 设置画布大小
+     *   "VideoEncode": {
+     *     "Width": 1920,
+     *     "Height": 1080,
+     *   },
+     *   "LayoutMode": 0, // 0~9 内置布局模板， 1000自定义布局， 只有1000时候才能修改LayoutInfo,目前只支持 0 和 1000
+     *   // 设置画面布局
+     *   "LayoutInfo": {
+     *     "LayoutList": [
+     *       {
+     *         "LocationX": 0,                   // 以画面左上角为原点的 x 坐标
+     *         "LocationY": 0,                   // 以画面左上角为原点的 y 坐标
+     *         "ImageWidth": 1920,               // 调整后的画面宽度
+     *         "ImageHeight": 1080,              // 调整后的画面高度
+     *         "ZOrder": 0,                      // 画面层级
+     *         "StreamType": 0,                  // 0 摄像头, 1 屏幕共享, 2 白板, 3 自定义
+     *         "Member_Account": "admin001",     // 该路流的用户ID
+     *         "BackgroundImageUrl": "ImageUrl",
+     *         "RoomId": "roomId",
+     *         "BackgroundColor": "0x1F212C",
+     *
+     *       }
+     *     ],
+     *    // 设置最大画面，只能有一路
+     *    "MaxUserLayout": {
+     *      "LocationX": 0,                      // 以画面左上角为原点的 x 坐标
+     *      "LocationY": 0,                      // 以画面左上角为原点的 y 坐标
+     *      "ImageWidth": 1920,                  // 调整后的画面宽度
+     *      "ImageHeight": 1080,                 // 调整后的画面高度
+     *      "ZOrder": 0,                         // 层级
+     *      "StreamType": 0,                     // 0为摄像头， 1为屏幕共享
+     *      "Member_Account": "admin001",
+     *      "BackgroundImageUrl": "ImageUrl",    // 可以设置看看，可能在最大画面时候没作用
+     *      "RoomId":"roomId",
+     *      "BackgroundColor":"0x1F212C"
+     *    }
+     *   }}');
+     */
+    setLiveStreamLayoutInfo(roomId: string, layoutInfo: string): Promise<void>;
+}
+
+/**
+ * 直播连线
+ * @class TUILiveConnectionManager
+ */
+declare class TUILiveConnectionManager {
+    private liveConnectionManagerWASM;
+    private logger;
+    private static liveConnectionManager;
+    constructor(options: {
+        Module: any;
+        logger: Logger;
+        roomEngineWASM: any;
+    });
+    /**
+     * 监听 TUILiveConnectionManager 事件
+     * @param {TUILiveConnectionManagerEvents} event 事件名
+     * @param func 事件回调函数
+     *
+     * @example
+     * const roomEngine = new TUIRoomEngine();
+     * const liveConnectionManager = roomEngine.getLiveConnectionManager();
+     * const callback = (inviter) => {
+     *   console.log('liveConnectionManager.onConnectionRequestReceived', inviter);
+     * };
+     * liveConnectionManager.on(TUILiveLayoutManagerEvents.onLiveVideoLayoutChanged, callback);
+     */
+    on(event: TUILiveConnectionManagerEvents, func: (...args: any[]) => void): void;
+    /**
+     * 取消监听 TUILiveConnectionManager 事件
+     * @param {TUILiveConnectionManagerEvents} event 事件名
+     * @param func 事件回调函数
+     *
+     * @example
+     * const roomEngine = new TUIRoomEngine();
+     * const liveConnectionManager = roomEngine.getLiveConnectionManager();
+     * const callback = (inviter) => {
+     *   console.log('liveConnectionManager.onConnectionRequestReceived', inviter);
+     * };
+     * liveConnectionManager.off(TUILiveLayoutManagerEvents.onLiveVideoLayoutChanged, callback);
+     */
+    off(event: TUILiveConnectionManagerEvents, func: (...args: any[]) => void): void;
+    /**
+     * 请求跨房连线
+     *
+     * @param {Array<string>} roomIdList 待邀请的连线房间ID列表
+     * @param {string} timeOut 请求超时时间, 单位 s
+     * @param {string} extensionInfo 扩展信息, 可选, 默认为: ''
+     * @returns {Promise<void>}
+     *
+     * @example
+     * const roomEngine = new TUIRoomEngine();
+     * const liveConnectionManager = roomEngine.getLiveConnectionManager();
+     * liveConnectionManager.requestConnection(['roomId1','roomId2'], 10);
+     */
+    requestConnection(roomIdList: Array<string>, timeOut: number, extensionInfo?: string): Promise<void>;
+    /**
+     * 取消跨房连线请求
+     *
+     * @param {Array<string>} roomIdList 被取消连线请求的房间Id列表
+     * @returns {Promise<void>}
+     *
+     * @example
+     * const roomEngine = new TUIRoomEngine();
+     * const liveConnectionManager = roomEngine.getLiveConnectionManager();
+     * liveConnectionManager.cancelConnectionRequest(['roomId1', 'roomId2']);
+     */
+    cancelConnectionRequest(roomIdList: Array<string>): Promise<void>;
+    /**
+     * 同意连线请求
+     *
+     * @param {string} roomId 直播房间 ID
+     * @returns {Promise<void>}
+     *
+     * @example
+     * const roomEngine = new TUIRoomEngine();
+     * const liveConnectionManager = roomEngine.getLiveConnectionManager();
+     * liveConnectionManager.acceptConnection('roomId');
+     */
+    acceptConnection(roomId: string): Promise<void>;
+    /**
+     * 拒绝连线请求
+     *
+     * @param {string} roomId 直播房间 ID
+     * @returns {Promise<void>}
+     *
+     * @example
+     * const roomEngine = new TUIRoomEngine();
+     * const liveConnectionManager = roomEngine.getLiveConnectionManager();
+     * liveConnectionManager.rejectConnection('roomId');
+     */
+    rejectConnection(roomId: string): Promise<void>;
+    /**
+     * 断开直播连线
+     *
+     * @returns {Promise<void>}
+     *
+     * @example
+     * const roomEngine = new TUIRoomEngine();
+     * const liveConnectionManager = roomEngine.getLiveConnectionManager();
+     * liveConnectionManager.disconnect();
+     */
+    disconnect(): Promise<void>;
+    private JSCallNativeFunctionPromise;
+    private observerFunction;
+    private handleLiveConnectionEvent;
+}
+
 /**
  * TUIRoomEngine 提供了音视频房间的能力
  *
@@ -1908,6 +2279,8 @@ declare class TUIRoomEngine {
     private conferenceListManager;
     private conferenceInvitationManager;
     private liveListManager;
+    private liveLayoutManager;
+    private liveConnectionManager;
     private static userId;
     private static sdkAppId;
     private static Module;
@@ -1935,6 +2308,13 @@ declare class TUIRoomEngine {
      */
     private JSCallNativeFunctionPromise;
     private JSCallNativeRequestFunctionPromise;
+    /**
+     * @private
+     * 调用 TUIRoomEngineWASM 的 CallAPI 方法
+     * @param funcName
+     * @param jsonString
+     */
+    private JSCallNativeCallAPIPromise;
     /**
      * 登录 TUIRoomEngine
      *
@@ -2020,7 +2400,7 @@ declare class TUIRoomEngine {
      * @param {string=} [options.roomName=roomId] 房间名称，默认值为 roomId，传入的值不能为空字符串
      * @param {TUIRoomType=} [options.roomType=TUIRoomType.kConference] 房间类型, 默认值为 TUIRoomType.kConference <br>
      * 办公协同、医疗问诊、远程会议、教育场景，roomType 设置为 TUIRoomType.kConference
-     * 电商直播、语聊房场景，roomType 设置为 TUIRoomType.kLivingRoom
+     * 电商直播、语聊房场景，roomType 设置为 TUIRoomType.kLive
      * @param {boolean=} [options.isSeatEnabled=false] 是否开启麦位控制，默认值为 false
      * @param {TUISeatMode=} [options.seatMode=TUISeatMode.kFreeToTake] 上麦模式(开启麦位控制后生效)，默认值为 TUISeatMode.kFreeToTake <br>
      * 自由上麦模式，台下观众可以自由上麦，无需申请，seatMode 设置为 TUISeatMode.kFreeToTake
@@ -2031,8 +2411,9 @@ declare class TUIRoomEngine {
      * @param {boolean=} [options.isMessageDisableForAllUser=false] 是否允许成员发送消息，默认不禁止（创建房间可选参数）
      * @param {number=} options.maxSeatCount 最大麦位数量 （创建房间可选参数）
      * @param {string=} [options.password=''] 房间密码，（该属性自 v2.5.0 版本支持） <br>
+     * @param {boolean=} [options.keepOwnerOnSeat=false] 是否保持房主座位，默认不保持房主座位（该属性自 v3.1.0 版本支持）
      * roomType 为 TUIRoomType.kConference (教育及会议场景) 时，maxSeatCount 值不做限制；
-     * roomType 为 TUIRoomType.kLive(直播场景) 时，maxSeatCount 最大限制为 16；
+     * roomType 为 TUIRoomType.kLive (直播场景) 时，maxSeatCount 最大限制为 16；
      * @returns {Promise<void>}
      *
      * @example
@@ -2057,6 +2438,7 @@ declare class TUIRoomEngine {
         isMessageDisableForAllUser?: boolean;
         maxSeatCount?: number;
         password?: string;
+        keepOwnerOnSeat?: boolean;
     }): Promise<void>;
     /**
      * 进入房间接口
@@ -2940,36 +3322,42 @@ declare class TUIRoomEngine {
      */
     getSeatApplicationList(): Promise<TUIRequest[]>;
     /**
+     * @since v3.1.0
      * 发送文本消息
-     * @deprecated 该接口自 v2.0.0 版本废弃，请使用 {@link getTIM} 方法获取 tim 实例发送消息
      * @param {object} options
-     * @param {string} options.messageText 文本消息内容
+     * @param {string} options.textContent 文本消息内容
+     * @param {object} options.extensionInfo 扩展信息
      * @returns {Promise<void>}
      *
      * @example
      * const roomEngine = new TUIRoomEngine();
      * await roomEngine.sendTextMessage({
-     *  messageText: 'hello, everyone',
+     *  textContent: 'hello, everyone',
+     *  extensionInfo: {}
      * });
      */
     sendTextMessage(options: {
-        messageText: string;
+        textContent: string;
+        extensionInfo: object;
     }): Promise<void>;
     /**
+     * @since v3.1.0
      * 发送自定义消息
      * @param {object} options
-     * @deprecated 该接口自 v2.0.0 版本废弃，请使用 {@link getTIM} 方法获取 tim 实例发送消息
-     * @param {string} options.messageText 自定义消息内容
+     * @param {string} options.businessId 业务 Id
+     * @param {string} options.data 自定义消息内容
      * @returns {Promise<void>}
      *
      * @example
      * const roomEngine = new TUIRoomEngine();
      * await roomEngine.sendCustomMessage({
-     *  messageText: '{ data:'', description: ''}',
+     *  businessId: '111',
+     *  data: '{"msg":"test"}',
      * });
      */
     sendCustomMessage(options: {
-        messageText: string;
+        businessId: string;
+        data: string;
     }): Promise<void>;
     /**
      * 开始屏幕共享
@@ -3196,12 +3584,19 @@ declare class TUIRoomEngine {
      * 开始进行麦克风测试
      * @param options
      * @param {number} options.interval 麦克风音量的回调时间
+     *
+     * @example
+     * const roomEngine = new TUIRoomEngine();
+     * await roomEngine.startMicDeviceTest({interval: 200});
      */
     startMicDeviceTest(options: {
         interval: number;
     }): Promise<void>;
     /**
      * 停止进行麦克风测试
+     * @example
+     * const roomEngine = new TUIRoomEngine();
+     * await roomEngine.stopMicDeviceTest();
      */
     stopMicDeviceTest(): Promise<void>;
     /**
@@ -3236,6 +3631,28 @@ declare class TUIRoomEngine {
      * const liveListManager = roomEngine.getLiveListManager();
      */
     getLiveListManager(): TUILiveListManager;
+    /**
+     * v3.0.0 版本起支持 getLiveLayoutManager 获取 TUILiveLayoutManager 模块
+     *
+     * @since v3.0.0
+     * @returns {TUILiveLayoutManager}
+     *
+     * @example
+     * const roomEngine = new TUIRoomEngine();
+     * const liveLayoutManager = roomEngine.getLiveLayoutManager();
+     */
+    getLiveLayoutManager(): TUILiveLayoutManager;
+    /**
+     * v3.2.0 版本起支持 getLiveConnectionManager 获取 TUILiveConnectionManager 模块
+     *
+     * @since v3.2.0
+     * @returns {TUILiveConnectionManager}
+     *
+     * @example
+     * const roomEngine = new TUIRoomEngine();
+     * const liveConnectionManager = roomEngine.getLiveConnectionManager();
+     */
+    getLiveConnectionManager(): TUILiveConnectionManager;
     /**
      * v2.6.0 版本起支持使用 getConferenceInvitationManager 获取 conferenceInvitation 模块
      * @since v2.6.0
@@ -3278,4 +3695,4 @@ declare class TUIRoomEngine {
     private static handleSetFramework;
 }
 
-export { TRTCRole, TUIAudioQuality, TUIAudioRoute, TUICaptureSourceType, TUIChangeReason, TUIConferenceCancelReason, type TUIConferenceInfo, TUIConferenceInvitationManager, TUIConferenceInvitationManagerEvents, TUIConferenceListManager, TUIConferenceListManagerEvents, type TUIConferenceModifyInfo, TUIConferenceStatus, type TUIDeviceInfo, type TUIEnterRoomOptions, TUIErrorCode, type TUIInvitation, TUIInvitationCode, TUIInvitationRejectedReason, TUIInvitationStatus, TUIKickedOutOfRoomReason, type TUILiveInfo, TUILiveLayoutManagerEvents, TUILiveListManagerEvents, type TUILiveListResult, TUILiveModifyFlag, type TUILiveModifyInfo, type TUILoginUserInfo, TUIMediaDevice, TUIMediaDeviceState, TUIMediaDeviceType, type TUIMessage, type TUINetwork, TUINetworkQuality, type TUIRequest, TUIRequestAction, type TUIRequestCallback, TUIRequestCallbackType, TUIResolutionMode, TUIRole, TUIRoomDeviceManager, TUIRoomDeviceMangerEvents, TUIRoomDismissedReason, TUIRoomEvents, type TUIRoomInfo, TUIRoomType, type TUISeatInfo, type TUISeatLockParams, TUISeatMode, type TUIUserInfo, type TUIVideoEncoderParams, TUIVideoQuality, TUIVideoStreamType, TUIRoomEngine as default };
+export { TRTCRole, TUIAudioQuality, TUIAudioRoute, TUICaptureSourceType, TUIChangeReason, TUIConferenceCancelReason, type TUIConferenceInfo, TUIConferenceInvitationManager, TUIConferenceInvitationManagerEvents, TUIConferenceListManager, TUIConferenceListManagerEvents, type TUIConferenceModifyInfo, TUIConferenceStatus, type TUIDeviceInfo, type TUIEnterRoomOptions, TUIErrorCode, type TUIInvitation, TUIInvitationCode, TUIInvitationRejectedReason, TUIInvitationStatus, TUIKickedOutOfRoomReason, TUILiveConnectionManagerEvents, type TUILiveInfo, TUILiveLayoutManager, TUILiveLayoutManagerEvents, TUILiveListManager, TUILiveListManagerEvents, type TUILiveListResult, TUILiveModifyFlag, type TUILiveModifyInfo, type TUILoginUserInfo, TUIMediaDevice, TUIMediaDeviceState, TUIMediaDeviceType, type TUIMessage, type TUINetwork, TUINetworkQuality, type TUIRequest, TUIRequestAction, type TUIRequestCallback, TUIRequestCallbackType, TUIResolutionMode, TUIRole, TUIRoomDeviceManager, TUIRoomDeviceMangerEvents, TUIRoomDismissedReason, TUIRoomEvents, type TUIRoomInfo, TUIRoomType, type TUISeatInfo, type TUISeatLockParams, TUISeatMode, type TUIUserInfo, type TUIVideoEncoderParams, TUIVideoQuality, TUIVideoStreamType, TUIRoomEngine as default };