@tencentcloud/tuiroom-engine-electron 2.2.2 → 2.3.3

package/index.d.ts

@@ -1,7 +1,7 @@
-import TIM from '@tencentcloud/chat';
+import { ChatSDK } from '@tencentcloud/chat';
 export { default as TIM, default as TencentCloudChat } from '@tencentcloud/chat';
 import TRTCCloud, { TRTCScreenCaptureSourceInfo, TRTCDeviceInfo } from 'trtc-electron-sdk';
-export { Rect, default as TRTCCloud, TRTCDeviceInfo, TRTCDeviceState, TRTCDeviceType, TRTCLogLevel, TRTCScreenCaptureProperty, TRTCScreenCaptureSourceInfo, TRTCScreenCaptureSourceType, TRTCVideoEncParam, TRTCVideoFillMode, TRTCVideoMirrorType, TRTCVideoResolution, TRTCVideoResolutionMode, TRTCVideoRotation, TRTCVideoStreamType, TRTCVolumeInfo } from 'trtc-electron-sdk';
+export { Rect, default as TRTCCloud, TRTCDeviceInfo, TRTCDeviceState, TRTCDeviceType, TRTCScreenCaptureProperty, TRTCScreenCaptureSourceInfo, TRTCScreenCaptureSourceType, TRTCVideoEncParam, TRTCVideoFillMode, TRTCVideoMirrorType, TRTCVideoResolution, TRTCVideoResolutionMode, TRTCVideoRotation, TRTCVideoStreamType, TRTCVolumeInfo } from 'trtc-electron-sdk';
 
 declare enum TUIErrorCode {
     ERR_SUCC = 0,
@@ -165,7 +165,7 @@ type TUIVideoEncoderParams = {
 };
 declare enum TUIRoomType {
     kConference = 1,
-    kLivingRoom = 2
+    kLive = 2
 }
 declare enum TUISpeechMode {
     kFreeToSpeak = 1,
@@ -220,6 +220,10 @@ declare enum TUIResolutionMode {
     kResolutionMode_Landscape = 0,
     kResolutionMode_Portrait = 1
 }
+declare enum TUIRoomDismissedReason {
+    kByOwner = 1,
+    kByServer = 2
+}
 type TUIUserInfo = {
     userId: string;
     userName: string;
@@ -228,11 +232,14 @@ type TUIUserInfo = {
     hasAudioStream: boolean;
     hasVideoStream: boolean;
     hasScreenStream: boolean;
+    isMessageDisabled: boolean;
     roomCustomInfo: Record<string, any>;
 };
 type TUISeatInfo = {
     index: number;
     userId: string;
+    userName: string;
+    avatarUrl: string;
     locked: boolean;
     isVideoLocked: boolean;
     isAudioLocked: boolean;
@@ -242,6 +249,8 @@ type TUIRequest = {
     timestamp: number;
     requestId: string;
     userId: string;
+    userName: string;
+    avatarUrl: string;
     content: string;
 };
 type TUIRequestCallback = {
@@ -345,10 +354,11 @@ declare enum TUIRoomEvents {
      * @event TUIRoomEvents#onRoomDismissed
      * @param {object} options
      * @param {string} options.roomId 房间号
+     * @param {TUIRoomDismissedReason} options.reason 房间解散原因枚举，该字段自 v2.3.0 开始支持
      * @example
      * const roomEngine = new TUIRoomEngine();
-     * roomEngine.on(TUIRoomEvents.onRoomDismissed, ({ roomId }) => {
-     *   console.log('roomEngine.onRoomDismissed', roomId);
+     * roomEngine.on(TUIRoomEvents.onRoomDismissed, ({ roomId,reason }) => {
+     *   console.log('roomEngine.onRoomDismissed', roomId,reason);
      * });
      */
     onRoomDismissed = "onRoomDismissed",
@@ -392,6 +402,19 @@ declare enum TUIRoomEvents {
      * });
      */
     onRoomSeatModeChanged = "onRoomSeatModeChanged",
+    /**
+     * @description 房间内人数变化事件
+     * @default 'onRoomUserCountChanged'
+     * @event TUIRoomEvents#onRoomUserCountChanged
+     * @param {object} options
+     * @param {number} options.userCount 房间内人数
+     * @example
+     * const roomEngine = new TUIRoomEngine();
+     * roomEngine.on(TUIRoomEvents.onRoomUserCountChanged, ({ roomId, userCount }) =>{
+     *    console.log('roomEngine.onRoomUserCountChanged', roomId, userCount);
+     * });
+     */
+    onRoomUserCountChanged = "onRoomUserCountChanged",
     /**
      * @description 所有成员摄像头使用权限改变事件
      * @default 'onAllUserCameraDisableChanged'
@@ -493,10 +516,11 @@ declare enum TUIRoomEvents {
      * @param {object} options
      * @param {string} options.userId 用户Id
      * @param {TUIRole} options.userRole 用户变更后的角色
+     * @param {TUIUserInfo} options.userInfo 用户信息,该字段自 v2.3.0 开始支持
      * @example
      * const roomEngine = new TUIRoomEngine();
-     * roomEngine.on(TUIRoomEvents.onUserRoleChanged, ({ userId, userRole }) => {
-     *   console.log('roomEngine.onUserRoleChanged', userId, userRole);
+     * roomEngine.on(TUIRoomEvents.onUserRoleChanged, ({ userInfo }) => {
+     *   console.log('roomEngine.onUserRoleChanged', userInfo);
      * });
      */
     onUserRoleChanged = "onUserRoleChanged",
@@ -595,10 +619,12 @@ declare enum TUIRoomEvents {
      * @description 当前用户被踢下麦事件
      * @default 'onKickedOffSeat'
      * @event TUIRoomEvents#onKickedOffSeat
+     * @param {number} options.seatIndex 麦位编号，该字段自 v2.3.0 开始支持
+     * @param {TUIUserInfo} options.userInfo 操作踢人的（主持人/管理员）用户信息，该字段自 v2.3.0 开始支持
      * @example
      * const roomEngine = new TUIRoomEngine();
-     * roomEngine.on(TUIRoomEvents.onKickedOffSeat, ({ userId }) => {
-     *   console.log('roomEngine.onKickedOffSeat', userId);
+     * roomEngine.on(TUIRoomEvents.onKickedOffSeat, ({ seatIndex, userInfo }) => {
+     *   console.log('roomEngine.onKickedOffSeat', seatIndex, userInfo);
      * });
      */
     onKickedOffSeat = "onKickedOffSeat",
@@ -622,10 +648,12 @@ declare enum TUIRoomEvents {
      * @param {object} options
      * @param {string} options.requestId 请求Id
      * @param {string} options.userId 取消请求的用户Id
+     * @param {TUIRequest} options.request 请求信息，该字段自 v2.3.0 开始支持
+     * @param {TUIUserInfo} options.userInfo 处理该请求的 管理员/房主 的用户信息，该字段自 v2.3.0 开始支持
      * @example
      * const roomEngine = new TUIRoomEngine();
-     * roomEngine.on(TUIRoomEvents.onRequestCancelled, ({ requestId, userId }) => {
-     *   console.log('roomEngine.onRequestCancelled', requestId, userId);
+     * roomEngine.on(TUIRoomEvents.onRequestCancelled, ({ request, userInfo }) => {
+     *   console.log('roomEngine.onRequestCancelled', request, userInfo);
      * });
      */
     onRequestCancelled = "onRequestCancelled",
@@ -636,10 +664,12 @@ declare enum TUIRoomEvents {
      * @param {object} options
      * @param {string} options.requestId 请求Id
      * @param {string} options.userId 处理该请求的 管理员/房主 的用户ID
+     * @param {TUIRequest} options.request 请求信息，该字段自 v2.3.0 开始支持
+     * @param {TUIUserInfo} options.userInfo 处理该请求的 管理员/房主 的用户信息，该字段自 v2.3.0 开始支持
      * @example
      * const roomEngine = new TUIRoomEngine();
-     * roomEngine.on(TUIRoomEvents.onRequestProcessed, ({ requestId, userId }) => {
-     *   console.log('roomEngine.onRequestProcessed', requestId, userId);
+     * roomEngine.on(TUIRoomEvents.onRequestProcessed, ({ request, userInfo }) => {
+     *   console.log('roomEngine.onRequestProcessed', request, userInfo);
      * });
      */
     onRequestProcessed = "onRequestProcessed",
@@ -982,7 +1012,7 @@ declare class TUIRoomEngine {
         sdkAppId: number;
         userId: string;
         userSig: string;
-        tim?: TIM;
+        tim?: ChatSDK;
     }): Promise<void>;
     /**
      * 设置当前用户基本信息（用户名、用户头像）
@@ -1054,7 +1084,7 @@ declare class TUIRoomEngine {
      * @param {boolean=} [options.isMessageDisableForAllUser=false] 是否允许成员发送消息，默认不禁止（创建房间可选参数）
      * @param {number=} options.maxSeatCount 最大麦位数量 （创建房间可选参数）<br>
      * roomType 为 TUIRoomType.kConference (教育及会议场景) 时，maxSeatCount 值不做限制；
-     * roomType 为 TUIRoomType.kLivingRoom (直播场景) 时，maxSeatCount 最大限制为 16；
+     * roomType 为 TUIRoomType.kLive(直播场景) 时，maxSeatCount 最大限制为 16；
      * @returns {Promise<void>}
      *
      * @example
@@ -1082,6 +1112,7 @@ declare class TUIRoomEngine {
      * 进入房间接口
      * @param {object} options
      * @param {string} options.roomId 房间号，字符串类型
+     * @param {TUIRoomType} options.roomType 房间类型, 默认值为 TUIRoomType.kConference (自 v2.3.0 支持)
      * @returns {Promise<TUIRoomInfo>} roomInfo
      * 该接口返回当前房间信息
      *
@@ -1089,10 +1120,12 @@ declare class TUIRoomEngine {
      * const roomEngine = new TUIRoomEngine();
      * const roomDetailInfo = await roomEngine.enterRoom({
      *  roomId: '12345',
+     *  roomType: TUIRoomType.kConference, // 设置房间类型为 TUIRoomType.kConference 类型
      * });
      */
     enterRoom(options: {
         roomId: string;
+        roomType: TUIRoomType;
     }): Promise<TUIRoomInfo>;
     /**
      * 解散房间接口，解散房间必须由房间所有者发起，解散房间之后房间不可进入
@@ -1517,12 +1550,12 @@ declare class TUIRoomEngine {
      * @param {TUIMediaDevice} options.device 请求的设备
      * @param {number} options.timeout 超时时间。若 timeout 设置为 0 ，则无超时时间
      * @param {Function} 请求回调，用来通知发起方请求被接受/拒绝/取消/超时/错误的回调
-     * @return {Promise<number>} <br/>
-     * 该接口返回 requestId，用户可使用该 requestId 调用 cancelRequest 接口取消请求
+     * @return {Promise<TUIRequest>} <br/>
+     * 该接口返回 request 结构体，当 request.requestId 不为 '' 时，用户可调用 cancelRequest 接口取消请求。
      *
      * @example
      * const roomEngine = new TUIRoomEngine();
-     * const requestId = roomEngine.openRemoteDeviceByAdmin({
+     * const request = roomEngine.openRemoteDeviceByAdmin({
      *   userId: 'user_1234',
      *   device: TUIMediaDevice.kMicrophone  //请求的设备为麦克风
      *   timeout: 0,
@@ -1562,12 +1595,12 @@ declare class TUIRoomEngine {
      * @param {TUIMediaDevice} options.device 请求的设备
      * @param {number} options.timeout 超时时间。若 timeout 设置为 0 ，则无超时时间
      * @param {Function} 请求回调，用来通知发起方请求被接受/拒绝/取消/超时/错误的回调
-     * @return {Promise<number>} <br/>
-     * 该接口返回 requestId，用户可使用该 requestId 调用 cancelRequest 接口取消请求
+     * @return {Promise<TUIRequest>} <br/>
+     * 该接口返回 request 结构体，当 request.requestId 不为 '' 时，用户可调用 cancelRequest 接口取消请求。
      *
      * @example
      * const roomEngine = new TUIRoomEngine();
-     * const requestId = roomEngine.applyToAdminToOpenLocalDevice({
+     * const request = roomEngine.applyToAdminToOpenLocalDevice({
      *   device: TUIMediaDevice.kMicrophone, //请求打开麦克风
      *   timeout: 0,
      *   requestCallback: ({ requestCallbackType, requestId, userId, code, message }) => {
@@ -1755,7 +1788,7 @@ declare class TUIRoomEngine {
      * @param {object} options
      * @param {number} options.maxSeatCount 设置房间麦位最大值<br/>
      * roomType 为 TUIRoomType.kConference (教育及会议场景) 时，maxSeatCount 值不做限制；
-     * roomType 为 TUIRoomType.kLivingRoom (直播场景) 时，maxSeatCount 最大限制为 16；
+     * roomType 为 TUIRoomType.kLive(直播场景) 时，maxSeatCount 最大限制为 16；
      * @returns {Promise<void>}
      * const roomEngine = new TUIRoomEngine();
      * await roomEngine.createRoom({ roomId: '12345' });
@@ -1784,7 +1817,7 @@ declare class TUIRoomEngine {
      * @param {number} options.seatIndex 麦位 index, 无麦位序号时设置为 -1
      * @param {number} options.timeout 超时时间。若 timeout 设置为 0，则无超时时间
      * @param {Function} options.requestCallback 请求回调，用来通知发起方请求被接受/拒绝/取消/超时/错误的回调
-     * @returns {Promise<number>} <br/>
+     * @returns {Promise<TUIRequest>} <br/>
      * 该接口返回 request 结构体，当 request.requestId 不为 '' 时，用户可调用 cancelRequest 接口取消上麦请求。
      *
      * @example
@@ -1845,12 +1878,12 @@ declare class TUIRoomEngine {
      * @param {string} options.userId  用户 Id
      * @param {number} options.timeout  超时时间，设置为 0 时，无超时时间
      * @param {Function} options.requestCallback 请求回调，用来通知发起方请求被接受/拒绝/取消/超时/错误的回调
-     * @returns {Promise<number>} <br/>
-     * 该接口返回 requestId，用户可使用该 requestId 调用 cancelRequest 接口取消请求
+     * @returns {Promise<TUIRequest>} <br/>
+     * 该接口返回 request 结构体，当 request.requestId 不为 '' 时，用户可调用 cancelRequest 接口取消请求。
      *
      * @example
      * const roomEngine = new TUIRoomEngine();
-     * const requestId = await roomEngine.takeUserOnSeatByAdmin({
+     * const request = await roomEngine.takeUserOnSeatByAdmin({
      *   seatIndex: 0,
      *   userId: 'user_1234',
      *   timeout: 0,
@@ -2058,6 +2091,7 @@ declare class TUIRoomEngine {
      */
     on(event: TUIRoomEvents, func: (...args: any[]) => void): void;
     private setObserver;
+    private supportForDeprecatedEvents;
     /**
      * 取消监听 roomEngine 的事件
      * @param event TUIRoomEvents
@@ -2227,7 +2261,7 @@ declare class TUIRoomEngine {
      * const roomEngine = new TUIRoomEngine();
      * const trtcCloud = roomEngine.getTIM();
      */
-    getTIM(): any;
+    getTIM(): ChatSDK;
     destroy(): void;
     /**
      * 实验性接口
@@ -2239,4 +2273,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, 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, 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 };