@tencentcloud/tuiroom-engine-electron 1.0.2 → 1.2.0

package/index.d.ts

@@ -1,6 +1,6 @@
 import TIM from "tim-js-sdk";
 import TRTCCloud, { TRTCDeviceInfo, TRTCScreenCaptureSourceInfo } from 'trtc-electron-sdk';
-import { TUIRoomInfo, TUIVideoStreamType, TUIVideoProfile, TUIAudioProfile, TUIRole, TUIRoomEvents, TUIRoomType, TUISeatInfo, TUIRequestCallback } from './types';
+import { TUIRoomInfo, TUIVideoStreamType, TUIVideoQuality, TUIAudioQuality, TUIRole, TUIRoomEvents, TUIRoomType, TUISeatInfo, TUIRequestCallback, TUISpeechMode, TUIMediaDevice, TUISeatLockParams, TUILoginUserInfo, TUIUserInfo, TUIRequest } from './types';
 export * from './types';
 export { TRTCDeviceType, TRTCDeviceState, TRTCDeviceInfo, TRTCVideoMirrorType, TRTCVideoRotation, TRTCVideoFillMode, TRTCVideoStreamType, TRTCScreenCaptureSourceInfo, TRTCScreenCaptureSourceType, Rect, TRTCVideoEncParam, TRTCVideoResolution, TRTCVideoResolutionMode, TRTCScreenCaptureProperty } from 'trtc-electron-sdk';
 /**
@@ -17,6 +17,8 @@ declare class TUIRoomEngine {
     private static Module;
     private logger;
     private roomId;
+    private localVideoQuality;
+    private LocalAudioQuality;
     static setModule(Module: any): void;
     static once(event: string, func: Function): void;
     constructor();
@@ -77,6 +79,14 @@ declare class TUIRoomEngine {
         userName: string;
         avatarUrl: string;
     }): Promise<void>;
+    /** 获取当前用户信息接口
+     * @returns {Promise<TUILoginUserInfo>} loginUserInfo
+     * 该接口返回用户信息
+     *
+     * @example
+     * await TUIRoomEngine.getSelfInfo();
+     */
+    static getSelfInfo(): Promise<TUILoginUserInfo>;
     /**
      * 登出 TUIRoomEngine, 登出 TUIRoomEngine 时将销毁所有 roomEngine 实例
      *
@@ -85,45 +95,58 @@ declare class TUIRoomEngine {
      */
     static logout(): Promise<void>;
     /**
-     * 主持人创建房间，调用 createRoom 的用户为房间的所有者。创建房间时可设置房间 Id, 房间名称，以及房间是否允许加入用户开启音视频，发送消息等功能。
+     * 主持人创建房间，调用 createRoom 的用户为房间的所有者。创建房间时可设置房间 Id，房间名称，房间类型，发言模式以及房间是否允许加入用户开启音视频，发送消息等功能。
      *
      * @param {object} options
      * @param {string} options.roomId 房间 Id，必填, roomId 限制长度为64字节，且仅支持以下范围的字符集：<br>
      * - 大小写英文字母（a-zA-Z）
      * - 数字（0-9）
      * - 空格 ! # $ % & ( ) + - : ; < = . > ? @ [ ] ^ _ { } | ~ ,
-     * @param {string} [options.name] 房间名称，必填，且不能为空字符串
-     * @param {TUIRoomType} [options.roomType] 房间类型, 必填 <br>
-     * 教育及会议场景设置房间类型为 TUIRoomType.kGroup，直播场景设置房间类型为 TUIRoomType.kOpen;
-     * @param {number=} options.maxSeatCount 最大麦位数量 <br>
-     * roomType 为 TUIRoomType.kGroup (教育及会议场景) 时，maxSeatCount 值不做限制；
-     * roomType 为 TUIRoomType.kOpen (直播场景) 时，maxSeatCount 最大限制为 16；
-     * @param {boolean=} [options.enableAudio=true] 是否允许加入用户打开音频
-     * @param {boolean=} [options.enableVideo=true] 是否允许加入用户打开视频
-     * @param {boolean=} [options.enableMessage=true] 是否允许加入用户发送消息
-     * @param {boolean=} [options.enableSeatControl=false] 是否开启麦位控制
+     * @param {string=} [options.roomName=roomId] 房间名称，默认值为 roomId，传入的值不能为空字符串
+     * @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.isMicrophoneDisableForAllUser=false] 是否开启全员禁麦，默认不开启全员禁麦（创建房间可选参数）
+     * @param {boolean=} [options.isCameraDisableForAllUser=false] 是否开启全员禁画，默认不开启全员禁画（创建房间可选参数）
+     * @param {boolean=} [options.isMessageDisableForAllUser=false] 是否允许成员发送消息，默认不禁止（创建房间可选参数）
+     * @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
      * const roomEngine = new TUIRoomEngine();
      * await roomEngine.createRoom({
      *  roomId: '12345',   // 填入您的房间 Id, 注意房间 Id 要求为字符串类型
-     *  name: 'Test Room',     // 填入您的房间名称, 房间名称默认为 roomId，最长 30 字节
-     *  roomType: TUIRoomType.kGroup, // 设置房间类型为 TUIRoomType.kGroup 类型
-     *  enableAudio: true,  // 设置是否允许加入用户打开音频
-     *  enableVideo: true,  // 设置是否允许加入用户打开视频
-     *  enableMessage: true,  // 设置是否允许加入用户发送消息
+     *  roomName: 'Test Room',     // 填入您的房间名称, 房间名称默认为 roomId，最长 30 字节
+     *  roomType: TUIRoomType.kConference, // 设置房间类型为 TUIRoomType.kConference 类型
+     *  speechMode: TUISpeechMode.kFreeToSpeak, // 设置会议模式为自由发言模式
      * });
      */
     createRoom(options: {
         roomId: string;
-        name: string;
-        roomType: TUIRoomType;
+        roomName?: string;
+        roomType?: TUIRoomType;
+        speechMode?: TUISpeechMode;
+        isMicrophoneDisableForAllUser?: boolean;
+        isCameraDisableForAllUser?: boolean;
+        isMessageDisableForAllUser?: boolean;
         maxSeatCount?: number;
-        enableAudio?: boolean;
-        enableVideo?: boolean;
-        enableMessage?: boolean;
-        enableSeatControl?: boolean;
+        enableCDNStreaming?: boolean;
+        cdnStreamDomain?: string;
     }): Promise<void>;
     /**
      * 进入房间接口
@@ -134,7 +157,7 @@ declare class TUIRoomEngine {
      *
      * @example
      * const roomEngine = new TUIRoomEngine();
-     * const roomInfo = await roomEngine.enterRoom({
+     * const roomDetailInfo = await roomEngine.enterRoom({
      *  roomId: '12345',
      * });
      */
