@tencentcloud/tuiroom-engine-js 3.3.0-beta.1 → 3.3.0-beta.3

package/index.d.ts

@@ -1292,13 +1292,19 @@ declare enum TUILiveLayoutManagerEvents {
      * @example
      * const roomEngine = new TUIRoomEngine();
      * const liveLayoutManager = roomEngine.getLiveLayoutManager();
-     * const callback = (roomId, seatLayout) => {
+     * const callback = ({ roomId, seatLayout }) => {
      *   console.log('liveLayoutManager.onSeatLayoutChanged', roomId, seatLayout);
      * });
      * liveLayoutManager.on(TUILiveLayoutManagerEvents.onSeatLayoutChanged, callback);
      */
     onSeatLayoutChanged = "onSeatLayoutChanged"
 }
+/** 麦上用户的媒体状态信息
+ * @typedef {object} TUIDeviceStatus
+ * @property {number} TUIDeviceStatusOpened 当前设备处于打开状态
+ * @property {number} TUIDeviceStatusClosedBySelf 当前设备处于关闭状态，且是用户主动关闭
+ * @property {number} TUIDeviceStatusClosedByAdmin 当前设备处于关闭状态，且是被房主/管理员强制关闭
+ */
 declare enum TUIDeviceStatus {
     TUIDeviceStatusOpened = 0,
     TUIDeviceStatusClosedBySelf = 1,
@@ -1309,7 +1315,7 @@ declare enum TUIDeviceStatus {
  * @typedef {object} TUISeatRegion
  * @property {string} roomId 直播间 ID
  * @property {number} seatIndex 麦位序号
- * @property {isSeatLocked} isSeatLocked 是否被锁定
+ * @property {boolean} isSeatLocked 是否被锁定
  * @property {string} userId 用户 ID
  * @property {string} userName 用户名称
  * @property {string} userAvatar 用户头像
@@ -1350,14 +1356,6 @@ type TUISeatLayout = {
     canvasHeight: number;
     regions: Array<TUISeatRegion>;
 };
-declare enum TUISeatLayoutTemplate {
-    LandscapeDynamic_1v3 = 200,
-    PortraitDynamic_Grid9 = 600,
-    PortraitDynamic_1v6 = 601,
-    PortraitFixed_Grid9 = 800,
-    PortraitFixed_1v6 = 801,
-    PortraitFixed_6v6 = 802
-}
 /**
  * 直播间统计信息
  * @typedef {object} TUILiveStatisticsData
@@ -1474,6 +1472,220 @@ declare enum TUILiveConnectionManagerEvents {
      * });
      */
     onConnectionRequestTimeout = "onConnectionRequestTimeout"
+}
+/**
+ * 直播连线配置信息
+ */
+type TUIBattleConfig = {
+    duration: number;
+    needResponse?: boolean;
+    extensionInfo?: string;
+};
+/**
+ * 直播PK用户信息
+ */
+type TUIBattleUser = {
+    roomId: string;
+    userId: string;
+    userName: string;
+    avatarUrl: string;
+    score: number;
+};
+/**
+ * 直播PK信息
+ */
+type TUIBattleInfo = {
+    fromUser: TUIBattleUser;
+    toUserList: Array<TUIBattleUser>;
+    extensionInfo: string;
+    battleId: string;
+    needResponse: boolean;
+    duration: number;
+    startTime: number;
+    endTime: number;
+};
+declare enum TUIBattleStoppedReason {
+    kStoppedByTimeOver = 0,
+    kStoppedByOtherExit = 1
+}
+declare enum TUIBattleCode {
+    kUnknown = -1,
+    kSuccess = 0,
+    kRoomNotExist = 1,
+    kBattling = 2,
+    kBattlingOtherRoom = 3,
+    kRoomExit = 4,
+    kRetry = 5
+}
+/**
+ * @since v3.3.0
+ * **TUILiveBattleManager** 事件列表<br>
+ */
+declare enum TUILiveBattleManagerEvents {
+    /**
+     * @description 接收到PK开始的监听事件
+     * @default 'onBattleStarted'
+     * @event TUILiveBattleManagerEvents#onBattleStarted
+     * @param {object} options
+     * @param {TUIBattleInfo} battleInfo PK信息
+     *
+     * @example
+     * const roomEngine = new TUIRoomEngine();
+     * const liveBattleManager = roomEngine.TUILiveBattleManager();
+     * liveBattleManager.on(TUILiveBattleManagerEvents.onBattleStarted, ({ battleInfo }) => {
+     *   console.log('liveBattleManager.onBattleStarted', battleInfo);
+     * });
+     */
+    onBattleStarted = "onBattleStarted",
+    /**
+     * @description 接收到PK结束的监听事件
+     * @default 'onBattleEnded'
+     * @event TUILiveBattleManagerEvents#onBattleEnded
+     * @param {object} options
+     * @param {TUIBattleInfo} battleInfo PK信息
+     * @param {TUIBattleStoppedReason} reason PK结束原因
+     *
+     * @example
+     * const roomEngine = new TUIRoomEngine();
+     * const liveBattleManager = roomEngine.TUILiveBattleManager();
+     * liveBattleManager.on(TUILiveBattleManagerEvents.onBattleEnded, ({ battleInfo, reason }) => {
+     *   console.log('liveBattleManager.onBattleEnded', battleInfo, reason);
+     * });
+     */
+    onBattleEnded = "onBattleEnded",
+    /**
+     * @description 接收到用户加入PK的监听事件
+     * @default 'onUserJoinBattle'
+     * @event TUILiveBattleManagerEvents#onUserJoinBattle
+     * @param {object} options
+     * @param {String} battleId PK的Id
+     * @param {TUIBattleUser} user PK用户信息
+     *
+     * @example
+     * const roomEngine = new TUIRoomEngine();
+     * const liveBattleManager = roomEngine.TUILiveBattleManager();
+     * liveBattleManager.on(TUILiveBattleManagerEvents.onUserJoinBattle, ({ battleId, user }) => {
+     *   console.log('liveBattleManager.onUserJoinBattle', battleId, user);
+     * });
+     */
+    onUserJoinBattle = "onUserJoinBattle",
+    /**
+     * @description 接收到用户退出PK的监听事件
+     * @default 'onUserExitBattle'
+     * @event TUILiveBattleManagerEvents#onUserExitBattle
+     * @param {object} options
+     * @param {String} battleId PK的Id
+     * @param {TUIBattleUser} user PK用户信息
+     *
+     * @example
+     * const roomEngine = new TUIRoomEngine();
+     * const liveBattleManager = roomEngine.TUILiveBattleManager();
+     * liveBattleManager.on(TUILiveBattleManagerEvents.onUserExitBattle, ({ battleId, user }) => {
+     *   console.log('liveBattleManager.onUserExitBattle', battleId, user);
+     * });
+     */
+    onUserExitBattle = "onUserExitBattle",
+    /**
+     * @description 接收到PK分数变化的监听事件
+     * @default 'onBattleScoreChanged'
+     * @event TUILiveBattleManagerEvents#onBattleScoreChanged
+     * @param {object} options
+     * @param {String} battleId PK的Id
+     * @param {Array<TUIBattleUser>} battleUserList PK用户信息列表
+     *
+     * @example
+     * const roomEngine = new TUIRoomEngine();
+     * const liveBattleManager = roomEngine.TUILiveBattleManager();
+     * liveBattleManager.on(TUILiveBattleManagerEvents.onBattleScoreChanged, ({ battleId, battleUserList }) => {
+     *   console.log('liveBattleManager.onBattleScoreChanged', battleId, battleUserList);
+     * });
+     */
+    onBattleScoreChanged = "onBattleScoreChanged",
+    /**
+     * @description 接收PK请求的监听事件
+     * @default 'onBattleRequestReceived'
+     * @event TUILiveBattleManagerEvents#onBattleRequestReceived
+     * @param {object} options
+     * @param {TUIBattleInfo} battleInfo PK信息
+     * @param {TUIBattleUser} inviter 发起PK请求的用户
+     * @param {TUIBattleUser} invitee 接收PK请求的用户
+     *
+     * @example
+     * const roomEngine = new TUIRoomEngine();
+     * const liveBattleManager = roomEngine.TUILiveBattleManager();
+     * liveBattleManager.on(TUILiveBattleManagerEvents.onBattleRequestReceived, ({ battleInfo, inviter, invitee }) => {
+     *   console.log('liveBattleManager.onBattleRequestReceived', battleInfo, inviter, invitee);
+     * });
+     */
+    onBattleRequestReceived = "onBattleRequestReceived",
+    /**
+     * @description 接收PK请求取消的监听事件
+     * @default 'onBattleRequestCancelled'
+     * @event TUILiveBattleManagerEvents#onBattleRequestCancelled
+     * @param {object} options
+     * @param {TUIBattleInfo} battleInfo PK信息
+     * @param {TUIBattleUser} inviter 发起PK请求的用户
+     * @param {TUIBattleUser} invitee 接收PK请求的用户
+     *
+     * @example
+     * const roomEngine = new TUIRoomEngine();
+     * const liveBattleManager = roomEngine.TUILiveBattleManager();
+     * liveBattleManager.on(TUILiveBattleManagerEvents.onBattleRequestCancelled, ({ battleInfo, inviter, invitee }) => {
+     *   console.log('liveBattleManager.onBattleRequestCancelled', battleInfo, inviter, invitee);
+     * });
+     */
+    onBattleRequestCancelled = "onBattleRequestCancelled",
+    /**
+     * @description 接收PK请求超时的监听事件
+     * @default 'onBattleRequestTimeout'
+     * @event TUILiveBattleManagerEvents#onBattleRequestTimeout
+     * @param {object} options
+     * @param {TUIBattleInfo} battleInfo PK信息
+     * @param {TUIBattleUser} inviter 发起PK请求的用户
+     * @param {TUIBattleUser} invitee 接收PK请求的用户
+     *
+     * @example
+     * const roomEngine = new TUIRoomEngine();
+     * const liveBattleManager = roomEngine.TUILiveBattleManager();
+     * liveBattleManager.on(TUILiveBattleManagerEvents.onBattleRequestTimeout, ({ battleInfo, inviter, invitee }) => {
+     *   console.log('liveBattleManager.onBattleRequestTimeout', battleInfo, inviter, invitee);
+     * });
+     */
+    onBattleRequestTimeout = "onBattleRequestTimeout",
+    /**
+     * @description 接收PK请求接受的监听事件
+     * @default 'onBattleRequestAccept'
+     * @event TUILiveBattleManagerEvents#onBattleRequestAccept
+     * @param {object} options
+     * @param {TUIBattleInfo} battleInfo PK信息
+     * @param {TUIBattleUser} inviter 发起PK请求的用户
+     * @param {TUIBattleUser} invitee 接收PK请求的用户
+     *
+     * @example
+     * const roomEngine = new TUIRoomEngine();
+     * const liveBattleManager = roomEngine.TUILiveBattleManager();
+     * liveBattleManager.on(TUILiveBattleManagerEvents.onBattleRequestAccept, ({ battleInfo, inviter, invitee }) => {
+     *   console.log('liveBattleManager.onBattleRequestAccept', battleInfo, inviter, invitee);
+     * });
+     */
+    onBattleRequestAccept = "onBattleRequestAccept",
+    /**
+     * @description 接收PK请求被拒绝的监听事件
+     * @default 'onBattleRequestReject'
+     * @event TUILiveBattleManagerEvents#onBattleRequestReject
+     * @param {object} options
+     * @param {TUIBattleInfo} battleInfo PK信息
+     * @param {TUIBattleUser} inviter 发起PK请求的用户
+     * @param {TUIBattleUser} invitee 接收PK请求的用户
+     *
+     * @example
+     * const roomEngine = new TUIRoomEngine();
+     * const liveBattleManager = roomEngine.TUILiveBattleManager();
+     * liveBattleManager.on(TUILiveBattleManagerEvents.onBattleRequestReject, ({ battleInfo, inviter, invitee }) => {
+     *   console.log('liveBattleManager.onBattleRequestReject', battleInfo, inviter, invitee);
+     * });
+     */
+    onBattleRequestReject = "onBattleRequestReject"
 }
 
 declare class Logger {
@@ -2073,9 +2285,123 @@ declare class TUILiveListManager {
         logger: Logger;
         roomEngineWASM: any;
     });
+    /**
+     * 开始直播
+     *
+     * @description 创建并开始一个新的直播间，房主调用此接口来启动直播
+     * @since 3.3.0
+     * @param {TUILiveInfo} liveInfo 直播间信息，包含房间ID、名称、公告等配置
+     * @returns {Promise<TUILiveInfo>} 返回创建成功后的直播间完整信息，包含CDN流地址等
+     * @throws {TUIError} 可能抛出的错误：
+     *   - ERR_ALREADY_ROOM_OWNER: 用户已经是房间所有者
+     *   - ERR_INVALID_PARAMETER: 传入的参数不合法
+     *   - ERR_LIVE_SERVER_PROCESS_FAILED: 服务器处理请求失败
+     * @example
+     * ```typescript
+     * const liveInfo = {
+     *   roomId: '123',
+     *   roomType: TUIRoomType.kLivingRoom,
+     *   name: 'ABC',
+     *   notice: 'this is a description',
+     *   isSeatEnabled: true,
+     *   seatMode: TUISeatMode.kApplyToTake,
+     *   seatLayoutTemplateId: 200,
+     *   coverUrl: '',
+     *   backgroundUrl: '',
+     *   categoryList: [],
+     *   activityStatus: 1,
+     *   isMessageDisableForAllUser: false,
+     *   isGiftEnabled: false,
+     *   isLikeEnabled: false,
+     *   isPublicVisible: false,
+     *   keepOwnerOnSeat: false,
+     * };
+     * const roomEngine = new TUIRoomEngine();
+     * const liveListManager = roomEngine.getLiveListManager();
+     * const resultLiveInfo = await liveListManager.startLive(liveInfo);
+     * console.log('直播开始成功，CDN流地址：', resultLiveInfo.cdnStreamUrl);
+     * ```
+     */
     startLive(liveInfo: TUILiveInfo): Promise<TUILiveInfo>;
+    /**
+     * 停止直播
+     *
+     * @description 结束当前正在进行的直播，只有房主可以调用此接口停止直播
+     * @since 3.3.0
+     * @returns {Promise<TUILiveStatisticsData>} 返回直播统计数据，包含观众人数、礼物数量、点赞数等信息
+     * @throws {TUIError} 可能抛出的错误：
+     *   - ERR_DESTROY_ROOM_NO_PERMISSION: 没有权限停止直播（仅房主可操作）
+     *   - ERR_OPERATION_INVALID_BEFORE_ENTER_ROOM: 需要进房后才可使用此功能
+     *   - ERR_LIVE_SERVER_PROCESS_FAILED: 服务器处理请求失败
+     * @example
+     * ```typescript
+     * try {
+     *   const roomEngine = new TUIRoomEngine();
+     *   const liveListManager = roomEngine.getLiveListManager();
+     *   const statistics = await liveListManager.stopLive();
+     *   console.log('直播结束，统计数据：', {
+     *     观众人数: statistics.totalViewers,
+     *     礼物总数: statistics.totalGiftsSent,
+     *     点赞总数: statistics.totalLikesReceived
+     *   });
+     * } catch (error) {
+     *   console.error('停止直播失败：', error);
+     * }
+     * ```
+     */
     stopLive(): Promise<TUILiveStatisticsData>;
+    /**
+     * 加入直播
+     *
+     * @description 观众加入指定的直播间，开始观看直播内容
+     * @since 3.3.0
+     * @param {string} roomId 要加入的直播间ID
+     * @returns {Promise<TUILiveInfo>} 返回加入成功后的直播间信息，包含直播间名称、公告等详细信息
+     * @throws {TUIError} 可能抛出的错误：
+     *   - ERR_ALREADY_ROOM_ENTER: 用户已经进入房间，重复进入房间操作
+     *   - ERR_INVALID_PARAMETER: 房间ID参数不合法
+     *   - ERR_LIVE_REQUEST_SERVER_TIMEOUT: 请求服务器超时
+     *   - ERR_LIVE_DISCONNECTED: 直播连接断开
+     * @example
+     * ```typescript
+     * try {
+     *   const roomEngine = new TUIRoomEngine();
+     *   const liveListManager = roomEngine.getLiveListManager();
+     *   const liveInfo = await liveListManager.joinLive('live_room_123');
+     *   console.log('成功加入直播间：', {
+     *     房间名称: liveInfo.name,
+     *     房间公告: liveInfo.notice,
+     *     CDN流地址: liveInfo.cdnStreamUrl
+     *   });
+     * } catch (error) {
+     *   console.error('加入直播间失败：', error);
+     * }
+     * ```
+     */
     joinLive(roomId: string): Promise<TUILiveInfo>;
+    /**
+     * 离开直播
+     *
+     * @description 观众退出当前正在观看的直播间，结束观看直播
+     * @since 3.3.0
+     * @returns {Promise<void>} 无返回值，成功离开直播间后Promise将resolve
+     * @throws {TUIError} 可能抛出的错误：
+     *   - ERR_OPERATION_INVALID_BEFORE_ENTER_ROOM: 需要进房后才可使用此功能
+     *   - ERR_EXIT_NOT_SUPPORTED_FOR_ROOM_OWNER: 房主不支持退房操作（房主只能停止直播）
+     *   - ERR_LIVE_SERVER_PROCESS_FAILED: 服务器处理请求失败
+     * @note 如果是房主想要结束直播，应该使用 stopLive() 接口而不是 leaveLive()
+     * @example
+     * ```typescript
+     * try {
+     *   const roomEngine = new TUIRoomEngine();
+     *   const liveListManager = roomEngine.getLiveListManager();
+     *   await liveListManager.leaveLive();
+     *   console.log('成功离开直播间');
+     * } catch (error) {
+     *   console.error('离开直播间失败：', error);
+     * }
+     * ```
+     */
     leaveLive(): Promise<void>;
     /**
      * 修改直播间信息
@@ -2321,6 +2647,92 @@ declare class TUILiveConnectionManager {
         logger: Logger;
         roomEngineWASM: any;
     });
+    /**
+     * 请求跨房连线
+     *
+     * @param {object} options
+     * @param {Array<string>} options.roomIdList 待邀请的连线房间ID列表
+     * @param {number} options.timeout 请求超时时间, 单位 s
+     * @param {string} options.extensionInfo 扩展信息, 可选, 默认为: ''
+     * @returns {Promise<void>}
+     *
+     * @example
+     * const roomEngine = new TUIRoomEngine();
+     * const liveConnectionManager = roomEngine.getLiveConnectionManager();
+     * liveConnectionManager.requestConnection({
+     *   roomIdList: ['roomId1','roomId2'],
+     *   timeout: 10,
+     *   extensionInfo: 'extension info'
+     * });
+     */
+    requestConnection(options: {
+        roomIdList: Array<string>;
+        timeout: number;
+        extensionInfo?: string;
+    }): Promise<void>;
+    /**
+     * 取消跨房连线请求
+     *
+     * @param {object} options
+     * @param {Array<string>} options.roomIdList 被取消连线请求的房间Id列表
+     * @returns {Promise<void>}
+     *
+     * @example
+     * const roomEngine = new TUIRoomEngine();
+     * const liveConnectionManager = roomEngine.getLiveConnectionManager();
+     * liveConnectionManager.cancelConnectionRequest({
+     *   roomIdList: ['roomId1', 'roomId2']
+     * });
+     */
+    cancelConnectionRequest(options: {
+        roomIdList: Array<string>;
+    }): Promise<void>;
+    /**
+     * 同意连线请求
+     *
+     * @param {object} options
+     * @param {string} options.roomId 直播房间 ID
+     * @returns {Promise<void>}
+     *
+     * @example
+     * const roomEngine = new TUIRoomEngine();
+     * const liveConnectionManager = roomEngine.getLiveConnectionManager();
+     * liveConnectionManager.acceptConnection({
+     *   roomId: 'roomId'
+     * });
+     */
+    acceptConnection(options: {
+        roomId: string;
+    }): Promise<void>;
+    /**
+     * 拒绝连线请求
+     *
+     * @param {object} options
+     * @param {string} options.roomId 直播房间 ID
+     * @returns {Promise<void>}
+     *
+     * @example
+     * const roomEngine = new TUIRoomEngine();
+     * const liveConnectionManager = roomEngine.getLiveConnectionManager();
+     * liveConnectionManager.rejectConnection({
+     *   roomId: 'roomId'
+     * });
+     */
+    rejectConnection(options: {
+        roomId: string;
+    }): Promise<void>;
+    /**
+     * 断开直播连线
+     *
+     * @returns {Promise<void>}
+     *
+     * @example
+     * const roomEngine = new TUIRoomEngine();
+     * const liveConnectionManager = roomEngine.getLiveConnectionManager();
+     * liveConnectionManager.disconnect();
+     */
+    disconnect(): Promise<void>;
+    private JSCallNativeFunctionPromise;
     /**
      * 监听 TUILiveConnectionManager 事件
      * @param {TUILiveConnectionManagerEvents} event 事件名
@@ -2332,7 +2744,7 @@ declare class TUILiveConnectionManager {
      * const callback = (inviter) => {
      *   console.log('liveConnectionManager.onConnectionRequestReceived', inviter);
      * };
-     * liveConnectionManager.on(TUILiveLayoutManagerEvents.onLiveVideoLayoutChanged, callback);
+     * liveConnectionManager.on(TUILiveConnectionManagerEvents.onLiveVideoLayoutChanged, callback);
      */
     on(event: TUILiveConnectionManagerEvents, func: (...args: any[]) => void): void;
     /**
@@ -2346,70 +2758,147 @@ declare class TUILiveConnectionManager {
      * const callback = (inviter) => {
      *   console.log('liveConnectionManager.onConnectionRequestReceived', inviter);
      * };
-     * liveConnectionManager.off(TUILiveLayoutManagerEvents.onLiveVideoLayoutChanged, callback);
+     * liveConnectionManager.off(TUILiveConnectionManagerEvents.onLiveVideoLayoutChanged, callback);
      */
     off(event: TUILiveConnectionManagerEvents, func: (...args: any[]) => void): void;
+    private observerFunction;
+}
+
+/**
+ * 直播PK
+ * @class TUILiveBattleManager
+ */
+declare class TUILiveBattleManager {
+    private liveBattleManagerWASM;
+    private logger;
+    private static liveBattleManager;
+    constructor(options: {
+        Module: any;
+        logger: Logger;
+        roomEngineWASM: any;
+    });
     /**
-     * 请求跨房连线
+     * 请求PK
      *
-     * @param {Array<string>} roomIdList 待邀请的连线房间ID列表
-     * @param {string} timeOut 请求超时时间, 单位 s
-     * @param {string} extensionInfo 扩展信息, 可选, 默认为: ''
+     * @param {object} options
+     * @param {TUIBattleConfig} options.config
+     * @param {Array<string>} options.userIdList
+     * @param {number} options.timeOut
      * @returns {Promise<void>}
      *
      * @example
      * const roomEngine = new TUIRoomEngine();
-     * const liveConnectionManager = roomEngine.getLiveConnectionManager();
-     * liveConnectionManager.requestConnection(['roomId1','roomId2'], 10);
+     * const liveBattleManager = roomEngine.getLiveBattleManager();
+     * liveBattleManager.requestBattle({
+     *   config: {duration: 100, needResponse: true},
+     *   userIdList: ['userId1'],
+     *   timeout: 10
+     * });
      */
-    requestConnection(roomIdList: Array<string>, timeOut: number, extensionInfo?: string): Promise<void>;
+    requestBattle(options: {
+        config: TUIBattleConfig;
+        userIdList: Array<string>;
+        timeout: number;
+    }): Promise<any>;
     /**
-     * 取消跨房连线请求
+     * 取消PK请求
      *
-     * @param {Array<string>} roomIdList 被取消连线请求的房间Id列表
+     * @param {object} options
+     * @param {string} options.battleId
+     * @param {Array<string>} options.userIdList
      * @returns {Promise<void>}
      *
      * @example
      * const roomEngine = new TUIRoomEngine();
-     * const liveConnectionManager = roomEngine.getLiveConnectionManager();
-     * liveConnectionManager.cancelConnectionRequest(['roomId1', 'roomId2']);
+     * const liveBattleManager = roomEngine.getLiveBattleManager();
+     * liveBattleManager.cancelBattleRequest({
+     *   battleId: 'battleId',
+     *   userIdList: ['userId1'],
+     * });
      */
-    cancelConnectionRequest(roomIdList: Array<string>): Promise<void>;
+    cancelBattleRequest(options: {
+        battleId: string;
+        userIdList: Array<string>;
+    }): Promise<void>;
     /**
-     * 同意连线请求
+     * 接受PK请求
      *
-     * @param {string} roomId 直播房间 ID
+     * @param {object} options
+     * @param {string} options.battleId
      * @returns {Promise<void>}
      *
      * @example
      * const roomEngine = new TUIRoomEngine();
-     * const liveConnectionManager = roomEngine.getLiveConnectionManager();
-     * liveConnectionManager.acceptConnection('roomId');
+     * const liveBattleManager = roomEngine.getLiveBattleManager();
+     * liveBattleManager.acceptBattle({
+     *   battleId: 'battleId',
+     * });
      */
-    acceptConnection(roomId: string): Promise<void>;
+    acceptBattle(options: {
+        battleId: string;
+    }): Promise<void>;
     /**
-     * 拒绝连线请求
+     * 拒绝PK请求
      *
-     * @param {string} roomId 直播房间 ID
+     * @param {object} options
+     * @param {string} options.battleId
      * @returns {Promise<void>}
      *
      * @example
      * const roomEngine = new TUIRoomEngine();
-     * const liveConnectionManager = roomEngine.getLiveConnectionManager();
-     * liveConnectionManager.rejectConnection('roomId');
+     * const liveBattleManager = roomEngine.getLiveBattleManager();
+     * liveBattleManager.rejectBattle({
+     *   battleId: 'battleId',
+     * });
      */
-    rejectConnection(roomId: string): Promise<void>;
+    rejectBattle(options: {
+        battleId: string;
+    }): Promise<void>;
     /**
-     * 断开直播连线
+     * 退出PK
      *
+     * @param {object} options
+     * @param {string} options.battleId
      * @returns {Promise<void>}
      *
      * @example
      * const roomEngine = new TUIRoomEngine();
-     * const liveConnectionManager = roomEngine.getLiveConnectionManager();
-     * liveConnectionManager.disconnect();
+     * const liveBattleManager = roomEngine.getLiveBattleManager();
+     * liveBattleManager.exitBattle({
+     *   battleId: 'battleId',
+     * });
      */
-    disconnect(): Promise<void>;
+    exitBattle(options: {
+        battleId: string;
+    }): Promise<void>;
+    /**
+     * 监听 TUILiveBattleManager 事件
+     * @param {TUILiveBattleManagerEvents} event 事件名
+     * @param func 事件回调函数
+     *
+     * @example
+     * const roomEngine = new TUIRoomEngine();
+     * const liveBattleManager = roomEngine.getLiveBattleManager();
+     * const callback = (battleInfo) => {
+     *   console.log('liveBattleManager.onBattleStarted', battleInfo);
+     * };
+     * liveBattleManager.on(TUILiveBattleManagerEvents.onBattleStarted, callback);
+     */
+    on(event: TUILiveBattleManagerEvents, func: (...args: any[]) => void): void;
+    /**
+     * 取消监听 TUILiveBattleManager 事件
+     * @param {TUILiveBattleManagerEvents} event 事件名
+     * @param func 事件回调函数
+     *
+     * @example
+     * const roomEngine = new TUIRoomEngine();
+     * const liveBattleManager = roomEngine.getLiveBattleManager();
+     * const callback = (battleInfo) => {
+     *   console.log('liveBattleManager.onBattleStarted', battleInfo);
+     * };
+     * liveBattleManager.off(TUILiveBattleManagerEvents.onBattleStarted, callback);
+     */
+    off(event: TUILiveBattleManagerEvents, func: (...args: any[]) => void): void;
     private JSCallNativeFunctionPromise;
     private observerFunction;
 }
