@tencentcloud/sdk-mcp 1.4.7 → 1.6.0-beta.1

package/resource/{doc → integration}/callkit/preset/android/integration.md

@@ -3,7 +3,7 @@
 ## 准备工作
 
 ### **环境要求**
-- **Android 版本要求**：Android 5.0（SDK API Level 21）及以上版本。
+- **Android 版本要求**：Android 5.0（SDK API level 21）及以上版本。
 
 - **Gradle 版本要求：**Gradle 4.2.1 及以上的版本。
 
@@ -81,7 +81,7 @@ dependencies {
    > 如果您集成 tuicallkit-kt 后报如下错误：
    >
 
-   > 原因是 AGP 8.0+ 要求 Gradle 运行时使用 Java 17 或更高版本。您可以在 Android Studio 中点击 Tools -> SDK Manager -> Build, Execution,Deployment -> Build Tools -> Gradle 配置 Gradle JDK 版本为 17 解决该问题
+   > 原因是 AGP 8.0+ 要求 Gradle 运行时使用 Java 17 或更高版本。您可以在 Android Studio 中点击 Tools -> SDK Manager -> Build,Execution,Deployment -> Build Tools -> Gradle 配置 Gradle JDK 版本为 17 解决该问题
    >
 
 ### 步骤3：登录
@@ -140,16 +140,17 @@ public class MainActivity extends AppCompatActivity {
 }
 
 ```
-| 参数 | 类型 | 说明 |
-| --- | --- | --- |
-| userId | String | 用户账号长度不超过32字节，不支持使用特殊字符，建议使用英文字母或数字。为避免多端登录冲突，请勿使用 1、123 等简单 ID。 |
-| sdkAppId | int | 在 [实时音视频 TRTC 控制台](https://console.cloud.tencent.com/trtc) 创建的音视频应用的唯一标识 SDKAppID。 |
-| secretKey | String | 在 [实时音视频 TRTC 控制台](https://console.cloud.tencent.com/trtc) 创建的音视频应用的 SDKSecretKey。 |
-| userSig | String | 一种安全保护签名，用于对用户进行登录鉴权认证，确认用户是否真实，阻止恶意攻击者盗用您的云服务使用权。 |
+
+|参数|类型|说明|
+|---------|---------|---------|
+|userId|String|只允许包含大小写英文字母(a-z A-Z)、数字(0-9)及下划线和连词符。|
+|sdkAppId|int|在 [实时音视频 TRTC 控制台](https://console.cloud.tencent.com/trtc) 创建的音视频应用的唯一标识 SDKAppID。|
+|secretKey|String|在 [实时音视频 TRTC 控制台](https://console.cloud.tencent.com/trtc) 创建的音视频应用的 SDKSecretKey。|
+|userSig|String|一种安全保护签名，用于对用户进行登录鉴权认证，确认用户是否真实，阻止恶意攻击者盗用您的云服务使用权。|
 
 > **说明：**
 >
-> - **开发环境**：如果您在本地开发调试阶段，可以采用本地 [GenerateTestUserSig.genTestUserSig](https://github.com/Tencent-RTC/TUIKit_Android/blob/main/application/debug/src/main/java/com/tencent/qcloud/tuikit/debug/GenerateTestUserSig.java) 函数生成 userSig。该方法中 secretKey 很容易被反编译逆向破解，一旦您的密钥泄露，攻击者就可以盗用您的腾讯云流量。
+> - **开发环境**：如果您在本地开发调试阶段，可以采用本地 [GenerateTestUserSig.genTestUserSig](https://github.com/Tencent-RTC/TUIKit_Android/blob/main/call/tuicallkit-kt/src/main/java/com/tencent/qcloud/tuikit/tuicallkit/debug/GenerateTestUserSig.kt) 函数生成 userSig。该方法中 secretKey 很容易被反编译逆向破解，一旦您的密钥泄露，攻击者就可以盗用您的腾讯云流量。
 > - **生产环境**：如果您的项目要发布上线，请采用 服务端生成 UserSig 的方式。
 
 ### 步骤4：设置昵称和头像[可选]
@@ -192,11 +193,12 @@ TUICallKit.createInstance(applicationContext).setSelfInfo(name, avatar,
         }
     });
 ```
-| 参数 | 类型 | 说明 |
-| --- | --- | --- |
-| nickname | String | 目标用户的昵称。 |
-| avatar | String | 目标用户的头像。 |
-| completion | CompletionHandler | 异步操作的结果回调。 |
+
+|参数|类型|说明|
+|---------|---------|---------|
+|nickname|String|目标用户的昵称。|
+|avatar|String|目标用户的头像。|
+|completion|CompletionHandler|异步操作的结果回调。|
 
 ### 步骤5：发起通话
 
@@ -247,8 +249,8 @@ TUICallKit.createInstance(this).calls(userIdList, mediaType, params, new Complet
 | 参数 | 类型 | 说明 |
 | --- | --- | --- |
 | userIdList | List<String> | 目标用户的 userId 列表。 |
-| mediaType | [CallMediaType](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-media-type/index.html) | 通话的媒体类型，例如视频通话、语音通话。<br>- Audio : 语音通话。<br>- Video : 视频通话。 |
-| params | [CallParams](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-params/index.html) | 通话扩展参数，例如房间号、通话邀请超时时间等。<br>- roomId : 此次通话的房间 ID。<br>- timeout : 发起通话等待的最长时间，超过该时间通话结束。<br>- userData : 发起通话时自定义扩展字段。<br>- chatGroupId : 与 chat 结合使用，Chat 群组的群 ID 。 |
+| mediaType | <a href="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-media-type/index.html">CallMediaType</a> | 通话的媒体类型，例如视频通话、语音通话。<br>- Audio : 语音通话。<br>- Video : 视频通话。 |
+| params | <a href="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-params/index.html">CallParams</a> | 通话扩展参数，例如房间号、通话邀请超时时间等。<br>- roomId : 此次通话的房间 ID。<br>- timeout : 发起通话等待的最长时间，超过该时间通话结束。<br>- userData : 发起通话时自定义扩展字段。<br>- chatGroupId : 与 chat 结合使用，Chat 群组的群 ID 。 |
 | completion | CompletionHandler | 异步操作的结果回调。 |
 
 ### 步骤6：接听通话
@@ -263,8 +265,8 @@ TUICallKit.createInstance(this).calls(userIdList, mediaType, params, new Complet
 
 > **注意：**
 >
-> 1. 该功能默认为开启状态（enable = true）。如需关闭，请在发起通话前调用 `enableAITranscriber`(enable: false)。
-> 2. AI 实时转录与翻译为增值服务。体验版赠送免费额度，可直接体验。如需开通正式版，请在 [实时音视频控制台](https://console.cloud.tencent.com/trtc) 开通套餐包，详见 [计费说明](https://cloud.tencent.com/document/product/647/111976)。
+> - 该功能默认为开启状态（enable = true）。如需关闭，请在发起通话前调用 `enableAITranscriber`(enable: false)。
+> - AI 实时转录与翻译为增值服务。体验版赠送免费额度，可直接体验。如需开通正式版，请在 [实时音视频控制台](https://console.cloud.tencent.com/trtc) 开通套餐包，详见 [计费说明](https://cloud.tencent.com/document/product/647/111976)。
 
 【Kotlin】
 ``` swift
@@ -372,8 +374,8 @@ TUICallKit.createInstance(context).calls(userIdList, mediaType, params, new Comp
 | 参数 | 类型 | 说明 |
 | --- | --- | --- |
 | userIdList | List<String> | 目标用户的 userId 列表。 |
-| mediaType | [CallMediaType](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-media-type/index.html) | 通话的媒体类型，例如视频通话、语音通话。<br>- Audio : 语音通话。<br>- Video : 视频通话。 |
-| params | [CallParams](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-params/index.html) | 通话扩展参数，例如房间号、通话邀请超时时间等。<br>- roomId : 此次通话的房间 ID。<br>- timeout : 发起通话等待的最长时间，超过该时间通话结束。<br>- userData : 发起通话时自定义扩展字段。<br>- chatGroupId : 与 chat 结合使用，Chat 群组的群 ID 。 |
+| mediaType | <a href="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-media-type/index.html">CallMediaType</a> | 通话的媒体类型，例如视频通话、语音通话。<br>- Audio : 语音通话。<br>- Video : 视频通话。 |
+| params | <a href="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-params/index.html">CallParams</a> | 通话扩展参数，例如房间号、通话邀请超时时间等。<br>- roomId : 此次通话的房间 ID。<br>- timeout : 发起通话等待的最长时间，超过该时间通话结束。<br>- userData : 发起通话时自定义扩展字段。<br>- chatGroupId : 与 chat 结合使用，Chat 群组的群 ID 。 |
 | completion | CompletionHandler | 异步操作的结果回调。 |
 
 - **加入多人通话：**可使用 `join` 方法加入指定的群组通话。
@@ -410,10 +412,11 @@ TUICallKit.createInstance(this).join(callId, new CompletionHandler() {
     }
 });
 ```
-| 参数 | 类型 | 说明 |
-| --- | --- | --- |
-| callId | String | 此次通话的唯一标识。 |
-| completion | CompletionHandler | 异步操作的结果回调。 |
+
+|参数|类型|说明|
+|---------|---------|---------|
+|callId|String|此次通话的唯一标识。|
+|completion|CompletionHandler|异步操作的结果回调。|
 
 ### 设置语言
 - **支持的语言：**目前支持**简体中文、繁体中文、英文、日文和阿拉伯语。**
@@ -483,9 +486,10 @@ TUICallKit.createInstance(context).setCallingBell(filePath);
 ```
 
 **详情：**这里仅限传入本地文件地址，需要确保该文件目录是应用可以访问的。铃声设置后与设备绑定，更换用户，铃声依旧会生效。如需恢复默认铃声，filePath传空即可。
-| 参数 | 类型 | 说明 |
-| --- | --- | --- |
-| filePath | String | 铃声文件的路径。 |
+
+|参数|类型|说明|
+|---------|---------|---------|
+|filePath|String|铃声文件的路径。|
 
 - **来电静音模式：**您可以通过 [enableMuteMode](https://cloud.tencent.com/document/product/647/78750#enableMuteMode) 设置静音模式。
 
@@ -511,7 +515,7 @@ TUICallKit.createInstance(context).enableMuteMode(true);
 
 ### 替换图标按钮
 
-您可以直接替换 [res\drawable-xxhdpi](https://github.com/Tencent-RTC/TUIKit_Android/tree/main/atomic_x/src/main/res-callview/drawable-xxhdpi) 文件夹下的图标，以确保整个 App 中的图标色调风格保持一致。以下列出了基本的功能按钮，您可以替换对应的图标以适配自己的业务场景。
+您可以直接替换 [res\drawable-xxhdpi](https://github.com/Tencent-RTC/TUIKit_Android/tree/main/call/tuicallkit-kt/src/main/res-callview/drawable-xxhdpi) 文件夹下的图标，以确保整个 App 中的图标色调风格保持一致。以下列出了基本的功能按钮，您可以替换对应的图标以适配自己的业务场景。
 
 常用图标文件名列表
 | 图标 | 文件名称 | 说明 |

package/resource/{doc → integration}/callkit/preset/flutter/integration.md

@@ -25,35 +25,52 @@ flutter pub add tencent_calls_uikit
 【Android】
 1. 由于 SDK 内部使用了 Java 反射机制（或特性），需要将部分 SDK 类加入不进行混淆处理的名单。
 
-  - 请在工程的`android/app/build.gradle` 文件中配置并开启混淆规则：
+  - 请在工程的`android/app/`目录下找到`build.gradle.kts`（或`build.gradle` ）文件中配置并开启混淆规则：
 
+【build.gradle.kts】
 ``` java
-  android {
-    ......
+android {
     buildTypes {
         release {
-            ......
             isMinifyEnabled = true
+            proguardFiles(
+                getDefaultProguardFile("proguard-android.txt"),
+                "proguard-rules.pro"
+            )
+        }
+    }
+}
+```
+
+【build.gradle】
+``` java
+android {
+    buildTypes {
+        release {
+            minifyEnabled true
             proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
         }
     }
 }
+
 ```
   - 在工程的 `android/app` 目录下创建 `proguard-rules.pro` 文件，并在其中添加如下代码：
 
 ``` java
 -keep class com.tencent.** { *; }
 ```
-2. 在工程的 `android/app/build.gradle `文件中配置开启 Multidex 支持。
-
-``` java
-  android {
-    ......
-    defaultConfig {
-      ......
-      multiDexEnabled true
-    }
-}
+2. （可选）如果您需要在应用外使用 CallKit 的悬浮窗能力，需要开启系统画中画特性。
+
+请在 App 主工程的 `AndroidManifest.xml` 里设置 `MainActivity` 的 `android:supportsPictureInPicture` 为 true：
+``` xml
+  <manifest xmlns:android="http://schemas.android.com/apk/res/android">
+    <application>
+        <activity
+            android:name=".MainActivity"
+            android:supportsPictureInPicture="true"
+        </activity>
+    </application>
+</manifest>
 ```
 
 【iOS】
@@ -68,27 +85,41 @@ flutter pub add tencent_calls_uikit
 <string>CallingApp需要访问您的麦克风权限，开启后录制的视频才会有声音</string>
 ```
 
+> **注意：**
+>
+
+> 由于 tencent_rtc_sdk 通过 Flutter FFI 调用接口，iOS Release 构建时 Xcode 的符号裁剪优化可能误移除 TRTC 的 C 符号，引发 `symbol not found` 错误。解决方案如下：
+>
+> 1. 在项目的 Build Settings 中找到 **Deployment Postprocessing**，将其设置为 **Yes 。**
+
+> 2. 在项目的 Build Settings 中找到 **Strip Style**，将其中 Release 的值设置为 **Non-Global Symbols 。**
+
 - Flutter 工程配置
 
-   在 Flutter 应用框架的 navigatorObservers 中添加 TUICallKit.navigatorObserver，以下是使用 MaterialApp 框架的示例代码：
+   为了确保 TUICallKit 能够正常管理页面导航和显示多语言界面，需要在 Flutter 应用框架中进行以下配置：
 
-   ``` java
-   import 'package:tencent_calls_uikit/tencent_calls_uikit.dart';
+  - 在 `navigatorObservers` 中添加 `TUICallKit.navigatorObserver`，用于监听页面路由变化和管理组件生命周期。
 
-    ......
+  - 在 `localizationsDelegates` 中添加相关本地化代理，确保界面文案能够根据系统语言正确显示。
 
-   class XXX extends StatelessWidget {
-     const XXX({super.key});
+      ``` java
+      import 'package:tencent_calls_uikit/tencent_calls_uikit.dart';
 
-    @override
-     Widget build(BuildContext context) {
-       return MaterialApp(
-         navigatorObservers: [TUICallKit.navigatorObserver],
-         ......
-       );
-     }
-   }
-   ```
+      class XXX extends StatelessWidget {
+        const XXX({super.key});
+
+       @override
+        Widget build(BuildContext context) {
+          return MaterialApp(
+            navigatorObservers: [TUICallKit.navigatorObserver],
+            localizationsDelegates: const [
+              // 您的 App 其他配置
+              AtomicLocalizations.delegate,
+            ],
+          );
+        }
+      }
+      ```
 
 ### 步骤3：登录
 
@@ -96,7 +127,7 @@ flutter pub add tencent_calls_uikit
 
 ``` java
 import 'package:tencent_calls_uikit/tencent_calls_uikit.dart';
-import 'package:tencent_calls_uikit/debug/generate_test_user_sig.dart';
+import 'package:tencent_calls_uikit/src/debug/generate_test_user_sig.dart';
 ......
 
 final String userId    = 'xxxxx';  // 请替换为您的 UserId
@@ -113,12 +144,13 @@ void login() async {
     }
 }
 ```
-| 参数 | 类型 | 说明 |
-| --- | --- | --- |
-| userId | String | 用户账号长度不超过32字节，不支持使用特殊字符，建议使用英文字母或数字。为避免多端登录冲突，请勿使用 1、123 等简单 ID。 |
-| sdkAppId | int | 在 [实时音视频 TRTC 控制台](https://console.cloud.tencent.com/trtc) 创建的音视频应用的唯一标识。 |
-| secretKey | String | 在 [实时音视频 TRTC 控制台](https://console.cloud.tencent.com/trtc) 创建的音视频应用的 SDKSecretKey。 |
-| userSig | String | 一种安全保护签名，用于对用户进行登录鉴权认证，确认用户是否真实，阻止恶意攻击者盗用您的云服务使用权。 |
+
+|参数|类型|说明|
+|---------|---------|---------|
+|userId|String|客户根据自己的业务自定义用户 ID，只允许包含大小写英文字母(a-z A-Z)、数字(0-9)及下划线和连词符。|
+|sdkAppId|int|在 [实时音视频 TRTC 控制台](https://console.cloud.tencent.com/trtc) 创建的音视频应用的唯一标识。|
+|secretKey|String|在 [实时音视频 TRTC 控制台](https://console.cloud.tencent.com/trtc) 创建的音视频应用的 SDKSecretKey。|
+|userSig|String|一种安全保护签名，用于对用户进行登录鉴权认证，确认用户是否真实，阻止恶意攻击者盗用您的云服务使用权。|
 
 > **说明：**
 >
@@ -139,10 +171,11 @@ void _setSelfInfo() {
     CompletionHandler result = TUICallKit.instance.setSelfInfo(nickname, avatar);
 }
 ```
-| 参数 | 类型 | 说明 |
-| --- | --- | --- |
-| nickname | String | 目标用户的昵称。 |
-| avatar | String | 目标用户的头像。 |
+
+|参数|类型|说明|
+|---------|---------|---------|
+|nickname|String|目标用户的昵称。|
+|avatar|String|目标用户的头像。|
 
 ### 步骤5：发起通话
 
@@ -159,18 +192,38 @@ void _call() {
     TUICallKit.instance.calls(participantIds, mediaType, callParams);
 }
 ```
-| 参数 | 类型 | 说明 |
-| --- | --- | --- |
-| userIdList | List<String> | 目标用户的 userId 列表。 |
-| mediaType | CallMediaType | 通话的媒体类型，例如视频通话、语音通话。 |
-| params | CallParams | 通话扩展参数，例如房间号、通话邀请超时时间等。 |
+
+|参数|类型|说明|
+|---------|---------|---------|
+|userIdList|List<String>|目标用户的 userId 列表。|
+|mediaType|CallMediaType|通话的媒体类型，例如视频通话、语音通话。|
+|params|CallParams|通话扩展参数，例如房间号、通话邀请超时时间等。|
 
 ### 步骤6：接听通话
 
-接听端完成登录后，拨打端发起通话，接收端就可以收到通话邀请，同时伴随铃声和振动。
+接听端完成登录后，拨打端发起通话，接听端就可以收到通话邀请，同时伴随铃声和振动。
 
 ## 更多功能
 
+### AI 转录与翻译
+
+您可以通过调用 `enableAITranscriber` 开启/关闭 AI 转录与翻译功能。
+
+> **注意：**
+>
+> 1. 该功能默认为开启状态（enable = true）。如需关闭，请在发起通话前调用 `enableAITranscriber`(enable: false)。
+> 2. AI 实时转录与翻译为增值服务。体验版赠送免费额度，可直接体验。如需开通正式版，请在 [实时音视频控制台](https://console.cloud.tencent.com/trtc) 开通套餐包，详见 [计费说明](https://cloud.tencent.com/document/product/647/111976)。
+
+``` java
+import 'package:tencent_calls_uikit/tencent_calls_uikit.dart';
+
+void _enableAITranscriber() {
+    TUICallKit.instance.enableAITranscriber(true);
+}
+```
+
+**详情：**默认为 true，通话界面上显示 AI 翻译相关页面，设置为 false 后关闭。
+
 ### 开启悬浮窗功能
 
 您可以通过调用 enableFloatWindow 开启/关闭悬浮窗功能，在初始化 TUICallKit 组件时启用该功能，默认状态为关闭（false）。可通过点击通话界面左上角的悬浮窗按钮，将通话界面缩小为悬浮窗形式。
@@ -219,11 +272,12 @@ void _call() {
     TUICallKit.instance.calls(participantIds, mediaType, callParams);
 }
 ```
-| 参数 | 类型 | 说明 |
-| --- | --- | --- |
-| userIdList | List<String> | 目标用户的 userId 列表。 |
-| mediaType | CallMediaType | 通话的媒体类型，例如视频通话、语音通话。 |
-| params | CallParams | 通话扩展参数，例如房间号、通话邀请超时时间，离线推送自定义内容等。 |
+
+|参数|类型|说明|
+|---------|---------|---------|
+|userIdList|List<String>|目标用户的 userId 列表。|
+|mediaType|CallMediaType|通话的媒体类型，例如视频通话、语音通话。|
+|params|CallParams|通话扩展参数，例如房间号、通话邀请超时时间，离线推送自定义内容等。|
 
 **加入多人通话：**可使用 `join` 方法加入指定的群组通话。
 
@@ -235,9 +289,10 @@ void join() {
     TUICallKit.instance.join(callId);
 }
 ```
-| 参数 | 类型 | 说明 |
-| --- | --- | --- |
-| callId | String | 此次通话的唯一标识。 |
+
+|参数|类型|说明|
+|---------|---------|---------|
+|callId|String|此次通话的唯一标识。|
 
 ### 语言设置
 - **支持的语言：**目前支持**简体中文、英文和日文，**默认语言为**英文 。**