@tencentcloud/tuiroom-engine-js 2.2.3 → 2.3.1

package/index.d.ts

@@ -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,20 @@ declare enum TUIRoomEvents {
      * });
      */
     onRoomSeatModeChanged = "onRoomSeatModeChanged",
+    /**
+     * @description 房间内人数变化事件
+     * @default 'onRoomUserCountChanged'
+     * @event TUIRoomEvents#onRoomUserCountChanged
+     * @param {object} options
+     * @param {string} options.roomId 房间号
+     * @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'
@@ -1044,7 +1063,7 @@ declare class TUIRoomEngine {
      * @param {string=} [options.roomName=roomId] 房间名称，默认值为 roomId，传入的值不能为空字符串
      * @param {TUIRoomType=} [options.roomType=TUIRoomType.kConference] 房间类型, 默认值为 TUIRoomType.kConference <br>
      * 办公协同、医疗问诊、远程会议、教育场景，roomType 设置为 TUIRoomType.kConference
-     * 电商直播、语聊房场景，roomType 设置为 TUIRoomType.kLivingRoom
+     * 电商直播、语聊房场景，roomType 设置为 TUIRoomType.kLive
      * @param {boolean=} [options.isSeatEnabled=false] 是否开启麦位控制，默认值为 false
      * @param {TUISeatMode=} [options.seatMode=TUISeatMode.kFreeToTake] 上麦模式(开启麦位控制后生效)，默认值为 TUISeatMode.kFreeToTake <br>
      * 自由上麦模式，台下观众可以自由上麦，无需申请，seatMode 设置为 TUISeatMode.kFreeToTake
@@ -1055,7 +1074,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
@@ -1083,6 +1102,7 @@ declare class TUIRoomEngine {
      * 进入房间接口
      * @param {object} options
      * @param {string} options.roomId 房间号，字符串类型
+     * @param {TUIRoomType} options.roomType 房间类型, 默认值为 TUIRoomType.kConference (自 v2.3.0 支持)
      * @returns {Promise<TUIRoomInfo>} roomInfo
      * 该接口返回当前房间信息
      *
@@ -1090,10 +1110,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>;
     /**
      * 解散房间接口，解散房间必须由房间所有者发起，解散房间之后房间不可进入
@@ -1765,7 +1787,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' });