@tencentcloud/tuiroom-engine-electron 1.2.0 → 1.3.0

package/index.d.ts

@@ -18,7 +18,7 @@ declare class TUIRoomEngine {
     private logger;
     private roomId;
     private localVideoQuality;
-    private LocalAudioQuality;
+    private localAudioQuality;
     static setModule(Module: any): void;
     static once(event: string, func: Function): void;
     constructor();
@@ -34,6 +34,7 @@ declare class TUIRoomEngine {
      * @param args
      */
     private JSCallNativeFunctionPromise;
+    private JSCallNativeRequestFunctionPromise;
     /**
      * 登录 TUIRoomEngine
      *
@@ -66,6 +67,9 @@ declare class TUIRoomEngine {
      * @param {object} options
      * @param {string} options.userName 用户名，必填
      * @param {string} options.avatarUrl 用户头像，必填
+     * @param {object=} options.customInfo 用户自定义资料
+     * App 管理员可以通过 [即时通信 IM 控制台 > 用户自定义字段](https://console.cloud.tencent.com/im/user-data) 新增自定义资料字段
+     * 用户自定义字段生效以后，用户可以调用 setSelfInfo 接口设置自定义资料
      * @returns {Promise<void>}
      *
      * @example
@@ -74,10 +78,21 @@ declare class TUIRoomEngine {
      *  userName: '',     // 填写您的新用户名
      *  avatarUrl: '',    // 填写您的新头像地址
      * })
+     *
+     * // 设置当前用户用户名, 用户头像及用户自定义消息
+     * await TUIRoomEngine.setSelfInfo({
+     *  userName: '',     // 填写您的新用户名
+     *  avatarUrl: '',    // 填写您的新头像地址
+     *  customInfo: {     // 填写用户自定义消息
+     *    Tag_Profile_Custom_Test: 'value1',
+     *    Tag_Profile_Custom_profile: 'value2,
+     *  },
+     * })
      */
     static setSelfInfo(options: {
         userName: string;
         avatarUrl: string;
+        customInfo?: Record<string, any>;
     }): Promise<void>;
     /** 获取当前用户信息接口
      * @returns {Promise<TUILoginUserInfo>} loginUserInfo
@@ -123,8 +138,6 @@ declare class TUIRoomEngine {
      * @param {number=} options.maxSeatCount 最大麦位数量 （创建房间可选参数）<br>
      * roomType 为 TUIRoomType.kConference (教育及会议场景) 时，maxSeatCount 值不做限制；
      * roomType 为 TUIRoomType.kLivingRoom (直播场景) 时，maxSeatCount 最大限制为 16；
-     * @param {boolean=} [options.enableCDNStreaming=false] 是否开启 CDN 直播流，默认值为 false
-     * @param {string=} [options.cdnStreamDomain=''] 直播推流域名，默认值为空
      * @returns {Promise<void>}
      *
      * @example
@@ -145,8 +158,6 @@ declare class TUIRoomEngine {
         isCameraDisableForAllUser?: boolean;
         isMessageDisableForAllUser?: boolean;
         maxSeatCount?: number;
-        enableCDNStreaming?: boolean;
-        cdnStreamDomain?: string;
     }): Promise<void>;
     /**
      * 进入房间接口
@@ -194,7 +205,7 @@ declare class TUIRoomEngine {
     fetchRoomInfo(): Promise<TUIRoomInfo>;
     /**
      * 更新房间的名字（仅群主或者管理员可以调用）
-     * @param {object} options 获取当前房间的名字
+     * @param {object} options
      * @param {string} options.roomName 更新当前房间的名字
      * @returns {Promise<void>}
      * @example
@@ -234,7 +245,7 @@ declare class TUIRoomEngine {
      * const userList = [];
      * let result;
      * do {
-     *  result = await globalProperties.roomEngine.getUserList();
+     *  result = await roomEngine.getUserList();
      *  userList.push(...result.userInfoList);
      * } while (result.nextSequence !== 0)
      */
@@ -258,113 +269,236 @@ declare class TUIRoomEngine {
         userId: string;
     }): Promise<any>;
     /**
-     * 设置房间麦位最大值
+     * 设置本地流的渲染位置
+     * @param {object} options 设置本地流的渲染位置的参数
+     * @param {TUIVideoStreamType} options.streamType 本地流类型
+     * @param {string} options.view streamType 对应的流渲染的 div 元素的 id
+     * @returns {Promise<void>}
+     *
+     * @example
+     * const roomEngine = new TUIRoomEngine();
+     *
+     * // 设置本地摄像头流的播放区域为 id 是 'preview-camera' 的 div 元素
+     * roomEngine.setLocalVideoView({
+     *  streamType: TUIVideoStreamType.kCameraStream,
+     *  view: 'preview-camera',
+     * });
+     *
+     * // 设置本地屏幕分享流的播放区域为 id 是 'preview-screen' 的 div 元素
+     * roomEngine.setLocalVideoView({
+     *  streamType: TUIVideoStreamType.kScreenStream,
+     *  view: 'preview-screen',
+     * });
+     */
+    setLocalVideoView(options: {
+        streamType: TUIVideoStreamType;
+        view: string;
+    }): void;
+    /**
+     * 打开本地摄像头，开始视频流采集
+     * @param {object} options 设置本地流的参数
+     * @returns {Promise<void>}
+     * @example
+     * const roomEngine = new TUIRoomEngine();
+     * await roomEngine.openLocalCamera();
+     */
+    openLocalCamera(): Promise<void>;
+    /**
+     * 关闭本地摄像头
+     * @returns {Promise<void>}
+     *
+     * @example
+     * const roomEngine = new TUIRoomEngine();
+     * await roomEngine.closeLocalCamera();
+     */
+    closeLocalCamera(): Promise<void>;
+    /**
+     * 打开麦克风
+     * @returns {Promise<void>}
+     *
+     * @example
+     * const roomEngine = new TUIRoomEngine();
+     * await roomEngine.openLocalMicrophone();
+     */
+    openLocalMicrophone(): Promise<void>;
+    /**
+     * 关闭本地麦克风, 停止采集音频流
+     * @returns {Promise<void>}
+     *
+     * @example
+     * const roomEngine = new TUIRoomEngine();
+     * await roomEngine.closeLocalMicrophone();
+     */
+    closeLocalMicrophone(): Promise<void>;
+    /**
+     * 设置本地视频流的编码参数
      * @param {object} options
-     * @param {number} options.maxSeatCount 设置房间麦位最大值<br/>
-     * roomType 为 TUIRoomType.kConference (教育及会议场景) 时，maxSeatCount 值不做限制；
-     * roomType 为 TUIRoomType.kLivingRoom (直播场景) 时，maxSeatCount 最大限制为 16；
+     * @param {TUIVideoQuality} options.quality
+     *
+     * - 360p TUIVideoQuality.kVideoQuality_360p <br/>
+     * - 540p TUIVideoQuality.kVideoQuality_540p <br/>
+     * - 720p TUIVideoQuality.kVideoQuality_720p <br/>
+     * - 1080p TUIVideoQuality.kVideoQuality_1080p <br/>
+     *
      * @returns {Promise<void>}
+     *
+     * @example
      * const roomEngine = new TUIRoomEngine();
-     * await roomEngine.createRoom({ roomId: '12345' });
-     * await roomEngine.setMaxSeatCount({ maxSeatCount: 16 })
+     * await roomEngine.updateVideoQuality({
+     *  quality: TUIVideoQuality.kVideoQuality_360p,
+     * });
      */
-    setMaxSeatCount(options: {
-        maxSeatCount: number;
+    updateVideoQuality(options: {
+        quality: TUIVideoQuality;
     }): Promise<void>;
-    private JSCallNativeRequestFunctionPromise;
     /**
-     * 麦下用户可调用 takeSeat 成为麦上用户，仅麦上用户可发布本地音视频流。<br/>
-     * 当 roomInfo.enableSeatControl 为 true 时，普通用户调用 takeSeat 方法需要等待主持人/管理员的同意后成为麦上用户。<br/>
-     * 当 roomInfo.enableSeatControl 为 false 时，普通用户调用 takeSeat 方法成功后即为麦上用户。<br/>
-     * 主持人&管理员调用 takeSeat 成功后即为麦上用户。<br/>
-     * 麦上用户的变更通过 TUIRoomEvents.onSeatListChanged 通知所有用户。<br/>
-     * @param {object} options 获取麦位的参数
-     * @param {number} options.seatIndex 麦位 index, 无麦位序号时设置为 -1
-     * @param {number} options.timeout 超时时间。若 timeout 设置为 0，则无超时时间
-     * @param {Function} options.requestCallback 请求回调，用来通知发起方请求被接受/拒绝/取消/超时/错误的回调
-     * @returns {Promise<number>} <br/>
-     * 当 roomIno.enableSeatControl 为 true，普通用户调用该接口时返回 request 结构体，普通用户可使用 request.requestId 调用 cancelRequest 接口取消上麦请求。
+     * 设置本地音频的参数<br/>
+     * @param {object} options 设置本地音频的参数
+     * @param {TUIAudioQuality} options.quality
+     *
+     * - TUIAudioQuality.kAudioProfileSpeech：语言模式；采样率：16k<br/>
+     * - TUIAudioQuality.kAudioProfileDefault：标准模式（或者默认模式）；采样率：48k<br/>
+     * - TUIAudioQuality.kAudioProfileMusic：音乐模式；采样率：48k
+     *
+     * @returns {Promise<void>}
      *
      * @example
      * const roomEngine = new TUIRoomEngine();
+     * await roomEngine.updateAudioQuality({
+     *  quality: TUIAudioQuality.kAudioProfileSpeech,
+     * });
+     */
+    updateAudioQuality(options: {
+        quality: TUIAudioQuality;
+    }): Promise<void>;
+    /**
+     * 开始向远端推本地视频流
+     * @returns {Promise<void>}
      *
-     * // 情景一：主持人/管理员上麦
-     * // 情景二：当 roomInfo.enableSeatControl 为 false 时，普通用户上麦
-     * await roomEngine.takeSeat({
-     *  seatIndex: -1,
-     *  timeout: 0,
+     * @example
+     * const roomEngine = new TUIRoomEngine();
+     * await roomEngine.startPushLocalVideo();
+     */
+    startPushLocalVideo(): Promise<void>;
+    /**
+     * 停止向远端推本地视频流
+     * @returns {Promise<void>}
+     *
+     * @example
+     * const roomEngine = new TUIRoomEngine();
+     * await roomEngine.startPushLocalVideo();
+     */
+    stopPushLocalVideo(): Promise<void>;
+    /**
+     * 开始向远端推本地音频流
+     * @returns {Promise<void>}
+     *
+     * @example
+     * const roomEngine = new TUIRoomEngine();
+     * await roomEngine.startPushLocalAudio();
+     */
+    startPushLocalAudio(): Promise<void>;
+    /**
+     * 停止向远端推本地音频流
+     * @returns {Promise<void>}
+     *
+     * @example
+     * const roomEngine = new TUIRoomEngine();
+     * await roomEngine.stopPushLocalAudio();
+     */
+    stopPushLocalAudio(): Promise<void>;
+    /**
+     * 设置远端流渲染的区域
+     *
+     * @param {object} options 设设置远端流渲染区域的参数
+     * @param {string} options.userId 用户 Id
+     * @param {TUIVideoStreamType} options.streamType 用户流类型
+     * @param {string} options.view 播放远端用户流的 div 元素的 id
+     * @returns {Promise<void>}
+     *
+     * @example
+     * const roomEngine = new TUIRoomEngine();
+     *
+     * // 设置远端用户视频流在 id 为 'remote_preview_camera' 的区域播放
+     * roomEngine.setRemoteVideoView()({
+     *  userId: 'user_1234',
+     *  streamType: TUIVideoStreamType.kCameraStream,
+     *  view: 'remote_preview_camera',
      * });
      *
-     * // 情景三：当 roomInfo.enableSeatControl 为 true 时，普通用户上麦
-     * const request = await roomEngine.instance?.takeSeat({
-     *  seatIndex: -1,
-     *  timeout: 0,
-     *  requestCallback: ({ requestCallbackType, requestId, userId, code, message }) => {
-     *    switch (requestCallbackType) {
-     *      case TUIRequestCallbackType.kRequestAccepted:
-     *        // 请求被接受
-     *        break;
-     *      case TUIRequestCallbackType.kRequestRejected:
-     *        // 请求被拒绝
-     *        break;
-     *      case TUIRequestCallbackType.kRequestCancelled:
-     *        // 请求已取消
-     *        break;
-     *      case TUIRequestCallbackType.kRequestTimeout:
-     *        // 请求超时
-     *        break;
-     *      case TUIRequestCallbackType.kRequestError:
-     *        // 请求错误
-     *        break;
-     *      default:
-     *        break;
-     *    }
-     *  },
+     * // 设置远端用户屏幕分享流在 id 为 'remote_preview_screen' 的区域播放
+     * roomEngine.setRemoteVideoView()({
+     *  userId: 'user_1234',
+     *  streamType: TUIVideoStreamType.kScreenStream,
+     *  view: 'remote_preview_screen',
      * });
      */
-    takeSeat(options: {
-        seatIndex: number;
-        timeout: number;
-        requestCallback?: (callbackInfo: TUIRequestCallback) => void;
-    }): Promise<TUIRequest>;
+    setRemoteVideoView(options: {
+        userId: string;
+        streamType: TUIVideoStreamType;
+        view: string;
+    }): Promise<void>;
     /**
-     * 离开麦位
+     * 开始播放远端用户视频流
+     *
+     * @param {object} options 开始播放远端用户视频流的参数
+     * @param {string} options.userId 用户 Id
+     * @param {TUIVideoStreamType} options.streamType 用户流类型
      * @returns {Promise<void>}
      *
      * @example
      * const roomEngine = new TUIRoomEngine();
-     * await roomEngine.leaveSeat();
+     * await roomEngine.startPlayRemoteVideo({
+     *  userId: 'user_1234',
+     *  streamType: TUIVideoStreamType.kCameraStream,
+     * });
      */
-    leaveSeat(): Promise<void>;
+    startPlayRemoteVideo(options: {
+        userId: string;
+        streamType: TUIVideoStreamType;
+    }): Promise<void>;
     /**
-     * 获取麦位列表
-     * @returns {Promise<TUISeatInfo[]>}
+     * 停止播放远端用户视频流
+     *
+     * @param {object} options 停止播放远端用户视频流的参数
+     * @param {string} options.userId 用户 Id
+     * @param {TUIVideoStreamType} options.streamType 用户流类型<br/>
+     *
+     * - TUIVideoStreamType.kCameraStream 视频流<br/>
+     * - TUIVideoStreamType.kScreenStream 屏幕分享流<br/>
+     * - TUIVideoStreamType.kCameraStreamLow 低清视频流
+     *
+     * @returns {Promise<void>}
      *
      * @example
      * const roomEngine = new TUIRoomEngine();
-     * const seatList = await roomEngine.getSeatList();
-     * ;
+     * await roomEngine.stopPlayRemoteVideo({
+     *  userId: 'user_1234',
+     *  streamType: TUIVideoStreamType.kCameraStream,
+     * });
      */
-    getSeatList(): Promise<TUISeatInfo[]>;
+    stopPlayRemoteVideo(options: {
+        userId: string;
+        streamType: TUIVideoStreamType;
+    }): Promise<void>;
     /**
-     * 锁定某个麦位状态
-     *
-     * @param {object} options 锁定某个麦位需要的参数
-     * @param {number} options.seatIndex 麦位索引
-     * @param {TUISeatLockParams} options.lockParams 设备
+     * 停止远端用户的音频流
+     * @param {object} options 停止远端用户音频流的参数
+     * @param {string} options.userId 停止远端用户的userId
+     * @param {boolean} options.isMute 是否停止远端用户的音频
      * @returns {Promise<void>}
      *
      * @example
      * const roomEngine = new TUIRoomEngine();
-     * await roomEngine.lockSeatByAdmin({
-     *  seatIndex: -1,
-     *  lockParams: TUISeatLockParams.lockVideo
+     * await roomEngine.muteRemoteAudioStream({
+     *  userId: 'user_1234',
+     *  isMute: true,
      * });
      */
-    lockSeatByAdmin(options: {
-        seatIndex: number;
-        lockParams: TUISeatLockParams;
-    }): Promise<any>;
+    muteRemoteAudioStream(options: {
+        userId: string;
+        isMute: boolean;
+    }): Promise<void>;
     /**
      * 请求远端用户打开媒体设备
      * @param {object} options 请求远端用户打开摄像头的参数
@@ -472,69 +606,6 @@ declare class TUIRoomEngine {
         userId: string;
         device: TUIMediaDevice;
     }): Promise<void>;
-    /**
-     * 邀请其他人上麦
-     * @param {object} options 邀请其他人上麦的参数
-     * @param {number} options.seatIndex  麦位 index, roomType 为 TUIRoomType.kConference 时无需关心，填 -1 即可
-     * @param {string} options.userId  用户 Id
-     * @param {number} options.timeout  超时时间，设置为 0 时，无超时时间
-     * @param {Function} options.requestCallback 请求回调，用来通知发起方请求被接受/拒绝/取消/超时/错误的回调
-     * @returns {Promise<number>} <br/>
-     * 该接口返回 requestId，用户可使用该 requestId 调用 cancelRequest 接口取消请求
-     *
-     * @example
-     * const roomEngine = new TUIRoomEngine();
-     * const requestId = await roomEngine.takeUserOnSeatByAdmin({
-     *   seatIndex: 0,
-     *   userId: 'user_1234',
-     *   timeout: 0,
-     *   requestCallback: ({ requestCallbackType, requestId, userId, code, message }) => {
-     *    switch (requestCallbackType) {
-     *      case TUIRequestCallbackType.kRequestAccepted:
-     *        // 请求被接受
-     *        break;
-     *      case TUIRequestCallbackType.kRequestRejected:
-     *        // 请求被拒绝
-     *        break;
-     *      case TUIRequestCallbackType.kRequestCancelled:
-     *        // 请求已取消
-     *        break;
-     *      case TUIRequestCallbackType.kRequestTimeout:
-     *        // 请求超时
-     *        break;
-     *      case TUIRequestCallbackType.kRequestError:
-     *        // 请求错误
-     *        break;
-     *      default:
-     *        break;
-     *    }
-     *  },
-     * });
-     */
-    takeUserOnSeatByAdmin(options: {
-        seatIndex: number;
-        userId: string;
-        timeout: number;
-        requestCallback?: (callbackInfo: TUIRequestCallback) => void;
-    }): Promise<TUIRequest>;
-    /**
-     * 要求其他人下麦
-     * @param {object} options 要求其他人下麦的参数
-     * @param {number} options.seatIndex 麦位 index
-     * @param {string} options.userId 用户 Id
-     * @returns {Promise<void>}
-     *
-     * @example
-     * const roomEngine = new TUIRoomEngine();
-     * await roomEngine.kickUserOffSeatByAdmin({
-     *   seatIndex: 0,
-     *   userId: 'user_1234',
-     * });
-     */
-    kickUserOffSeatByAdmin(options: {
-        seatIndex: number;
-        userId: string;
-    }): Promise<void>;
     /**
      * 取消已经发出的请求
      * @param {object} options 取消已经发出请求的参数
@@ -569,243 +640,64 @@ declare class TUIRoomEngine {
      * // 拒绝远端的请求
      * await roomEngine.responseRemoteRequest({
      *  requestId: '',    // 请使用实际 requestId
-     *  agree: false,
-     * });
-     */
-    responseRemoteRequest(options: {
-        requestId: string;
-        agree: boolean;
-    }): Promise<any>;
-    /**
-     * 设置本地流的渲染位置
-     * @param {object} options 设置本地流的渲染位置的参数
-     * @param {TUIVideoStreamType} options.streamType 本地流类型
-     * @param {string} options.view streamType 对应的流渲染的 div 元素的 id
-     * @returns {Promise<void>}
-     *
-     * @example
-     * const roomEngine = new TUIRoomEngine();
-     *
-     * // 设置本地摄像头流的播放区域为 id 是 'preview-camera' 的 div 元素
-     * roomEngine.setLocalVideoView({
-     *  streamType: TUIVideoStreamType.kCameraStream,
-     *  view: 'preview-camera',
-     * });
-     *
-     * // 设置本地屏幕分享流的播放区域为 id 是 'preview-screen' 的 div 元素
-     * roomEngine.setLocalVideoView({
-     *  streamType: TUIVideoStreamType.kScreenStream,
-     *  view: 'preview-screen',
-     * });
-     */
-    setLocalVideoView(options: {
-        streamType: TUIVideoStreamType;
-        view: string;
-    }): void;
-    /**
-     * 打开本地摄像头，开始视频流采集
-     * @param {object} options 设置本地流的参数
-     * @returns {Promise<void>}
-     * @example
-     * const roomEngine = new TUIRoomEngine();
-     * await roomEngine.openLocalCamera();
-     */
-    openLocalCamera(): Promise<void>;
-    /**
-     * 关闭本地摄像头
-     * @returns {Promise<void>}
-     *
-     * @example
-     * const roomEngine = new TUIRoomEngine();
-     * await roomEngine.closeLocalCamera();
-     */
-    closeLocalCamera(): Promise<void>;
-    /**
-     * 打开麦克风
-     * @returns {Promise<void>}
-     *
-     * @example
-     * const roomEngine = new TUIRoomEngine();
-     * await roomEngine.openLocalMicrophone();
-     */
-    openLocalMicrophone(): Promise<void>;
-    /**
-     * 关闭本地麦克风, 停止采集音频流
-     * @returns {Promise<void>}
-     *
-     * @example
-     * const roomEngine = new TUIRoomEngine();
-     * await roomEngine.closeLocalMicrophone();
-     */
-    closeLocalMicrophone(): Promise<void>;
-    /**
-     * 设置本地视频流的编码参数
-     * @param {object} options
-     * @param {TUIVideoQuality} options.quality
-     *
-     * - 360p TUIVideoQuality.kVideoQuality_360p <br/>
-     * - 540p TUIVideoQuality.kVideoQuality_540p <br/>
-     * - 720p TUIVideoQuality.kVideoQuality_720p <br/>
-     * - 1080p TUIVideoQuality.kVideoQuality_1080p <br/>
-     *
-     * @returns {Promise<void>}
-     *
-     * @example
-     * const roomEngine = new TUIRoomEngine();
-     * await roomEngine.updateVideoQuality({
-     *  quality: TUIVideoQuality.kVideoQuality_360p,
-     * });
-     */
-    updateVideoQuality(options: {
-        quality: TUIVideoQuality;
-    }): Promise<void>;
-    /**
-     * 设置本地音频的参数<br/>
-     * @param {object} options 设置本地音频的参数
-     * @param {TUIAudioQuality} options.quality
-     *
-     * - TUIAudioQuality.kAudioProfileSpeech：语言模式；采样率：16k<br/>
-     * - TUIAudioQuality.kAudioProfileDefault：标准模式（或者默认模式）；采样率：48k<br/>
-     * - TUIAudioQuality.kAudioProfileMusic：音乐模式；采样率：48k
-     *
-     * @returns {Promise<void>}
-     *
-     * @example
-     * const roomEngine = new TUIRoomEngine();
-     * await roomEngine.updateAudioQuality({
-     *  quality: TUIAudioQuality.kAudioProfileSpeech,
-     * });
-     */
-    updateAudioQuality(options: {
-        quality: TUIAudioQuality;
-    }): Promise<void>;
-    /**
-     * 开始向远端推本地视频流
-     * @returns {Promise<void>}
-     *
-     * @example
-     * const roomEngine = new TUIRoomEngine();
-     * await roomEngine.startPushLocalVideo();
-     */
-    startPushLocalVideo(): Promise<void>;
-    /**
-     * 停止向远端推本地视频流
-     * @returns {Promise<void>}
-     *
-     * @example
-     * const roomEngine = new TUIRoomEngine();
-     * await roomEngine.startPushLocalVideo();
-     */
-    stopPushLocalVideo(): Promise<void>;
-    /**
-     * 开始向远端推本地音频流
-     * @returns {Promise<void>}
-     *
-     * @example
-     * const roomEngine = new TUIRoomEngine();
-     * await roomEngine.startPushLocalAudio();
-     */
-    startPushLocalAudio(): Promise<void>;
-    /**
-     * 停止向远端推本地音频流
-     * @returns {Promise<void>}
-     *
-     * @example
-     * const roomEngine = new TUIRoomEngine();
-     * await roomEngine.stopPushLocalAudio();
-     */
-    stopPushLocalAudio(): Promise<void>;
-    /**
-     * 设置远端流渲染的区域
-     *
-     * @param {object} options 设设置远端流渲染区域的参数
-     * @param {string} options.userId 用户 Id
-     * @param {TUIVideoStreamType} options.streamType 用户流类型
-     * @param {string} options.view 播放远端用户流的 div 元素的 id
-     * @returns {Promise<void>}
-     *
-     * @example
-     * const roomEngine = new TUIRoomEngine();
-     *
-     * // 设置远端用户视频流在 id 为 'remote_preview_camera' 的区域播放
-     * roomEngine.setRemoteVideoView()({
-     *  userId: 'user_1234',
-     *  streamType: TUIVideoStreamType.kCameraStream,
-     *  view: 'remote_preview_camera',
-     * });
-     *
-     * // 设置远端用户屏幕分享流在 id 为 'remote_preview_screen' 的区域播放
-     * roomEngine.setRemoteVideoView()({
-     *  userId: 'user_1234',
-     *  streamType: TUIVideoStreamType.kScreenStream,
-     *  view: 'remote_preview_screen',
-     * });
-     */
-    setRemoteVideoView(options: {
-        userId: string;
-        streamType: TUIVideoStreamType;
-        view: string;
-    }): Promise<void>;
+     *  agree: false,
+     * });
+     */
+    responseRemoteRequest(options: {
+        requestId: string;
+        agree: boolean;
+    }): Promise<any>;
     /**
-     * 开始播放远端用户视频流
-     *
-     * @param {object} options 开始播放远端用户视频流的参数
-     * @param {string} options.userId 用户 Id
-     * @param {TUIVideoStreamType} options.streamType 用户流类型
+     * 禁止/允许所有用户打开媒体设备（此接口对于房主和管理员无效）
+     * @param {object} options
+     * @param {TUIMediaDevice} options.device 操作的媒体设备
+     * @param {boolean} options.isDisable 是否被禁止
      * @returns {Promise<void>}
-     *
      * @example
-     * const roomEngine = new TUIRoomEngine();
-     * await roomEngine.startPlayRemoteVideo({
-     *  userId: 'user_1234',
-     *  streamType: TUIVideoStreamType.kCameraStream,
-     * });
+     * // Example 1: 禁止所有用户打开麦克风
+     * await roomEngine.disableDeviceForAllUserByAdmin({
+     *  device: TUIMediaDevice.kMicrophone,
+     *  isDisable: true,
+     * })
+     * // Example 2: 允许所有用户打开麦克风
+     * await roomEngine.disableDeviceForAllUserByAdmin({
+     *  device: TUIMediaDevice.kMicrophone,
+     *  isDisable: false,
+     * })
      */
-    startPlayRemoteVideo(options: {
-        userId: string;
-        streamType: TUIVideoStreamType;
+    disableDeviceForAllUserByAdmin(options: {
+        device: TUIMediaDevice;
+        isDisable: boolean;
     }): Promise<void>;
     /**
-     * 停止播放远端用户视频流
-     *
-     * @param {object} options 停止播放远端用户视频流的参数
-     * @param {string} options.userId 用户 Id
-     * @param {TUIVideoStreamType} options.streamType 用户流类型<br/>
-     *
-     * - TUIVideoStreamType.kCameraStream 视频流<br/>
-     * - TUIVideoStreamType.kScreenStream 屏幕分享流<br/>
-     * - TUIVideoStreamType.kCameraStreamLow 低清视频流
-     *
+     * 禁止/允许所有用户发送消息
+     * @param {object} options
+     * @param {boolean} options.isDisable 是否被禁止
      * @returns {Promise<void>}
-     *
      * @example
-     * const roomEngine = new TUIRoomEngine();
-     * await roomEngine.stopPlayRemoteVideo({
-     *  userId: 'user_1234',
-     *  streamType: TUIVideoStreamType.kCameraStream,
-     * });
+     * await roomEngine.disableSendingMessageForAllUser({
+     *  isDisable: true,
+     * })
+  
      */
-    stopPlayRemoteVideo(options: {
-        userId: string;
-        streamType: TUIVideoStreamType;
+    disableSendingMessageForAllUser(options: {
+        isDisable: boolean;
     }): Promise<void>;
     /**
-     * 停止远端用户的音频流
-     * @param {object} options 停止远端用户音频流的参数
-     * @param {string} options.userId 停止远端用户的userId
-     * @param {boolean} options.isMute 是否停止远端用户的音频
+     * 禁止/允许某个用户发送消息
+     * @param {object} options
+     * @param {string} options.userId 用户的 Id
+     * @param {boolean} options.isDisable 是否被禁止
      * @returns {Promise<void>}
-     *
      * @example
-     * const roomEngine = new TUIRoomEngine();
-     * await roomEngine.muteRemoteAudioStream({
+     * await roomEngine.disableSendingMessageByAdmin({
      *  userId: 'user_1234',
-     *  isMute: true,
-     * });
+     *  isDisable: true,
+     * })
      */
-    muteRemoteAudioStream(options: {
+    disableSendingMessageByAdmin(options: {
         userId: string;
-        isMute: boolean;
+        isDisable: boolean;
     }): Promise<void>;
     /**
      * 改变用户的角色，仅主持人可调用该接口
@@ -848,57 +740,179 @@ declare class TUIRoomEngine {
         userId: string;
     }): Promise<void>;
     /**
-     * 所有用户的设备是否允许被使用
-     * @param {object} options 所有用户的设备是否被允许使用所用到的参数
-     * @param {TUIMediaDevice} options.device 被禁用的设备
-     * @param {boolean} options.isDisable 是否被禁用
+     * 设置房间麦位最大值
+     * @param {object} options
+     * @param {number} options.maxSeatCount 设置房间麦位最大值<br/>
+     * roomType 为 TUIRoomType.kConference (教育及会议场景) 时，maxSeatCount 值不做限制；
+     * roomType 为 TUIRoomType.kLivingRoom (直播场景) 时，maxSeatCount 最大限制为 16；
      * @returns {Promise<void>}
-     * @example
-     * // Example 1: 禁止所有用户打开麦克风
-     * await roomEngine.disableDeviceForAllUserByAdmin({
-     *  device: TUIMediaDevice.kMicrophone,
-     *  isDisable: true,
-     * })
-     * // Example 2: 允许所有用户打开麦克风
-     * await roomEngine.disableDeviceForAllUserByAdmin({
-     *  device: TUIMediaDevice.kMicrophone,
-     *  isDisable: false,
-     * })
+     * const roomEngine = new TUIRoomEngine();
+     * await roomEngine.createRoom({ roomId: '12345' });
+     * await roomEngine.setMaxSeatCount({ maxSeatCount: 16 })
      */
-    disableDeviceForAllUserByAdmin(options: {
-        device: TUIMediaDevice;
-        isDisable: boolean;
+    setMaxSeatCount(options: {
+        maxSeatCount: number;
     }): Promise<void>;
     /**
-     * 所有用户的是否允许发消息
-     * @param {object} options 所有用户是否被允许发消息所用到的参数
-     * @param {boolean} options.isDisable 是否被允许使用
+     * 获取麦位列表
+     * @returns {Promise<TUISeatInfo[]>}
+     *
+     * @example
+     * const roomEngine = new TUIRoomEngine();
+     * const seatList = await roomEngine.getSeatList();
+     * ;
+     */
+    getSeatList(): Promise<TUISeatInfo[]>;
+    /**
+     * 麦下用户可调用 takeSeat 成为麦上用户，仅麦上用户可发布本地音视频流。<br/>
+     * 主持人&管理员调用 takeSeat 成功后即为麦上用户。<br/>
+     * roomInfo.SpeechMode 为 TUISpeechMode.kFreeToSpeak 模式时，普通用户调用 takeSeat 方法成功后即为麦上用户。<br/>
+     * roomInfo.SpeechMode 为 TUISpeechMode.kSpeakAfterTakingSeat 模式时，普通用户调用 takeSeat 方法需要等待主持人/管理员的同意后成为麦上用户。<br/>
+     * 麦上用户的变更通过 TUIRoomEvents.onSeatListChanged 通知所有用户。<br/>
+     * @param {object} options 获取麦位的参数
+     * @param {number} options.seatIndex 麦位 index, 无麦位序号时设置为 -1
+     * @param {number} options.timeout 超时时间。若 timeout 设置为 0，则无超时时间
+     * @param {Function} options.requestCallback 请求回调，用来通知发起方请求被接受/拒绝/取消/超时/错误的回调
+     * @returns {Promise<number>} <br/>
+     * 该接口返回 request 结构体，当 request.requestId 不为 '' 时，用户可调用 cancelRequest 接口取消上麦请求。
+     *
+     * @example
+     * const roomEngine = new TUIRoomEngine();
+     *
+     * // 情景一：主持人/管理员上麦
+     * // 情景二：roomInfo.SpeechMode 为 TUISpeechMode.kFreeToSpeak 模式时，普通用户上麦
+     * await roomEngine.takeSeat({
+     *  seatIndex: -1,
+     *  timeout: 0,
+     * });
+     *
+     * // 情景三：roomInfo.SpeechMode 为 TUISpeechMode.kSpeakAfterTakingSeat 模式时，普通用户上麦
+     * const request = await roomEngine.instance?.takeSeat({
+     *  seatIndex: -1,
+     *  timeout: 0,
+     *  requestCallback: ({ requestCallbackType, requestId, userId, code, message }) => {
+     *    switch (requestCallbackType) {
+     *      case TUIRequestCallbackType.kRequestAccepted:
+     *        // 请求被接受
+     *        break;
+     *      case TUIRequestCallbackType.kRequestRejected:
+     *        // 请求被拒绝
+     *        break;
+     *      case TUIRequestCallbackType.kRequestCancelled:
+     *        // 请求已取消
+     *        break;
+     *      case TUIRequestCallbackType.kRequestTimeout:
+     *        // 请求超时
+     *        break;
+     *      case TUIRequestCallbackType.kRequestError:
+     *        // 请求错误
+     *        break;
+     *      default:
+     *        break;
+     *    }
+     *  },
+     * });
+     */
+    takeSeat(options: {
+        seatIndex: number;
+        timeout: number;
+        requestCallback?: (callbackInfo: TUIRequestCallback) => void;
+    }): Promise<TUIRequest>;
+    /**
+     * 离开麦位
      * @returns {Promise<void>}
+     *
      * @example
-     * await roomEngine.disableSendingMessageForAllUser({
-     *  isDisable: true,
-     * })
-  
+     * const roomEngine = new TUIRoomEngine();
+     * await roomEngine.leaveSeat();
      */
-    disableSendingMessageForAllUser(options: {
-        isDisable: boolean;
-    }): Promise<void>;
+    leaveSeat(): Promise<void>;
+    /**
+     * 邀请其他人上麦（仅房间主持人和管理员可调用此方法）
+     * @param {object} options 邀请其他人上麦的参数
+     * @param {number} options.seatIndex  麦位 index, roomType 为 TUIRoomType.kConference 时无需关心，填 -1 即可
+     * @param {string} options.userId  用户 Id
+     * @param {number} options.timeout  超时时间，设置为 0 时，无超时时间
+     * @param {Function} options.requestCallback 请求回调，用来通知发起方请求被接受/拒绝/取消/超时/错误的回调
+     * @returns {Promise<number>} <br/>
+     * 该接口返回 requestId，用户可使用该 requestId 调用 cancelRequest 接口取消请求
+     *
+     * @example
+     * const roomEngine = new TUIRoomEngine();
+     * const requestId = await roomEngine.takeUserOnSeatByAdmin({
+     *   seatIndex: 0,
+     *   userId: 'user_1234',
+     *   timeout: 0,
+     *   requestCallback: ({ requestCallbackType, requestId, userId, code, message }) => {
+     *    switch (requestCallbackType) {
+     *      case TUIRequestCallbackType.kRequestAccepted:
+     *        // 请求被接受
+     *        break;
+     *      case TUIRequestCallbackType.kRequestRejected:
+     *        // 请求被拒绝
+     *        break;
+     *      case TUIRequestCallbackType.kRequestCancelled:
+     *        // 请求已取消
+     *        break;
+     *      case TUIRequestCallbackType.kRequestTimeout:
+     *        // 请求超时
+     *        break;
+     *      case TUIRequestCallbackType.kRequestError:
+     *        // 请求错误
+     *        break;
+     *      default:
+     *        break;
+     *    }
+     *  },
+     * });
+     */
+    takeUserOnSeatByAdmin(options: {
+        seatIndex: number;
+        userId: string;
+        timeout: number;
+        requestCallback?: (callbackInfo: TUIRequestCallback) => void;
+    }): Promise<TUIRequest>;
     /**
-     * 特定用户是否被允许发消息
-     * @param {object} options 特定用户的是否被允许发消息所用到的参数
-     * @param {string} options.userId 特定用户的 userId
-     * @param {boolean} options.isDisable 是否被允许使用
+     * 将其他人踢下麦（仅房间主持人和管理员可调用此方法）
+     * @param {object} options 要求其他人下麦的参数
+     * @param {number} options.seatIndex 麦位 index
+     * @param {string} options.userId 用户 Id
      * @returns {Promise<void>}
+     *
      * @example
-     * await roomEngine.disableSendingMessageByAdmin({
-     *  userId: 'user_1234',
-     *  isDisable: true,
-     * })
+     * const roomEngine = new TUIRoomEngine();
+     * await roomEngine.kickUserOffSeatByAdmin({
+     *   seatIndex: 0,
+     *   userId: 'user_1234',
+     * });
      */
-    disableSendingMessageByAdmin(options: {
+    kickUserOffSeatByAdmin(options: {
+        seatIndex: number;
         userId: string;
-        isDisable: boolean;
     }): Promise<void>;
+    /**
+     * 锁定某个麦位状态（仅房间主持人和管理员可调用此方法）
+     *
+     * @param {object} options 锁定某个麦位需要的参数
+     * @param {number} options.seatIndex 麦位索引
+     * @param {TUISeatLockParams} options.lockParams 锁麦参数
+     * @returns {Promise<void>}
+     *
+     * @example
+     * const roomEngine = new TUIRoomEngine();
+     * await roomEngine.lockSeatByAdmin({
+     *  seatIndex: -1,
+     *  lockParams: {
+     *    lockSeat: true,
+     *    lockVideo: true,
+     *    lockAudio: true,
+     *  }
+     * });
+     */
+    lockSeatByAdmin(options: {
+        seatIndex: number;
+        lockParams: TUISeatLockParams;
+    }): Promise<any>;
     /**
      * 发送文本消息
      * @param {object} options
@@ -1139,6 +1153,18 @@ declare class TUIRoomEngine {
      * await roomEngine.stopCameraDeviceTest();
      */
     stopCameraDeviceTest(): Promise<void>;
+    /**
+     * 开始进行麦克风测试
+     * @param options
+     * @param {number} options.interval 麦克风音量的回调时间
+     */
+    startMicDeviceTest(options: {
+        interval: number;
+    }): Promise<void>;
+    /**
+     * 停止进行麦克风测试
+     */
+    stopMicDeviceTest(): Promise<void>;
     /**
      * 获取 trtcCloud 实例
      * @returns {TRTCCloud} trtcCloud