@tencentcloud/sdk-mcp 1.2.5 → 1.2.7

package/resource/doc/roomkit/common/error_code.md

@@ -0,0 +1,67 @@
+---
+product: 'Room'
+tech_stack: 'roomKit'
+framework: 'common'
+title: 'roomKit 错误码大全'
+keywords: ['错误码', '报错', 'roomKit', 'room 套餐问题', '麦克风权限问题', '摄像头/麦克风问题']
+---
+
+# RoomKit 错误码大全
+
+## RoomKit 错误码 (Topic: RoomKit Error Code)
+
+## 错误码 -2
+**原因：** 操作频率超限，请求过于频繁，请稍后重试。
+**解决方案：** 操作频率超限，请求过于频繁，请稍后重试。
+
+## 错误码 -1002
+**原因：** SDK 未初始化。
+**解决方案：** 请先调用初始化接口完成 SDK 初始化。
+
+## 错误码 -1004
+**原因：** 未购买套餐包或者已欠费。
+**解决方案：** 请前往[腾讯云控制台](https://buy.cloud.tencent.com/trtc)购买。首次使用，可以[开通体验版](https://cloud.tencent.com/document/product/647/105439)</a>。
+
+## 错误码 -1101
+**原因：** 摄像头权限被拒绝。
+**解决方案：** 请检查浏览器设置，确保已允许使用您的摄像头。如果您确认已授予权限， 请前往 [音视频能力检测工具] 检查您的设备和环境是否支持： https://web.sdk.qcloud.com/trtc/webrtc/demo/detect/index.html
+
+## 错误码 -1105
+**原因：** 麦克风权限被拒绝。
+**解决方案：** 请检查浏览器设置，确保已允许使用您的麦克风。如果您确认已授予权限， 请前往 [音视频能力检测工具] 检查您的设备和环境是否支持： https://web.sdk.qcloud.com/trtc/webrtc/demo/detect/index.html
+
+## 错误码 -1100
+**原因：** 打开摄像头失败。
+**解决方案：** 请检查浏览器设置，确保已允许使用您的摄像头。如果您确认已授予权限， 请前往 [音视频能力检测工具] 检查您的设备和环境是否支持： https://web.sdk.qcloud.com/trtc/webrtc/demo/detect/index.html
+
+## 错误码 -1104
+**原因：** 打开麦克风失败。
+**解决方案：** 请检查浏览器设置，确保已允许使用您的麦克风。如果您确认已授予权限， 请前往 [音视频能力检测工具] 检查您的设备和环境是否支持： https://web.sdk.qcloud.com/trtc/webrtc/demo/detect/index.html
+
+## 错误码 100007
+**原因：** 
+**解决方案：** 未购买套餐包或者已欠费，请前往[腾讯云控制台购买](https://buy.cloud.tencent.com/trtc)。首次使用，可以[开通体验版](https://cloud.tencent.com/document/product/647/105439)。
+
+## 错误码 70001
+**原因：** 用户签名已过期。
+**解决方案：** 建议生成的签名有效期不少于 24 小时。可参阅[生成 UserSig(用户鉴权)](https://cloud.tencent.com/document/product/269/32688)</a>。
+
+## 错误码 70003
+**原因：** 非法的用户签名。
+**解决方案：** 请重新生成。可参阅[生成 UserSig(用户鉴权)](https://cloud.tencent.com/document/product/269/32688)</a>。
+
+## 错误码 70014
+**原因：** SDKAppID 与用户签名不匹配。
+**解决方案：** 请检查。可前往[腾讯云控制台](https://console.cloud.tencent.com/trtc/usersigtool)验证签名。
+
+## 错误码 5300
+**原因：** 获取设备或者采集音视频出现异常。
+**解决方案：** 请前往 [音视频能力检测工具] 检查您的设备和环境是否支持： https://web.sdk.qcloud.com/trtc/webrtc/demo/detect/index.html
+
+## 错误码 5301
+**原因：** 未检测到摄像头/麦克风设备。
+**解决方案：** 请确保您的摄像头/麦克风已连接，并检查系统或浏览器设置中摄像头/麦克风是否可用。
+
+## 错误码 5302
+**原因：** 摄像头/麦克风权限被拒绝。
+**解决方案：** 请检查浏览器设置，确保已允许使用您的摄像头和麦克风。如果您确认已授予权限， 请前往 [音视频能力检测工具] 检查您的设备和环境是否支持： https://web.sdk.qcloud.com/trtc/webrtc/demo/detect/index.html

package/resource/doc/rtcengine/faq/common/userSig.md

@@ -0,0 +1,309 @@
+## 概览
+
+本文档主要介绍腾讯云实时音视频（TRTC）服务的两种鉴权方式，目前，腾讯云实时音视频（TRTC）、即时通信（IM）等服务都采用了 UserSig 的鉴权方式。UserSig 是腾讯云设计的一种安全保护签名，目的是为了阻止恶意攻击者盗用您的云服务使用权。如果您要使用这些基础云服务，就需要在 SDK 初始化或登录函数中提供 SDKAppID，UserID 和 UserSig 三个关键信息，具体含义如下：
+- SDKAppID 用于标识您的应用。
+
+- UserID 用于标识您的用户。
+
+- UserSig 则是基于前两者计算出的安全签名，它由 **HMAC SHA256** 加密算法计算得出。只要攻击者不能伪造 UserSig，就无法盗用您的云服务流量。
+
+
+## 在调试阶段如何计算 UserSig？
+
+如果您希望快速跑通 Demo，了解 TRTC SDK 相关能力，您可以通过 [客户端示例代码](https://write.woa.com/#client) 和 [控制台](https://write.woa.com/#console) 两种方法计算获取 UserSig，具体请参见以下介绍。
+
+> **不安全：**
+> 
+
+> 注意，如下两种 UserSig 获取计算方案仅适用于调试，如果产品要正式上线，**不推荐**采用这种方案，因为客户端代码（尤其是 Web 端）中的 SECRETKEY 很容易被反编译逆向破解。一旦您的密钥泄露，攻击者就可以盗用您的腾讯云流量。
+> 
+
+
+### 客户端计算 UserSig
+
+#### **1. 获取 SDKAPPID 和密钥**：
+- 登录**实时音视频控制台** > [应用管理](https://console.cloud.tencent.com/trtc/app)。
+
+- 单击您需查看的 SDKAppID 对应的**应用信息**，单击进入**应用概览**。
+
+- **点击SDK密钥查看**密钥，即可获取用于计算 UserSig 的加密密钥。
+
+- 单击**复制密钥**，可将密钥拷贝到剪贴板中。
+
+   ![](https://write-document-release-1258344699.cos.ap-guangzhou.tencentcos.cn/100031390357/6db784719d3211f091df5254005ef0f7.png)
+
+
+#### **2. 计算 UserSig：**
+
+为了方便客户端使用，我们提供各平台计算 UserSig 的源码文件，您可直接下载使用：
+<table>
+<tr>
+<td rowspan="1" colSpan="1" >Android</td>
+
+<td rowspan="1" colSpan="1" >iOS</td>
+
+<td rowspan="1" colSpan="1" >Web</td>
+
+<td rowspan="1" colSpan="1" >微信小程序</td>
+
+<td rowspan="1" colSpan="1" >Windows（C++）</td>
+
+<td rowspan="1" colSpan="1" >Windows（C#）</td>
+
+<td rowspan="1" colSpan="1" >Flutter</td>
+
+<td rowspan="1" colSpan="1" >Mac</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >[GitHub](https://github.com/LiteAVSDK/TRTC_Android/tree/main/TRTC-API-Example/Debug/src/main/java/com/tencent/trtc/debug/GenerateTestUserSig.java)</td>
+
+<td rowspan="1" colSpan="1" >[GitHub](https://github.com/LiteAVSDK/TRTC_iOS/tree/main/TRTC-API-Example-OC/Debug/GenerateTestUserSig.h)</td>
+
+<td rowspan="1" colSpan="1" >[GitHub](https://github.com/LiteAVSDK/TRTC_Web/blob/main/quick-demo-js/js/libs/generateTestUserSig.js)</td>
+
+<td rowspan="1" colSpan="1" >[GitHub](https://github.com/LiteAVSDK/Live_WXMini/blob/main/TRTCScenesDemo/TUICallKit-WX-Demo/debug/GenerateTestUserSig.js)</td>
+
+<td rowspan="1" colSpan="1" >[GitHub](https://github.com/LiteAVSDK/TRTC_Windows/blob/main/TRTC-API-Example-C%2B%2B/TRTC-API-Example-Qt/src/Util/defs.h)</td>
+
+<td rowspan="1" colSpan="1" >[GitHub](https://github.com/LiteAVSDK/TRTC_Windows/blob/main/TRTC-API-Example-CSharp/TRTC-API-Example-CSharp/GenerateTestUserSig.cs)</td>
+
+<td rowspan="1" colSpan="1" >[GitHub](https://github.com/Tencent-RTC/TRTC_Flutter/blob/master/TRTC-API-Example/lib/debug/generate_test_user_sig.dart)</td>
+
+<td rowspan="1" colSpan="1" >[GitHub](https://github.com/LiteAVSDK/TRTC_Mac/tree/main/OCDemo/TRTCDemo/TRTC/GenerateTestUserSig.h)</td>
+</tr>
+</table>
+
+
+示例代码如下（当然您也可以参考我们各产品的 Demo 工程，详见各产品的开发文档）：
+
+
+
+
+【Android】
+``` java
+// Step1: 导入源码文件
+import com.xxx.xxx.GenerateTestUserSig;
+
+// Step2：填写上一步骤中获取到的 SDKAppID，SDK 密钥
+GenerateTestUserSig.SDKAPPID = xxxxxx;
+GenerateTestUserSig.SECRETKEY = "xxxxxx";
+
+// Step3：根据 userID，生成 userSig
+String userSig = GenerateTestUserSig.genTestUserSig("userID");
+```
+
+
+【iOS】
+``` objectivec
+// Step1: 导入头文件
+#import "GenerateTestUserSig.h"
+
+// Step2: 填写上一步骤中获取到的 SDKAppID，SDK 密钥
+[GenerateTestUserSig setSDKAPPID:xxxxxx];
+[GenerateTestUserSig setSECRETKEY:@"xxxxxx"];
+
+// Step3：根据 userID，生成 userSig
+NSString *userSig = [GenerateTestUserSig genTestUserSig:@"userID"];
+
+```
+
+
+【Web】
+``` javascript
+// Step1: 导入模块
+<script src='js/libs/lib-generate-test-usersig.min.js'></script>
+<script src='js/libs/generateTestUserSig.js'></script>
+
+// Step2：填写上一步骤中获取到的 SDKAppID，SDK 密钥、输入自定义的userID，生成 userSig
+const {sdkAppId, userSig } = genTestUserSig({
+	sdkAppId: xxxxxx, 
+	userId: 'xxxxxx',
+	sdkSecretKey: 'xxxxxx',
+}
+```
+
+
+【微信小程序】
+``` javascript
+// Step1: 导入模块
+import { genTestUserSig } from 'GenerateTestUserSig';
+
+// Step2：填写上一步骤中获取到的 SDKAppID，SDK 密钥、输入自定义的userID，生成 userSig
+const {userSig } = genTestUserSig({
+	sdkAppId: xx, 
+	userId: 'xxxxxx',
+	sdkSecretKey: 'xxxxxx'
+ })
+```
+
+
+【Window（C++）】
+``` cpp
+// Step1: 导入头文件
+#include "GenerateTestUserSig.h"
+
+// Step2：填写上一步骤中获取到的 SDKAppID，SDK 密钥
+const int SDKAPPID = xxxxxx;
+const char* SECRETKEY = "xxxxxx";
+
+// Step3：根据 userID，生成 userSig
+const char* userSig = GenerateTestUserSig::genTestUserSig("userID", SDKAPPID, SECRETKEY);
+```
+
+
+【Window（C#）】
+``` csharp
+// Step1: 导入头文件
+using GenerateTestUserSig;
+
+// Step2: 填写上一步骤中获取到的 SDKAppID 和 SDK 密钥
+GenerateTestUserSig.SDKAPPID = xxxxxx; 
+GenerateTestUserSig.SECRETKEY = "xxxxxx";
+
+// Step3：根据 userID，生成 userSig
+string userSig = GenerateTestUserSig.GetInstance().GenTestUserSig("userID");
+```
+
+
+【Flutter】
+``` django
+// Step1: 导入源码文件
+import 'package:xxx/GenerateTestUserSig.dart';
+
+// Step2: 填写上一步骤中获取到的 SDKAppID，SDK 密钥
+GenerateTestUserSig.SDKAPPID = xxxxxx;
+GenerateTestUserSig.SECRETKEY = "xxxxxx";
+
+// Step3：根据 userID，生成 userSig
+String userSig = GenerateTestUserSig.genTestUserSig("userID");
+```
+
+
+【Mac】
+``` objectivec
+// Step1: 导入头文件
+#import "GenerateTestUserSig.h"
+
+// Step2: 填写上一步骤中获取到的 SDKAppID，SDK 密钥
+[GenerateTestUserSig setSDKAPPID:xxxxxx];
+[GenerateTestUserSig setSECRETKEY:@"xxxxxx"];
+
+// Step3：根据 userID，生成 userSig
+NSString *userSig = [GenerateTestUserSig genTestUserSig:@"userID"];
+```
+
+### 控制台获取 UserSig
+- 登录**实时音视频控制台**，进入**开发辅助** > [UserSig生成&校验](https://console.cloud.tencent.com/trtc/usersigtool)。
+
+- 在签名（UserSig）生成工具下，选择对应的 SDKAppID 和 UserID。
+
+- 单击**生成签名(UserSig)**，即可计算得到对应的 UserSig。
+
+   ![](https://write-document-release-1258344699.cos.ap-guangzhou.tencentcos.cn/100031390357/5492b1619d3211f091df5254005ef0f7.png)
+
+
+## 在正式运行阶段如何计算 UserSig？
+
+业务正式运行阶段，TRTC 提供安全等级更高的服务端计算 UserSig 的方案，可以最大限度地保障计算 UserSig 用的密钥不被泄露，因为攻破一台服务器的难度要高于逆向一款 App。具体的实现流程如下：
+
+![](https://write-document-release-1258344699.cos.ap-guangzhou.tencentcos.cn/100023397867/eeb64e021c6411ed9c01525400d6c3c4.png)
+
+1. 您的 App 在调用 SDK 的初始化函数之前，首先要向您的服务器请求 UserSig。
+
+2. 您的服务器根据 SDKAppID 和 UserID 计算 UserSig，计算源码见文档前半部分。
+
+3. 服务器将计算好的 UserSig 返回给您的 App。
+
+4. 您的 App 将获得的 UserSig 通过特定 API 传递给 SDK。
+
+5. SDK 将 `SDKAppID + UserID + UserSig` 提交给腾讯云服务器进行校验。
+
+6. 腾讯云校验 UserSig，确认合法性。
+
+7. 校验通过后，会向 TRTCSDK 提供实时音视频服务。
+
+
+
+
+为了简化您的实现过程，我们提供了多个语言版本的 UserSig 计算源代码及其示例：
+<table>
+<tr>
+<td rowspan="1" colSpan="1" >语言版本</td>
+
+<td rowspan="1" colSpan="1" >签名算法</td>
+
+<td rowspan="1" colSpan="1" >源代码</td>
+
+<td rowspan="1" colSpan="1" >使用示例</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >Java</td>
+
+<td rowspan="1" colSpan="1" >HMAC-SHA256</td>
+
+<td rowspan="1" colSpan="1" >[genSig](https://github.com/tencentyun/tls-sig-api-v2-java/blob/master/src/main/java/com/tencentyun/TLSSigAPIv2.java)</td>
+
+<td rowspan="1" colSpan="1" >[GitHub](https://github.com/tencentyun/tls-sig-api-v2-java)</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >GO</td>
+
+<td rowspan="1" colSpan="1" >HMAC-SHA256</td>
+
+<td rowspan="1" colSpan="1" >[GenSig](https://github.com/tencentyun/tls-sig-api-v2-golang/blob/master/tencentyun/TLSSigAPI.go)</td>
+
+<td rowspan="1" colSpan="1" >[GitHub](https://github.com/tencentyun/tls-sig-api-v2-golang)</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >PHP</td>
+
+<td rowspan="1" colSpan="1" >HMAC-SHA256</td>
+
+<td rowspan="1" colSpan="1" >[genSig](https://github.com/tencentyun/tls-sig-api-v2-php/blob/master/src/TLSSigAPIv2.php)</td>
+
+<td rowspan="1" colSpan="1" >[GitHub](https://github.com/tencentyun/tls-sig-api-v2-php)</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >Node.js</td>
+
+<td rowspan="1" colSpan="1" >HMAC-SHA256</td>
+
+<td rowspan="1" colSpan="1" >[genSig](https://github.com/tencentyun/tls-sig-api-v2-node/blob/master/TLSSigAPIv2.js)</td>
+
+<td rowspan="1" colSpan="1" >[GitHub](https://github.com/tencentyun/tls-sig-api-v2-node)</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >Python</td>
+
+<td rowspan="1" colSpan="1" >HMAC-SHA256</td>
+
+<td rowspan="1" colSpan="1" >[genSig](https://github.com/tencentyun/tls-sig-api-v2-python/blob/master/TLSSigAPIv2.py)</td>
+
+<td rowspan="1" colSpan="1" >[GitHub](https://github.com/tencentyun/tls-sig-api-v2-python)</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >C#</td>
+
+<td rowspan="1" colSpan="1" >HMAC-SHA256</td>
+
+<td rowspan="1" colSpan="1" >[GenSig](https://github.com/tencentyun/tls-sig-api-v2-cs/blob/master/tls-sig-api-v2-cs/TLSSigAPIv2.cs)</td>
+
+<td rowspan="1" colSpan="1" >[GitHub](https://github.com/tencentyun/tls-sig-api-v2-cs)</td>
+</tr>
+</table>
+
+
+## 常见问题
+
+### **SDK 密钥如何切换为非对称密钥？**
+
+若查看密钥时只能获取公钥和私钥信息，可点击下图所示位置切换为最新的非对称密钥，请注意：切换密钥前请确保线上业务已停用。
+
+![](https://write-document-release-1258344699.cos.ap-guangzhou.tencentcos.cn/100026631907/1ce5156f039e11f09c4a5254001c06ec.png)

package/resource/doc/rtcengine/faq/{web.md → web/web.md}

@@ -1,4 +1,4 @@
-# Tutorial: 自动播放受限处理建议
+# 最佳实践: 自动播放受限处理建议
 
 ## 简介
 
@@ -83,7 +83,7 @@ function showCustomDialog(event) {
 - Android Webview 关闭自动播放限制：调用 [setMediaPlaybackRequiresUserGesture(false)](https://developer.android.com/reference/android/webkit/WebSettings#setMediaPlaybackRequiresUserGesture(boolean)) 关闭自动播放限制。
 - iOS Webview 关闭自动播放限制：[设置 mediaTypesRequiringUserActionForPlayback 为 WKAudiovisualMediaTypeNone](https://developer.apple.com/documentation/webkit/wkwebviewconfiguration/1851524-mediatypesrequiringuseractionfor)
 
-# Tutorial: 应对防火墙受限
+# 最佳实践: 应对防火墙受限
 
 ## 功能描述
 

package/resource/doc/rtcengine/web/{how_to_integrated_web_rtc_engine.md → how_to_integrated_web_sdk.md}

@@ -1,4 +1,6 @@
-# Tutorial: 开始集成音视频通话
+# 开始集成音视频通话
+## 说明
+RTC Engine Web SDK 也称为 TRTC Web SDK，是腾讯云实时音视频 Web SDK。提供 npm package name “trtc-sdk-v5”。
 
 ## 前提条件
 
@@ -32,10 +34,13 @@ import TRTC from 'trtc-sdk-v5';
 
 ```html
 <script src="trtc.js"></script>
+// or
+<script src="https://cdn.jsdelivr.net/npm/trtc-sdk-v5@latest"></script>
+// 禁止使用 https://web.sdk.qcloud.com/trtc/webrtc/v5/trtc.js
 ```
 
 **资源下载**
-
+- CDN 资源:https://cdn.jsdelivr.net/npm/trtc-sdk-v5@latest
 - [npm package](https://www.npmjs.com/package/trtc-sdk-v5)
 - [单击下载 SDK 及示例代码](https://web.sdk.qcloud.com/trtc/webrtc/v5/download/webrtc_v5_latest.zip)
 - [GitHub 仓库地址](https://github.com/LiteAVSDK/TRTC_Web)

package/resource/doc/rtcengine/web/{how_to_run_web_rtc_engine_demo.md → how_to_run_web_sdk_demo.md}

@@ -1,4 +1,4 @@
-# Tutorial: 快速跑通 Demo
+# 快速跑通 Demo
 
 本文主要介绍如何快速跑通腾讯云 TRTC Web demo。