@tencentcloud/sdk-mcp 1.3.8 → 1.4.0

package/resource/doc/rtcengine/web/plugin/40-advanced-video-mixer.md

@@ -2,8 +2,6 @@
 
 本文档详细介绍了如何使用 TRTC Web SDK 的 VideoMixer 插件，将摄像头、屏幕共享、文字、图片和视频等多个输入源合成为一个视频轨道，实现自定义布局的推流。开发者可以灵活控制每个源的布局（位置、大小、层级 zIndex）。
 
-![The Workflow of Video Mixer](./assets/videomixer-workflow.png)
-
 ## 前提条件
 
 - TRTC Web SDK version >= 5.12.0.
@@ -51,7 +49,7 @@ const { track } = await trtc.startPlugin('VideoMixer', options);
 合流插件只负责生成合流后的视频轨道，推流操作仍由 TRTC SDK 控制。将 startPlugin 返回的 track 作为参数传入 startLocalVideo 接口即可进行推流。
 
 ```js
-await trtc.startLocalVideo({ option: { 
+await trtc.startLocalVideo({ option: {
   videoTrack: track,
   profile: { width: 1920, height: 1080, bitrate: 2000 } // 设置编码参数
 }});
@@ -64,7 +62,7 @@ await trtc.startLocalVideo({ option: {
 **更新规则：**
 
 * **输入源说明：** 输入源分为：`camera, screen, text, image, video`。都是数组，每一个数组元素代表一个输入源，通过 id 属性做唯一标识。
-* **更新输入源：** 传入相同 id，并修改其他参数。  
+* **更新输入源：** 传入相同 id，并修改其他参数。
 * **添加输入源：** 传入新的 id 对象。
 * **移除输入源：** 从对应的输入源数组中去掉该对象。
 
@@ -73,7 +71,7 @@ await trtc.startLocalVideo({ option: {
 可以控制摄像头的采集和布局。
 
 ```javascript
