@tencentcloud/tuiroom-engine-js 3.5.0-beta.2 → 3.5.0

package/index.d.ts

@@ -287,6 +287,11 @@ type TUIUserInfo = {
     isMessageDisabled: boolean;
     roomCustomInfo: Record<string, any>;
 };
+declare enum TUIUserInfoModifyFlag {
+    kNone = 0,
+    kUserRole = 1,
+    kNameCard = 2
+}
 type TUISeatInfo = {
     index: number;
     userId: string;
@@ -311,6 +316,8 @@ type TUIRequest = {
     nameCard: string;
     avatarUrl: string;
     content: string;
+    fromUser: TUIUserInfo;
+    toUser: TUIUserInfo;
 };
 type TUIRequestCallback = {
     requestCallbackType: TUIRequestCallbackType;
@@ -618,10 +625,11 @@ declare enum TUIRoomEvents {
      * @event TUIRoomEvents#onUserInfoChanged
      * @param {object} options
      * @param {TUIUserInfo} options.userInfo 用户信息
+     * @param {TUIUserInfoModifyFlag} options.modifyFlag 用户信息变更标记位，该字段自 v3.5.1 开始支持
      * @example
      * const roomEngine = new TUIRoomEngine();
-     * roomEngine.on(TUIRoomEvents.onUserInfoChanged, ({ userInfo }) => {
-     *   console.log('roomEngine.onUserInfoChanged', userInfo);
+     * roomEngine.on(TUIRoomEvents.onUserInfoChanged, ({ userInfo, modifyFlag }) => {
+     *   console.log('roomEngine.onUserInfoChanged', userInfo, modifyFlag);
      * });
      */
     onUserInfoChanged = "onUserInfoChanged",
@@ -961,6 +969,7 @@ declare enum TUIConferenceListManagerEvents {
     onConferenceWillStart = "onConferenceWillStart",
     /**
      * @description 会议取消回调
+     * @deprecated  该接口自 v3.5.0 版本废弃，请使用 onConferenceDidCancelled'.
      *
      * @param {object} options
      * @param {string} options.roomId 会议Id，即房间 roomId 。
@@ -975,6 +984,22 @@ declare enum TUIConferenceListManagerEvents {
      * })
      */
     onConferenceCancelled = "onConferenceCancelled",
+    /**
+     * @description 会议取消回调 代替 onConferenceCancelled
+     *
+     * @param {object} options
+     * @param {TUIConferenceInfo} options.conferenceInfo 会议信息。
+     * @param {TUIConferenceCancelReason} options.reason 会议取消原因。
+     * @param {TUIUserInfo} options.operateUser 取消会议操作者信息。
+     *
+     * @example
+     * const roomEngine = new TUIRoomEngine();
+     * const conferenceListManager = roomEngine.getConferenceListManager();
+     * conferenceListManager.on(TUIConferenceListManagerEvents.onConferenceDidCancelled, ({ conferenceInfo, reason, operateUser }) => {
+     *  console.log('conferenceListManager.onConferenceDidCancelled', conferenceInfo, reason, operateUser);
+     * })
+     */
+    onConferenceDidCancelled = "onConferenceDidCancelled",
     /**
      * @description 会议信息变更回调
      *
@@ -991,6 +1016,7 @@ declare enum TUIConferenceListManagerEvents {
     onConferenceInfoChanged = "onConferenceInfoChanged",
     /**
      * @description 参会人员变更回调
+     * @deprecated  该接口自 v3.5.0 版本废弃，请使用 onScheduleAttendeesUpdated'.
      *
      * @param {object} options
      * @param {string} options.roomId 会议Id，即房间roomId。
@@ -1005,8 +1031,25 @@ declare enum TUIConferenceListManagerEvents {
      * })
      */
     onScheduleAttendeesChanged = "onScheduleAttendeesChanged",
+    /**
+     * @description 参会人员变更回调  代替 onScheduleAttendeesChanged
+     *
+     * @param {object} options
+     * @param {TUIConferenceInfo} options.conferenceInfo 会议信息。
+     * @param {Array<TUIUserInfo>} options.leftUsers 离开成员列表。
+     * @param {Array<TUIUserInfo>} options.joinedUsers 新加入成员列表。
+     *
+     * @example
+     * const roomEngine = new TUIRoomEngine();
+     * const conferenceListManager = roomEngine.getConferenceListManager();
+     * conferenceListManager.on(TUIConferenceListManagerEvents.onScheduleAttendeesUpdated, ({ conferenceInfo, leftUsers, joinedUsers }) => {
+     *  console.log('conferenceListManager.onScheduleAttendeesUpdated', conferenceInfo, leftUsers, joinedUsers);
+     * })
+     */
+    onScheduleAttendeesUpdated = "onScheduleAttendeesUpdated",
     /**
      * @description 会议状态变更回调
+     * @deprecated  该接口自 v3.5.0 版本废弃，请使用 onConferenceStatusUpdated'.
      *
      * @param {object} options
      * @param {string} options.roomId 会议Id，即房间roomId。
@@ -1019,7 +1062,22 @@ declare enum TUIConferenceListManagerEvents {
      *  console.log('conferenceListManager.onConferenceStatusChanged', roomId, status );
      * })
      */
-    onConferenceStatusChanged = "onConferenceStatusChanged"
+    onConferenceStatusChanged = "onConferenceStatusChanged",
+    /**
+     * @description 会议状态变更回调
+     *
+     * @param {object} options
+     * @param {TUIConferenceInfo} options.conferenceInfo 会议Id，即房间roomId。
+     * @param {TUIConferenceStatus} options.status 会议状态。
+     *
+     * @example
+     * const roomEngine = new TUIRoomEngine();
+     * const conferenceListManager = roomEngine.getConferenceListManager();
+     * conferenceListManager.on(TUIConferenceListManagerEvents.onConferenceStatusUpdated, ({ conferenceInfo, status }) => {
+     *  console.log('conferenceListManager.onConferenceStatusUpdated', conferenceInfo, status );
+     * })
+     */
+    onConferenceStatusUpdated = "onConferenceStatusUpdated"
 }
 /**
  * @since v2.6.0
@@ -1155,15 +1213,15 @@ declare enum TUIConferenceInvitationManagerEvents {
      * @default 'onInvitationAdded'
      * @event TUIConferenceInvitationManagerEvents#onInvitationAdded
      * @param {object} options
-     * @param {TUIRoomInfo} options.roomInfo 会议信息。
+     * @param {string} options.roomId 会议信息。
      * @param {TUIInvitation} options.invitation 邀请信息。
      *
      *
      * @example
      * const roomEngine = new TUIRoomEngine();
      * const conferenceInvitationManager = roomEngine.getConferenceInvitationManager();
-     * conferenceInvitationManager.on(TUIConferenceInvitationManagerEvents.onInvitationAdded, ({ roomInfo, invitation }) => {
-     *  console.log('conferenceInvitationManager.onInvitationAdded', roomInfo, invitation);
+     * conferenceInvitationManager.on(TUIConferenceInvitationManagerEvents.onInvitationAdded, ({ roomId, invitation }) => {
+     *  console.log('conferenceInvitationManager.onInvitationAdded', roomId, invitation);
      * })
      */
     onInvitationAdded = "onInvitationAdded",
@@ -1172,15 +1230,15 @@ declare enum TUIConferenceInvitationManagerEvents {
      * @default 'onInvitationRemoved'
      * @event TUIConferenceInvitationManagerEvents#onInvitationRemoved
      * @param {object} options
-     * @param {TUIRoomInfo} options.roomInfo 会议信息。
+     * @param {string} options.roomId 会议信息。
      * @param {TUIInvitation} options.invitation 邀请信息。
      *
      *
      * @example
      * const roomEngine = new TUIRoomEngine();
      * const conferenceInvitationManager = roomEngine.getConferenceInvitationManager();
-     * conferenceInvitationManager.on(TUIConferenceInvitationManagerEvents.onInvitationRemoved, ({ roomInfo, invitation }) => {
-     *  console.log('conferenceInvitationManager.onInvitationRemoved', roomInfo, invitation);
+     * conferenceInvitationManager.on(TUIConferenceInvitationManagerEvents.onInvitationRemoved, ({ roomId, invitation }) => {
+     *  console.log('conferenceInvitationManager.onInvitationRemoved', roomId, invitation);
      * })
      */
     onInvitationRemoved = "onInvitationRemoved",
@@ -1189,15 +1247,15 @@ declare enum TUIConferenceInvitationManagerEvents {
      * @default 'onInvitationStatusChanged'
      * @event TUIConferenceInvitationManagerEvents#onInvitationStatusChanged
      * @param {object} options
-     * @param {TUIRoomInfo} options.roomInfo 会议信息。
+     * @param {string} options.roomId 会议信息。
      * @param {TUIInvitation} options.invitation 邀请信息。
      *
      *
      * @example
      * const roomEngine = new TUIRoomEngine();
      * const conferenceInvitationManager = roomEngine.getConferenceInvitationManager();
-     * conferenceInvitationManager.on(TUIConferenceInvitationManagerEvents.onInvitationStatusChanged, ({ roomInfo, invitation }) => {
-     *  console.log('conferenceInvitationManager.onInvitationStatusChanged', roomInfo, invitation);
+     * conferenceInvitationManager.on(TUIConferenceInvitationManagerEvents.onInvitationStatusChanged, ({ roomId, invitation }) => {
+     *  console.log('conferenceInvitationManager.onInvitationStatusChanged', roomId, invitation);
      * })
      */
     onInvitationStatusChanged = "onInvitationStatusChanged"
@@ -1956,7 +2014,7 @@ declare class TUIRoomDeviceManager {
      * await roomEngine.startCameraDeviceTest({ view: 'test-preview' });
      */
     startCameraDeviceTest(options: {
-        view: string;
+        view: string | HTMLDivElement;
     }): Promise<void>;
     /**
      * 停止摄像头测试
@@ -2164,7 +2222,10 @@ declare class TUIConferenceListManager {
         statusArray?: TUIConferenceStatus[];
         cursor: string;
         count: number;
-    }): Promise<Array<TUIConferenceInfo>>;
+    }): Promise<{
+        conferenceList: TUIConferenceInfo[];
+        cursor: string;
+    }>;
     /**
      * 获取预定会议邀请成员列表
      *
@@ -2193,7 +2254,11 @@ declare class TUIConferenceListManager {
         roomId: string;
         cursor: string;
         count: number;
-    }): Promise<Array<TUIUserInfo>>;
+    }): Promise<{
+        attendeeList: TUIUserInfo[];
+        cursor: string;
+        totalCount: number;
+    }>;
     /**
      * 添加成员至邀请列表
      *
@@ -2292,7 +2357,7 @@ declare class TUIConferenceInvitationManager {
      * @param {string} options.userIdList 成员 userId 列表。
      * @param {number} options.timeout 超时时间。若 timeout 设置为 0s ，则无超时时间
      * @param {string} options.extensionInfo 自定义扩展信息
-     * @returns {Promise<void>}
+     * @returns {Promise<Map<string, TUIInvitationCode>>}
      *
      * @example
      * const roomEngine = new TUIRoomEngine();
@@ -2308,7 +2373,7 @@ declare class TUIConferenceInvitationManager {
         userIdList: string[];
         timeout: number;
         extensionInfo?: string;
-    }): Promise<void>;
+    }): Promise<Map<string, TUIInvitationCode>>;
     /**
      * 取消呼叫
      *
@@ -2395,7 +2460,10 @@ declare class TUIConferenceInvitationManager {
         roomId: string;
         cursor: string;
         count: number;
-    }): Promise<Array<TUIInvitation>>;
+    }): Promise<{
+        invitationList: TUIInvitation[];
+        cursor: string;
+    }>;
     /**
      * 监听 conferenceInvitationManager 的事件
      * @param event TUIConferenceListManagerEvents
@@ -4760,5 +4828,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, 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 { 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, TUIUserInfoModifyFlag, 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 };