@tencentcloud/tuiroom-engine-electron 2.9.0 → 3.0.0

package/index.d.ts

@@ -23,33 +23,28 @@ declare enum TUIErrorCode {
     ERR_MICROPHONE_DEVICE_EMPTY = -1107,
     ERR_GET_SCREEN_SHARING_TARGET_FAILED = -1108,
     ERR_START_SCREEN_SHARING_FAILED = -1109,
-    ERR_ROOM_ID_NOT_EXIST = -2100,
+    ERR_ALREADY_ROOM_OWNER = -1200,
+    ERR_IM_ATTRIBUTE_WRITE_CONFLICT = -1201,
+    ERR_ALREADY_ROOM_ENTER = -1202,
+    ERR_DESTROY_ROOM_NO_PERMISSION = -1203,
+    ERR_LIVE_REQUEST_SERVER_TIMEOUT = -1300,
+    ERR_LIVE_SERVER_PROCESS_FAILED = -1301,
+    ERR_LIVE_DISCONNECTED = -1302,
+    ERR_LIVE_NO_AVAILABLE_HEVC_DECODERS = -1303,
     ERR_OPERATION_INVALID_BEFORE_ENTER_ROOM = -2101,
     ERR_EXIT_NOT_SUPPORTED_FOR_ROOM_OWNER = -2102,
     ERR_OPERATION_NOT_SUPPORTED_IN_CURRENT_ROOM_TYPE = -2103,
     ERR_ROOM_ID_INVALID = -2105,
-    ERR_ROOM_ID_OCCUPIED = -2106,
     ERR_ROOM_NAME_INVALID = -2107,
     ERR_ALREADY_IN_OTHER_ROOM = -2108,
-    ERR_NEED_PASSWORD = -2109,
-    ERR_WRONG_PASSWORD = -2110,
-    ERR_ROOM_USER_FULL = -2111,
     ERR_USER_NOT_EXIST = -2200,
-    ERR_USER_NOT_ENTERED = -2201,
     ERR_NEED_OWNER_PERMISSION = -2300,
     ERR_NEED_ADMIN_PERMISSION = -2301,
     ERR_REQUEST_NO_PERMISSION = -2310,
     ERR_REQUEST_ID_INVALID = -2311,
     ERR_REQUEST_ID_REPEAT = -2312,
-    ERR_REQUEST_ID_CONFLICT = -2313,
     ERR_MAX_SEAT_COUNT_LIMIT = -2340,
-    ERR_ALREADY_IN_SEAT = -2341,
-    ERR_SEAT_OCCUPIED = -2342,
-    ERR_SEAT_LOCKED = -2343,
     ERR_SEAT_INDEX_NOT_EXIST = -2344,
-    ERR_USER_NOT_IN_SEAT = -2345,
-    ERR_ALL_SEAT_OCCUPIED = -2346,
-    ERR_SEAT_NOT_SUPPORT_LINK_MIC = -2347,
     ERR_OPEN_MICROPHONE_NEED_SEAT_UNLOCK = -2360,
     ERR_OPEN_MICROPHONE_NEED_PERMISSION_FROM_ADMIN = -2361,
     ERR_OPEN_CAMERA_NEED_SEAT_UNLOCK = -2370,
@@ -57,7 +52,28 @@ declare enum TUIErrorCode {
     ERR_OPEN_SCREEN_SHARE_NEED_SEAT_UNLOCK = -2372,
     ERR_OPEN_SCREEN_SHARE_NEED_PERMISSION_FROM_ADMIN = -2373,
     ERR_SEND_MESSAGE_DISABLED_FOR_ALL = -2380,
-    ERR_SEND_MESSAGE_DISABLED_FOR_CURRENT = -2381
+    ERR_SEND_MESSAGE_DISABLED_FOR_CURRENT = -2381,
+    ERR_ROOM_ID_OCCUPIED = 100003,
+    ERR_ROOM_ID_NOT_EXIST = 100004,
+    ERR_USER_NOT_ENTERED = 100005,
+    ERR_NEED_PASSWORD = 100018,
+    ERR_WRONG_PASSWORD = 100019,
+    ERR_ROOM_USER_FULL = 100008,
+    ERR_REQUEST_CONFLICT = 100102,
+    ERR_SEAT_OCCUPIED = 100210,
+    ERR_ALREADY_IN_SEAT = 100203,
+    ERR_SEAT_LOCKED = 100200,
+    ERR_ALL_SEAT_OCCUPIED = 100205,
+    ERR_USER_NOT_IN_SEAT = 100206,
+    ERR_SEAT_NOT_SUPPORT_LINK_MIC = 100211,
+    ERR_ROOM_ALREADY_CONNECTED = 100401,
+    ERR_ROOM_CONNECTED_IN_OTHER = 100403,
+    ERR_MAX_CONNECTED_COUNT_LIMIT = 100404,
+    ERR_BATTLE_IN_RUNNING = 100419,
+    ERR_BATTLE_ID_NOT_EXIST = 100411,
+    ERR_ROOM_BATTLEID_IN_OTHER = 100415,
+    ERR_ROOM_METADATA_EXCEED_KEY_COUNT_LIMIT = 100500,
+    ERR_ROOM_METADATA_EXCEED_VALUE_SIZE_LIMIT = 100501
 }
 type TUIRoomInfo = {
     roomId: string;
@@ -446,6 +462,7 @@ declare enum TUIRoomEvents {
      * @default 'onRoomUserCountChanged'
      * @event TUIRoomEvents#onRoomUserCountChanged
      * @param {object} options
+     * @param {string} options.roomId 房间号
      * @param {number} options.userCount 房间内人数
      * @example
      * const roomEngine = new TUIRoomEngine();
@@ -1010,13 +1027,15 @@ declare enum TUIConferenceInvitationManagerEvents {
      * @param {object} options
      * @param {TUIRoomInfo} options.roomInfo 会议信息。
      * @param {TUIInvitation} options.invitation 邀请信息。
+     * @param {TUIInvitationRejectedReason} options.reason 拒绝加入会议的原因。
+     *
      *
      *
      * @example
      * const roomEngine = new TUIRoomEngine();
      * const conferenceInvitationManager = roomEngine.getConferenceInvitationManager();
-     * conferenceInvitationManager.on(TUIConferenceInvitationManagerEvents.onInvitationRejected, ({ roomInfo, invitation }) => {
-     *  console.log('conferenceInvitationManager.onInvitationRejected', roomInfo, invitation);
+     * conferenceInvitationManager.on(TUIConferenceInvitationManagerEvents.onInvitationRejected, ({ roomInfo, invitation, reason }) => {
+     *  console.log('conferenceInvitationManager.onInvitationRejected', roomInfo, invitation, reason);
      * })
      */
     onInvitationRejected = "onInvitationRejected",
@@ -1106,6 +1125,72 @@ declare enum TUIConferenceInvitationManagerEvents {
      * })
      */
     onInvitationStatusChanged = "onInvitationStatusChanged"
+}
+type TUILiveInfo = {
+    basicRoomInfo: TUIRoomInfo;
+    isGiftEnabled: boolean;
+    isLikeEnabled: boolean;
+    isPublicVisible: boolean;
+    activityStatus: number;
+    viewCount: number;
+    coverUrl: string;
+    backgroundUrl: string;
+    categoryList: Array<number>;
+};
+type TUILiveModifyInfo = {
+    roomId: string;
+    isPublicVisible?: boolean;
+    activityStatus?: number;
+    coverUrl?: string;
+    backgroundUrl?: string;
+    categoryList?: Array<number>;
+};
+declare enum TUILiveModifyFlag {
+    kNone = 0,
+    kActivityStatus = 256,
+    kCoverUrl = 512,
+    kCategory = 1024,
+    kEnableGift = 2048,
+    kEnableLike = 4096,
+    kPublic = 8192,
+    kBackgroundUrl = 262144
+}
+type TUILiveListResult = {
+    cursor: string;
+    listInfoList: Array<TUILiveInfo>;
+};
+/**
+ * @since v2.9.0
+ * ** TUILiveListManager 事件列表**<br>
+ */
+declare enum TUILiveListManagerEvents {
+    /**
+     * @description 直播间信息发生变化事件回调
+     * @default 'onLiveInfoChanged'
+     * @event TUILiveListManagerEvents#onLiveInfoChanged
+     * @param {object} options
+     * @param {TUILiveInfo} options.liveInfo 直播间信息
+     * @param {TUILiveModifyFlag} options.modifyFlag 直播间修改标识
+     *
+     * @example
+     * const roomEngine = new TUIRoomEngine();
+     * const liveListManager = roomEngine.getLiveListManager();
+     * liveListManager.on(TUILiveListManagerEvents.onLiveInfoChanged, ({ liveInfo, modifyFlag}) => {
+     *   console.log('liveListManager.onLiveInfoChanged', liveInfo, modifyFlag);
+     * });
+     */
+    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 class Logger {
@@ -1691,6 +1776,124 @@ declare class TUIConferenceInvitationManager {
     off(event: string, func: (...args: any[]) => void): void;
 }
 
+/**
+ * 直播列表
+ * @class TUILiveListManager
+ */
+declare class TUILiveListManager {
+    private liveListManagerWASM;
+    private logger;
+    private static liveListManager;
+    constructor(options: {
+        Module: any;
+        logger: Logger;
+        roomEngineWASM: any;
+    });
+    /**
+     * 修改直播间信息
+     *
+     * @param {object} options
+     * @param {string} options.roomId 直播房间 ID
+     * @param {number} options.activityStatus 可选，直播间活跃状态: 用户自定义标记
+     * @param {Array<number>} options.categoryList 可选，直播间分类标签，单个房间最大支持3个标记
+     * @param {string} options.coverUrl 可选，直播间封面图片 HTTP URL 地址，最大支持 200 个字节
+     * @param {string} options.backgroundUrl 可选，直播间背景图片 HTTP URL 地址，最大支持 200 个字节
+     * @param {boolean} options.isPublicVisible 可选，直播间是否公开
+     * @returns {Promise<void>}
+     *
+     * @example
+     * const roomEngine = new TUIRoomEngine();
+     * const liveListManager = roomEngine.getLiveListManager();
+     * liveListManager.setLiveInfo({
+     *   roomId: "141569",
+     *   coverUrl: "https://qcloudimg.tencent-cloud.cn/image/document/live-cover.png",
+     *   isPublicVisible: false,
+     *   activityStatus: 1,
+     *   categoryList: [1,2,3],
+     *   backgroundUrl: "https://qcloudimg.tencent-cloud.cn/image/document/live-cover.png"
+     * });
+     */
+    setLiveInfo(options: {
+        roomId: string;
+        activityStatus?: number;
+        categoryList?: Array<number>;
+        coverUrl?: string;
+        isPublicVisible?: boolean;
+        backgroundUrl?: string;
+    }): Promise<void>;
+    /**
+     * 获取直播间信息
+     *
+     * @param {object} options
+     * @param {string} options.roomId 直播房间 ID
+     * @returns {Promise<TUILiveInfo>}
+     *
+     * @example
+     * const roomEngine = new TUIRoomEngine();
+     * const liveListManager = roomEngine.getLiveListManager();
+     * const result = await liveListManager.getLiveInfo({ roomId: "141569" });
+     */
+    getLiveInfo(options: {
+        roomId: string;
+    }): Promise<TUILiveInfo>;
+    /**
+     * 获取直播间列表
+     *
+     * @param {object} options
+     * @param {string} options.cursor 分页获取索引，第一次拉取填 ''，返回的数据中 cursor 不为 ''，表示需要分页，请以返回的 cursor 作为参数再次调用接口拉取，直至返回的cursor为 ''，表示数据已经全部拉取。
+     * @param {number} options.count  本次拉取数量
+     * @returns {Promise<TUILiveListResult>}
+     *
+     * @example
+     * const roomEngine = new TUIRoomEngine();
+     * const liveListManager = roomEngine.getLiveListManager();
+     * const liveList = [];
+     * let cursor = '';
+     * let count = 20;
+     * let result;
+     * do {
+     *   result = await liveListManager.fetchLiveList({ cursor, count });
+     *   liveList.push(...result.liveInfoList);
+     *   cursor = result.cursor;
+     * } while(cursor !== '');
+     */
+    fetchLiveList(options: {
+        cursor: string;
+        count: number;
+    }): Promise<TUILiveListResult>;
+    private JSCallNativeFunctionPromise;
+    /**
+     * 监听 TUILiveListManager 事件
+     * @param {TUILiveListManagerEvents} event - 事件名
+     * @param {Function} func - 事件回调函数
+     *
+     * @example
+     * const roomEngine = new TUIRoomEngine();
+     * const liveListManager = roomEngine.getLiveListManager();
+     * const callback = ({ liveModifyInfo }) => {
+     *   console.log('liveListManager.onLiveInfoChanged', liveModifyInfo);
+     * };
+     * liveListManager.on(TUILiveListManagerEvents.onLiveInfoChanged, callback);
+     */
+    on(event: TUILiveListManagerEvents, func: (...args: any[]) => void): void;
+    /**
+     * 取消 TUILiveListManager 事件监听
+     * @param {TUILiveListManagerEvents} event - 事件名
+     * @param {Function} func - 事件回调函数
+     *
+     * @example
+     * const roomEngine = new TUIRoomEngine();
+     * const liveListManager = roomEngine.getLiveListManager();
+     * const callback = ({ liveModifyInfo }) => {
+     *   console.log('liveListManager.onLiveInfoChanged', liveModifyInfo);
+     * };
+     * liveListManager.off(TUILiveListManagerEvents.onLiveInfoChanged, callback);
+     */
+    off(event: TUILiveListManagerEvents, func: (...args: any[]) => void): void;
+    private observerFunction;
+    private handleLiveInfoChangeEvent;
+}
+
 /**
  * TUIRoomEngine 提供了音视频房间的能力
  *
@@ -1704,6 +1907,7 @@ declare class TUIRoomEngine {
     private deviceManager;
     private conferenceListManager;
     private conferenceInvitationManager;
+    private liveListManager;
     private static userId;
     private static sdkAppId;
     private static Module;
@@ -3021,6 +3225,17 @@ declare class TUIRoomEngine {
      * @returns {TUIConferenceListManager} conferenceListManager
      */
     getConferenceListManager(): TUIConferenceListManager;
+    /**
+     * v3.0.0 版本器支持 getLiveListManager 获取 TUILiveListManager 模块
+     *
+     * @since v3.0.0
+     * @returns {TUILiveListManager}
+     *
+     * @example
+     * const roomEngine = new TUIRoomEngine();
+     * const liveListManager = roomEngine.getLiveListManager();
+     */
+    getLiveListManager(): TUILiveListManager;
     /**
      * v2.6.0 版本起支持使用 getConferenceInvitationManager 获取 conferenceInvitation 模块
      * @since v2.6.0
@@ -3063,4 +3278,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 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, 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 };