@tencentcloud/sdk-mcp 1.6.3 → 1.6.5

package/resource/knowledge/callkit/faq/web.md

@@ -1,8 +1,7 @@
 > **说明：**
 >
-> - 如果并没有解决您的问题，也欢迎您加入我们的 TUICallKit 技术交流 QQ 群： **605115878 **来进行交流讨论。
+> - 如果并没有解决您的问题，也欢迎您加入我们的 TUICallKit 技术交流 QQ 群： **605115878** 来进行交流讨论。
 > - 我们团队即将在 Web 端丰富更多不同的组件，以满足您的开发需求。
-
 > 希望您能抽出几分钟时间，为您自己的需求投上一票，我们将优先开发！
 >
 
@@ -10,7 +9,6 @@
 
 > **说明：**
 >
-
 > 以下问题对于 TUICallKit 与 TUICallEngine SDK 同样适用。
 >
 
@@ -36,7 +34,6 @@ trtcCloudInstance?.callExperimentalAPI(JSON.stringify(params));
 
 > **建议：**
 >
-
 > 保留自动播放弹窗，但是需要调整弹窗样式，需要升级到最新的 TUICallKit 版本（**V4.4.0+ 支持**）。调整的弹窗组件路径：`components/common/AutoPlayDialog` 下的 `vue` 文件。
 >
 
@@ -88,7 +85,6 @@ TUICallKit（含 TUICallEngine SDK）依赖的 `tim-js-sdk` 版本需要 ≥ 2.2
 
 > **注意：**
 >