-// 更新 id 为 'camera1' 的摄像头布局  
+// 更新 id 为 'camera1' 的摄像头布局
 await trtc.updatePlugin('VideoMixer', {
   camera: [
     {
@@ -84,7 +82,7 @@ await trtc.updatePlugin('VideoMixer', {
   ]
 });
 
-// 移除所有摄像头  
+// 移除所有摄像头
 await trtc.updatePlugin('VideoMixer', { camera: [] });
 // 如果只是想临时隐藏画布上的输入源，而不是物理关闭采集，可以在 layout 参数中设置 hidden: true。其他输入源同理。
 ```
@@ -102,7 +100,7 @@ await trtc.updatePlugin('VideoMixer', {
       y: 0,
       width: 1920,
       height: 1080,
-      zIndex: 0,      
+      zIndex: 0,
     },
     systemAudio: true, // 是否采集系统音频，默认不采集 v5.15 版本新增
   }],
@@ -143,13 +141,13 @@ await trtc.updatePlugin('VideoMixer', {
 
 ```js
 await trtc.updatePlugin('VideoMixer', {
-  image: [{ 
-    id: 'img1', 
+  image: [{
+    id: 'img1',
     url: './image.png',
     layout: { x: 0, y: 500, width: 800, height: 400, zIndex: 4 }
   }],
-  video: [{ 
-    id: 'video1', 
+  video: [{
+    id: 'video1',
     url: './video.mp4',
     layout: { x: 0, y: 0, width: 1000, height: 500, zIndex: 5 }
   }]
@@ -190,11 +188,11 @@ try {
   })
   console.log(result.successOptions) // 本次更新成功应用的参数
 } catch (error: any) {
-  // 场景二：全部失败时的错误捕获 (捕获抛出的错误)  
+  // 场景二：全部失败时的错误捕获 (捕获抛出的错误)
   console.error(error);
   error?.data?.failedDetails.forEach(({ id, error }: { id: string, error: any }) => {
     console.error(`${id} mix failed`, error);
-  })  
+  })
 }
 ```
 
@@ -221,7 +219,6 @@ try {
 | video             | [VideoSource](#videosource)[]       | 选填     | 控制视频输入源的参数                                                                                                 |
 | onScreenShareStop | `(id: string) => {}`                | 选填     | 合流共享屏幕停止时调用的回调，用户未通过 sdk 而是通过浏览器按钮取消屏幕分享时可能会用到，回调参数为停止采集的屏幕 id |
 
-
 **Returns: Promise\<MixParseResult\>**
 
 `MixParseResult`
@@ -230,7 +227,10 @@ try {
 | ------ | ----------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
 | track  | [MediaStreamTrack](https://developer.mozilla.org/en-US/docs/Web/API/MediaStreamTrack)  | 合流输出的视频轨道                                                                                                                                                                                                                                                           |
 | systemAudioTrackList  | object | 系统音频轨道列表。在设置 ScreenSource 参数 systemAudio:true 并且采集成功后会返回系统音频的 audio track。数据格式为：{key: audioTrack}，其中 key 为 ScreenSource 配置的 ID，例如： {id1: audioTrack，id2: audioTrack}                                                                                                                                                                                                                                                         |
-| result | object            | 本次传入的参数中执行成功或失败的相关信息，结构如下：<table><tr><th>Name</th><th>Type</th><th>Description</th></tr><tr><td>successOptions</td><td>[Options](#options)</td><td>本次更新成功执行的 options </td></tr><tr><td>failedDetails</td><td>MixFailedDetail[]</td><td>本次更新执行失败详细信息</td></tr></table> |
+| result | object            | 本次传入的参数中执行成功或失败的相关信息，结构如下：| Name | Type | Description |
+| --- | --- | --- |
+| successOptions | [Options](#options) | 本次更新成功执行的 options |
+| failedDetails | MixFailedDetail[] | 本次更新执行失败详细信息 | |
 
 `MixFailedDetail`
 
@@ -323,10 +323,10 @@ try {
 
 ### 1. 帧率与性能优化
 
-* **帧率设置：**  
-  * **不推荐**手动设置 canvasInfo.frameRate。  
-  * **推荐**由插件内部自动计算：当存在摄像头或屏幕分享时，取两者中的最大帧率；否则固定为 15 帧。手动指定可能导致性能损失。  
-* **性能考量：**  
+* **帧率设置：**
+  * **不推荐**手动设置 canvasInfo.frameRate。
+  * **推荐**由插件内部自动计算：当存在摄像头或屏幕分享时，取两者中的最大帧率；否则固定为 15 帧。手动指定可能导致性能损失。
+* **性能考量：**
   * 画布分辨率越大、合流的输入源越多，渲染开销越大。业务侧应根据用户设备性能情况，决定合适的画布参数和输入源数量。
 
 ### 2. 分辨率、码率怎么设置？
@@ -377,4 +377,4 @@ await trtc.startPlugin('VideoMixer', {
     console.log(`screen share stop, id: ${id}`);
   }
 });
-```
+```

package/resource/doc/rtcengine/web/plugin/41-advanced-small-stream-auto-switcher.md

@@ -84,7 +84,7 @@ trtc.startPlugin('SmallStreamAutoSwitcher', {
 2. 帧率条件：小流帧率稳定（最大帧率与最小帧率的差值不超过最大帧率的1/3）
 3. 限制条件：用户当前订阅的是小流，且该用户只切换过1次小流，且不在休眠期
 
-> **注意：** 
+> **注意：**
 > - 检测频率为每 2 秒一次
 > - 网络质量和帧率数据的统计窗口大小自动适应poorDuration和goodDuration的最大值
 > - 每次切换后会进入 `sleepTime` 时长的休眠期，期间不会再次触发自动切换

package/resource/doc/rtcengine/web/plugin/42-advanced-realtime-transcriber.md

@@ -90,7 +90,7 @@ const robotId = await trtc.startPlugin('RealtimeTranscriber', {
 trtc.on(TRTC.EVENT.REALTIME_TRANSCRIBER_MESSAGE, (data) => {
   console.log(`👤 ${data.speakerUserId}:`);
   console.log(`  原文: ${data.sourceText}`);
-  
+
   if (data.translationTexts) {
     Object.entries(data.translationTexts).forEach(([lang, text]) => {
       console.log(`  ${lang.toUpperCase()}: ${text}`);
@@ -204,10 +204,10 @@ trtc.on(TRTC.EVENT.REALTIME_TRANSCRIBER_STATE_CHANGED, (event) => {
 ```javascript
 trtc.on(TRTC.EVENT.REALTIME_TRANSCRIBER_MESSAGE, (event) => {
   const { speakerUserId, sourceText, translationTexts, isCompleted } = event;
-  
+
   // 显示实时转录结果
   console.log(`[${isCompleted ? '完成' : '进行中'}] ${speakerUserId}: ${sourceText}`);
-  
+
   // 显示翻译结果
   if (translationTexts) {
     translationTexts.forEach(({ language, text }) => {
@@ -301,7 +301,7 @@ const subtitleMap = new Map();
 
 trtc.on(TRTC.EVENT.REALTIME_TRANSCRIBER_MESSAGE, (event) => {
   subtitleMap.set(event.segmentId, event);
-  
+
   if (event.isCompleted) {
     // 语音片段完成，可以归档
     archiveSubtitle(subtitleMap.get(event.segmentId));

package/resource/doc/rtcengine/web/plugin/43-advanced-face-detection.md

@@ -34,8 +34,8 @@
 ```javascript
 import { FaceDetection } from 'trtc-sdk-v5/plugins/video-effect/face-detection';
 
-const trtc = TRTC.create({ 
-  plugins: [FaceDetection], 
+const trtc = TRTC.create({
+  plugins: [FaceDetection],
   assetsPath: 'https://xxxx/assets'  // 替换为您的静态资源地址
 });
 ```
@@ -177,4 +177,4 @@ await trtc.updatePlugin('FaceDetection', {
 
 **2. 视频流恢复后需要重新开启检测吗？**
 
-不需要。插件会自动处理视频流状态变化，恢复后会继续检测。
+不需要。插件会自动处理视频流状态变化，恢复后会继续检测。