@tencent-rtc/mcp 1.7.2 → 1.7.3

package/resource/knowledge/roomkit/preset/vue/features/ai-denoiser.md

@@ -0,0 +1,67 @@
+AI noise cancellation is powered by the AI algorithms from Tencent's Tianlai Lab. It can intelligently detect and remove noise interference mixed into the transmitted signal, thereby significantly improving voice quality, enhancing sound clarity, and improving the listening experience. Applying the AI noise cancellation feature in TUIRoomKit lets users get a clear and stable audio experience in various environments such as offices, internet cafes, shopping malls, and outdoors.
+
+## Online experience
+
+You can also enter our [Real-Time Communication Experience Center](https://rtcube.cloud.tencent.com/component/experience-center/index.html#/detail) to experience the excellent sound quality delivered by the AI noise cancellation capability online.
+
+#
+
+## Enabling AI noise cancellation
+
+TUIRoomKit provides a very convenient activation process. You only need two steps to try it out:
+1. Go to the Real-Time Communication console and select the application you want to enable it for.
+
+2. Go to Value-added Features and turn on the AI noise cancellation switch.
+
+   Then you can enjoy the better noise cancellation of TUIRoomKit in your application!
+
+## Web asset configuration
+
+TUIRoomKit automatically enables AI noise cancellation after the user joins the room, provided that you have completed the following asset configuration:
+1. Publish the `denoiser-wasm.js` file located in the `node_modules/trtc-sdk-v5/plugins/ai-denoiser` directory to a CDN or static resource server, and make sure the files are under the same public path. For details, see the [AI noise cancellation plugin documentation](https://web.sdk.qcloud.com/trtc/webrtc/v5/doc/zh-cn/tutorial-35-advanced-ai-denoiser.html).
+
+2. Before joining the room, call the following interface to pass the public path above to TUIRoomKit:
+
+【With UI integration】
+
+【Vue3】
+``` typescript
+import { conference } from '@tencentcloud/roomkit-web-vue3';
+
+conference.callExperimentalAPI({
+  api: 'setRtcAssetsPath',
+  params: { assetsPath: 'XXXXX/assets/' }, // Directory path where the denoiser-wasm.js file is located
+});
+```
+
+【React】
+``` typescript
+import { conference } from '@tencentcloud/roomkit-web-react';
+
+conference.callExperimentalAPI({
+  api: 'setRtcAssetsPath',
+  params: { assetsPath: 'XXXXX/assets/' }, // Directory path where the denoiser-wasm.js file is located
+});
+```
+
+【Without UI integration】
+
+【Vue3】
+``` typescript
+import { callExperimentalAPI } from 'tuikit-atomicx-vue3';
+
+callExperimentalAPI({
+  api: 'setRtcAssetsPath',
+  params: { assetsPath: 'XXXXX/assets/' }, // Directory path where the denoiser-wasm.js file is located
+});
+```
+
+【React】
+``` typescript
+import { callExperimentalAPI } from 'tuikit-atomicx-react';
+
+callExperimentalAPI({
+  api: 'setRtcAssetsPath',
+  params: { assetsPath: 'XXXXX/assets/' }, // Directory path where the denoiser-wasm.js file is located
+});
+```

package/resource/knowledge/roomkit/preset/vue/features/network-proxy.md

@@ -0,0 +1,79 @@
+The Conference SDK is built on Tencent Cloud Chat (IM) and Tencent Real-Time Communication (TRTC). It supports configuring the IM and TRTC proxies together in intranet / firewall environments, which is suitable for scenarios such as private deployment and enterprise intranet isolation where a direct connection to Tencent Cloud services is not available.
+
+## Proxy architecture
+
+|Proxy server|Proxy link|
+|---------|---------|
+|IM proxy|Proxies the signaling channels for IM login, message sending/receiving, etc. (WebSocket), as well as the upload and download of resources such as chat images and files.|
+|TRTC WebSocket proxy (e.g. Nginx)|Proxies the signaling channels for TRTC room entry, control, etc. (WebSocket), and is responsible for room management and user state synchronization.|
+|TRTC TURN Server|Relays TRTC audio and video media streams.|
+
+> **Note:**
+> The proxy servers (IM proxy, Nginx, TURN) need to be deployed by yourself. For how to set them up, see [TRTC Web SDK handling firewall restrictions](https://web.sdk.qcloud.com/trtc/webrtc/v5/doc/zh-cn/tutorial-34-advanced-proxy.html).
+>
+
+## API and parameters
+
+The Conference SDK allows you to configure the intranet proxy uniformly through the `callExperimentalAPI` interface before calling `login()`:
+``` typescript
+callExperimentalAPI({
+  api: 'setNetworkProxy',
+  params: {
+    im?: { /* IM proxy parameters */ },
+    rtc?: { /* TRTC proxy parameters */ },
+  },
+});
+```
+
+### IM proxy parameters
+
+|Parameter|Type|Description|
+|---------|---------|---------|
+|`proxyServer`|String|IM signaling WebSocket proxy address.|
+|`fileUploadProxy`|String|IM file upload proxy address.|
+|`fileDownloadProxy`|String|IM file download proxy address.|
+
+### TRTC proxy parameters
+
+|Parameter|Type|Description|
+|---------|---------|---------|
+|`websocketProxy`|String|TRTC signaling WebSocket proxy address, e.g. `wss://proxy.example.com/ws/`.|
+|`turnServer`|Array|List of TURN servers. Each item contains `url` / `username` / `credential`.|
+|`iceTransportPolicy`|`'relay' \| 'all'`|Client-side ICE transport policy. In an intranet environment, it is recommended to set it to `'relay'` to force a connection to the TURN server.|
+
+## Sample code
+
+``` typescript
+import { conference } from '@tencentcloud/roomkit-web-vue3';
+
+conference.callExperimentalAPI({
+  api: 'setNetworkProxy',
+  params: {
+    im: {
+      proxyServer: 'wss://proxy.example.com:8080',
+      fileUploadProxy: 'https://proxy.example.com:8080',
+      fileDownloadProxy: 'https://proxy.example.com:8080',
+    },
+    rtc: {
+      websocketProxy: 'wss://proxy.example.com/ws/',
+      turnServer: [
+        { url: '14.3.3.3:3478', username: 'turn', credential: 'turn' },
+      ],
+      iceTransportPolicy: 'relay',
+    },
+  },
+});
+
+await conference.login({ sdkAppId, userId, userSig });
+await conference.createAndJoinRoom({ roomId });
+```
+
+## FAQs
+
+### A user can join the conference normally on the public network, but cannot join it on the intranet?
+
+Check whether `setNetworkProxy` was called before `login()`. If it is already configured but still fails, check the TURN port and the outbound allowlist of the proxy server.
+
+### A user can join the conference but cannot see the remote video or hear the remote audio?
+
+Confirm that `turnServer` is reachable, and set `iceTransportPolicy` to `'relay'` in an intranet environment.

package/resource/knowledge/roomkit/preset/vue/features/recording.md

@@ -0,0 +1,85 @@
+This document introduces the cloud recording feature of the Conference SDK. **The Conference SDK integrates mixed-stream room recording by default.** The room owner or administrator can start recording with one click through the client interface and the with-UI integration component, **without the customer building a backend** to call the TRTC cloud API. If the default recording capability does not meet your business needs, refer to Differences from TRTC cloud recording in this document, and refer to [TRTC cloud recording](https://cloud.tencent.com/document/product/647/76497) to integrate it yourself.
+
+> **Note:**
+> The Conference SDK cloud recording is implemented based on the [TRTC cloud recording](https://cloud.tencent.com/document/product/647/76497) capability, with typical mixed-stream recording parameters preset for meeting scenarios, helping you complete recording configuration more simply and quickly.
+>
+
+## Prerequisites
+
+Before using Conference SDK cloud recording, confirm that you have completed the following steps:
+- You have purchased a Conference SDK package that includes cloud recording capability and obtained the SDKAppID information.
+
+- Enable the recording file storage service: Recording files can be stored in [Cloud VOD (VOD)](https://console.cloud.tencent.com/vod) or [Cloud Object Storage (COS)](https://console.cloud.tencent.com/cos). Complete the activation in the corresponding console and record the storage information.
+
+- [Submit a ticket](https://console.cloud.tencent.com/workorder/category), select the **Real-Time Communication** product, and state that you need to configure cloud recording storage information (VOD or COS) for the Conference SDK.
+
+## Feature description
+
+The Conference SDK provides a **managed cloud recording** solution: The server is responsible for authentication and recording task management, and the customer only needs to configure the recording file storage address. Then, during a meeting, the room owner or administrator can start recording with one click through the client.
+
+## Recording effect
+
+The Conference SDK uses **mixed-stream recording** mode by default, mixing the audio and video streams published in the room into one complete recording file. The recording content includes:
+- **Audio**: The voices of all participants in the room.
+
+- **Video**: All views with the camera turned on or screen sharing.
+
+   The recording layout **switches automatically** with the in-meeting state, and the recording task is **not restarted** during the switch:
+
+   |In-meeting state|Mixed-stream layout|Maximum number of views|
+   |---------|---------|---------|
+   |No screen sharing / whiteboard|[Grid layout](https://cloud.tencent.com/document/product/647/76497#nine)|Up to **25** video views|
+   |With screen sharing / whiteboard|[Screen sharing layout](https://cloud.tencent.com/document/product/647/76497#share) (sharing as the main view)|Up to **1** screen sharing / whiteboard + **16** video views|
+   |Audio only|-|—|
+
+## Obtaining files after the meeting
+
+After recording ends, the files are stored in the VOD or COS you configured. You can obtain the recording files in the following ways:
+- Go to [Real-Time Communication Console > Application Management](https://console.cloud.tencent.com/trtc/app), and view the recording files stored in Cloud VOD (VOD) under **Recording Management > Recording File Management**.
+
+- If stored in Cloud Object Storage (COS), go to the [Cloud Object Storage (COS) console](https://console.cloud.tencent.com/cos) to view them.
+
+- For details on finding, receiving, deleting, and playing back files, refer to [Recording file management](https://cloud.tencent.com/document/product/647/76497#file).
+
+## Differences from TRTC cloud recording
+
+Both Conference SDK room recording and TRTC cloud recording are based on the underlying TRTC cloud recording service. The SDK has preset mixed-stream recording parameters for meeting scenarios. If you need capabilities such as **specifying subscribed hosts, customizing the mixed-stream layout, or controlling recording start/stop from the server**, you can use TRTC cloud recording to integrate it yourself. The main differences are as follows:
+
+|Comparison item|**Conference SDK room recording**|**TRTC cloud recording**|
+|---------|---------|---------|
+|Recording scope|Applicable to rooms created through the Conference SDK under the current SDKAppID.|Applicable to all TRTC rooms under the current SDKAppID (including rooms created directly by other SDKs or the TRTC SDK).|
+|Start method|During a meeting, the room owner or administrator starts and stops recording with one click through the client interface / with-UI component.|Enable global auto-recording in the console, or have a self-built backend call the REST API (e.g. `CreateCloudRecording`) to control recording.|
+|Recording files|By default, **mixed-stream recording** produces one mixed file; the layout switches automatically based on whether there is screen sharing / whiteboard in the meeting (grid layout up to 25 streams, screen sharing layout 1+16 streams).|Global auto-recording is **single-stream** (one file per host); the REST API method can choose single-stream or mixed-stream, and supports custom layouts and subscription lists.|
+|Integration cost|Just submit a ticket to configure the storage address, **no self-built backend required**.|You need to configure a recording template in the TRTC console yourself, or integrate the REST API and callbacks.|
+
+> **Note:**
+> - The two solutions can be used at the same time, but this may produce multiple recording files and additional [costs](https://cloud.tencent.com/document/product/647/75047).
+> - If you already use Conference SDK room recording, it is not recommended to also enable TRTC **global auto-recording**, to avoid recording the same room repeatedly.
+> - For configuration and integration details, see [Implementing cloud recording and playback](https://cloud.tencent.com/document/product/647/76497).
+
+## FAQs
+
+### **Can multiple recording solutions be used at the same time?**
+
+Multiple recording solutions do not conflict, and you can use multiple recording solutions at the same time, but this will produce multiple recording files and [costs](https://cloud.tencent.com/document/product/647/75047).
+
+### How do I view the recording duration details?
+
+You can view some recording duration details in [Real-Time Communication Console > Cloud Recording](https://console.cloud.tencent.com/trtc/cloudrecord):
+
+### How do I manage recording files?
+
+The current [recording file management](https://cloud.tencent.com/document/product/647/76497#file) mainly offers the following operations:
+
+[Find recording files](https://cloud.tencent.com/document/product/647/76497#find_file), [Receive recording files](https://cloud.tencent.com/document/product/647/76497#receive_file), [Delete recording files](https://cloud.tencent.com/document/product/647/76497#delete_file), [Play back recording files](https://cloud.tencent.com/document/product/647/76497#record_file).
+
+### How do I customize the recording file name?
+
+Renaming recording files is not currently supported. Only [API recording](https://cloud.tencent.com/document/product/647/76497#API_record) supports customizing a file name prefix: When storing to Cloud VOD using [API recording](https://cloud.tencent.com/document/product/647/76497#API_record), you can customize the file name prefix through the UserDefineRecordId parameter in [TencentVod](https://cloud.tencent.com/document/api/647/44055#TencentVod). The prefix and the auto-generated recording file name are separated by `_UserDefine_u_`.
+
+### More documentation
+- [Implementing cloud recording and playback](https://cloud.tencent.com/document/product/647/76497)
+
+- [Cloud recording server event callbacks](https://cloud.tencent.com/document/product/647/81113)
+
+- [Cloud recording billing description](https://cloud.tencent.com/document/product/647/75047)

package/resource/knowledge/roomkit/preset/vue/features/whiteboard-annotation.md

@@ -0,0 +1,86 @@
+TUIRoomKit has built-in whiteboard and screen sharing annotation. After completing the TUIRoomKit integration, users can use the following in a meeting without writing any extra code:
+- **Whiteboard**: Opens a blank canvas for writing, explaining, and brainstorming.
+
+- **Screen sharing annotation**: Circle key points, add arrows, or mark issues on the screen being shared.
+
+## Online experience
+
+Visit [TUIRoomKit online experience](https://rtcube.cloud.tencent.com/component/experience-center/index.html#/detail) and enter a meeting scenario to experience the whiteboard and screen sharing annotation.
+
+## Getting started
+
+First, refer to [Quick Integration](https://cloud.tencent.com/document/product/647/81962) to integrate `@tencentcloud/roomkit-web-vue3`, and upgrade to version `6.1.0` or later.
+
+### Using the whiteboard
+1. Enter a **multi-person meeting**.
+
+2. Click **Screen Share** in the bottom toolbar.
+
+3. Select **Whiteboard** from the expanded menu.
+
+4. The whiteboard is immediately shared with other members in the room. The initiator can use tools such as the pen, laser pointer, shapes, arrows, eraser, undo, redo, clear, and save snapshot.
+
+   Whiteboard in a meeting
+
+### Using screen sharing annotation
+1. Start screen sharing.
+
+2. Click the **Annotate** button on the shared screen.
+
+3. Use the pen, shapes, or arrows to mark key points on the shared content.
+
+4. After ending screen sharing, the annotation is automatically closed.
+
+   Annotating on the screen sharing view
+
+## Permission control
+
+The whiteboard uses the same permissions as screen sharing:
+- **The room owner and administrators** can prohibit or allow ordinary members from sharing their screen through meeting controls.
+
+- **Ordinary members** who are prohibited from sharing their screen cannot start screen sharing, nor can they start the whiteboard.
+
+- **Screen sharing annotation** is available only to the current screen sharer. Other members can view the shared view and the annotation content, but cannot draw on that view.
+
+   If a member cannot see the whiteboard entry, first confirm whether their screen sharing permission has been disabled.
+
+## Disabling the whiteboard and annotation
+
+If your application does not need the whiteboard and annotation, you can hide the feature entries:
+``` typescript
+import {
+  BuiltinWidget,
+  conference,
+} from '@tencentcloud/roomkit-web-vue3';
+
+conference.setWidgetVisible({
+  [BuiltinWidget.WhiteboardWidget]: false,
+  [BuiltinWidget.AnnotationWidget]: false,
+});
+```
+
+## Scope of use
+- Supports the latest stable versions of Chrome and Edge on Windows and macOS desktops.
+
+- Does not yet support mobile browsers and webinar (Webinar) rooms.
+
+- Currently, the initiator draws while other members watch in real time; simultaneous drawing by multiple people is not yet supported.
+
+- The whiteboard and regular screen sharing cannot be enabled at the same time. When you need annotation, start screen sharing first, and then start annotation on the shared view.
+
+## FAQs
+
+### Why is there no whiteboard entry in the meeting?
+
+Please confirm:
+1. `@tencentcloud/roomkit-web-vue3` has been upgraded to version **6.1.0** or later.
+
+2. The current room is a multi-person meeting, not a webinar (Webinar) room.
+
+3. The current user has screen sharing permission.
+
+4. You are using desktop Chrome or Edge that supports screen sharing.
+
+### Do I need to close it manually before exiting the meeting?
+
+No. When you exit the room, the component automatically stops the whiteboard and releases related resources; screen sharing annotation is also automatically stopped when the sharing ends.

package/server.js

@@ -41,7 +41,7 @@ User-visible output rules (MUST):
 export function createServer() {
     const server = new McpServer({
         name: "Tencent RTC MCP Server",
-        version: "1.7.2",
+        version: "1.7.3",
     }, {
         instructions: SERVER_INSTRUCTIONS,
     });

package/utils/preflight-route.js

@@ -10,6 +10,10 @@ const PRODUCT_SIGNALS = {
 // 平台词（纯运行形态，不含任何产品词）
 const PLATFORM_NATIVE_SIGNAL = /\b(android|ios|flutter|c\+\+|native)\b|安卓\s*(sdk|端|原生)|iOS\s*(SDK|端|原生)|原生\s*(sdk|端)?|native\s+(?:sdk|client|app)|mobile\s+(?:sdk|native)/i;
 const PLATFORM_WEB_SIGNAL = /\b(web|h5|html5|browser|webview)\b|浏览器|网页|Web端|H5端|网页端|web\s+(?:app|client|page)|in-?browser|mobile\s+browser|安卓\s*(浏览器|网页|H5|Web|webview)|iOS\s*(浏览器|网页|H5|Web|webview)|Android\s*(?:浏览器|网页|H5|Web|webview|browser|web)|iPad\s*(?:浏览器|网页|H5|Web|browser|web)|\b(Safari|Chrome|Edge|UC|QQ浏览器|QQ\s+Browser)\b/i;
+// 小程序信号：小程序 / 微信小程序 / miniprogram / mini program / AppService（小程序逻辑层专有名词）。
+// 命中即锁定 miniprogram，并像 web 一样压制 native 单字与 native 兜底，
+// 避免「PC 微信小程序…没有原生 WebSocket」这类描述里的「原生」被 PLATFORM_NATIVE_SIGNAL 误命中后兜底成 android。
+const PLATFORM_MINIPROGRAM_SIGNAL = /小程序|微信小程序|\bmini[-\s]?program\b|\bminiprogram\b|\bAppService\b/i;
 // 平台+产品复合词（运行形态 + 产品线路标识）
 const WEB_PRODUCT_PAIR_SIGNAL = /\bweb\s+(trtc|sdk|im|chat|roomkit)\b|\b(trtc|sdk|im|chat|roomkit)\s+web\b|trtc[-\s]?sdk|trtc\.js/i;
 // API 词（客户端调用形态）
@@ -42,12 +46,19 @@ function collectPromptSignals(prompt) {
     if (TRTC_SIGNAL.test(prompt))
         products.add('trtc');
     // 平台 tokens：web signal 锁定 → 压制 native 单字(安卓/iOS 仅归 hostEnv);
+    // miniprogram signal 锁定 → 同样压制 native 单字与 native 兜底(小程序逻辑层"没有原生 X"不应被判成 native)。
     // 真复合词(unreal/unity/harmonyos/react-native/flutter/c++)不受影响。
     const platforms = [];
     const webLocked = PLATFORM_WEB_SIGNAL.test(prompt) || WEB_PRODUCT_PAIR_SIGNAL.test(prompt);
     if (webLocked) {
         platforms.push('web');
     }
+    // 小程序信号优先级高于 native 单字/兜底：命中即锁定 miniprogram。
+    // web + 小程序可同时成立(如"小程序 web-view"),各自入 platforms 由 search core 做多平台归并。
+    const mpLocked = PLATFORM_MINIPROGRAM_SIGNAL.test(prompt);
+    if (mpLocked) {
+        platforms.push('miniprogram');
+    }
     const nativeSpecificHits = [];
     if (/\b(?:unreal|UE[45]?|unreal-engine)\b/i.test(prompt))
         nativeSpecificHits.push('unreal-engine');
@@ -61,17 +72,18 @@ function collectPromptSignals(prompt) {
         nativeSpecificHits.push('flutter');
     if (/\b(?:c\+\+)\b/i.test(prompt))
         nativeSpecificHits.push('c++');
-    // 安卓/iOS 单字只在非 web-locked 时进 platforms(web-locked 时仅归 hostEnv)
-    if (!webLocked && /\b(?:ios|iphone|ipad|苹果)\b/i.test(prompt))
+    // 安卓/iOS 单字只在非 web-locked 且非 miniprogram-locked 时进 platforms(否则仅归 hostEnv)
+    if (!webLocked && !mpLocked && /\b(?:ios|iphone|ipad|苹果)\b/i.test(prompt))
         nativeSpecificHits.push('ios');
-    if (!webLocked && /\b(?:android|安卓)\b/i.test(prompt))
+    if (!webLocked && !mpLocked && /\b(?:android|安卓)\b/i.test(prompt))
         nativeSpecificHits.push('android');
-    // 真复合词(如 unity/unreal/flutter/harmonyos/react-native/c++)无条件 push;单字在 webLocked 时被压制
+    // 真复合词(如 unity/unreal/flutter/harmonyos/react-native/c++)无条件 push;单字在 web/miniprogram 锁定时被压制
     if (nativeSpecificHits.length > 0) {
         platforms.push(...nativeSpecificHits);
     }
-    else if (!webLocked && PLATFORM_NATIVE_SIGNAL.test(prompt)) {
-        // 仅 "native" 词,未指定细分 → 默认 android(webLocked 时不触发 fallback,避免被 \b(android|ios|...) 反向命中把 web 路径覆盖成 native)
+    else if (!webLocked && !mpLocked && PLATFORM_NATIVE_SIGNAL.test(prompt)) {
+        // 仅 "native" 词,未指定细分 → 默认 android(web/miniprogram 锁定时不触发 fallback,
+        // 避免被 \b(android|ios|...) 或"原生"反向命中把 web/小程序 路径覆盖成 native)
         platforms.push('android');
     }
     // Host env：仅用于标记，不进 platforms 归一化

package/utils/report-cls-client.js

@@ -28,7 +28,7 @@ function sendCLSReport(reportData) {
     const time = Date.now();
     const data = {
         platform: 'mcp',
-        verison: '1.7.2',
+        verison: '1.7.3',
         sdkappid: `${SDKAppID}`,
         method: method,
         userid: queryID || userID,

package/utils/report-es-client.js

@@ -7,7 +7,7 @@ function reportESClient(reportData) {
         report: [
             {
                 platform: 'mcp',
-                version: '1.7.2',
+                version: '1.7.3',
                 sdkappid: `${SDKAppID}`,
                 method: method,
                 userID: `${userID}`,