@tencentcloud/tuiroom-engine-js 1.2.1 → 1.3.1

package/index.d.ts

@@ -67,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
@@ -75,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
@@ -124,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
@@ -146,8 +158,6 @@ declare class TUIRoomEngine {
         isCameraDisableForAllUser?: boolean;
         isMessageDisableForAllUser?: boolean;
         maxSeatCount?: number;
-        enableCDNStreaming?: boolean;
-        cdnStreamDomain?: string;
     }): Promise<void>;
     /**
      * 进入房间接口
@@ -290,9 +300,18 @@ declare class TUIRoomEngine {
      * @returns {Promise<void>}
      * @example
      * const roomEngine = new TUIRoomEngine();
+     *
+     * // 桌面端打开摄像头
      * await roomEngine.openLocalCamera();
+     *
+     * // 移动端使用前置摄像头打开视频预览
+     * await roomEngine.openLocalCamera({ isFrontCamera: true });
+     * // 移动端使用后置摄像头打开视频预览
+     * await roomEngine.openLocalCamera({ isFrontCamera: false });
      */
-    openLocalCamera(): Promise<void>;
+    openLocalCamera(options?: {
+        isFrontCamera?: boolean;
+    }): Promise<void>;
     /**
      * 关闭本地摄像头
      * @returns {Promise<void>}
@@ -1075,6 +1094,19 @@ declare class TUIRoomEngine {
     setCurrentCameraDevice(options: {
         deviceId: string;
     }): Promise<void>;
+    /**
+     * 切换前后置摄像头，该接口只适用于移动端浏览器
+     * @param {Object} options
+     * @param {boolean} options.isFrontCamera 是否切换为前置摄像头
+     *
+     * // 移动端切换为前置摄像头
+     * await roomEngine.switchCamera({ isFrontCamera: true });
+     * // 移动端切换为后置摄像头
+     * await roomEngine.switchCamera({ isFrontCamera: false });
+     */
+    switchCamera(options: {
+        isFrontCamera: boolean;
+    }): Promise<void>;
     /**
      * 设置要使用的麦克风设备<br>
      * @param {Object} options
@@ -1143,6 +1175,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