@tencentcloud/tuiroom-engine-js 1.7.1-beta.0 → 2.0.0

package/index.d.ts

@@ -1,9 +1,10 @@
 import TIM from '@tencentcloud/chat';
+import TencentCloudChat from '@tencentcloud/chat';
 import TRTCCloud, { TRTCDeviceInfo, TRTCScreenCaptureSourceInfo } from 'trtc-cloud-js-sdk';
-import { TUIRoomInfo, TUIVideoStreamType, TUIVideoQuality, TUIAudioQuality, TUIRole, TUIRoomEvents, TUIRoomType, TUISeatInfo, TUIRequestCallback, TUISpeechMode, TUIMediaDevice, TUISeatLockParams, TUILoginUserInfo, TUIUserInfo, TUIRequest, TUIVideoEncoderParams, TUIResolutionMode } from './types';
+import { TUIRoomInfo, TUIVideoStreamType, TUIVideoQuality, TUIAudioQuality, TUIRole, TUIRoomEvents, TUIRoomType, TUISeatInfo, TUIRequestCallback, TUISpeechMode, TUIMediaDevice, TUISeatLockParams, TUILoginUserInfo, TUIUserInfo, TUIRequest, TUIVideoEncoderParams, TUIResolutionMode, TUISeatMode } from './types';
 export * from './types';
 export { TRTCDeviceType, TRTCDeviceState, TRTCDeviceInfo, TRTCVideoMirrorType, TRTCVideoRotation, TRTCVideoFillMode, TRTCVideoStreamType, TRTCScreenCaptureSourceInfo, TRTCScreenCaptureSourceType, Rect, TRTCVideoEncParam, TRTCVideoResolution, TRTCVideoResolutionMode, TRTCVolumeInfo, TRTCLogLevel, } from 'trtc-cloud-js-sdk';
