trtc-sdk-v5 5.2.1 → 5.3.0-beta.2

package/index.d.ts

@@ -14,7 +14,7 @@
 	        profile?: keyof typeof videoProfileMap | VideoProfile;
 	        fillMode?: 'contain' | 'cover' | 'fill';
 	        mirror?: boolean;
-	        small?: keyof typeof videoProfileMap | VideoProfile;
+	        small?: keyof typeof videoProfileMap | VideoProfile | boolean;
 	        qosPreference?: typeof TRTCType.QOS_PREFERENCE_SMOOTH | typeof TRTCType.QOS_PREFERENCE_CLEAR;
 	        videoTrack?: MediaStreamTrack;
 	    };
@@ -1116,15 +1116,22 @@
 	    * await trtc.updateLocalVideo({ publish:true });
 	    * @example <caption>示例 3：预览及发布指定的摄像头</caption>
 	    * // 使用指定的摄像头。
+	    * // 在 DOM 中的 elementId 为 localVideo 的标签上预览视频。
+	    * const view = document.getElementById('localVideo');
 	    * const cameraList = await TRTC.getCameraList();
 	    * if (cameraList[0]) {
 	    *   await trtc.startLocalVideo({
-	    *     view: document.getElementById('localVideo'), // 在 DOM 中的 elementId 为 localVideo 的标签上预览视频。
+	    *     view,
 	    *     option: {
 	    *       cameraId: cameraList[0].deviceId,
 	    *     }
 	    *   });
 	    * }
+	    *
+	    * // 在移动端指定使用前置摄像头
+	    * await trtc.startLocalVideo({ view, option: { useFrontCamera: true }});
+	    * // 在移动端指定使用后置摄像头
+	    * await trtc.startLocalVideo({ view, option: { useFrontCamera: false }});
 	    * @memberof TRTC
 	    */
 	    startLocalVideo(config?: LocalVideoConfig): Promise<void>;
@@ -1559,8 +1566,24 @@
 	    * <br>
 	    * **Note**
 	    * - 该接口不支持在 http 协议下使用，请使用 https 协议部署您的网站。{@link https://developer.mozilla.org/en-US/docs/Web/API/MediaDevices/getUserMedia#Privacy_and_security Privacy and security}
-	    * - 出于安全的考虑，在用户未授权摄像头或麦克风访问权限前，label 及 deviceId 字段可能都是空的。因此建议在用户授权访问后，
-	    * 再调用该接口获取设备详情。
+	    * - 出于安全的考虑，在用户未授权摄像头或麦克风访问权限前，label 及 deviceId 字段可能都是空的。因此建议在用户授权访问后，再调用该接口获取设备详情。
+	    * - 可以调用浏览器原生接口 [getCapabilities](https://developer.mozilla.org/en-US/docs/Web/API/InputDeviceInfo/getCapabilities) 获取摄像头支持的最大分辨率、帧率、移动端设备区分前后置摄像头等。该接口支持 Chrome 67+, Edge 79+, Safari 17+, Opera 54+ 浏览器。
+	    * @example
+	    * const cameraList = await TRTC.getCameraList();
+	    * if (cameraList[0] && cameraList[0].getCapabilities) {
+	    *   const { width, height, frameRate, facingMode } = cameraList[0].getCapabilities();
+	    *   // 摄像头支持的最大分辨率、帧率。
+	    *   console.log(width.max, height.max, frameRate.max);
+	    *
+	    *   // 在移动端区分该摄像头是前置还是后置。
+	    *   if (facingMode) {
+	    *     if (facingMode[0] === 'user') {
+	    *       // 前置摄像头
+	    *     } else if (facingMode[0] === 'environment') {
+	    *       // 后置摄像头
+	    *     }
+	    *   }
+	    * }
 	    * @returns {Promise.<MediaDeviceInfo[]>} Promise 返回 {@link https://developer.mozilla.org/en-US/docs/Web/API/MediaDeviceInfo|MediaDeviceInfo} 数组
 	    */
 	    static getCameraList(): Promise<DeviceInfo[]>;
@@ -1569,8 +1592,14 @@
 	    * <br>
 	    * **Note**
 	    * - 该接口不支持在 http 协议下使用，请使用 https 协议部署您的网站。{@link https://developer.mozilla.org/en-US/docs/Web/API/MediaDevices/getUserMedia#Privacy_and_security Privacy and security}
-	    * - 出于安全的考虑，在用户未授权摄像头或麦克风访问权限前，label 及 deviceId 字段可能都是空的。因此建议在用户授权访问后，
-	    * 再调用该接口获取设备详情。
+	    * - 出于安全的考虑，在用户未授权摄像头或麦克风访问权限前，label 及 deviceId 字段可能都是空的。因此建议在用户授权访问后，再调用该接口获取设备详情。
+	    * - 可以调用浏览器原生接口 [getCapabilities](https://developer.mozilla.org/en-US/docs/Web/API/InputDeviceInfo/getCapabilities) 获取麦克风能力信息，例如支持的最大声道数等。该接口支持 Chrome 67+, Edge 79+, Safari 17+, Opera 54+ 浏览器。
+	    * @example
+	    * const microphoneList = await TRTC.getMicrophoneList();
+	    * if (microphoneList[0] && microphoneList[0].getCapabilities) {
+	    *   const { channelCount } = microphoneList[0].getCapabilities();
+	    *   console.log(channelCount.max);
+	    * }
 	    * @returns {Promise.<MediaDeviceInfo[]>} Promise 返回 {@link https://developer.mozilla.org/en-US/docs/Web/API/MediaDeviceInfo|MediaDeviceInfo} 数组
 	    */
 	    static getMicrophoneList(): Promise<DeviceInfo[]>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "trtc-sdk-v5",
-  "version": "5.2.1",
+  "version": "5.3.0-beta.2",
   "description": "Tencent Cloud RTC SDK for Web",
   "main": "trtc.js",
   "types": "index.d.ts",