-
 > [TUICallEngine login](https://web.sdk.qcloud.com/component/trtccalling/doc/TUICallEngine/web/TUICallEngine.html#login) 是一个异步接口，避免在 login 还未完成，直接调用 TUICallEngine 的接口。
 >
 
@@ -150,7 +146,6 @@ UserSig 是腾讯云为其云服务设计的一种安全保护签名，是一种
 
    > **警告：**
    >
-
    > 此方式是在前端代码中配置 SecretKey，该方法中 SecretKey 很容易被反编译逆向破解，一旦您的密钥泄露，攻击者就可以盗用您的腾讯云流量，因此**该方法仅适合本地跑通功能调试**，生产环境请看方式三。
    >
 
@@ -169,9 +164,7 @@ UserSig 是腾讯云为其云服务设计的一种安全保护签名，是一种
 
 - 通过 [即时通信 IM 控制台](https://console.cloud.tencent.com/im) 进行创建和获取，单击目标应用卡片，进入应用的账号管理页面，也可创建账号并获取 userID。
 
-### 如何
-
-**解决源码拷贝可能导致的报错**？
+### 如何**解决源码拷贝可能导致的报错**？
 
 【ESLint 报错】
 
@@ -294,7 +287,6 @@ xcopy .\node_modules\@trtc\calls-uikit-vue2  .\src\components\TUICallKit /i /e
 
 > **注意：**
 >
-
 > 此方法可能与您的 ESLint、TypeScript 配置冲突，若出现报错，可参见 解决源码拷贝导致的报错。
 >
 
@@ -321,7 +313,6 @@ import { TUICallKit, TUICallKitAPI } from "./components/TUICallKit/src/index";
 
    > **注意：**
    >
-
    > **v3.1.3+ 支持。**
    >
 
@@ -347,7 +338,6 @@ import { TUICallKit, TUICallKitAPI } from "./components/TUICallKit/src/index";
 
    > **注意：**
    >
-
    > TRTC 应对防火墙受限参见 [设置代理服务器](https://web.sdk.qcloud.com/component/trtccalling/doc/TUICallEngine/web/zh-cn/tutorial-11-set_proxy_server.html)。
    >
 

package/resource/knowledge/callkit/preset/android/api.md

@@ -244,8 +244,7 @@ fun enableVirtualBackground(enable: Boolean);
 
 > **注意：**
 >
-
-> **v2.9+版本废弃，建议使用 **[calls](https://liteav.sdk.cloudcachetci.com/doc/product/tuikit/atomic-x/android/zh/-atomic-x%20-core%20-a-p-i/io.trtc.tuikit.atomicxcore.api.call/-call-store/calls.html)** 接口。**
+> **v2.9+版本废弃，建议使用** [calls](https://liteav.sdk.cloudcachetci.com/doc/product/tuikit/atomic-x/android/zh/-atomic-x%20-core%20-a-p-i/io.trtc.tuikit.atomicxcore.api.call/-call-store/calls.html) **接口。**
 >
 
 【Kotlin】
@@ -271,8 +270,7 @@ fun call(userId: String, mediaType: TUICallDefine.MediaType)
 
 > **注意：**
 >
-
-> **v2.9+版本废弃，建议使用 **[calls](https://liteav.sdk.cloudcachetci.com/doc/product/tuikit/atomic-x/android/zh/-atomic-x%20-core%20-a-p-i/io.trtc.tuikit.atomicxcore.api.call/-call-store/calls.html)** 接口。**
+> **v2.9+版本废弃，建议使用** [calls](https://liteav.sdk.cloudcachetci.com/doc/product/tuikit/atomic-x/android/zh/-atomic-x%20-core%20-a-p-i/io.trtc.tuikit.atomicxcore.api.call/-call-store/calls.html) **接口。**
 >
 
 【Kotlin】
@@ -303,7 +301,7 @@ fun call(
 
 > **注意：**
 >
-> - **v2.9+版本废弃，建议使用 **[calls](https://liteav.sdk.cloudcachetci.com/doc/product/tuikit/atomic-x/android/zh/-atomic-x%20-core%20-a-p-i/io.trtc.tuikit.atomicxcore.api.call/-call-store/calls.html)** 接口。**
+> - **v2.9+版本废弃，建议使用** [calls](https://liteav.sdk.cloudcachetci.com/doc/product/tuikit/atomic-x/android/zh/-atomic-x%20-core%20-a-p-i/io.trtc.tuikit.atomicxcore.api.call/-call-store/calls.html) **接口。**
 > - 使用群组通话前需要创建 IM 群组，如果已经创建，请忽略。
 > - 群组的创建详见：[IM 群组管理](https://cloud.tencent.com/document/product/269/75394) ，或者您也可以直接使用 [IM TUIKit](https://cloud.tencent.com/document/product/269/37059)，一站式集成聊天、通话等场景。
 
@@ -331,7 +329,7 @@ void groupCall(String groupId, List<String> userIdList, TUICallDefine.MediaType
 
 > **注意：**
 >
-> - **v2.9+版本废弃，建议使用 **[calls](https://liteav.sdk.cloudcachetci.com/doc/product/tuikit/atomic-x/android/zh/-atomic-x%20-core%20-a-p-i/io.trtc.tuikit.atomicxcore.api.call/-call-store/calls.html)** 接口。**
+> - **v2.9+版本废弃，建议使用** [calls](https://liteav.sdk.cloudcachetci.com/doc/product/tuikit/atomic-x/android/zh/-atomic-x%20-core%20-a-p-i/io.trtc.tuikit.atomicxcore.api.call/-call-store/calls.html) **接口。**
 > - 使用群组通话前需要创建 IM 群组，如果已经创建，请忽略。
 > - 群组的创建详见：[IM 群组管理](https://cloud.tencent.com/document/product/269/75394) ，或者您也可以直接使用 [IM TUIKit](https://cloud.tencent.com/document/product/269/37059)，一站式集成聊天、通话等场景。
 
@@ -364,7 +362,7 @@ void groupCall(String groupId, List<String> userIdList, TUICallDefine.MediaType
 
 > **注意：**
 >
-> - **v2.9+版本废弃，建议使用 **[join](https://liteav.sdk.cloudcachetci.com/doc/product/tuikit/atomic-x/android/zh/-atomic-x%20-core%20-a-p-i/io.trtc.tuikit.atomicxcore.api.call/-call-store/join.html)** 接口。**
+> - **v2.9+版本废弃，建议使用** [join](https://liteav.sdk.cloudcachetci.com/doc/product/tuikit/atomic-x/android/zh/-atomic-x%20-core%20-a-p-i/io.trtc.tuikit.atomicxcore.api.call/-call-store/join.html) **接口。**
 > - 加入群组中已有的音视频通话前，需要提前创建或加入 IM 群组，并且群组中已有用户在通话中，如果已经创建，请忽略。
 > - 群组的创建详见：[IM 群组管理](https://cloud.tencent.com/document/product/269/75394) ，或者您也可以直接使用 [IM TUIKit](https://cloud.tencent.com/document/product/269/37059)，一站式集成聊天、通话等场景。
 
@@ -393,7 +391,6 @@ void joinInGroupCall(TUICommonDefine.RoomId roomId, String groupId, TUICallDefin
 > **说明：**
 >
 > - 目前支持隐藏以下按钮：
-
 > Camera（摄像头）、Microphone（麦克风）、AudioDevice（音频设备）、SwitchCamera（切换摄像头）、InviteUser（邀请用户）。
 >
 > - **v3.2.+** 版本支持。

package/resource/knowledge/callkit/preset/ios/api.md

@@ -152,8 +152,7 @@ public func setScreenOrientation(orientation: Int, completion: CompletionClosure
 
 > **注意：**
 >
-
-> **建议使用 **[calls](https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore/callstore/calls(participantids:callmediatype:params:completion:))** 接口。**
+> **建议使用** [calls](https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore/callstore/calls(participantids:callmediatype:params:completion:)) **接口。**
 >
 
 【Swift】
@@ -179,8 +178,7 @@ public func call(userId: String, callMediaType: TUICallMediaType)
 
 > **注意：**
 >
-
-> **建议使用 **[calls](https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore/callstore/calls(participantids:callmediatype:params:completion:))** 接口。**
+> **建议使用** [calls](https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore/callstore/calls(participantids:callmediatype:params:completion:)) **接口。**
 >
 
 【Swift】
@@ -208,7 +206,7 @@ public func call(userId: String, callMediaType: TUICallMediaType, params: TUICal
 
 > **注意：**
 >
-> - **建议使用 **[calls](https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore/callstore/calls(participantids:callmediatype:params:completion:))** 接口。**
+> - **建议使用** [calls](https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore/callstore/calls(participantids:callmediatype:params:completion:)) **接口。**
 > - 使用群组通话前需要创建 IM 群组，如果已经创建，请忽略。
 > - 群组的创建详见：[IM 群组管理](https://cloud.tencent.com/document/product/269/75394#.E5.88.9B.E5.BB.BA.E7.BE.A4.E7.BB.84) ，或者您也可以直接使用 [IM TUIKit](https://cloud.tencent.com/document/product/269/37059)，一站式集成聊天、通话等场景。
 
@@ -235,7 +233,7 @@ public func groupCall(groupId: String, userIdList: [String], callMediaType: TUIC
 
 > **注意：**
 >
-> - **建议使用 **[join](https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore/callstore/join(callid:completion:))** 接口。**
+> - **建议使用** [join](https://tencent-rtc.github.io/TUIKit_iOS/documentation/atomicxcore/callstore/join(callid:completion:)) **接口。**
 > - 加入群组中已有的音视频通话前，需要提前创建或加入 IM 群组，并且群组中已有用户在通话中，如果已经创建，请忽略。
 > - 群组的创建详见：[IM 群组管理](https://cloud.tencent.com/document/product/269/75394#.E5.88.9B.E5.BB.BA.E7.BE.A4.E7.BB.84) ，或者您也可以直接使用 [IM TUIKit](https://cloud.tencent.com/document/product/269/37059)，一站式集成聊天、通话等场景。
 

package/resource/knowledge/callkit/preset/miniprogram/api.md

@@ -0,0 +1,295 @@
+TUICallKit 是音视频通话组件的**含 UI 接口**，使用 TUICallKit API，您可以通过简单接口快速实现一个类微信的音视频通话场景；更详细的接入步骤，详见 [快速接入 TUICallKit](https://cloud.tencent.com/document/product/647/78733)。
+
+> **说明：**
+>
+> - 为提供更优质的音视频通信能力，原 @trtc/call-uikit-wechat 包已正式停止维护，建议开发者迁移至 @trtc/calls-uikit-wx-uniapp、@trtc/calls-uikit-wx 新包。
+> - 新包对接口进行了优化调整，部分旧版接口不再兼容，同步提供更简洁、稳定的新接口方案。
+
+## API 概览
+
+|API|描述|
+|---------|---------|
+|<TUICallKit />|TUICallKit 通话 UI 组件。|
+|init|初始化 TUICallKit|
+|calls|发起单人或多人通话。|
+|join|主动加入通话。|
+|setSelfInfo|设置用户的头像、昵称。|
+|setCallingBell|设置自定义来电铃声。|
+|setLogLevel|设置日志级别。|
+|enableMuteMode|开启/关闭来电铃声。|
+|enableFloatWindow|开启/关闭悬浮窗功能。|
+|hideFeatureButton|隐藏按钮。|
+|setLocalViewBackgroundImage|设置本地用户通话界面背景图。|
+|setRemoteViewBackgroundImage|设置远端用户通话界面背景图。|
+|setLayoutMode|设置通话界面布局模式。|
+|setCameraDefaultState|设置摄像头是否默认打开。|
+|destroyed|销毁 TUICallKit。|
+|getTUICallEngineInstance|获取 TUICallEngine 实例。|
+
+## API 详情
+
+【uni-app 小程序】
+``` javascript
+import { TUICallKitAPI } from "@trtc/calls-uikit-wx-uniapp";
+```
+
+【微信小程序】
+``` javascript
+import { TUICallKitAPI } from "@trtc/calls-uikit-wx";
+```
+
+### init
+
+初始化 TUICallKit。
+``` javascript
+TUICallKitAPI.init({
+     sdkAppID: 0, // 替换为您自己账号下的 SDKAppId
+     userID: 'jane', // 填写当前用的 userID
+     userSig: 'xxxxxxxxxxxx',
+     tim: null, // 如果您不需要 TIM 实例，可忽略
+})
+```
+
+参数如下表所示：
+
+|参数|类型|说明|是否必填|
+|---------|---------|---------|---------|
+|sdkAppID|Number|您可以在**实时音视频控制台** > [应用管理](https://console.cloud.tencent.com/trtc/app) > **应用信息**中查看 SDKAppID。|是|
+|userID|String|当前用户的 ID，字符串类型，只允许包含英文字母（a-z 和 A-Z）、数字（0-9）、连词符（-）和下划线（_）。|是|
+|userSig|String|腾讯云设计的一种安全保护签名，获取方式请参见：[如何计算及使用 UserSig](https://cloud.tencent.com/document/product/647/17275)。|是|
+|tim|ChatSDK|TIM 实例。|否|
+
+这里详细介绍一下 init 中的几个参数：
+- **userSig**：使用步骤三中获取的 SecretKey 对 sdkAppID、userID 等信息进行加密，就可以得到 userSig，它是一个鉴权用的票据，用于腾讯云识别当前用户是否能够使用 TRTC 的服务，更多信息请参见 [如何计算及使用 UserSig](https://cloud.tencent.com/document/product/647/17275)。
+
+- **tim** 可以将外部的 tim 实例通过 init 透传给 callkit ，tim 参数适用于业务中已存在 TIM 实例，为保证 TIM 实例唯一性。
+
+### calls
+
+发起 1v1 或 多人通话。
+``` javascript
+TUICallKitAPI.calls({
+    userIDList: ["jane", "mike", "tommy"],
+    type: 1,
+})
+```
+
+参数如下表所示：
+| 参数 | 类型 | 含义 | 是否必填 |
+| --- | --- | --- | --- |
+| userIDList | Array<String> | 目标用户的 userId 列表，示例：["jane", "mike", "tommy"]。 | 是 |
+| type | CallMediaType | 通话的媒体类型，参数值说明参见 CallMediaType 通话类型。 | 是 |
+| chatGroupID | String | 与 chat 结合使用时， chat 群组的群 ID。 | 是 |
+| roomID | Number | 数字房间号，范围 [1, 2147483647]。 | 否 |
+| userData | String | 扩展字段：用于在邀请信令中增加扩展信息。 | 否 |
+| timeout | Number | - 通话的超时时间，0为不超时，单位 s(秒)（选填） 。设置范围：10s ~ 600s。如果传入0，默认30s。<br>- 被叫需要在30s 内处于登录状态，timeout 值才会有效，具体参见 timeout 字段设置无效。 | 否 |
+| offlinePushInfo | Object | 自定义离线消息推送（选填）。 | 否 |
+
+### join
+
+主动加入通话。
+``` javascript
+TUICallKitAPI.join({callId: xx});
+```
+
+参数如下表所示：
+
+|参数|类型|含义|是否必填|
+|---------|---------|---------|---------|
+|callId|String|此次通话的唯一 ID。|是|
+
+### setSelfInfo
+
+设置用户头像、昵称。
+
+> **注意：**
+>
+> **通话中使用该接口修改用户信息，UI 不会立即更新，需要等到下次通话才能看到变化。**
+>
+
+``` javascript
+TUICallKitAPI.setSelfInfo({ nickName: "xxx", avatar: "http://xxx" });
+```
+
+参数如下表所示：
+
+|参数|类型|含义|
+|---------|---------|---------|
+|nickName|String|设置昵称。|
+|avatar|String|头像地址。|
+
+### setCallingBell
+
+设置自定义来电铃声。
+
+这里仅限传入本地文件地址，需要确保该文件目录是应用可以访问的。
+- 传入路径应为本地铃声文件的绝对地址。
+
+- 如需恢复默认铃声，`filePath` 传空即可。
+
+- 支持的铃声文件格式：
+
+   |格式|iOS|Android|
+   |---------|---------|---------|
+   |m4a|√|√|
+   |mp3|√|√|
+   |wav|√|√|
+   |aac|√|√|
+
+   ``` javascript
+   TUICallKitAPI.setCallingBell("filePath")
+   ```
+
+   参数如下表所示：
+
+   |参数|类型|含义|
+   |---------|---------|---------|
+   |filePath|String|铃声地址。|
+
+### setLogLevel
+
+设置日志级别，低于 level 的日志将不会输出。
+``` javascript
+TUICallKitAPI.setLogLevel(level)
+```
+
+参数如下表所示：
+| 参数 | 值 | 含义 |
+| --- | --- | --- |
+| level | 0 | 普通级别，日志量较多，接入时建议使用。 |
+| 1 | release 级别，SDK 输出关键信息，生产环境时建议使用。 |  |
+| 2 | 告警级别，SDK 只输出告警和错误级别的日志。 |  |
+| 3 | 错误级别，SDK 只输出错误级别的日志。 |  |
+| 4 | 无日志级别，SDK 将不打印任何日志。 |  |
+
+### enableMuteMode
+
+开启/关闭来电铃声。
+- 默认为 `false`，收到通话请求将播放来电铃声。
+
+- 若为 `true`，收到通话请求不会播放来电铃声。
+
+   ``` javascript
+   try {
+     await TUICallKitAPI.enableMuteMode(enable: boolean)
+   } catch (error: any) {
+     console.error(`[TUICallKit] Failed to call the enableMuteMode API. Reason: ${error}`);
+   }
+   ```
+
+### enableFloatWindow
+
+开启/关闭悬浮窗功能。默认为 false，通话界面左上角的悬浮窗按钮隐藏，设置为 true 后显示。
+``` javascript
+try {
+  await TUICallKitAPI.enableFloatWindow(enable: boolean)
+} catch (error: any) {
+  console.error(`[TUICallKit] Failed to call the enableFloatWindow API. Reason: ${error}`);
+}
+```
+
+### hideFeatureButton
+
+隐藏功能按钮，目前仅支持 摄像头，麦克风和切换前后置按钮。
+``` typescript
+TUICallKitAPI.hideFeatureButton(buttonName: FeatureButton);
+```
+
+参数列表：
+
+|参数|类型|是否必填|含义|
+|---------|---------|---------|---------|
+|buttonName|FeatureButton|是|按钮名称。|
+
+### setLocalViewBackgroundImage
+
+设置本地用户通话背景。
+``` typescript
+TUICallKitAPI.setLocalViewBackgroundImage(url: string);
+```
+
+参数列表：
+| 参数 | 类型 | 是否必填 | 含义 |
+| --- | --- | --- | --- |
+| url | String | 是 | 图片地址（支持本地路径和网络地址）。<br><strong>注意：</strong><br>如果使用网络地址，需要将网络地址添加到 request 合法域名。 |
+
+### setRemoteViewBackgroundImage
+
+设置远端用户通话背景。
+``` typescript
+TUICallKitAPI.setRemoteViewBackgroundImage(userId: string, url: string);
+```
+
+参数列表：
+| 参数 | 类型 | 是否必填 | 含义 |
+| --- | --- | --- | --- |
+| userId | String | 是 | 远端用户 userId，设置为 '*' 表示对所有远端用户生效。 |
+| url | String | 是 | 图片地址（支持本地路径和网络地址）。<br><strong>注意：</strong><br>如果使用网络地址，需要将网络地址添加到 request 合法域名。 |
+
+### setLayoutMode
+
+设置通话界面布局模式。
+``` javascript
+import { TUICallKitAPI, LayoutMode } from "../../TUICallKit/src/index";
+TUICallKitAPI.setLayoutMode(LayoutMode.LocalInLargeView);
+```
+
+参数列表：
+
+|参数|类型|是否必填|含义|
+|---------|---------|---------|---------|
+|layoutMode|LayoutMode|是|用户流的布局模式。|
+
+### setCameraDefaultState
+
+设置摄像头是否默认打开。
+``` javascript
+TUICallKitAPI.setCameraDefaultState(true);
+```
+
+参数列表：
+
+|参数|类型|是否必填|含义|
+|---------|---------|---------|---------|
+|isOpen|boolean|是|是否开启摄像头。|
+
+### destroyed
+
+销毁 TUICallKit。
+``` javascript
+TUICallKitAPI.destroyed()
+```
+
+### getTUICallEngineInstance
+
+获取 TUICallEngine 实例。
+``` javascript
+TUICallKitAPI.getTUICallEngineInstance();
+```
+
+## TUICallKit 类型定义
+
+### **offlinePushInfo**
+
+|参数|类型|是否必填|含义|
+|---------|---------|---------|---------|
+|offlinePushInfo.title|String|否|离线推送标题（选填）。|
+|offlinePushInfo.description|String|否|离线推送内容（选填）。|
+|offlinePushInfo.androidOPPOChannelID|String|否|离线推送设置 OPPO 手机 8.0 系统及以上的渠道 ID（选填）。|
+|offlinePushInfo.extension|String|否|离线推送透传内容（选填）（tsignaling 版本 ≥ 0.9.0）。|
+
+### FeatureButton
+
+|FeatureButton 类型|描述|
+|---------|---------|
+|FeatureButton.Camera|摄像头按钮。|
+|FeatureButton.Microphone|麦克风按钮。|
+|FeatureButton.SwitchCamera|切换前后置摄像头按钮。|
+|FeatureButton.InviteUser|邀请他人按钮。|
+
+### LayoutMode
+
+|LayoutMode 类型|描述|
+|---------|---------|
+|LayoutMode.LocalInLargeView|本地用户在大窗显示。|
+|LayoutMode.RemoteInLargeView|远端用户在大窗显示。|