@@ -2431,6 +2920,7 @@ declare class TUIRoomEngine {
     private liveListManager;
     private liveLayoutManager;
     private liveConnectionManager;
+    private liveBattleManager;
     private static userId;
     private static sdkAppId;
     private static Module;
@@ -3861,6 +4351,17 @@ declare class TUIRoomEngine {
      * const liveConnectionManager = roomEngine.getLiveConnectionManager();
      */
     getLiveConnectionManager(): TUILiveConnectionManager;
+    /**
+     * v3.3.0 版本起支持 getLiveBattleManager 获取 TUILiveBattleManager 模块
+     *
+     * @since v3.3.0
+     * @returns {TUILiveBattleManager}
+     *
+     * @example
+     * const roomEngine = new TUIRoomEngine();
+     * const liveBattleManager = roomEngine.getLiveBattleManager();
+     */
+    getLiveBattleManager(): TUILiveBattleManager;
     /**
      * v2.6.0 版本起支持使用 getConferenceInvitationManager 获取 conferenceInvitation 模块
      * @since v2.6.0
@@ -3903,4 +4404,4 @@ declare class TUIRoomEngine {
     private static handleSetFramework;
 }
 
-export { TRTCRole, TUIAudioQuality, TUIAudioRoute, type TUIAutoPlayCallbackInfo, TUICaptureSourceType, TUIChangeReason, TUIConferenceCancelReason, type TUIConferenceInfo, TUIConferenceInvitationManager, TUIConferenceInvitationManagerEvents, TUIConferenceListManager, TUIConferenceListManagerEvents, type TUIConferenceModifyInfo, TUIConferenceStatus, type TUIDeviceInfo, TUIDeviceStatus, type TUIEnterRoomOptions, TUIErrorCode, type TUIInvitation, TUIInvitationCode, TUIInvitationRejectedReason, TUIInvitationStatus, TUIKickedOutOfRoomReason, TUILiveConnectionManagerEvents, type TUILiveConnectionUser, type TUILiveInfo, TUILiveLayoutManager, TUILiveLayoutManagerEvents, TUILiveListManager, TUILiveListManagerEvents, type TUILiveListResult, TUILiveModifyFlag, type TUILiveModifyInfo, type TUILiveStatisticsData, 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 TUISeatLayout, TUISeatLayoutTemplate, type TUISeatLockParams, TUISeatMode, type TUISeatRegion, type TUIUserInfo, type TUIVideoEncoderParams, TUIVideoQuality, TUIVideoStreamType, TUIRoomEngine as default };
+export { TRTCRole, TUIAudioQuality, TUIAudioRoute, type TUIAutoPlayCallbackInfo, TUIBattleCode, type TUIBattleConfig, type TUIBattleInfo, TUIBattleStoppedReason, type TUIBattleUser, TUICaptureSourceType, TUIChangeReason, TUIConferenceCancelReason, type TUIConferenceInfo, TUIConferenceInvitationManager, TUIConferenceInvitationManagerEvents, TUIConferenceListManager, TUIConferenceListManagerEvents, type TUIConferenceModifyInfo, TUIConferenceStatus, type TUIDeviceInfo, TUIDeviceStatus, type TUIEnterRoomOptions, TUIErrorCode, type TUIInvitation, TUIInvitationCode, TUIInvitationRejectedReason, TUIInvitationStatus, TUIKickedOutOfRoomReason, TUILiveBattleManagerEvents, TUILiveConnectionManagerEvents, type TUILiveConnectionUser, type TUILiveInfo, TUILiveLayoutManager, TUILiveLayoutManagerEvents, TUILiveListManager, TUILiveListManagerEvents, type TUILiveListResult, TUILiveModifyFlag, type TUILiveModifyInfo, type TUILiveStatisticsData, 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 TUISeatLayout, type TUISeatLockParams, TUISeatMode, type TUISeatRegion, type TUIUserInfo, type TUIVideoEncoderParams, TUIVideoQuality, TUIVideoStreamType, TUIRoomEngine as default };