@@ -142,7 +165,7 @@ declare class TUIRoomEngine {
         roomId: string;
     }): Promise<TUIRoomInfo>;
     /**
-     * 销毁房间接口，销毁房间必须由房间所有者发起，销毁房间之后房间不可进入
+     * 解散房间接口，解散房间必须由房间所有者发起，解散房间之后房间不可进入
      * @returns {Promise<void>}
      *
      * @example
@@ -162,42 +185,40 @@ declare class TUIRoomEngine {
     /**
      * 获取房间信息
      * @returns {Promise<TUIRoomInfo>} roomInfo
-     * 该接口返回房间信息
+     * 获取房间信息
      *
      * @example
      * const roomEngine = new TUIRoomEngine();
-     * const roomInfo = roomEngine.getRoomInfo();
+     * const roomInfo = await roomEngine.fetchRoomInfo();
      */
-    getRoomInfo(): Promise<TUIRoomInfo>;
+    fetchRoomInfo(): Promise<TUIRoomInfo>;
     /**
-     * 更新房间信息, 只有房间所有者有权限更新房间信息
+     * 更新房间的名字（仅群主或者管理员可以调用）
+     * @param {object} options 获取当前房间的名字
+     * @param {string} options.roomName 更新当前房间的名字
+     * @returns {Promise<void>}
+     * @example
+     * const roomEngine = new TUIRoomEngine();
+     * await roomEngine.createRoom({ roomId: '12345' });
+     * await roomEngine.updateRoomNameByAdmin({ roomName: '新的名字' });
      */
