@tencentcloud/tuiroom-engine-electron 2.4.2 → 2.5.0

package/index.d.ts

@@ -27,11 +27,12 @@ declare enum TUIErrorCode {
     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_OPERATION_NOT_SUPPORTED_IN_CURRENT_SPEECH_MODE = -2104,
     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,
@@ -64,6 +65,7 @@ type TUIRoomInfo = {
     roomType: TUIRoomType;
     isSeatEnabled: boolean;
     seatMode: TUISeatMode;
+    password: string;
     isMicrophoneDisableForAllUser: boolean;
     isScreenShareDisableForAllUser: boolean;
     isCameraDisableForAllUser: boolean;
@@ -76,6 +78,9 @@ type TUIRoomInfo = {
     createTime: number;
     roomMemberCount: number;
 };
+type TUIEnterRoomOptions = {
+    password: string;
+};
 type TUILoginUserInfo = {
     userId: string;
     userName: string;
@@ -171,11 +176,6 @@ declare enum TUIRoomType {
     kConference = 1,
     kLive = 2
 }
-declare enum TUISpeechMode {
-    kFreeToSpeak = 1,
-    kApplyToSpeak = 2,
-    kSpeakAfterTakingSeat = 3
-}
 declare enum TUISeatMode {
     kFreeToTake = 1,
     kApplyToTake = 2
@@ -231,6 +231,7 @@ declare enum TUIRoomDismissedReason {
 type TUIUserInfo = {
     userId: string;
     userName: string;
+    nameCard: string;
     avatarUrl: string;
     userRole: TUIRole;
     hasAudioStream: boolean;
@@ -243,6 +244,7 @@ type TUISeatInfo = {
     index: number;
     userId: string;
     userName: string;
+    nameCard: string;
     avatarUrl: string;
     locked: boolean;
     isVideoLocked: boolean;
@@ -254,6 +256,7 @@ type TUIRequest = {
     requestId: string;
     userId: string;
     userName: string;
+    nameCard: string;
     avatarUrl: string;
     content: string;
 };
@@ -289,6 +292,31 @@ type TUIDeviceInfo = {
         }[];
     };
 };
+declare enum TUIConferenceStatus {
+    kConferenceStatusNone = 0,
+    kConferenceStatusNotStarted = 1,
+    kConferenceStatusRunning = 2
+}
+declare enum TUIConferenceCancelReason {
+    kConferenceCancelReasonCancelledByAdmin = 0,
+    kConferenceCancelReasonRemovedFromAttendees = 1
+}
+type TUIConferenceInfo = {
+    scheduleStartTime: number;
+    scheduleEndTime: number;
+    scheduleAttendees: string[];
+    reminderSecondsBeforeStart: number;
+    status: TUIConferenceStatus;
+    basicRoomInfo: TUIRoomInfo;
+};
+type TUIConferenceModifyInfo = {
+    scheduleStartTime?: number;
+    scheduleEndTime?: number;
+    basicRoomInfo: {
+        roomId: string;
+        roomName?: string;
+    };
+};
 /**
  * **TUIRoomEngine 事件列表**<br>
  * @namespace TUIRoomEvents
@@ -379,20 +407,6 @@ declare enum TUIRoomEvents {
      * });
      */
     onRoomNameChanged = "onRoomNameChanged",
-    /**
-     * @description 房间模式修改事件
-     * @deprecated 该事件自 v2.0.0 版本废弃
-     * @default 'onRoomSpeechModeChanged'
-     * @event TUIRoomEvents#onRoomSpeechModeChanged
-     * @param {object} options
-     * @param {TUISpeechMode} options.speechMode 房间模式
-     * @example
-     * const roomEngine = new TUIRoomEngine();
-     * roomEngine.on(TUIRoomEvents.onRoomSpeechModeChanged, ({ roomId, speechMode }) =>{
-     *    console.log('roomEngine.onRoomSpeechModeChanged', roomId, speechMode);
-     * });
-     */
-    onRoomSpeechModeChanged = "onRoomSpeechModeChanged",
     /**
      * @description 上麦模式修改事件
      * @default 'onRoomSeatModeChanged'
@@ -513,9 +527,24 @@ declare enum TUIRoomEvents {
      * });
      */
     onRemoteUserLeaveRoom = "onRemoteUserLeaveRoom",
+    /**
+     * @since v2.5.0
+     * @description 房间内用户信息改变事件
+     * @default 'onUserInfoChanged'
+     * @event TUIRoomEvents#onUserInfoChanged
+     * @param {object} options
+     * @param {TUIUserInfo} options.userInfo 用户信息
+     * @example
+     * const roomEngine = new TUIRoomEngine();
+     * roomEngine.on(TUIRoomEvents.onUserInfoChanged, ({ userInfo }) => {
+     *   console.log('roomEngine.onUserInfoChanged', userInfo);
+     * });
+     */
+    onUserInfoChanged = "onUserInfoChanged",
     /**
      * @description 用户角色改变事件
-     * @default 'onKickedOutOfRoom'
+     * @deprecated 该接口自 v2.5.0 版本废弃，请使用'onUserInfoChanged'.
+     * @default 'onUserRoleChanged'
      * @event TUIRoomEvents#onUserRoleChanged
      * @param {object} options
      * @param {string} options.userId 用户Id
@@ -779,6 +808,104 @@ declare enum TUIRoomDeviceMangerEvents {
      * });
      */
     onTestSpeakerVolume = "onTestSpeakerVolume"
+}
+/**
+ * @since v2.5.0
+ * **TUIConferenceListManager 事件列表**<br>
+ * @namespace TUIConferenceListManagerEvents
+ */
+declare enum TUIConferenceListManagerEvents {
+    /**
+     * @description 会议预定回调
+     * @default 'onConferenceScheduled'
+     * @event TUIConferenceListManagerEvents#onConferenceScheduled
+     * @param {object} options
+     * @param {string} options.conferenceInfo 会议信息。
+     *
+     * @example
+     * const roomEngine = new TUIRoomEngine();
+     * const conferenceListManager = roomEngine.getConferenceListManager();
+     * conferenceListManager.on(TUIConferenceListManagerEvents.onConferenceScheduled, ({ conferenceInfo }) => {
+     *  console.log('conferenceListManager.onConferenceScheduled', conferenceInfo);
+     * })
+     */
+    onConferenceScheduled = "onConferenceScheduled",
+    /**
+     * @description 会议即将开始回调
+     * @default 'onConferenceWillStart'
+     * @event TUIConferenceListManagerEvents#onConferenceWillStart
+     * @param {object} options
+     * @param {string} options.conferenceInfo 会议信息。
+     *
+     * @example
+     * const roomEngine = new TUIRoomEngine();
+     * const conferenceListManager = roomEngine.getConferenceListManager();
+     * conferenceListManager.on(TUIConferenceListManagerEvents.onConferenceWillStart, ({ conferenceInfo }) => {
+     *  console.log('conferenceListManager.onConferenceWillStart', conferenceInfo);
+     * })
+     */
+    onConferenceWillStart = "onConferenceWillStart",
+    /**
+     * @description 会议取消回调
+     *
+     * @param {object} options
+     * @param {string} options.roomId 会议Id，即房间 roomId 。
+     * @param {TUIConferenceCancelReason} options.reason 会议取消原因。
+     * @param {TUIUserInfo} options.operateUser 取消会议操作者信息。
+     *
+     * @example
+     * const roomEngine = new TUIRoomEngine();
+     * const conferenceListManager = roomEngine.getConferenceListManager();
+     * conferenceListManager.on(TUIConferenceListManagerEvents.onConferenceCancelled, ({ roomId, reason, operateUser }) => {
+     *  console.log('conferenceListManager.onConferenceCancelled', roomId, reason, operateUser);
+     * })
+     */
+    onConferenceCancelled = "onConferenceCancelled",
+    /**
+     * @description 会议信息变更回调
+     *
+     * @param {object} options
+     * @param {TUIConferenceModifyInfo} options.conferenceModifyInfo 会议信息。
+     *
+     * @example
+     * const roomEngine = new TUIRoomEngine();
+     * const conferenceListManager = roomEngine.getConferenceListManager();
+     * conferenceListManager.on(TUIConferenceListManagerEvents.onConferenceInfoChanged, ({ conferenceModifyInfo }) => {
+     *  console.log('conferenceListManager.onConferenceInfoChanged', conferenceModifyInfo);
+     * })
+     */
+    onConferenceInfoChanged = "onConferenceInfoChanged",
+    /**
+     * @description 参会人员变更回调
+     *
+     * @param {object} options
+     * @param {string} options.roomId 会议Id，即房间roomId。
+     * @param {Array<TUIUserInfo>} options.leftUsers 离开成员列表。
+     * @param {Array<TUIUserInfo>} options.joinedUsers 新加入成员列表。
+     *
+     * @example
+     * const roomEngine = new TUIRoomEngine();
+     * const conferenceListManager = roomEngine.getConferenceListManager();
+     * conferenceListManager.on(TUIConferenceListManagerEvents.onScheduleAttendeesChanged, ({ roomId, leftUsers, joinedUsers }) => {
+     *  console.log('conferenceListManager.onScheduleAttendeesChanged', roomId, leftUsers, joinedUsers);
+     * })
+     */
+    onScheduleAttendeesChanged = "onScheduleAttendeesChanged",
+    /**
+     * @description 会议状态变更回调
+     *
+     * @param {object} options
+     * @param {string} options.roomId 会议Id，即房间roomId。
+     * @param {TUIConferenceStatus} options.status 会议状态。
+     *
+     * @example
+     * const roomEngine = new TUIRoomEngine();
+     * const conferenceListManager = roomEngine.getConferenceListManager();
+     * conferenceListManager.on(TUIConferenceListManagerEvents.onConferenceStatusChanged, ({ roomId, status }) => {
+     *  console.log('conferenceListManager.onConferenceStatusChanged', roomId, status );
+     * })
+     */
+    onConferenceStatusChanged = "onConferenceStatusChanged"
 }
 
 declare class Logger {
@@ -810,9 +937,11 @@ declare class TUIRoomDeviceManager {
     private deviceManagerWASM;
     private logger;
     private static deviceManager;
+    private trtcCloud;
     constructor(options: {
         Module: any;
         logger: Logger;
+        trtcCloud: TRTCCloud;
     });
     setDeviceManagerWASM(deviceManagerWASM: any): void;
     /**
@@ -959,6 +1088,248 @@ declare class TUIRoomDeviceManager {
     off(event: string, func: (...args: any[]) => void): void;
 }
 
+/**
+ * 会议列表
+ * @class conferenceListManager
+ */
+declare class TUIConferenceListManager {
+    private static readonly ROOM_NAME;
+    private static readonly SCHEDULED_START_TIME;
+    private static readonly SCHEDULED_END_TIME;
+    private conferenceListManagerWASM;
+    private logger;
+    private static conferenceListManager;
+    constructor(options: {
+        Module: any;
+        logger: Logger;
+    });
+    setConferenceListManagerWASM(conferenceListManager: any): void;
+    /**
+     * @private
+     * 调用 TUIRoomEngineWASM 的异步方法
+     * @param funcName
+     * @param args
+     */
+    private JSCallNativeFunctionPromise;
+    /**
+     * 预定会议
+     * @param {object} options
+     * @param {string} options.roomId 房间 Id，必填, roomId 限制长度为64字节，且仅支持以下范围的字符集：<br>
+     * - 大小写英文字母（a-zA-Z）
+     * - 数字（0-9）
+     * - 空格 ! # $ % & ( ) + - : ; < = . > ? @ [ ] ^ _ { } | ~ ,
+     * @param {number} [options.scheduleStartTime] 预定会议开始时间（计数单位为秒的时间戳）
+     * @param {number} [options.scheduleEndTime] 预定会议结束时间（计数单位为秒的时间戳）
+     * @param {array=} [options.scheduleAttendees=[]] 预定会议邀请成员 userId 列表
+     * @param {number=} [options.reminderSecondsBeforeStart=0] 会议开始前提醒时间，单位秒
+     * @param {string=} [options.roomName=roomId] 房间名称，默认值为 roomId，传入的值不能为空字符串
+     * @param {TUIRoomType=} [options.roomType=TUIRoomType.kConference] 房间类型, 默认值为 TUIRoomType.kConference <br>
+     * 办公协同、医疗问诊、远程会议、教育场景，roomType 设置为 TUIRoomType.kConference
+     * 电商直播、语聊房场景，roomType 设置为 TUIRoomType.kLive
+     * @param {boolean=} [options.isSeatEnabled=false] 是否开启麦位控制，默认值为 false
+     * @param {TUISeatMode=} [options.seatMode=TUISeatMode.kFreeToTake] 上麦模式(开启麦位控制后生效)，默认值为 TUISeatMode.kFreeToTake <br>
+     * 自由上麦模式，台下观众可以自由上麦，无需申请，seatMode 设置为 TUISeatMode.kFreeToTake
+     * 申请上麦模式，台下观众上麦需要房主或者管理员同意后才能上麦，seatMode 设置为 TUISeatMode.kApplyToTake
+     * @param {boolean=} [options.isMicrophoneDisableForAllUser=false] 是否开启全员禁麦，默认不开启全员禁麦（创建房间可选参数）
+     * @param {boolean=} [options.isScreenShareDisableForAllUser=false] 是否开启禁止屏幕分享，默认不开启禁止屏幕分享权限（该属性自 v2.2.0 版本 以后支持，创建房间可选参数）
+     * @param {boolean=} [options.isCameraDisableForAllUser=false] 是否开启全员禁画，默认不开启全员禁画（创建房间可选参数）
+     * @param {boolean=} [options.isMessageDisableForAllUser=false] 是否允许成员发送消息，默认不禁止（创建房间可选参数）
+     * @param {number=} options.maxSeatCount 最大麦位数量 （创建房间可选参数）
+     * @param {string=} [options.password=''] 房间密码，（该属性自 v2.5.0 版本支持）
+     * @returns {Promise<void>}
+     *
+     * @example
+     * const roomEngine = new TUIRoomEngine();
+     * const conferenceListManager = roomEngine.getConferenceListManager();
+     * await conferenceListManager.scheduleConference({
+     *  roomId: '12345', // 填入您的房间 Id, 注意房间 Id 要求为字符串类型
+     *  scheduleStartTime: 1720004257, // 填入您的会议预定开始时间的时间戳，单位秒。
+     *  scheduleEndTime: 1720001317, // 填入您的会议预定结束时间的时间戳，单位秒。
+     * });
+     */
+    scheduleConference(options: {
+        scheduleStartTime: number;
+        scheduleEndTime: number;
+        scheduleAttendees?: string[];
+        reminderSecondsBeforeStart?: number;
+        roomId: string;
+        roomName?: string;
+        roomType?: TUIRoomType;
+        isSeatEnabled?: boolean;
+        seatMode?: TUISeatMode;
+        isMicrophoneDisableForAllUser?: boolean;
+        isScreenShareDisableForAllUser?: boolean;
+        isCameraDisableForAllUser?: boolean;
+        isMessageDisableForAllUser?: boolean;
+        maxSeatCount?: number;
+        password?: string;
+    }): Promise<void>;
+    /**
+     * 取消预定会议
+     *
+     * @param {object} options
+     * @param {string} options.roomId  要取消会议Id,即房间roomId。
+     * @returns {Promise<void>}
+     *
+     * @example
+     * const roomEngine = new TUIRoomEngine();
+     * const conferenceListManager = roomEngine.getConferenceListManager();
+     * await conferenceListManager.cancelConference({
+     *  roomId: '12345',   // 填入您要取消的会议 Id ,即房间 roomId 。
+     * });
+     */
+    cancelConference(options: {
+        roomId: string;
+    }): Promise<void>;
+    /**
+     * 更新预定会议信息
+     *
+     * @param {object} options
+     * @param {string} options.roomId  会议的房间Id。
+     * @param {string} options.roomName  会议的名称。
+     * @param {string} options.scheduleStartTime  预定会议的开始时间（计数单位为秒的时间戳）。
+     * @param {string} options.scheduleEndTime  预定会议的结束时间（计数单位为秒的时间戳）。
+     * @returns {Promise<void>}
+     *
+     * @example
+     * const roomEngine = new TUIRoomEngine();
+     * const conferenceListManager = roomEngine.getConferenceListManager();
+     * await conferenceListManager.updateConferenceInfo({
+     *  roomId: '12345',   // 填入您要更新的会议房间 roomId 。
+     *  roomName: 'myRoomName',  // 填入您更新后的会议名称。
+     *  scheduleStartTime: 1720004257, // 填入您更新后的会议预定开始时间的时间戳，单位秒。
+     *  scheduleEndTime: 1720001317, // 填入您更新后的会议预定结束时间的时间戳，单位秒。
+     * });
+     */
+    updateConferenceInfo(options: {
+        roomId: string;
+        roomName?: string;
+        scheduleStartTime?: number;
+        scheduleEndTime?: number;
+    }): Promise<void>;
+    /**
+     * 获取预定会议列表
+     *
+     * @param {object} options
+     * @param {object} options.statusArray 会议状态数组，默认值为拉取全部状态会议。
+     * @param {string} options.cursor 分页获取索引，第一次拉取填 ''，回调成功 如果callback返回的数据中 cursor 不为 ''，表示需要分页，请以返回的 cursor 作为参数再次调用接口拉取，直至返回的cursor为 ''，表示数据已经全部拉取。
+     * @param {string} options.count  本次拉取数量。
+     *
+     * @example
+     * const roomEngine = new TUIRoomEngine();
+     * const conferenceListManager = roomEngine.getConferenceListManager();
+     * const conferenceList = [];
+     * let result;
+     * let cursor = '';
+     * let count = 20;
+     * do {
+     *  result = await conferenceListManager.fetchScheduledConferenceList({ cursor, count });
+     *  conferenceList.push(...result.conferenceList);
+     *  cursor = result.cursor;
+     * } while (cursor !== '')
+     */
+    fetchScheduledConferenceList(options: {
+        statusArray?: TUIConferenceStatus[];
+        cursor: string;
+        count: number;
+    }): Promise<Array<TUIConferenceInfo>>;
+    /**
+     * 获取预定会议邀请成员列表
+     *
+     * @param {object} options
+     * @param {string} options.roomId  会议 Id ,即房间 roomId 。
+     * @param {string} options.cursor 分页获取索引，第一次拉取填 ""，回调成功 如果 callback 返回的数据中 cursor 不为""，表示需要分页，请以返回的 cursor 作为参数再次调用接口拉取，直至返回的 cursor 为""，表示数据已经全部拉取。
+     * @param {string} options.count  本次拉取数量。
+     *
+     * @example
+     * const roomEngine = new TUIRoomEngine();
+     * const conferenceListManager = roomEngine.getConferenceListManager();
+     * const attendeeList = [];
+     * let result;
+     * let cursor = '';
+     * let totalCount = 0;
+     * let roomId = '12345';
+     * let count = 20;
+     * do {
+     *  result = await conferenceListManager.fetchAttendeeList({ roomId, cursor, count });
+     *  attendeeList.push(...result.attendeeList);
+     *  cursor = result.cursor;
+     *  totalCount = result.totalCount;
+     * } while (cursor !== '')
+     */
+    fetchAttendeeList(options: {
+        roomId: string;
+        cursor: string;
+        count: number;
+    }): Promise<Array<TUIUserInfo>>;
+    /**
+     * 添加成员至邀请列表
+     *
+     * @param {object} options
+     * @param {string} options.roomId  会议 Id ,即房间 roomId 。
+     * @param {string} options.userIdList 成员 userId 列表。
+     * @returns {Promise<void>}
+     *
+     * @example
+     * const roomEngine = new TUIRoomEngine();
+     * const conferenceListManager = roomEngine.getConferenceListManager();
+     * await conferenceListManager.addAttendeesByAdmin({
+     *  roomId: '12345',   // 填入您要添加成员的会议 Id ,即房间 roomId 。
+     *  userIdList: ['123'],  // 填入您要邀请的成员 Id 数组。
+     * });
+     */
+    addAttendeesByAdmin(options: {
+        roomId: string;
+        userIdList: string[];
+    }): Promise<void>;
+    /**
+     * 从邀请列表移除成员
+     *
+     * @param {object} options
+     * @param {string} options.roomId  会议 Id ,即房间 roomId 。
+     * @param {string} options.userIdList 成员 userId 列表。
+     * @returns {Promise<void>}
+     *
+     * @example
+     * const roomEngine = new TUIRoomEngine();
+     * const conferenceListManager = roomEngine.getConferenceListManager();
+     * await conferenceListManager.removeAttendeesByAdmin({
+     *  roomId: '12345',   // 填入您要移除成员的会议 Id ,即房间 roomId 。
+     *  userIdList: ['123'],  // 填入您要移除的成员 Id 数组。
+     * });
+     */
+    removeAttendeesByAdmin(options: {
+        roomId: string;
+        userIdList: string[];
+    }): Promise<void>;
+    /**
+     * 监听 conferenceListManager 的事件
+     * @param event TUIConferenceListManagerEvents
+     * @param func function
+     * @returns {void}
+     *
+     * @example
+     * const roomEngine = new TUIRoomEngine();
+     * const conferenceListManager = roomEngine.getConferenceListManager();
+     * conferenceListManager.on(event, func);
+     */
+    on(event: TUIConferenceListManagerEvents, func: (...args: any[]) => void): void;
+    private setObserver;
+    private handleConferenceChangedEvent;
+    /**
+     * 取消监听  ConferenceListManager 的事件
+     * @param event TUIConferenceListManagerEvents
+     * @param func function
+     * @returns {void}
+     *
+     * @example
+     * const roomEngine = new TUIRoomEngine();
+     * const conferenceListManager = roomEngine.getConferenceListManager();
+     * conferenceListManager.off(event, func);
+     */
+    off(event: string, func: (...args: any[]) => void): void;
+}
+
 /**
  * TUIRoomEngine 提供了音视频房间的能力
  *
@@ -968,17 +1339,24 @@ declare class TUIRoomEngine {
     static className: string;
     private static isReady;
     private roomEngineWASM;
+    private trtcCloud;
     private deviceManager;
+    private conferenceListManager;
+    private conferenceListManagerWASM;
     private static userId;
     private static sdkAppId;
     private static Module;
+    private static shareInstance;
     private logger;
     private roomId;
     private localVideoQuality;
     private localAudioQuality;
     static setModule(Module: any): void;
     static once(event: string, func: (...args: any[]) => void): void;
-    constructor();
+    static getInstance(): TUIRoomEngine;
+    constructor(options?: {
+        isSharedInstance?: boolean;
+    });
     /**
      * @private
      * 调用 TUIRoomEngineWASM 的静态方法
@@ -1086,7 +1464,8 @@ declare class TUIRoomEngine {
      * @param {boolean=} [options.isScreenShareDisableForAllUser=false] 是否开启禁止屏幕分享，默认不开启禁止屏幕分享权限（该属性自 v2.2.0 版本 以后支持，创建房间可选参数）
      * @param {boolean=} [options.isCameraDisableForAllUser=false] 是否开启全员禁画，默认不开启全员禁画（创建房间可选参数）
      * @param {boolean=} [options.isMessageDisableForAllUser=false] 是否允许成员发送消息，默认不禁止（创建房间可选参数）
-     * @param {number=} options.maxSeatCount 最大麦位数量 （创建房间可选参数）<br>
+     * @param {number=} options.maxSeatCount 最大麦位数量 （创建房间可选参数）
+     * @param {string=} [options.password=''] 房间密码，（该属性自 v2.5.0 版本支持） <br>
      * roomType 为 TUIRoomType.kConference (教育及会议场景) 时，maxSeatCount 值不做限制；
      * roomType 为 TUIRoomType.kLive(直播场景) 时，maxSeatCount 最大限制为 16；
      * @returns {Promise<void>}
@@ -1098,6 +1477,7 @@ declare class TUIRoomEngine {
      *  roomName: 'Test Room',     // 填入您的房间名称, 房间名称默认为 roomId，最长 30 字节
      *  roomType: TUIRoomType.kConference, // 设置房间类型为 TUIRoomType.kConference 类型
      *  isSeatEnabled: false, // 不开启麦位控制
+     *  password: '1234', // 填入您的房间密码，不填入则不设置房间密码
      * });
      */
     createRoom(options: {
@@ -1111,12 +1491,14 @@ declare class TUIRoomEngine {
         isCameraDisableForAllUser?: boolean;
         isMessageDisableForAllUser?: boolean;
         maxSeatCount?: number;
+        password?: string;
     }): Promise<void>;
     /**
      * 进入房间接口
      * @param {object} options
      * @param {string} options.roomId 房间号，字符串类型
      * @param {TUIRoomType} options.roomType 房间类型, 默认值为 TUIRoomType.kConference (自 v2.3.0 支持)
+     * @param {TUIEnterRoomOptions} options.options 进入房间的可选参数 (自 v2.5.0 支持)
      * @returns {Promise<TUIRoomInfo>} roomInfo
      * 该接口返回当前房间信息
      *
@@ -1125,11 +1507,15 @@ declare class TUIRoomEngine {
      * const roomDetailInfo = await roomEngine.enterRoom({
      *  roomId: '12345',
      *  roomType: TUIRoomType.kConference, // 设置房间类型为 TUIRoomType.kConference 类型
+     *  options: {
+     *    password: '1234',
+     *  }
      * });
      */
     enterRoom(options: {
         roomId: string;
         roomType: TUIRoomType;
+        options?: TUIEnterRoomOptions;
     }): Promise<TUIRoomInfo>;
     /**
      * 解散房间接口，解散房间必须由房间所有者发起，解散房间之后房间不可进入
@@ -1172,16 +1558,6 @@ declare class TUIRoomEngine {
     updateRoomNameByAdmin(options: {
         roomName: string;
     }): Promise<void>;
-    /**
-     * 更新房间的发言模式（仅群主或者管理员可以调用）
-     * @deprecated 该接口自 v2.0.0 版本废弃
-     * @param {object} options
-     * @param {TUISpeechMode} options.speechMode 发言类型
-     * @returns {Promise<void>}
-     */
-    updateRoomSpeechModeByAdmin(options: {
-        speechMode: TUISpeechMode;
-    }): Promise<void>;
     /**
      * 更新房间上麦模式（仅群主或者管理员可以调用）
      * 房间上麦模式更新后，roomEngine 会通过 TUIRoomEvents.onRoomSeatModeChanged 回调通知房间内用户
@@ -1199,6 +1575,23 @@ declare class TUIRoomEngine {
     updateRoomSeatModeByAdmin(options: {
         seatMode: TUISeatMode;
     }): Promise<void>;
+    /**
+     * 更新房间密码（仅群主或者管理员可以调用）
+     *
+     * @since v2.5.0
+     * @param {object} options
+     * @param {string} options.password 房间密码
+     * @returns {Promise<void>}
+     *
+     * @example
+     * const roomEngine = new TUIRoomEngine();
+     * await roomEngine.updateRoomPasswordByAdmin({
+     *   password: '1234',  // 更新密码为 1234
+     * });
+     */
+    updateRoomPasswordByAdmin(options: {
+        password: string;
+    }): Promise<void>;
     /**
      * 获取当前房间用户列表，注意该接口一次拉取的用户列表量最大为 50 个
      *
@@ -1772,6 +2165,27 @@ declare class TUIRoomEngine {
         userId: string;
         userRole: TUIRole;
     }): Promise<void>;
+    /**
+     * 修改房间内用户名称
+     * @since v2.5.0
+     * @param {object} options 修改房间内用户名称，普通成员可修改自己的，管理员可修改自己和普通成员的。
+     * @param {string} options.userId 用户 Id
+     * @param {string} options.nameCard 房间内用户名称
+     * @returns {Promise<void>}
+     *
+     * @example
+     * const roomEngine = new TUIRoomEngine();
+     * // 修改房间内用户名称
+     * await roomEngine.changeUserNameCard({
+     *  userId: 'user_1234',
+     *  nameCard: 'jack',
+     * });
+     *
+     */
+    changeUserNameCard(options: {
+        userId: string;
+        nameCard: string;
+    }): Promise<void>;
     /**
      * 将用户踢出房间，仅主持人和管理员可调用该接口
      * @param {object} options
@@ -2260,16 +2674,27 @@ declare class TUIRoomEngine {
      * @returns {TUIRoomDeviceManager} deviceManager
      */
     getMediaDeviceManager(): TUIRoomDeviceManager;
+    /**
+     * v2.5.0 版本起支持使用 getConferenceListManager 获取 conferenceListManager 模块
+     * @since v2.5.0
+     *
+     * @example
+     * // 获取会议列表
+     * const conferenceListManager = roomEngine.getConferenceListManager();
+     *
+     * @returns {TUIConferenceListManager} conferenceListManager
+     */
+    getConferenceListManager(): TUIConferenceListManager;
     /**
      * 获取 trtcCloud 实例
      * @returns {TRTCCloud} trtcCloud
-     * web 端 trtcCloud 能力请查看：https://web.sdk.qcloud.com/trtc/webrtc/trtcCloud/doc/TRTCCloud.html
+     * web 端 trtcCloud 能力请查看：https://web.sdk.qcloud.com/trtc/webrtc/trtcCloud/doc/this.trtcCloud.html
      *
      * @example
      * const roomEngine = new TUIRoomEngine();
      * const trtcCloud = roomEngine.getTRTCCloud();
      */
-    getTRTCCloud(): TRTCCloud;
+    getTRTCCloud(): any;
     /**
      * 获取 tim 实例
      * @returns {TIM} tim
@@ -2291,4 +2716,4 @@ declare class TUIRoomEngine {
     private static handleSetFramework;
 }
 
-export { TRTCRole, TUIAudioQuality, TUIAudioRoute, TUICaptureSourceType, TUIChangeReason, type TUIDeviceInfo, TUIErrorCode, 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, TUISpeechMode, type TUIUserInfo, type TUIVideoEncoderParams, TUIVideoQuality, TUIVideoStreamType, TUIRoomEngine as default };
+export { TRTCRole, TUIAudioQuality, TUIAudioRoute, TUICaptureSourceType, TUIChangeReason, TUIConferenceCancelReason, type TUIConferenceInfo, TUIConferenceListManager, TUIConferenceListManagerEvents, type TUIConferenceModifyInfo, TUIConferenceStatus, type TUIDeviceInfo, type TUIEnterRoomOptions, TUIErrorCode, 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 };