@tencentcloud/tuiroom-engine-js 3.4.3-beta.3 → 3.4.4

package/index.d.ts

@@ -297,6 +297,11 @@ type TUISeatInfo = {
     isVideoLocked: boolean;
     isAudioLocked: boolean;
 };
+declare enum TUIMoveSeatPolicy {
+    kAbortWhenOccupied = 0,
+    kForceReplace = 1,
+    kSwapPosition = 2
+}
 type TUIRequest = {
     requestAction: TUIRequestAction;
     timestamp: number;
@@ -1226,6 +1231,25 @@ type TUILiveInfo = {
     readonly lebEncrypted?: string;
     readonly lebSignature?: string;
 };
+type StartLiveOptions = {
+    roomId: string;
+    roomType?: TUIRoomType;
+    name: string;
+    notice?: string;
+    isMessageDisableForAllUser?: boolean;
+    isGiftEnabled?: boolean;
+    isLikeEnabled?: boolean;
+    isPublicVisible?: boolean;
+    isSeatEnabled?: boolean;
+    keepOwnerOnSeat?: boolean;
+    seatLayoutTemplateId?: number;
+    maxSeatCount?: number;
+    seatMode?: TUISeatMode;
+    coverUrl?: string;
+    backgroundUrl?: string;
+    categoryList?: Array<number>;
+    activityStatus?: number;
+};
 /**
  * 直播连线用户信息
  */
@@ -1714,6 +1738,84 @@ declare enum TUILiveBattleManagerEvents {
      * });
      */
     onBattleRequestReject = "onBattleRequestReject"