+    updateRoomNameByAdmin(options: {
+        roomName: string;
+    }): Promise<void>;
     /**
-     * 主持人更新房间信息，注意仅房间所有者有权限更新房间信息
-     * @param {object} roomInfo 主持人更新房间的信息
-     * @param {string} roomInfo.name 更新房间的名字
-     * @param {true} roomInfo.enableVideo 更新房间是否允许其他用户开启摄像头
-     * @param {true} roomInfo.enableAudio 更新房间是否允许其他用户开启麦克风
-     * @param {true} roomInfo.enableMessage 更新房间是否允许其他用户发送消息
-     * @param {true} roomInfo.enableSeatControl 更新房间是否进行麦位控制<br/>
-     * 注意：enableSeatControl 设置为 true 时为举手发言模式，enableSeatControl 设置为 false 时为自由发言模式。
-     * @param {true} roomInfo.maxSeatCount 更新房间麦位最大值<br/>
-     * - roomType 为 TUIRoomType.kGroup (教育及会议场景) 时，maxSeatCount 值不做限制；
-     * - roomType 为 TUIRoomType.kOpen (直播场景) 时，maxSeatCount 最大限制为 16；
+     * 更新房间的发言模式（仅群主或者管理员可以调用）
+     * @param {object} options
+     * @param {TUISpeechMode} options.speechMode 发言类型
      * @returns {Promise<void>}
      *
      * @example
      * const roomEngine = new TUIRoomEngine();
-     * await roomEngine.createRoom({ roomId: '12345' });
-     * await roomEngine.updateRoomInfo({ name: '新的名字', enableVideo: true });
-     */
-    updateRoomInfo(options: {
-        name?: string;
-        enableVideo?: boolean;
-        enableAudio?: boolean;
-        enableMessage?: boolean;
-        enableSeatControl?: boolean;
-        maxSeatCount?: number;
+     * await roomEngine.updateRoomSpeechModeByAdmin({
+     *   speechMode: TUISpeechMode.kSpeakAfterTakingSeat,  // 更新为上麦后发言模式
+     * });
+     */
+    updateRoomSpeechModeByAdmin(options: {
+        speechMode: TUISpeechMode;
     }): Promise<void>;
     /**
      * 获取当前房间用户列表，注意该接口一次拉取的用户列表量最大为 100 个
@@ -210,19 +231,18 @@ declare class TUIRoomEngine {
      *
      * @example
      * const roomEngine = new TUIRoomEngine();
-     * let result;
      * const userList = [];
+     * let result;
      * do {
-     *  result = await roomEngine.getUserList();
-     *  userList
+     *  result = await globalProperties.roomEngine.getUserList();
+     *  userList.push(...result.userInfoList);
      * } while (result.nextSequence !== 0)
      */
     getUserList(options?: {
         nextSequence?: Number;
-    }): Promise<object>;
+    }): Promise<Array<TUIUserInfo>>;
     /**
      * 获取用户的详细信息
-     *
      * @param {object} options 获取用户信息的参数
      * @param {string} options.userId 根据 userId 获取该用户的详细信息
      * @returns Promise<TUIUserInfo> userInfo
@@ -237,6 +257,20 @@ declare class TUIRoomEngine {
     getUserInfo(options: {
         userId: string;
     }): Promise<any>;
+    /**
+     * 设置房间麦位最大值
+     * @param {object} options
+     * @param {number} options.maxSeatCount 设置房间麦位最大值<br/>
+     * roomType 为 TUIRoomType.kConference (教育及会议场景) 时，maxSeatCount 值不做限制；
+     * roomType 为 TUIRoomType.kLivingRoom (直播场景) 时，maxSeatCount 最大限制为 16；
+     * @returns {Promise<void>}
+     * const roomEngine = new TUIRoomEngine();
+     * await roomEngine.createRoom({ roomId: '12345' });
+     * await roomEngine.setMaxSeatCount({ maxSeatCount: 16 })
+     */
+    setMaxSeatCount(options: {
+        maxSeatCount: number;
+    }): Promise<void>;
     private JSCallNativeRequestFunctionPromise;
     /**
      * 麦下用户可调用 takeSeat 成为麦上用户，仅麦上用户可发布本地音视频流。<br/>
@@ -249,7 +283,7 @@ declare class TUIRoomEngine {
      * @param {number} options.timeout 超时时间。若 timeout 设置为 0，则无超时时间
      * @param {Function} options.requestCallback 请求回调，用来通知发起方请求被接受/拒绝/取消/超时/错误的回调
      * @returns {Promise<number>} <br/>
-     * 当 roomIno.enableSeatControl 为 true，普通用户调用该接口时返回 requestId，普通用户可使用该 requestId 调用 cancelRequest 接口取消上麦请求。
+     * 当 roomIno.enableSeatControl 为 true，普通用户调用该接口时返回 request 结构体，普通用户可使用 request.requestId 调用 cancelRequest 接口取消上麦请求。
      *
      * @example
      * const roomEngine = new TUIRoomEngine();
@@ -262,7 +296,7 @@ declare class TUIRoomEngine {
      * });
      *
      * // 情景三：当 roomInfo.enableSeatControl 为 true 时，普通用户上麦
-     * const requestId = await roomEngine.instance?.takeSeat({
+     * const request = await roomEngine.instance?.takeSeat({
      *  seatIndex: -1,
      *  timeout: 0,
      *  requestCallback: ({ requestCallbackType, requestId, userId, code, message }) => {
@@ -292,7 +326,7 @@ declare class TUIRoomEngine {
         seatIndex: number;
         timeout: number;
         requestCallback?: (callbackInfo: TUIRequestCallback) => void;
-    }): Promise<string>;
+    }): Promise<TUIRequest>;
     /**
      * 离开麦位
      * @returns {Promise<void>}
@@ -313,9 +347,29 @@ declare class TUIRoomEngine {
      */
     getSeatList(): Promise<TUISeatInfo[]>;
     /**
-     * 请求远端用户打开摄像头
+     * 锁定某个麦位状态
+     *
+     * @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: TUISeatLockParams.lockVideo
+     * });
+     */
+    lockSeatByAdmin(options: {
+        seatIndex: number;
+        lockParams: TUISeatLockParams;
+    }): Promise<any>;
+    /**
+     * 请求远端用户打开媒体设备
      * @param {object} options 请求远端用户打开摄像头的参数
      * @param {string} options.userId 用户 Id
+     * @param {TUIMediaDevice} options.device 请求的设备
      * @param {number} options.timeout 超时时间。若 timeout 设置为 0 ，则无超时时间
      * @param {Function} 请求回调，用来通知发起方请求被接受/拒绝/取消/超时/错误的回调
      * @return {Promise<number>} <br/>
@@ -323,8 +377,9 @@ declare class TUIRoomEngine {
      *
      * @example
      * const roomEngine = new TUIRoomEngine();
-     * const requestId = roomEngine.requestToOpenRemoteCamera({
+     * const requestId = roomEngine.openRemoteDeviceByAdmin({
      *   userId: 'user_1234',
+     *   device: TUIMediaDevice.kMicrophone  //请求的设备为麦克风
      *   timeout: 0,
      *   requestCallback: ({ requestCallbackType, requestId, userId, code, message }) => {
      *    switch (requestCallbackType) {
@@ -349,41 +404,26 @@ declare class TUIRoomEngine {
      *  },
      * });
      */
