@tencentcloud/tuiroom-engine-js 3.5.2 → 3.6.1-beta.1

package/index.d.ts

@@ -254,10 +254,7 @@ declare enum TUIRequestAction {
     kRequestRemoteUserOnSeat = 5,
     kApplyToAdminToOpenLocalCamera = 6,
     kApplyToAdminToOpenLocalMicrophone = 7,
-    kApplyToAdminToOpenLocalScreenShare = 8,
-    kCloseRemoteCamera = 9,
-    kCloseRemoteMicrophone = 10,
-    kCloseRemoteScreenShare = 11
+    kApplyToAdminToOpenLocalScreenShare = 8
 }
 declare enum TUIRequestCallbackType {
     kRequestAccepted = 0,
@@ -290,11 +287,6 @@ type TUIUserInfo = {
     isMessageDisabled: boolean;
     roomCustomInfo: Record<string, any>;
 };
-declare enum TUIUserInfoModifyFlag {
-    kNone = 0,
-    kUserRole = 1,
-    kNameCard = 2
-}
 type TUISeatInfo = {
     index: number;
     userId: string;
@@ -319,8 +311,6 @@ type TUIRequest = {
     nameCard: string;
     avatarUrl: string;
     content: string;
-    fromUser: TUIUserInfo;
-    toUser: TUIUserInfo;
 };
 type TUIRequestCallback = {
     requestCallbackType: TUIRequestCallbackType;
@@ -628,11 +618,10 @@ 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, modifyFlag }) => {
-     *   console.log('roomEngine.onUserInfoChanged', userInfo, modifyFlag);
+     * roomEngine.on(TUIRoomEvents.onUserInfoChanged, ({ userInfo }) => {
+     *   console.log('roomEngine.onUserInfoChanged', userInfo);
      * });
      */
     onUserInfoChanged = "onUserInfoChanged",
@@ -972,7 +961,6 @@ declare enum TUIConferenceListManagerEvents {
     onConferenceWillStart = "onConferenceWillStart",
     /**
      * @description 会议取消回调
-     * @deprecated  该接口自 v3.5.0 版本废弃，请使用 onConferenceDidCancelled'.
      *
      * @param {object} options
      * @param {string} options.roomId 会议Id，即房间 roomId 。
@@ -987,22 +975,6 @@ 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 会议信息变更回调
      *
@@ -1019,7 +991,6 @@ declare enum TUIConferenceListManagerEvents {
     onConferenceInfoChanged = "onConferenceInfoChanged",
     /**
      * @description 参会人员变更回调
-     * @deprecated  该接口自 v3.5.0 版本废弃，请使用 onScheduleAttendeesUpdated'.
      *
      * @param {object} options
      * @param {string} options.roomId 会议Id，即房间roomId。
@@ -1034,25 +1005,8 @@ 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。
@@ -1065,22 +1019,7 @@ declare enum TUIConferenceListManagerEvents {
      *  console.log('conferenceListManager.onConferenceStatusChanged', roomId, status );
      * })
      */
-    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"
+    onConferenceStatusChanged = "onConferenceStatusChanged"
 }
 /**
  * @since v2.6.0
@@ -1216,15 +1155,15 @@ declare enum TUIConferenceInvitationManagerEvents {
      * @default 'onInvitationAdded'
      * @event TUIConferenceInvitationManagerEvents#onInvitationAdded
      * @param {object} options
-     * @param {string} options.roomId 会议信息。
+     * @param {TUIRoomInfo} options.roomInfo 会议信息。
      * @param {TUIInvitation} options.invitation 邀请信息。
      *
      *
      * @example
      * const roomEngine = new TUIRoomEngine();
      * const conferenceInvitationManager = roomEngine.getConferenceInvitationManager();
-     * conferenceInvitationManager.on(TUIConferenceInvitationManagerEvents.onInvitationAdded, ({ roomId, invitation }) => {
-     *  console.log('conferenceInvitationManager.onInvitationAdded', roomId, invitation);
+     * conferenceInvitationManager.on(TUIConferenceInvitationManagerEvents.onInvitationAdded, ({ roomInfo, invitation }) => {
+     *  console.log('conferenceInvitationManager.onInvitationAdded', roomInfo, invitation);
      * })
      */
     onInvitationAdded = "onInvitationAdded",
@@ -1233,15 +1172,15 @@ declare enum TUIConferenceInvitationManagerEvents {
      * @default 'onInvitationRemoved'
      * @event TUIConferenceInvitationManagerEvents#onInvitationRemoved
      * @param {object} options
-     * @param {string} options.roomId 会议信息。
+     * @param {TUIRoomInfo} options.roomInfo 会议信息。
      * @param {TUIInvitation} options.invitation 邀请信息。
      *
      *
      * @example
      * const roomEngine = new TUIRoomEngine();
      * const conferenceInvitationManager = roomEngine.getConferenceInvitationManager();
-     * conferenceInvitationManager.on(TUIConferenceInvitationManagerEvents.onInvitationRemoved, ({ roomId, invitation }) => {
-     *  console.log('conferenceInvitationManager.onInvitationRemoved', roomId, invitation);
+     * conferenceInvitationManager.on(TUIConferenceInvitationManagerEvents.onInvitationRemoved, ({ roomInfo, invitation }) => {
+     *  console.log('conferenceInvitationManager.onInvitationRemoved', roomInfo, invitation);
      * })
      */
     onInvitationRemoved = "onInvitationRemoved",
@@ -1250,15 +1189,15 @@ declare enum TUIConferenceInvitationManagerEvents {
      * @default 'onInvitationStatusChanged'
      * @event TUIConferenceInvitationManagerEvents#onInvitationStatusChanged
      * @param {object} options
-     * @param {string} options.roomId 会议信息。
+     * @param {TUIRoomInfo} options.roomInfo 会议信息。
      * @param {TUIInvitation} options.invitation 邀请信息。
      *
      *
      * @example
      * const roomEngine = new TUIRoomEngine();
      * const conferenceInvitationManager = roomEngine.getConferenceInvitationManager();
-     * conferenceInvitationManager.on(TUIConferenceInvitationManagerEvents.onInvitationStatusChanged, ({ roomId, invitation }) => {
-     *  console.log('conferenceInvitationManager.onInvitationStatusChanged', roomId, invitation);
+     * conferenceInvitationManager.on(TUIConferenceInvitationManagerEvents.onInvitationStatusChanged, ({ roomInfo, invitation }) => {
+     *  console.log('conferenceInvitationManager.onInvitationStatusChanged', roomInfo, invitation);
      * })
      */
     onInvitationStatusChanged = "onInvitationStatusChanged"
@@ -2017,7 +1956,7 @@ declare class TUIRoomDeviceManager {
      * await roomEngine.startCameraDeviceTest({ view: 'test-preview' });
      */
     startCameraDeviceTest(options: {
-        view: string | HTMLDivElement;
+        view: string;
     }): Promise<void>;
     /**
      * 停止摄像头测试
@@ -2225,10 +2164,7 @@ declare class TUIConferenceListManager {
         statusArray?: TUIConferenceStatus[];
         cursor: string;
         count: number;
-    }): Promise<{
-        conferenceList: TUIConferenceInfo[];
-        cursor: string;
-    }>;
+    }): Promise<Array<TUIConferenceInfo>>;
     /**
      * 获取预定会议邀请成员列表
      *
@@ -2257,11 +2193,7 @@ declare class TUIConferenceListManager {
         roomId: string;
         cursor: string;
         count: number;
-    }): Promise<{
-        attendeeList: TUIUserInfo[];
-        cursor: string;
-        totalCount: number;
-    }>;
+    }): Promise<Array<TUIUserInfo>>;
     /**
      * 添加成员至邀请列表
      *
@@ -2360,7 +2292,7 @@ declare class TUIConferenceInvitationManager {
      * @param {string} options.userIdList 成员 userId 列表。
      * @param {number} options.timeout 超时时间。若 timeout 设置为 0s ，则无超时时间
      * @param {string} options.extensionInfo 自定义扩展信息
-     * @returns {Promise<Map<string, TUIInvitationCode>>}
+     * @returns {Promise<void>}
      *
      * @example
      * const roomEngine = new TUIRoomEngine();
@@ -2376,7 +2308,7 @@ declare class TUIConferenceInvitationManager {
         userIdList: string[];
         timeout: number;
         extensionInfo?: string;
-    }): Promise<Map<string, TUIInvitationCode>>;
+    }): Promise<void>;
     /**
      * 取消呼叫
      *
@@ -2463,10 +2395,7 @@ declare class TUIConferenceInvitationManager {
         roomId: string;
         cursor: string;
         count: number;
-    }): Promise<{
-        invitationList: TUIInvitation[];
-        cursor: string;
-    }>;
+    }): Promise<Array<TUIInvitation>>;
     /**
      * 监听 conferenceInvitationManager 的事件
      * @param event TUIConferenceListManagerEvents
@@ -4831,5 +4760,4 @@ 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, 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 };
+export { type GiftCategory, type GiftInfo, type StartLiveOptions, TRTCRole, TUIAudioQuality, TUIAudioRoute, type TUIAutoPlayCallbackInfo, TUIBattleCode, type TUIBattleConfig, type TUIBattleInfo, TUIBattleStoppedReason, type TUIBattleUser, TUICaptureSourceType, TUIChangeReason, TUIConferenceCancelReason, type TUIConferenceInfo, TUIConferenceInvitationManager, TUIConferenceInvitationManagerEvents, TUIConferenceListManager, TUIConferenceListManagerEvents, type TUIConferenceModifyInfo, TUIConferenceStatus, TUIConnectionCode, type TUIDeviceInfo, TUIDeviceStatus, type TUIEnterRoomOptions, TUIErrorCode, type TUIInvitation, TUIInvitationCode, TUIInvitationRejectedReason, TUIInvitationStatus, TUIKickedOutOfRoomReason, TUILiveBattleManagerEvents, TUILiveConnectionManagerEvents, type TUILiveConnectionUser, TUILiveGiftManagerEvents, type TUILiveInfo, TUILiveLayoutManager, TUILiveLayoutManagerEvents, TUILiveListManager, TUILiveListManagerEvents, type TUILiveListResult, TUILiveModifyFlag, type TUILiveModifyInfo, type TUILiveStatisticsData, TUILiveStatisticsModifyFlag, type TUILoginUserInfo, TUIMediaDevice, TUIMediaDeviceState, TUIMediaDeviceType, type TUIMessage, TUIMoveSeatPolicy, type TUINetwork, TUINetworkQuality, TUIRenderMode, type TUIRequest, TUIRequestAction, type TUIRequestCallback, TUIRequestCallbackType, TUIResolutionMode, TUIRole, TUIRoomDeviceManager, TUIRoomDeviceMangerEvents, TUIRoomDismissedReason, TUIRoomEvents, type TUIRoomInfo, TUIRoomType, type TUISeatInfo, type TUISeatLayout, type TUISeatLockParams, TUISeatMode, type TUISeatRegion, type TUIUserInfo, type TUIVideoEncoderParams, TUIVideoQuality, TUIVideoStreamType, TUIRoomEngine as default };