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

package/index.d.ts

@@ -410,7 +410,7 @@
 	     * @example
 	     *
 	     * trtc.on(TRTC.EVENT.ERROR, error => {
-	     *   console.error('client error observed: ' + error);
+	     *   console.error('trtc error observed: ' + error);
 	     *   const errorCode = error.code;
 	     *   const extraCode = error.extraCode;
 	     * });
@@ -531,7 +531,7 @@
 	    readonly REMOTE_VIDEO_UNAVAILABLE: "remote-video-unavailable";
 	    /**
 	     * @description 音量大小事件<br>
-	     * 调用 {@link Client#enableAudioVolumeEvaluation enableAudioVolumeEvaluation} 接口开启音量大小回调后，SDK 会定时抛出该事件，通知每个 userId 的音量大小。<br>
+	     * 调用 {@link TRTC#enableAudioVolumeEvaluation enableAudioVolumeEvaluation} 接口开启音量大小回调后，SDK 会定时抛出该事件，通知每个 userId 的音量大小。<br>
 	     * **Note**
 	     * - 回调中包含本地麦克风音量及远端用户的音量，无论是否有人说话，都会触发该回调。
 	     * - 回调 event.result 会根据音量大小，按大到小进行排序。
@@ -563,7 +563,7 @@
 	     *    其枚举值及含义如下表所示：
 	     *    | 数值 | 含义 |
 	     *    | :--- | :---- |
-	     *    | 0 | 网络状况未知，表示当前 client 实例还没有建立上行/下行连接 |
+	     *    | 0 | 网络状况未知，表示当前 trtc 实例还没有建立上行/下行连接 |
 	     *    | 1 | 网络状况极佳 |
 	     *    | 2 | 网络状况较好|
 	     *    | 3 | 网络状况一般 |
@@ -604,7 +604,7 @@
 	     * @default 'connection-state-changed'
 	     * @memberof module:EVENT
 	     * @example
-	     * client.on(TRTC.CONNECTION_STATE_CHANGED, event => {
+	     * trtc.on(TRTC.CONNECTION_STATE_CHANGED, event => {
 	     *   const prevState = event.prevState;
 	     *   const curState = event.state;
 	     * });
@@ -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.1",
   "description": "Tencent Cloud RTC SDK for Web",
   "main": "trtc.js",
   "types": "index.d.ts",