-    requestToOpenRemoteCamera(options: {
+    openRemoteDeviceByAdmin(options: {
         userId: string;
+        device: TUIMediaDevice;
         timeout: number;
         requestCallback?: (callbackInfo: TUIRequestCallback) => void;
-    }): Promise<string>;
+    }): Promise<TUIRequest>;
     /**
-     * 关闭远端用户摄像头
+     * 参会者向主持人申请打开设备
      *
-     * @param {object} options 关闭远端用户摄像头的参数
-     * @param {string} options.userId 用户 Id
-     * @returns {Promise<void>}
-     *
-     * @example
-     * const roomEngine = new TUIRoomEngine();
-     * await roomEngine.closeRemoteCamera({
-     *   userId: 'user_1234',
-     * });
-     */
-    closeRemoteCamera(options: {
-        userId: string;
-    }): Promise<void>;
-    /**
-     * 请求远端用户打开麦克风
-     *
-     * @param {object} options 请求远端用户打开麦克风的参数
-     * @param {string} options.userId 用户 Id
-     * @param {number} options.timeout 超时时间，设置为 0 时，无超时时间
-     * @param {Function} options.requestCallback 请求回调，用来通知发起方请求被接受/拒绝/取消/超时/错误的回调
-     * @returns {Promise<number>} <br/>
+     * @param {object} options 请求远端用户打开摄像头的参数
+     * @param {TUIMediaDevice} options.device 请求的设备
+     * @param {number} options.timeout 超时时间。若 timeout 设置为 0 ，则无超时时间
+     * @param {Function} 请求回调，用来通知发起方请求被接受/拒绝/取消/超时/错误的回调
+     * @return {Promise<number>} <br/>
      * 该接口返回 requestId，用户可使用该 requestId 调用 cancelRequest 接口取消请求
      *
      * @example
      * const roomEngine = new TUIRoomEngine();
-     * const requestId = await roomEngine.requestToOpenRemoteMicrophone({
-     *   userId: 'user_1234',
+     * const requestId = roomEngine.applyToAdminToOpenLocalDevice({
+     *   device: TUIMediaDevice.kMicrophone, //请求打开麦克风
      *   timeout: 0,
      *   requestCallback: ({ requestCallbackType, requestId, userId, code, message }) => {
      *    switch (requestCallbackType) {
@@ -408,47 +448,34 @@ declare class TUIRoomEngine {
      *  },
      * });
      */
