@tencentcloud/sdk-mcp 1.7.2 → 1.7.4

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

@@ -0,0 +1,80 @@
+视频会议 SDK 基于腾讯云即时通信 IM 与实时音视频 TRTC 提供服务，支持在内网 / 防火墙环境下统一配置 IM 与 TRTC 代理，适用于私有化部署、企业内网隔离等无法直连腾讯云服务的场景。
+
+## 代理架构
+
+|代理服务器|代理链路|
+|---------|---------|
+|IM 代理|代理 IM 登录、消息收发等信令通道（WebSocket），以及聊天图片、文件等资源的上传与下载。|
+|TRTC WebSocket 代理（如 Nginx）|代理 TRTC 进房、控制等信令通道（WebSocket），负责房间管理与用户状态同步。|
+|TRTC TURN Server|中继转发 TRTC 音视频媒体流。|
+
+> **说明：**
+> 代理服务器（IM 代理、Nginx、TURN）需自行部署，搭建方式参见 [TRTC Web SDK 应对防火墙受限](https://web.sdk.qcloud.com/trtc/webrtc/v5/doc/zh-cn/tutorial-34-advanced-proxy.html)。
+>
+
+## 接口与参数
+
+视频会议 SDK 支持用户在调用 `login()` 之前通过 `callExperimentalAPI` 接口统一配置内网代理：
+``` typescript
+callExperimentalAPI({
+  api: 'setNetworkProxy',
+  params: {
+    im?: { /* IM 代理参数 */ },
+    rtc?: { /* TRTC 代理参数 */ },
+  },
+});
+```
+
+### IM 代理参数
+
+|参数|类型|说明|
+|---------|---------|---------|
+|`proxyServer`|String|IM 信令 WebSocket 代理地址。|
+|`fileUploadProxy`|String|IM 文件上传代理地址。|
+|`fileDownloadProxy`|String|IM 文件下载代理地址。|
+
+### TRTC 代理参数
+
+|参数|类型|说明|
+|---------|---------|---------|
+|`websocketProxy`|String|TRTC 信令 WebSocket 代理地址，如 `wss://proxy.example.com/ws/`。|
+|`turnServer`|Array|TURN 服务器列表，每项含 `url` / `username` / `credential`。|
+|`iceTransportPolicy`|`'relay' \| 'all'`|客户端 ICE 传输策略；内网环境建议设为 `'relay'`，强制连接 TURN server。|
+
+## 示例代码
+
+``` typescript
+import { conference } from '@tencentcloud/roomkit-web-react';
+
+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 });
+```
+
+## 常见问题
+
+### 用户在外网正常进会，但是内网无法进会？
+
+检查是否在 `login()` 前调用了 `setNetworkProxy`；若已配置仍失败，排查 TURN 端口与代理服务器出站白名单。
+
+### 用户能进会但看不到远端画面、听不到远端声音？
+
+确认 `turnServer` 可达，内网环境将 `iceTransportPolicy` 设为 `'relay'`。
+

package/resource/knowledge/roomkit/preset/react/integration.md

@@ -2,208 +2,6 @@ TUIRoomKit 是腾讯云推出的音视频房间 UI 应用。本次升级引入
 
 本文档介绍如何将 TUIRoomKit 集成到现有的 React 项目中，同时介绍如何对 TUIRoomKit 的样式、布局及功能进行自定义修改。
 
-<style>
-.vsdk-survey-card * {
-  box-sizing: border-box;
-}
-
-.vsdk-survey-card {
-  position: relative;
-  display: flex;
-  align-items: center;
-  justify-content: space-between;
-  gap: 20px;
-  padding: 18px 22px;
-  margin: 16px 0;
-  border-radius: 14px;
-  width: 90%;
-  overflow: hidden;
-  background: linear-gradient(180deg, #FFFFFF 0%, #F8FBFF 100%);
-  border: 1px solid #D7E8FF;
-  box-shadow: 0 4px 16px rgba(0,110,255,.05);
-  transition: all .25s ease;
-}
-
-.vsdk-survey-card::before{
-  content:"";
-  position:absolute;
-  right:-60px;
-  top:-60px;
-  width:180px;
-  height:180px;
-  background:radial-gradient(circle,
-      rgba(0,110,255,.16) 0%,
-      rgba(0,110,255,.08) 45%,
-      transparent 75%);
-  pointer-events:none;
-}
-
-.vsdk-survey-card::after{
-  content:"";
-  position:absolute;
-  left:-40px;
-  bottom:-60px;
-  width:120px;
-  height:120px;
-  background:radial-gradient(circle,
-      rgba(76,169,255,.08),
-      transparent 70%);
-  pointer-events:none;
-}
-
-.vsdk-survey-card:hover{
-  border-color:#006EFF;
-  box-shadow:
-      0 10px 28px rgba(0,110,255,.10),
-      0 0 36px rgba(0,110,255,.08);
-  transform:translateY(-2px);
-}
-
-.vsdk-card-left{
-  display:flex;
-  align-items:center;
-  gap:14px;
-  flex:1;
-  min-width:0;
-  position:relative;
-  z-index:1;
-}
-
-.vsdk-ico{
-  width:46px;
-  height:46px;
-  flex:0 0 46px;
-  border-radius:12px;
-  background:linear-gradient(180deg,#EDF5FF,#DCEBFF);
-  display:flex;
-  align-items:center;
-  justify-content:center;
-  font-size:22px;
-  box-shadow:
-      inset 0 1px 0 rgba(255,255,255,.8),
-      0 6px 18px rgba(0,110,255,.12);
-}
-
-.vsdk-text{
-  min-width:0;
-}
-
-.vsdk-title{
-  display:flex;
-  align-items:center;
-  gap:8px;
-  flex-wrap:wrap;
-  font-size:18px;
-  font-weight:600;
-  color:#1F2329;
-  line-height:1.4;
-}
-
-.vsdk-badge{
-  padding:2px 8px;
-  border-radius:999px;
-  background:#EAF3FF;
-  color:#006EFF;
-  font-size:11px;
-  font-weight:600;
-}
-
-.vsdk-desc{
-  margin-top:6px;
-  font-size:13px;
-  line-height:1.7;
-  color:#4E5969;
-}
-
-.vsdk-card-right{
-  flex-shrink:0;
-  position:relative;
-  z-index:1;
-}
-
-.vsdk-cta{
-  display:inline-flex;
-  align-items:center;
-  justify-content:center;
-  min-width:112px;
-  height:40px;
-  padding:0 22px;
-  border-radius:8px;
-  background:#006EFF;
-  color:#FFFFFF;
-  text-decoration:none;
-  font-size:14px;
-  font-weight:600;
-  box-shadow:0 8px 20px rgba(0,110,255,.25);
-  transition:all .2s ease;
-}
-
-.vsdk-cta:hover{
-  background:#0052D9;
-  box-shadow:0 10px 24px rgba(0,110,255,.35);
-}
-
-@media (max-width:768px){
-
-.vsdk-survey-card{
-    flex-direction:column;
-    align-items:flex-start;
-}
-
-.vsdk-card-left{
-    width:100%;
-    align-items:flex-start;
-}
-
-.vsdk-title{
-    font-size:16px;
-}
-
-.vsdk-desc{
-    font-size:12px;
-}
-
-.vsdk-card-right{
-    width:100%;
-    margin-top:14px;
-}
-
-.vsdk-cta{
-    width:100%;
-}
-
-}
-</style>
-
-<div class="vsdk-survey-card">
-
-<div class="vsdk-card-left">
-
-<div class="vsdk-ico">💡</div>
-
-<div class="vsdk-text">
-
-<div class="vsdk-title">
-有接入卡点？30 秒反馈
-<span class="vsdk-badge">全部选填</span>
-</div>
-
-<div class="vsdk-desc">
-正在了解或评估视频会议 SDK？UI、功能、文档或套餐开通如有卡点，欢迎填写反馈。
-</div>
-
-</div>
-
-</div>
-
-<div class="vsdk-card-right">
-<a class="vsdk-cta" href="https://wj.qq.com/s2/27395009/ac34/" target="_blank">
-填写反馈
-</a>
-</div>
-
-</div>
-
 ## 前提条件
 
 ### 开通服务

package/resource/knowledge/roomkit/preset/uniapp-app/integration.md

@@ -0,0 +1,279 @@
+本文档介绍如何在 uniapp 业务项目中集成 TUIRoomKit，快速获得开箱即用的多人音视频会议能力。
+
+## 前提条件
+
+### 开通服务
+
+请参考 开通服务 领取 TUIRoomKit 体验版，并在 [应用管理](https://console.cloud.tencent.com/trtc) 页面获取以下信息：
+- **SDKAppID**：应用标识（必填），腾讯云基于 SDKAppID 完成计费统计。
+
+- **SDKSecretKey**：应用密钥，用于初始化配置文件的密钥信息。
+
+### 环境准备
+- **IDE**： HBuilderX 升级到新版本。
+
+- **语言**： nvue。
+
+- **运行环境**： Node.js v12 版本及以上。
+
+- **包管理**： npm (版本需与 Node 版本匹配)。
+
+- **支持平台**： uni-app 打包 App。
+
+## 集成步骤
+
+### 步骤1：创建项目
+
+打开 HBuilderX，在菜单栏中选择**文件 > 新建 > 项目**，创建一个名为 `room-example` 的 uni-app vue3 项目。
+
+### 步骤2：安装 TUIKit 插件
+
+进入[【官方】腾讯云聊天+通话+直播响应式 SDK](https://ext.dcloud.net.cn/plugin)。点击**下载插件并导入 HBuilderX**，将插件导入 `room-example` 项目中。
+
+### 步骤3：配置原生模块与 Android 权限
+
+【Android 权限配置】
+
+``` json
+<uses-permission android:name="android.permission.CAMERA"/>
+<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE"/>
+<uses-permission android:name="android.permission.RECORD_AUDIO" />
+<uses-permission android:name="android.permission.INTERNET"/>
+<uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE"/>
+```
+
+【iOS 权限配置】
+
+``` java
+"privacyDescription" : {
+    "NSCameraUsageDescription" : "应用需要访问您的相机以进行直播",
+    "NSMicrophoneUsageDescription" : "应用需要访问您的麦克风以进行直播"
+},
+"UIBackgroundModes" : [ "audio" ]
+```
+
+### 步骤4：集成 TUIKit
+1. **拷贝 TUIKit 页面及静态资源**：将 `⁠uni_modules/tuikit-atomic-x/quickstart_room/`⁠下的`⁠pages/*⁠` 拷贝到项目 `page`⁠ 目录，⁠`static/*⁠` 拷贝到项目 `static` 目录下。
+
+【Windows 端】
+``` bash
+xcopy /E /I /Y "uni_modules\tuikit-atomic-x\quickstart_room\static\*" "static\" && xcopy /E /I /Y "uni_modules\tuikit-atomic-x\quickstart_room\pages\*" "pages\"
+```
+
+【Mac 端】
+``` bash
+cp -r uni_modules/tuikit-atomic-x/quickstart_room/static/* static/ && cp -r uni_modules/tuikit-atomic-x/quickstart_room/pages/* pages/
+```
+
+   2. **配置页面路由：**替换 `pages.json` 内容，注册所需页面路由：
+
+   ``` json
+   {
+     "pages": [
+       {
+         "path": "pages/login/login",
+         "style": {
+           "navigationStyle": "custom"
+         }
+       },
+       {
+         "path": "pages/index/index",
+         "style": {
+           "navigationStyle": "custom"
+         }
+       },
+       {
+         "path": "pages/scenes/room/index",
+         "style": {
+           "navigationStyle": "custom"
+         }
+       },
+       {
+         "path": "pages/scenes/room/join/index",
+         "style": {
+           "navigationStyle": "custom"
+         }
+       },
+       {
+         "path": "pages/scenes/room/create/index",
+         "style": {
+           "navigationStyle": "custom"
+         }
+       },
+       {
+         "path": "pages/scenes/room/main/index",
+         "style": {
+           "navigationStyle": "custom",
+           "disableScroll": true,
+           "disableSwipeBack": true
+         }
+       }
+     ],
+     "globalStyle": {
+       "navigationBarTextStyle": "black",
+       "navigationBarTitleText": "腾讯云 IM",
+       "navigationBarBackgroundColor": "#EBF0F6",
+       "backgroundColor": "#F8F8F8"
+     }
+   }
+   ```
+
+## 运行和测试
+
+> **说明：**
+> 接入过程中遇到任何卡点或有改进建议，欢迎通过 [视频会议 SDK 接入反馈问卷](https://wj.qq.com/s2/27395009/ac34/) 反馈，官方会及时跟进处理。
+>
+
+### 步骤1：**制作自定义基座**
+
+点击**运行** > **运行到手机或模拟器** > **制作自定义调试基座**。
+
+> **说明：**
+> 首次制作自定义基座需要下载 Gradle 依赖，Android 通常需要 10～20 分钟，iOS 需要 5～10 分钟。过程中请勿中断。
+>
+
+### 步骤2：**登录**
+
+在 `pages/login/login.vue` 中，填入 `SDKAppID`、 `userID`、`SecretKey`，点击**登录**。
+| 参数 | 类型 | 说明 |
+| --- | --- | --- |
+| SDKAppID | Number | SDKAppID 是 RoomKit 客户应用的唯一标识。您可以在 <a href="https://console.cloud.tencent.com/trtc">TRTC 控制台 > 应用管理</a> 创建新应用获取 。<br><strong>说明：</strong><br>SDKAppID 是 RoomKit 客户应用的唯一标识。我们建议每一个独立的 App 都申请一个新的 SDKAppID。不同 SDKAppID 之间是天然隔离的，不能互通。 |
+| SecretKey | String | SecretKey 是 RoomKit 客户应用的密钥。您可以在 <a href="https://console.cloud.tencent.com/trtc">TRTC 控制台 > 应用管理</a> 对应应用获取。<br><strong>安全提示：</strong><br>- 项目示例支持通过 <code>genTestUserSig</code> 函数生成 <code>userSig</code>。该方法中 <code>SecretKey</code> 很容易被反编译逆向破解，一旦您的密钥泄露，攻击者就可以盗用您的腾讯云流量。<strong>该方法仅适合本地跑通功能调试</strong>。 正确的 UserSig 签发方式请参见 <a href="https://cloud.tencent.com/document/product/647/17275#formal">服务端生成 UserSig</a>。<br>- 敏感信息（SecretKey）仅用于 Demo 测试，不可提交到代码仓库或用于生产环境。 |
+| userID | String | 用户的唯一标识符，由您定义，只能包含大小写字母（a-z，A-Z）、数字（0-9）、下划线和连字符。 |
+
+``` java
+
+import { ref } from 'vue'
+import { useLoginState } from '@/uni_modules/tuikit-atomic-x/state/LoginState';
+import { genTestUserSig  } from '@/uni_modules/tuikit-atomic-x/debug/GenerateTestUserSig';
+const { login } = useLoginState();
+
+const sdkAppId = 0; // SDKAppID
+const userId = ref(''); // userID
+const secretKey = ''; // SecretKey
+
+// 登录
+login({
+  sdkAppID: sdkAppId,
+  userID: userId.value,
+  userSig: genTestUserSig({
+    SDKAppID: sdkAppId,
+    userID: userId.value,
+    secretKey: secretKey
+  }).userSig,
+  success: () => {
+    uni.reLaunch({ url: '/pages/scenes/chat/conversationList/conversationList' })
+  },
+  fail: (code: number, msg: string) => {
+    uni.showToast({ title: msg || '登录失败', icon: 'none' })
+  }
+})
+```
+
+### 步骤3：**运行项目**
+
+点击**运行** > **运行到手机或模拟器** > **运行到 Android/iOS 基座**，使用制作好的**自定义基座**运行到手机。
+
+## AI 助手：知识咨询与代码集成
+
+您在接入视频会议 SDK 过程中，可以通过 MCP 使用 AI 助手，快速完成知识咨询、报错排查和集成代码生成。支持 Web/Android/iOS/Flutter/uni-app/HarmonyOS 等平台，答案基于官方文档。适用于查询 Room 组件和 AtomicXCore SDK 用法以及集成文档等场景，[立即体验，提出您的第一个问题](https://cloud.tencent.com/document/product/647/129285)。
+
+## 高级功能
+
+### 屏幕共享
+
+#### Android - 无需配置
+
+开箱即用。
+
+#### iOS - 需配置 Broadcast Upload Extension
+
+##### **步骤1：生成并绑定** Extension
+
+使用您的账号 [登录](https://developer.apple.com/)，进行以下操作，注意完成后需要下载对应的 Provisioning Profile。
+1. 单击 Certificates, IDs & Profiles。
+
+2. 在右侧的界面中单击加号。
+
+3. 选择 App Groups，单击 Continue。
+
+4. 在弹出的表单中填写 Description 和 Identifier，其中 Identifier 需要传入接口中的对应的 AppGroup 参数。完成后单击 Continue。
+
+5. 回到 Identifier 页面，左上边的菜单中选择 App IDs，然后单击您的 App ID（主 App 与 Extension 的 AppID 需要进行同样的配置）。
+
+6. 选中 App Groups 并单击 Edit。
+
+7. 在弹出的表单中选择您之前创建的 App Group，单击 Continue 返回编辑页，单击 Save 保存。
+
+##### **步骤2：配置屏幕共享扩展。**
+
+2. 在 `nativeResources/ios` 下新建 `ios-extension.json` 文件，配置文件内容如下：
+
+   |参数|说明|
+   |---------|---------|
+   |identifier|步骤1中 Apple 开发者后台创建的 Extension 的 Bundle ID。|
+   |profile|`nativeResources/ios` 下的 .mobileprovision 的文件名。|
+   |entitlements.com.apple.security.application-groups|步骤1中 Apple 开发者后台创建的 App Group ID。|
+
+   ``` java
+    {
+      "ScreenShareExtension.appex": {
+        "identifier": "xxx",
+        "profile": "xxx.mobileprovision",
+        "entitlements": {
+          "com.apple.security.application-groups": ["xxx"]
+        }
+      }
+    }
+   ```
+
+3. 在 `nativeResources/ios` 下新建 UniApp.entitlements 文件，配置文件内容如下：
+
+   |**参数**|**说明**|
+   |---------|---------|
+   |com.apple.security.application-groups|步骤1中 Apple 开发者后台创建的 App Group ID。|
+
+   ``` xml
+   <?xml version="1.0" encoding="UTF-8"?>
+   <plist version="1.0">
+    <dict>
+      <key>com.apple.security.application-groups</key>
+      <array>
+        <string>xxx</string>
+      </array>
+    </dict>
+   </plist>
+   ```
+
+4. 在 项目根目录下新建 `Info.plist` 文件，配置文件内容如下：
+
+   |**参数**|**说明**|
+   |---------|---------|
+   |TUIRoomAppGroup|步骤1中 Apple 开发者后台创建的 App Group ID。|
+
+   ``` xml
+   <?xml version="1.0" encoding="UTF-8"?>
+   <plist version="1.0">
+    <dict>
+      <key>TUIRoomAppGroup</key>
+      <string>xxx</string>
+    </dict>
+   </plist>
+   ```
+
+##### **步骤3：**重新制作自定义基座**。**
+
+点击**运行** > **运行到手机或模拟器** > **制作 iOS 自定义调试基座。**
+
+## 常见问题
+
+#### **该 TUIKit 插件是否支持编译到 H5 或微信小程序？**
+
+**不支持。**由于新版 TUIKit 基于 **UTS (Uni-app Type Script)** 插件架构开发，深度依赖 Android 和 iOS 的原生能力（如原生渲染引擎、本地数据库、音视频编解码），因此仅支持打包为 **App (Android/iOS)**。
+
+#### **我的现有项目全是** `.vue` **页面（Webview 渲染），能直接集成吗？**
+
+**可以混用，但需要注意页面模式。**
+
+nvue 页面和 vue 页面可以互相跳转，但是 vue 页面的子组件不建议是 nvue 组件。TUIKit 的 UI 组件是 nvue 组件，因此使用 TUIKit 所在的**页面（pages）**必须也是 nvue 文件。
+

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

@@ -0,0 +1,69 @@
+TUIRoomKit 内置 AI 会议助手功能，为在线会议提供 AI 智能辅助。会议界面默认提供 AI 会议助手入口按钮，用户可通过该按钮使用以下核心功能：
+- **AI 实时字幕：**在会议进行中，实时将语音讨论内容转化为文字字幕并显示在屏幕上，辅助沟通与理解。
+
+- **AI 实时翻译：**开启 AI 实时字幕后，默认同步开启实时翻译功能。房主可设置翻译语言，具体支持的语言。
+
+- **AI 实时会议记录：**在会议进行中，持续将语音讨论内容转录为文本记录，便于会后整理与回顾。
+
+## 前提条件
+
+### 1. 开通智能语音服务
+
+使用 AI 功能，会产生费用消耗，计费规则参考 AI 智能语音。
+
+### 2. 基础环境集成
+
+请参考 [快速接入](https://cloud.tencent.com/document/product/647/81962) 将 `@tencentcloud/roomkit-web-vue3` 集成到项目中，确保版本 `≥ 5.1.2`。
+
+## 显示或隐藏 AI 会议助手
+
+AI 会议助手入口按钮默认显示在会议界面，无需额外配置即可使用。如需隐藏或重新显示该按钮，可调用 `conference.setWidgetVisible` 接口控制 `AIToolsWidget` 组件的可见性。
+
+> **说明：**
+> 入口按钮显示后不会自动开启转录任务，需由房主主动点击「AI 实时字幕」或「AI 实时会议记录」后，组件内部才会开启 AI 转录任务。
+>
+
+``` typescript
+<template>
+  <ConferenceMainView />
+</template>
+
+<script setup lang="ts">
+import { conference, BuiltinWidget } from '@tencentcloud/roomkit-web-vue3';
+
+// AI 会议助手入口按钮默认显示；如需隐藏，可将其可见性设为 false
+conference.setWidgetVisible({ [BuiltinWidget.AIToolsWidget]: false });
+</script>
+```
+
+## 关闭 AI 会议助手
+
+使用 **AI 会议助手**组件时，开发者无需手动关闭 AI 转录任务。组件内部已实现自动清理机制：
+- **退出房间时**：自动停止 AI 转录任务。
+
+- **资源释放**：自动清理相关内存资源。
+
+## 开发注意事项
+- **版本依赖**：AI 会议助手功能需要 `@tencentcloud/roomkit-web-vue3` 版本 ≥ 5.1.2，请确保已安装符合要求的版本。
+
+- **调用时机：**入口按钮默认显示，无需额外配置。如需通过 `conference.setWidgetVisible` 调整按钮的显示状态，请确保该代码在 `ConferenceMainView` 加载前执行。
+
+- **计费逻辑：**AI 转录任务由房主主动开启，同一个房间只计费一次，普通成员使用不会重复计费。
+
+- **网络要求：**AI 识别依赖稳定的上行网络，网络抖动可能导致字幕出现延迟或丢失。
+
+## 常见问题
+
+### 会议界面未出现“AI 会议助手”按钮？
+
+**问题描述：**已集成 TUIRoomKit，但会议界面未出现“AI 会议助手”按钮。
+
+**解决方案：**AI 会议助手入口按钮默认显示，若未出现请依次排查：1. 是否调用了 `conference.setWidgetVisible` 将 `AIToolsWidget` 设为了 `false`；2. 当前是否为直播（Webinar）房间，该场景暂不展示该按钮；3. `@tencentcloud/roomkit-web-vue3` 版本是否符合要求。
+
+### 房间内所有成员都能使用 AI 功能吗？
+
+**功能说明**：转录任务仅房主可开启。房主点击开启 AI 转录任务后，房间内所有成员均可使用 AI 实时字幕与会议记录功能。
+
+### AI 功能是否会产生重复计费？
+
+**计费说明**：不会重复计费。转录任务仅由房主开启一次，因此每个会议房间只会产生一次计费。若房主未开启转录任务，则不会开启转录，也不会产生相关费用。

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

@@ -0,0 +1,67 @@
+AI 降噪源自腾讯天籁实验室的 AI 算法，能够智能检测和去除混合在传播信号中的噪声干扰，从而显著提高语音的质量，提升声音的清晰度，改善用户听感。AI 降噪特性在 TUIRoomKit 中的应用，可以让用户在办公室、网吧、商场、户外等各种环境下都能够获得清晰、稳定的声音体验。
+
+## 在线体验
+
+您也可以进入我们的 [实时音视频体验馆](https://rtcube.cloud.tencent.com/component/experience-center/index.html#/detail)，在线体验 AI 降噪能力带来的优秀声音效果。
+
+#
+
+## 开通 AI 降噪
+
+TUIRoomKit 提供了非常便捷的开通流程，您只需要两个步骤即可体验：
+1. 进入 实时音视频控制台 ，选择您需要开通的应用。
+
+2. 进入增值功能，打开 AI 降噪开关即可。
+
+   然后您就可以在您的应用上愉快的体验 TUIRoomKit 更好的降噪效果了！
+
+## Web 端资源配置
+
+TUIRoomKit 在用户进房后会自动开启 AI 降噪，前提是您已完成以下 assets 资源配置：
+1. 将 `node_modules/trtc-sdk-v5/plugins/ai-denoiser` 目录下的 `denoiser-wasm.js` 文件发布至 CDN 或静态资源服务器中，并确保文件处于同一个公共路径下。详细说明请参见 [AI 降噪插件文档](https://web.sdk.qcloud.com/trtc/webrtc/v5/doc/zh-cn/tutorial-35-advanced-ai-denoiser.html)。
+
+2. 在进房前，调用以下接口将上述公共路径传入 TUIRoomKit：
+
+【含 UI 集成】
+
+【Vue3】
+``` typescript
+import { conference } from '@tencentcloud/roomkit-web-vue3';
+
+conference.callExperimentalAPI({
+  api: 'setRtcAssetsPath',
+  params: { assetsPath: 'XXXXX/assets/' }, // denoiser-wasm.js 文件所在目录路径
+});
+```
+
+【React】
+``` typescript
+import { conference } from '@tencentcloud/roomkit-web-react';
+
+conference.callExperimentalAPI({
+  api: 'setRtcAssetsPath',
+  params: { assetsPath: 'XXXXX/assets/' }, // denoiser-wasm.js 文件所在目录路径
+});
+```
+
+【无 UI 集成】
+
+【Vue3】
+``` typescript
+import { callExperimentalAPI } from 'tuikit-atomicx-vue3';
+
+callExperimentalAPI({
+  api: 'setRtcAssetsPath',
+  params: { assetsPath: 'XXXXX/assets/' }, // denoiser-wasm.js 文件所在目录路径
+});
+```
+
+【React】
+``` typescript
+import { callExperimentalAPI } from 'tuikit-atomicx-react';
+
+callExperimentalAPI({
+  api: 'setRtcAssetsPath',
+  params: { assetsPath: 'XXXXX/assets/' }, // denoiser-wasm.js 文件所在目录路径
+});
+```