@tencentcloud/tuiroom-engine-electron 2.2.2 → 2.3.1

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,
@@ -228,11 +228,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 +245,8 @@ type TUIRequest = {
     timestamp: number;
     requestId: string;
     userId: string;
+    userName: string;
+    avatarUrl: string;
     content: string;
 };
 type TUIRequestCallback = {
@@ -392,6 +397,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'
@@ -982,7 +1000,7 @@ declare class TUIRoomEngine {
         sdkAppId: number;
         userId: string;
         userSig: string;
-        tim?: TIM;
+        tim?: ChatSDK;
     }): Promise<void>;
     /**
      * 设置当前用户基本信息（用户名、用户头像）
@@ -1054,7 +1072,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 +1100,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 +1108,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>;
     /**
      * 解散房间接口，解散房间必须由房间所有者发起，解散房间之后房间不可进入
@@ -1755,7 +1776,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' });
@@ -2227,7 +2248,7 @@ declare class TUIRoomEngine {
      * const roomEngine = new TUIRoomEngine();
      * const trtcCloud = roomEngine.getTIM();
      */
-    getTIM(): any;
+    getTIM(): ChatSDK;
     destroy(): void;
     /**
      * 实验性接口