-    requestToOpenRemoteMicrophone(options: {
-        userId: string;
+    applyToAdminToOpenLocalDevice(options: {
+        device: TUIMediaDevice;
         timeout: number;
         requestCallback?: (callbackInfo: TUIRequestCallback) => void;
-    }): Promise<string>;
-    /**
-     * 关闭远端用户麦克风
-     *
-     * @param {object} options 关闭远端用户麦克风, 仅房间主持人和管理员可调用此方法
-     * @param {string} options.userId 用户 Id
-     * @returns {Promise<void>}
-     *
-     * @example
-     * const roomEngine = new TUIRoomEngine();
-     * await roomEngine.closeRemoteMicrophone({
-     *   userId: 'user_1234',
-     * });
-     */
-    closeRemoteMicrophone(options: {
-        userId: string;
-    }): Promise<void>;
+    }): Promise<TUIRequest>;
     /**
-     * 停止远端用户屏幕分享
+     * 关闭远端用户媒体设备
      *
-     * @param {object} options 停止远端用户屏幕分享, 仅房间主持人和管理员可调用此方法
+     * @param {object} options 关闭远端用户摄像头的参数
      * @param {string} options.userId 用户 Id
+     * @param {TUIMediaDevice} options.device 用户 Id
      * @returns {Promise<void>}
      *
      * @example
      * const roomEngine = new TUIRoomEngine();
-     * await roomEngine.stopRemoteScreenSharing({
+     * await roomEngine.closeRemoteDeviceByAdmin({
      *   userId: 'user_1234',
+     *   device: TUIMediaDevice.kMicrophone, //关闭掉麦克风
      * });
      */