-export { TRTCCloud, TIM };
+export { TRTCCloud, TIM, TencentCloudChat };
 /**
  * TUIRoomEngine 提供了音视频房间的能力
  *
@@ -122,17 +123,10 @@ declare class TUIRoomEngine {
      * @param {TUIRoomType=} [options.roomType=TUIRoomType.kConference] 房间类型, 默认值为 TUIRoomType.kConference <br>
      * 办公协同、医疗问诊、远程会议、教育场景，roomType 设置为 TUIRoomType.kConference
      * 电商直播、语聊房场景，roomType 设置为 TUIRoomType.kLivingRoom
-     * @param {TUISpeechMode=} [options.speechMode=TUISpeechMode.kFreeToSpeak] 房间内发言模式，默认值为 TUISpeechMode.kFreeToSpeak
-     * 1. roomType 为 TUIRoomType.kConference (教育及会议场景) 时：
-     * a. speechMode 设置为 TUISpeechMode.kFreeToSpeak，用户进房默认可以打开摄像头和麦克风
-     * b. speechMode 设置为 TUISpeechMode.kApplyToSpeak，用户进房默认不打开摄像头和麦克风，需要向主持人申请打开摄像头或麦克风
-     * TUIRoomType.kConference 场景下，TUISpeechMode.kFreeToSpeak 及 TUISpeechMode.kApplyToSpeak 模式可互相切换
-     * c. speechMode 设置为 TUISpeechMode.kSpeakAfterTakingSeat，用户进房后需要调用 takeSeat 上麦接口获取打开摄像头和麦克风的权限
-     *
-     * 2. roomType 为 TUIRoomType.kLivingRoom (直播场景) 时：
-     * a. speechMode 设置为 TUISpeechMode.kFreeToSpeak，上麦不需要主持人同意
-     * b. speechMode 设置为 TUISpeechMode.kSpeakAfterTakingSeat，上麦需要主持人同意
-     * TUIRoomType.kLivingRoom 场景下，TUISpeechMode.kFreeToSpeak 及 TUISpeechMode.kSpeakAfterTakingSeat 模式可互相切换
+     * @param {boolean=} [options.isSeatEnabled=false] 是否开启麦位控制，默认值为 false
+     * @param {TUISeatMode=} [options.seatMode=TUISeatMode.kFreeToTake] 上麦模式(开启麦位控制后生效)，默认值为 TUISeatMode.kFreeToTake <br>
+     * 自由上麦模式，台下观众可以自由上麦，无需申请，seatMode 设置为 TUISeatMode.kFreeToTake
+     * 申请上麦模式，台下观众上麦需要房主或者管理员同意后才能上麦，seatMode 设置为 TUISeatMode.kApplyToTake
      * @param {boolean=} [options.isMicrophoneDisableForAllUser=false] 是否开启全员禁麦，默认不开启全员禁麦（创建房间可选参数）
      * @param {boolean=} [options.isCameraDisableForAllUser=false] 是否开启全员禁画，默认不开启全员禁画（创建房间可选参数）
      * @param {boolean=} [options.isMessageDisableForAllUser=false] 是否允许成员发送消息，默认不禁止（创建房间可选参数）
@@ -147,14 +141,15 @@ declare class TUIRoomEngine {
      *  roomId: '12345',   // 填入您的房间 Id, 注意房间 Id 要求为字符串类型
      *  roomName: 'Test Room',     // 填入您的房间名称, 房间名称默认为 roomId，最长 30 字节
      *  roomType: TUIRoomType.kConference, // 设置房间类型为 TUIRoomType.kConference 类型
-     *  speechMode: TUISpeechMode.kFreeToSpeak, // 设置会议模式为自由发言模式
+     *  isSeatEnabled: false, // 不开启麦位控制
      * });
      */
     createRoom(options: {
         roomId: string;
         roomName?: string;
         roomType?: TUIRoomType;
-        speechMode?: TUISpeechMode;
+        isSeatEnabled?: boolean;
+        seatMode?: TUISeatMode;
         isMicrophoneDisableForAllUser?: boolean;
         isCameraDisableForAllUser?: boolean;
         isMessageDisableForAllUser?: boolean;
@@ -219,18 +214,30 @@ declare class TUIRoomEngine {
     }): Promise<void>;
     /**
      * 更新房间的发言模式（仅群主或者管理员可以调用）
+     * @deprecated 该接口自 v2.0.0 版本废弃
      * @param {object} options
      * @param {TUISpeechMode} options.speechMode 发言类型
      * @returns {Promise<void>}
+     */
+    updateRoomSpeechModeByAdmin(options: {
+        speechMode: TUISpeechMode;
+    }): Promise<void>;
+    /**
+     * 更新房间上麦模式（仅群主或者管理员可以调用）
+     * 房间上麦模式更新后，roomEngine 会通过 TUIRoomEvents.onRoomSeatModeChanged 回调通知房间内用户
+     * @since v2.0.0
+     * @param {object} options
+     * @param {TUISeatMode} options.seatMode 发言类型
+     * @returns {Promise<void>}
      *
      * @example
      * const roomEngine = new TUIRoomEngine();
-     * await roomEngine.updateRoomSpeechModeByAdmin({
-     *   speechMode: TUISpeechMode.kSpeakAfterTakingSeat,  // 更新为上麦后发言模式
+     * await roomEngine.updateRoomSeatModeByAdmin({
+     *   seatMode: TUISeatMode.kApplyToTake,  // 更新为申请上麦模式
      * });
      */
-    updateRoomSpeechModeByAdmin(options: {
-        speechMode: TUISpeechMode;
+    updateRoomSeatModeByAdmin(options: {
+        seatMode: TUISeatMode;
     }): Promise<void>;
     /**
      * 获取当前房间用户列表，注意该接口一次拉取的用户列表量最大为 100 个
@@ -980,6 +987,7 @@ declare class TUIRoomEngine {
     }): Promise<any>;
     /**
      * 发送文本消息
+     * @deprecated 该接口自 v2.0.0 版本废弃，请使用 {@link getTIM} 方法获取 tim 实例发送消息
      * @param {object} options
      * @param {string} options.messageText 文本消息内容
      * @returns {Promise<void>}