+}
+/**
+ * 礼物信息
+ */
+type GiftInfo = {
+    giftID: string;
+    name: string;
+    desc: string;
+    iconUrl: string;
+    resourceUrl: string;
+    level: number;
+    coins: number;
+    extensionInfo: Record<string, string>;
+};
+/**
+ * 礼物分类信息
+ */
+type GiftCategory = {
+    categoryID: string;
+    name: string;
+    desc: string;
+    extensionInfo: Record<string, string>;
+    giftList: GiftInfo[];
+};
+declare enum TUILiveGiftManagerEvents {
+    /**
+     * @description 接收到礼物数量发送变化监听事件
+     * @default 'onGiftCountChanged'
+     * @event TUILiveGiftManagerEvents#onGiftCountChanged
+     * @param {object} options
+     * @param {String} roomId 房间Id
+     * @param {Number} totalGiftsSent 总礼物数
+     * @param {Number} totalGiftCoins 总礼物价值
+     * @param {Number} totalUniqueGiftSenders 总礼物发送者数量
+     *
+     * @example
+     * const roomEngine = new TUIRoomEngine();
+     * const liveGiftManager = roomEngine.TUILiveGiftManager();
+     * liveGiftManager.on(TUILiveGiftManagerEvents.onGiftCountChanged, ({ roomId, totalGiftsSent, totalGiftCoins, totalUniqueGiftSenders }) => {
+     *   console.log('liveGiftManager.onGiftCountChanged', roomId, totalGiftsSent, totalGiftCoins, totalUniqueGiftSenders);
+     * });
+     */
+    onGiftCountChanged = "onGiftCountChanged",
+    /**
+     * @description 接收到礼物消息的监听事件
+     * @default 'onReceiveGiftMessage'
+     * @event TUILiveGiftManagerEvents#onReceiveGiftMessage
+     * @param {object} options
+     * @param {String} roomId 房间Id
+     * @param {GiftInfo} giftInfo 礼物信息
+     * @param {number} count 礼物数量
+     * @param {TUIUserInfo} sender 发送者信息
+     *
+     * @example
+     * const roomEngine = new TUIRoomEngine();
+     * const liveGiftManager = roomEngine.TUILiveGiftManager();
+     * liveGiftManager.on(TUILiveGiftManagerEvents.onReceiveGiftMessage, ({ roomId, giftInfo, count, sender }) => {
+     *   console.log('liveGiftManager.onReceiveGiftMessage', roomId, giftInfo, count, sender);
+     * });
+     */
+    onReceiveGiftMessage = "onReceiveGiftMessage",
+    /**
+     * @description 接收到点赞消息的监听事件
+     * @default 'onReceiveLikesMessage'
+     * @event TUILiveGiftManagerEvents#onReceiveLikesMessage
+     * @param {object} options
+     * @param {String} roomId 房间Id
+     * @param {number} totalLikesReceived 总点赞数
+     * @param {TUIUserInfo} sender 发送者信息
+     *
+     * @example
+     * const roomEngine = new TUIRoomEngine();
+     * const liveGiftManager = roomEngine.TUILiveGiftManager();
+     * liveGiftManager.on(TUILiveGiftManagerEvents.onReceiveLikesMessage, ({ roomId, totalLikesReceived, sender }) => {
+     *   console.log('liveGiftManager.onReceiveLikesMessage', roomId, totalLikesReceived, sender);
+     * });
+     */
+    onReceiveLikesMessage = "onReceiveLikesMessage"
 }
 
 declare class Logger {
@@ -2318,7 +2420,7 @@ declare class TUILiveListManager {
      *
      * @description 创建并开始一个新的直播间，房主调用此接口来启动直播
      * @since 3.3.0
-     * @param {TUILiveInfo} liveInfo 直播间信息，包含房间ID、名称、公告等配置
+     * @param {StartLiveOptions | TUILiveInfo} liveInfo 直播间信息，包含房间ID、名称、公告等配置
      * @returns {Promise<TUILiveInfo>} 返回创建成功后的直播间完整信息，包含CDN流地址等
      * @throws {TUIError} 可能抛出的错误：
      *   - ERR_ALREADY_ROOM_OWNER: 用户已经是房间所有者
@@ -2350,7 +2452,7 @@ declare class TUILiveListManager {
      * console.log('直播开始成功，CDN流地址：', resultLiveInfo.cdnStreamUrl);
      * ```
      */
-    startLive(liveInfo: TUILiveInfo): Promise<TUILiveInfo>;
+    startLive(liveInfo: StartLiveOptions | TUILiveInfo): Promise<TUILiveInfo>;
     /**
      * 停止直播
      *
@@ -2931,6 +3033,151 @@ declare class TUILiveBattleManager {
     private observerFunction;
 }
 
+declare class TUILiveGiftManager {
+    private liveGiftManagerWASM;
+    private logger;
+    private static liveGiftManager;
+    constructor(options: {
+        Module: any;
+        logger: Logger;
+        roomEngineWASM: any;
+    });
+    /**
+     * 获取礼物列表
+     *
+     * @param {object} options
+     * @param {String} options.roomId 房间ID
+     * @returns {Promise<{giftCategoryList: GiftCategory[]}>}
+     *
+     * @example
+     * const roomEngine = new TUIRoomEngine();
+     * const liveGiftManager = roomEngine.getLiveGiftManager();
+     * liveGiftManager.getGiftList({
+     *   roomId: 'roomId'
+     * });
+     */
+    getGiftList(options: {
+        roomId: string;
+    }): Promise<{
+        giftCategoryList: GiftCategory[];
+    }>;
+    /**
+     * 发送礼物
+     *
+     * @param {object} options
+     * @param {string} options.roomId 房间ID
+     * @param {string} options.giftId 礼物ID
+     * @param {number} options.count 礼物数量
+     * @returns {Promise<void>}
+     *
+     * @example
+     * const roomEngine = new TUIRoomEngine();
+     * const liveGiftManager = roomEngine.getLiveGiftManager();
+     * liveGiftManager.sendGift({
+     *   roomId: 'roomId',
+     *   giftId: 'giftId',
+     *   count: 1
+     * });
+     */
+    sendGift(options: {
+        roomId: string;
+        giftId: string;
+        count: number;
+    }): Promise<void>;
+    /**
+     * 发送点赞
+     *
+     * @param {object} options
+     * @param {string} options.roomId 房间ID
+     * @param {number} options.count 点赞数量
+     * @returns {Promise<void>}
+     *
+     * @example
+     * const roomEngine = new TUIRoomEngine();
+     * const liveGiftManager = roomEngine.getLiveGiftManager();
+     * liveGiftManager.sendLikes({
+     *   roomId: 'roomId',
+     *   count: 1
+     * });
+     */
+    sendLikes(options: {
+        roomId: string;
+        count: number;
+    }): Promise<void>;
+    /**
+     * 获取礼物数量
+     *
+     * @param {object} options
+     * @param {string} options.roomId 房间ID
+     * @returns {Promise<{totalGiftCoins:number, totalGiftsSent: number, totalUniqueGiftSenders: number}>}
+     *
+     * @example
+     * const roomEngine = new TUIRoomEngine();
+     * const liveGiftManager = roomEngine.getLiveGiftManager();
+     * liveGiftManager.getGiftCountByAnchor({
+     *   roomId: 'roomId'
+     * });
+     */
+    getGiftCountByAnchor(options: {
+        roomId: string;
+    }): Promise<{
+        totalGiftCoins: number;
+        totalGiftsSent: number;
+        totalUniqueGiftSenders: number;
+    }>;
+    /**
+     * 获取点赞数量
+     *
+     * @param {object} options
+     * @param {string} options.roomId 房间ID
+     * @returns {Promise<{totalLikesReceived: number}>}
+     *
+     * @example
+     * const roomEngine = new TUIRoomEngine();
+     * const liveGiftManager = roomEngine.getLiveGiftManager();
+     * liveGiftManager.getLikesCount({
+     *   roomId: 'roomId'
+     * });
+     */
+    getLikesCount(options: {
+        roomId: string;
+    }): Promise<{
+        totalLikesReceived: number;
+    }>;
+    /**
+     * 监听 TUILiveGiftManager 事件
+     * @param {TUILiveGiftManagerEvents} event 事件名
+     * @param func 事件回调函数
+     *
+     * @example
+     * const roomEngine = new TUIRoomEngine();
+     * const liveGiftManager = roomEngine.getLiveGiftManager();
+     *
+     * const callback = ({ roomId, totalGiftsSent, totalGiftCoins, totalUniqueGiftSenders }) => {
+     *   console.log('Demo onGiftCountChanged', { roomId, totalGiftsSent, totalGiftCoins, totalUniqueGiftSenders });
+     * }
+     * liveGiftManager.on(TUILiveGiftManagerEvents.onGiftCountChanged, callback);
+     */
+    on(event: TUILiveGiftManagerEvents, func: (...args: any[]) => void): void;
+    /**
+     * 取消监听 TUIliveGiftManager 事件
+     * @param {TUILiveGiftManagerEvents} event 事件名
+     * @param func 事件回调函数
+     *
+     * @example
+     * const roomEngine = new TUIRoomEngine();
+     * const liveGiftManager = roomEngine.getLiveGiftManager();
+     *
+     * const callback = ({ roomId, totalGiftsSent, totalGiftCoins, totalUniqueGiftSenders }) => {
+     *   console.log('Demo onGiftCountChanged', { roomId, totalGiftsSent, totalGiftCoins, totalUniqueGiftSenders });
+     * }
+     * liveGiftManager.off(TUILiveGiftManagerEvents.onGiftCountChanged, callback);
+     */
+    off(event: TUILiveGiftManagerEvents, func: (...args: any[]) => void): void;
+    private JSCallNativeFunctionPromise;
+    private observerFunction;
+}
+
 /**
  * TUIRoomEngine 提供了音视频房间的能力
  *
@@ -2949,6 +3196,7 @@ declare class TUIRoomEngine {
     private liveLayoutManager;
     private liveConnectionManager;
     private liveBattleManager;
+    private liveGiftManager;
     private static userId;
     private static sdkAppId;
     private static Module;
@@ -2980,10 +3228,18 @@ declare class TUIRoomEngine {
     /**
      * @private
      * 调用 TUIRoomEngineWASM 的 CallAPI 方法
+     * 该接口废弃，后续逐步替换为 JSCallNativeCallAPIPromiseNew 方法
      * @param funcName
      * @param jsonString
      */
     private JSCallNativeCallAPIPromise;
+    /**
+     * 调用 roomEngineWASM 的 CallAPI 方法
+     * @param funcName 函数名
+     * @param args 参数
+     * @returns Promise
+     */
+    private JSCallNativeCallAPIPromiseNew;
     /**
      * 登录 TUIRoomEngine
      *
@@ -3476,7 +3732,7 @@ declare class TUIRoomEngine {
      */
     stopPushLocalVideo(): Promise<void>;
     /**
-     * 开始向远端推本地音频流
+     * 停止向远端推本地音频流
      * @returns {Promise<void>}
      *
      * @example
@@ -3486,7 +3742,7 @@ declare class TUIRoomEngine {
      */
     muteLocalAudio(): Promise<void>;
     /**
-     * 停止向远端推本地音频流
+     * 开始向远端推本地音频流
      * @returns {Promise<void>}
      *
      * @example
@@ -3951,6 +4207,23 @@ declare class TUIRoomEngine {
     moveToSeat(options: {
         targetSeatIndex: number;
     }): Promise<void>;
+    /**
+     * 移动麦上的用户（仅支持房主或者管理员使用此接口）
+     * @since v3.4.3
+     * @note 当目标麦位有人时，支持三种移麦策略：
+     * - 目标麦位有人时放弃移动（默认）
+     * - 强制替换 - 将原麦位用户踢下麦
+     * - 交换位置 - 互换两个用户的麦位
+     * @param {string} options.userId 待移动的麦上用户
+     * @param {number} options.targetSeatIndex 移麦目标麦位 index, 移麦成功后您将会在此麦位上。
+     * @param {TUIMoveSeatPolicy} options.policy 移动麦上用户时的策略, 默认为目标麦位有人时放弃移动
+     * @returns {Promise<void>}
+     */
+    moveUserToSeatByAdmin(options: {
+        userId: string;
+        targetSeatIndex: number;
+        policy: TUIMoveSeatPolicy;
+    }): Promise<void>;
     /**
      * 邀请其他人上麦（仅房间主持人和管理员可调用此方法）
      * @param {object} options 邀请其他人上麦的参数
@@ -4405,6 +4678,17 @@ declare class TUIRoomEngine {
      * const liveBattleManager = roomEngine.getLiveBattleManager();
      */
     getLiveBattleManager(): TUILiveBattleManager;
+    /**
+     * v3.4.4 版本起支持 getLiveGiftManager 获取 TUILiveGiftManager 模块
+     *
+     * @since v3.4.4
+     * @returns {TUILiveGiftManager}
+     *
+     * @example
+     * const roomEngine = new TUIRoomEngine();
+     * const liveGiftManager = roomEngine.getLiveGiftManager();
+     */
+    getLiveGiftManager(): TUILiveGiftManager;
     /**
      * v2.6.0 版本起支持使用 getConferenceInvitationManager 获取 conferenceInvitation 模块
      * @since v2.6.0
@@ -4454,5 +4738,5 @@ declare class TUIRoomEngine {
     private static handleSetFramework;
 }
 
-export { TRTCRole, TUIAudioQuality, TUIAudioRoute, TUIBattleCode, TUIBattleStoppedReason, TUICaptureSourceType, TUIChangeReason, TUIConferenceCancelReason, TUIConferenceInvitationManager, TUIConferenceInvitationManagerEvents, TUIConferenceListManager, TUIConferenceListManagerEvents, TUIConferenceStatus, TUIConnectionCode, TUIDeviceStatus, TUIErrorCode, TUIInvitationCode, TUIInvitationRejectedReason, TUIInvitationStatus, TUIKickedOutOfRoomReason, TUILiveBattleManagerEvents, TUILiveConnectionManagerEvents, TUILiveLayoutManager, TUILiveLayoutManagerEvents, TUILiveListManager, TUILiveListManagerEvents, TUILiveModifyFlag, TUIMediaDevice, TUIMediaDeviceState, TUIMediaDeviceType, TUINetworkQuality, TUIRenderMode, TUIRequestAction, TUIRequestCallbackType, TUIResolutionMode, TUIRole, TUIRoomDeviceManager, TUIRoomDeviceMangerEvents, TUIRoomDismissedReason, TUIRoomEvents, TUIRoomType, TUISeatMode, TUIVideoQuality, TUIVideoStreamType, TUIRoomEngine as default };
-export type { TUIAutoPlayCallbackInfo, TUIBattleConfig, TUIBattleInfo, TUIBattleUser, TUIConferenceInfo, TUIConferenceModifyInfo, TUIDeviceInfo, TUIEnterRoomOptions, TUIInvitation, TUILiveConnectionUser, TUILiveInfo, TUILiveListResult, TUILiveModifyInfo, TUILiveStatisticsData, TUILoginUserInfo, TUIMessage, TUINetwork, TUIRequest, TUIRequestCallback, TUIRoomInfo, TUISeatInfo, TUISeatLayout, TUISeatLockParams, TUISeatRegion, TUIUserInfo, TUIVideoEncoderParams };
+export { TRTCRole, TUIAudioQuality, TUIAudioRoute, TUIBattleCode, TUIBattleStoppedReason, TUICaptureSourceType, TUIChangeReason, TUIConferenceCancelReason, TUIConferenceInvitationManager, TUIConferenceInvitationManagerEvents, TUIConferenceListManager, TUIConferenceListManagerEvents, TUIConferenceStatus, TUIConnectionCode, TUIDeviceStatus, TUIErrorCode, TUIInvitationCode, TUIInvitationRejectedReason, TUIInvitationStatus, TUIKickedOutOfRoomReason, TUILiveBattleManagerEvents, TUILiveConnectionManagerEvents, TUILiveGiftManagerEvents, TUILiveLayoutManager, TUILiveLayoutManagerEvents, TUILiveListManager, TUILiveListManagerEvents, TUILiveModifyFlag, TUIMediaDevice, TUIMediaDeviceState, TUIMediaDeviceType, TUIMoveSeatPolicy, TUINetworkQuality, TUIRenderMode, TUIRequestAction, TUIRequestCallbackType, TUIResolutionMode, TUIRole, TUIRoomDeviceManager, TUIRoomDeviceMangerEvents, TUIRoomDismissedReason, TUIRoomEvents, TUIRoomType, TUISeatMode, TUIVideoQuality, TUIVideoStreamType, TUIRoomEngine as default };
+export type { GiftCategory, GiftInfo, StartLiveOptions, TUIAutoPlayCallbackInfo, TUIBattleConfig, TUIBattleInfo, TUIBattleUser, TUIConferenceInfo, TUIConferenceModifyInfo, TUIDeviceInfo, TUIEnterRoomOptions, TUIInvitation, TUILiveConnectionUser, TUILiveInfo, TUILiveListResult, TUILiveModifyInfo, TUILiveStatisticsData, TUILoginUserInfo, TUIMessage, TUINetwork, TUIRequest, TUIRequestCallback, TUIRoomInfo, TUISeatInfo, TUISeatLayout, TUISeatLockParams, TUISeatRegion, TUIUserInfo, TUIVideoEncoderParams };