-    stopRemoteScreenSharing(options: {
+    closeRemoteDeviceByAdmin(options: {
         userId: string;
+        device: TUIMediaDevice;
     }): Promise<void>;
     /**
      * 邀请其他人上麦
      * @param {object} options 邀请其他人上麦的参数
-     * @param {number} options.seatIndex  麦位 index
+     * @param {number} options.seatIndex  麦位 index, roomType 为 TUIRoomType.kConference 时无需关心，填 -1 即可
      * @param {string} options.userId  用户 Id
      * @param {number} options.timeout  超时时间，设置为 0 时，无超时时间
      * @param {Function} options.requestCallback 请求回调，用来通知发起方请求被接受/拒绝/取消/超时/错误的回调
@@ -457,7 +484,7 @@ declare class TUIRoomEngine {
      *
      * @example
      * const roomEngine = new TUIRoomEngine();
-     * const requestId = await roomEngine.requestRemoteUserOnSeat({
+     * const requestId = await roomEngine.takeUserOnSeatByAdmin({
      *   seatIndex: 0,
      *   userId: 'user_1234',
      *   timeout: 0,
@@ -484,12 +511,12 @@ declare class TUIRoomEngine {
      *  },
      * });
      */
-    requestRemoteUserOnSeat(options: {
+    takeUserOnSeatByAdmin(options: {
         seatIndex: number;
         userId: string;
         timeout: number;
         requestCallback?: (callbackInfo: TUIRequestCallback) => void;
-    }): Promise<string>;
+    }): Promise<TUIRequest>;
     /**
      * 要求其他人下麦
      * @param {object} options 要求其他人下麦的参数
@@ -499,12 +526,12 @@ declare class TUIRoomEngine {
      *
      * @example
      * const roomEngine = new TUIRoomEngine();
-     * await roomEngine.kickRemoteUserOffSeat({
+     * await roomEngine.kickUserOffSeatByAdmin({
      *   seatIndex: 0,
      *   userId: 'user_1234',
      * });
      */
-    kickRemoteUserOffSeat(options: {
+    kickUserOffSeatByAdmin(options: {
         seatIndex: number;
         userId: string;
     }): Promise<void>;
@@ -560,31 +587,27 @@ declare class TUIRoomEngine {
      * const roomEngine = new TUIRoomEngine();
      *
      * // 设置本地摄像头流的播放区域为 id 是 'preview-camera' 的 div 元素
-     * await roomEngine.setLocalRenderView({
+     * roomEngine.setLocalVideoView({
      *  streamType: TUIVideoStreamType.kCameraStream,
      *  view: 'preview-camera',
      * });
      *
      * // 设置本地屏幕分享流的播放区域为 id 是 'preview-screen' 的 div 元素
-     * await roomEngine.setLocalRenderView({
+     * roomEngine.setLocalVideoView({
      *  streamType: TUIVideoStreamType.kScreenStream,
      *  view: 'preview-screen',
      * });
      */
-    setLocalRenderView(options: {
+    setLocalVideoView(options: {
         streamType: TUIVideoStreamType;
         view: string;
-    }): Promise<void>;
+    }): void;
     /**
      * 打开本地摄像头，开始视频流采集
+     * @param {object} options 设置本地流的参数
      * @returns {Promise<void>}
-     *
      * @example
      * const roomEngine = new TUIRoomEngine();
-     * await roomEngine.setLocalRenderView({
-     *  streamType: TUIVideoStreamType.kScreenStream,
-     *  view: 'preview-screen',
-     * });
      * await roomEngine.openLocalCamera();
      */
     openLocalCamera(): Promise<void>;
@@ -598,7 +621,7 @@ declare class TUIRoomEngine {
      */
     closeLocalCamera(): Promise<void>;
     /**
-     * 打开本地麦克风, 开始采集音频流
+     * 打开麦克风
      * @returns {Promise<void>}
      *
      * @example
@@ -616,46 +639,45 @@ declare class TUIRoomEngine {
      */
     closeLocalMicrophone(): Promise<void>;
     /**
-     * 设置本地视频的参数
-     * @param {object} options 设置本地视频的参数
-     * @param {TUIVideoProfile} options.videoProfile
+     * 设置本地视频流的编码参数
+     * @param {object} options
+     * @param {TUIVideoQuality} options.quality
      *
-     * - 清晰 TUIVideoProfile.kLowDefinition <br/>
-     * - 标清 TUIVideoProfile.kStandardDefinition <br/>
-     * - 高清 TUIVideoProfile.kHighDefinition <br/>
-     * - 超清 TUIVideoProfile.kSuperDefinition <br/>
+     * - 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.setLocalVideoProfile({
-     *  videoProfile: TUIVideoProfile.kHighDefinition,
+     * await roomEngine.updateVideoQuality({
+     *  quality: TUIVideoQuality.kVideoQuality_360p,
      * });
      */
-    setLocalVideoProfile(options: {
-        videoProfile: TUIVideoProfile;
+    updateVideoQuality(options: {
+        quality: TUIVideoQuality;
     }): Promise<void>;
     /**
      * 设置本地音频的参数<br/>
-     * 注意：该方法需要在 openLocalMicrophone 之前进行设置，否则不会生效。
      * @param {object} options 设置本地音频的参数
-     * @param {TUIAudioProfile} options.audioProfile
+     * @param {TUIAudioQuality} options.quality
      *
-     * - TUIAudioProfile.kAudioProfileSpeech：语言模式；采样率：16k<br/>
-     * - TUIAudioProfile.kAudioProfileDefault：标准模式（或者默认模式）；采样率：48k<br/>
-     * - TUIAudioProfile.kAudioProfileMusic：音乐模式；采样率：48k
+     * - TUIAudioQuality.kAudioProfileSpeech：语言模式；采样率：16k<br/>
+     * - TUIAudioQuality.kAudioProfileDefault：标准模式（或者默认模式）；采样率：48k<br/>
+     * - TUIAudioQuality.kAudioProfileMusic：音乐模式；采样率：48k
      *
      * @returns {Promise<void>}
      *
      * @example
      * const roomEngine = new TUIRoomEngine();
-     * await roomEngine.setLocalAudioProfile({
-     *  audioProfile: TUIAudioProfile.kAudioProfileSpeech,
+     * await roomEngine.updateAudioQuality({
+     *  quality: TUIAudioQuality.kAudioProfileSpeech,
      * });
      */
-    setLocalAudioProfile(options: {
-        audioProfile: TUIAudioProfile;
+    updateAudioQuality(options: {
+        quality: TUIAudioQuality;
     }): Promise<void>;
     /**
      * 开始向远端推本地视频流
@@ -706,20 +728,20 @@ declare class TUIRoomEngine {
      * const roomEngine = new TUIRoomEngine();
      *
      * // 设置远端用户视频流在 id 为 'remote_preview_camera' 的区域播放
-     * roomEngine.setRemoteRenderView({
+     * roomEngine.setRemoteVideoView()({
      *  userId: 'user_1234',
      *  streamType: TUIVideoStreamType.kCameraStream,
      *  view: 'remote_preview_camera',
      * });
      *
      * // 设置远端用户屏幕分享流在 id 为 'remote_preview_screen' 的区域播放
-     * roomEngine.setRemoteRenderView({
+     * roomEngine.setRemoteVideoView()({
      *  userId: 'user_1234',
      *  streamType: TUIVideoStreamType.kScreenStream,
      *  view: 'remote_preview_screen',
      * });
      */
-    setRemoteRenderView(options: {
+    setRemoteVideoView(options: {
         userId: string;
         streamType: TUIVideoStreamType;
         view: string;
@@ -767,11 +789,29 @@ declare class TUIRoomEngine {
         userId: string;
         streamType: TUIVideoStreamType;
     }): Promise<void>;
+    /**
+     * 停止远端用户的音频流
+     * @param {object} options 停止远端用户音频流的参数
+     * @param {string} options.userId 停止远端用户的userId
+     * @param {boolean} options.isMute 是否停止远端用户的音频
+     * @returns {Promise<void>}
+     *
+     * @example
+     * const roomEngine = new TUIRoomEngine();
+     * await roomEngine.muteRemoteAudioStream({
+     *  userId: 'user_1234',
+     *  isMute: true,
+     * });
+     */
+    muteRemoteAudioStream(options: {
+        userId: string;
+        isMute: boolean;
+    }): Promise<void>;
     /**
      * 改变用户的角色，仅主持人可调用该接口
      * @param {object} options 改变用户的角色，仅主持人可调用该接口的参数
      * @param {string} options.userId 用户 Id
-     * @param {TUIRole} options.role 用户角色
+     * @param {TUIRole} options.userRole 用户角色
      * @returns {Promise<void>}
      *
      * @example
@@ -779,60 +819,85 @@ declare class TUIRoomEngine {
      * // 将房间移交给用户 user_1234
      * await roomEngine.changeUserRole({
      *  userId: 'user_1234',
-     *  role: TUIRole.kRoomOwner,
+     *  userRole: TUIRole.kRoomOwner,
+     * });
+     *
+     * // 将用户 user_1234 设置为房间管理员
+     * await roomEngine.changeUserRole({
+     *  userId: 'user_1234',
+     *  userRole: TUIRole.kAdministrator,
      * });
      */
     changeUserRole(options: {
         userId: string;
-        role: TUIRole;
+        userRole: TUIRole;
     }): Promise<void>;
     /**
-     * 禁止远端用户发送消息，仅主持人和管理员可调用该接口
+     * 将用户踢出房间，仅主持人和管理员可调用该接口
      * @param {object} options
-     * @param {string} options.userId 远端用户 userId
-     * @param {number} options.duration 禁止时长，单位秒。如设为 1000，则表示从现在起禁言该用户 1000 秒
+     * @param {string} options.userId 用户 Id
      * @returns {Promise<void>}
      *
      * @example
      * const roomEngine = new TUIRoomEngine();
-     * await roomEngine.muteRemoteUser({
+     * await roomEngine.kickRemoteUserOutOfRoom({
      *  userId: 'user_1234',
-     *  duration: 1000,
      * });
      */
-    muteRemoteUser(options: {
+    kickRemoteUserOutOfRoom(options: {
         userId: string;
-        duration: number;
     }): Promise<void>;
     /**
-     * 取消禁止远端用户发送消息，仅主持人和管理员可调用该接口
-     * @param {object} options
-     * @param {string} options.userId 远端用户 userId
+     * 所有用户的设备是否允许被使用
+     * @param {object} options 所有用户的设备是否被允许使用所用到的参数
+     * @param {TUIMediaDevice} options.device 被禁用的设备
+     * @param {boolean} options.isDisable 是否被禁用
      * @returns {Promise<void>}
-     *
      * @example
-     * const roomEngine = new TUIRoomEngine();
-     * await roomEngine.unmuteRemoteUser({
-     *  userId: 'user_1234',
-     * });
+     * // Example 1: 禁止所有用户打开麦克风
+     * await roomEngine.disableDeviceForAllUserByAdmin({
+     *  device: TUIMediaDevice.kMicrophone,
+     *  isDisable: true,
+     * })
+     * // Example 2: 允许所有用户打开麦克风
+     * await roomEngine.disableDeviceForAllUserByAdmin({
+     *  device: TUIMediaDevice.kMicrophone,
+     *  isDisable: false,
+     * })
      */
-    unmuteRemoteUser(options: {
-        userId: string;
+    disableDeviceForAllUserByAdmin(options: {
+        device: TUIMediaDevice;
+        isDisable: boolean;
     }): Promise<void>;
     /**
-     * 将用户踢出房间，仅主持人和管理员可调用该接口
-     * @param {object} options
-     * @param {string} options.userId 用户 Id
+     * 所有用户的是否允许发消息
+     * @param {object} options 所有用户是否被允许发消息所用到的参数
+     * @param {boolean} options.isDisable 是否被允许使用
      * @returns {Promise<void>}
-     *
      * @example
-     * const roomEngine = new TUIRoomEngine();
-     * await roomEngine.kickOutRemoteUser({
+     * await roomEngine.disableSendingMessageForAllUser({
+     *  isDisable: true,
+     * })
+  
+     */
+    disableSendingMessageForAllUser(options: {
+        isDisable: boolean;
+    }): Promise<void>;
+    /**
+     * 特定用户是否被允许发消息
+     * @param {object} options 特定用户的是否被允许发消息所用到的参数
+     * @param {string} options.userId 特定用户的 userId
+     * @param {boolean} options.isDisable 是否被允许使用
+     * @returns {Promise<void>}
+     * @example
+     * await roomEngine.disableSendingMessageByAdmin({
      *  userId: 'user_1234',
-     * });
+     *  isDisable: true,
+     * })
      */
-    kickOutRemoteUser(options: {
+    disableSendingMessageByAdmin(options: {
         userId: string;
+        isDisable: boolean;
     }): Promise<void>;
     /**
      * 发送文本消息
@@ -969,7 +1034,7 @@ declare class TUIRoomEngine {
      *    console.info("camera deviceName: " + camera.deviceName + " deviceId:" + camera.deviceId);
      * }
      */
-    getCameraDevicesList(): Promise<any>;
+    getCameraDevicesList(): Promise<TRTCDeviceInfo[]>;
     /**
      * 获取麦克风设备列表<br>
      * @returns {Promise<TRTCDeviceInfo[]>} 麦克风列表