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

package/index.d.ts

@@ -1310,17 +1310,26 @@ declare enum TUILiveListManagerEvents {
      * @default 'onLiveInfoChanged'
      * @event TUILiveListManagerEvents#onLiveInfoChanged
      * @param {object} options
-     * @param {TUILiveInfo} options.liveInfo 直播间信息
-     * @param {TUILiveModifyFlag} options.modifyFlag 直播间修改标识
+     * @param {TUILiveModifyInfo} options.liveModifyInfo 直播间变更信息
      *
      * @example
      * const roomEngine = new TUIRoomEngine();
      * const liveListManager = roomEngine.getLiveListManager();
-     * liveListManager.on(TUILiveListManagerEvents.onLiveInfoChanged, ({ liveInfo, modifyFlag}) => {
-     *   console.log('liveListManager.onLiveInfoChanged', liveInfo, modifyFlag);
+     * liveListManager.on(TUILiveListManagerEvents.onLiveInfoChanged, ({ liveModifyInfo}) => {
+     *   console.log('liveListManager.onLiveInfoChanged', liveModifyInfo);
      * });
      */
-    onLiveInfoChanged = "onLiveInfoChanged"
+    onLiveInfoChanged = "onLiveInfoChanged",
+    /**
+     * @since v3.5.0
+     * @description 直播间统计信息发生变化事件回调
+     * @default 'onLiveStatisticsChanged'
+     * @event TUILiveListManagerEvents#onLiveStatisticsChanged
+     * @param {object} options
+     * @param {string} options.roomId  直播间 ID
+     * @param {TUILiveStatisticsData} options.statistics  直播间统计变更信息
+     */
+    onLiveStatisticsChanged = "onLiveStatisticsChanged"
 }
 declare enum TUILiveLayoutManagerEvents {
     /**
@@ -1416,14 +1425,27 @@ type TUISeatLayout = {
  * @property {number} totalGiftCoins 礼物总价值
  * @property {number} totalUniqueGiftSenders 礼物发送者总数
  * @property {number} totalLikesReceived 点赞总数
+ * @property {number} totalMessageCount 消息总数
+ * @property {number} liveDuration 直播时长，单位秒
  */
 type TUILiveStatisticsData = {
-    totalViewers: number;
-    totalGiftsSent: number;
-    totalGiftCoins: number;
-    totalUniqueGiftSenders: number;
-    totalLikesReceived: number;
+    totalViewers?: number;
+    totalGiftsSent?: number;
+    totalGiftCoins?: number;
+    totalUniqueGiftSenders?: number;
+    totalLikesReceived?: number;
+    totalMessageCount?: number;
+    liveDuration?: number;
 };
+declare enum TUILiveStatisticsModifyFlag {
+    kNone = 0,
+    kTotalViewers = 1,
+    kTotalGiftsSent = 2,
+    kTotalGiftCoins = 4,
+    kTotalUniqueGiftSenders = 8,
+    kTotalLikesReceived = 16,
+    kTotalMessageCount = 32
+}
 /**
  * @since v3.0.5
  * **TUILiveConnectionManager** 事件列表<br>
@@ -1738,6 +1760,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 {
@@ -2955,6 +3055,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 提供了音视频房间的能力
  *
@@ -2973,6 +3218,7 @@ declare class TUIRoomEngine {
     private liveLayoutManager;
     private liveConnectionManager;
     private liveBattleManager;
+    private liveGiftManager;
     private static userId;
     private static sdkAppId;
     private static Module;
@@ -4454,6 +4700,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
@@ -4503,5 +4760,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, TUIMoveSeatPolicy, TUINetworkQuality, TUIRenderMode, TUIRequestAction, TUIRequestCallbackType, TUIResolutionMode, TUIRole, TUIRoomDeviceManager, TUIRoomDeviceMangerEvents, TUIRoomDismissedReason, TUIRoomEvents, TUIRoomType, TUISeatMode, TUIVideoQuality, TUIVideoStreamType, TUIRoomEngine as default };
-export type { 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 };
+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, TUILiveStatisticsModifyFlag, 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 };