@tencent-rtc/mcp 1.0.0

package/resource/doc/tuicallkit/flutter/how_to_integrated_flutter_callkit.md

@@ -0,0 +1,226 @@
+This article will guide you through the process of integrating the TUICallKit component quickly. By following this documentation, you can complete the access work in just 10 minutes and ultimately obtain an application with a complete user interface as well as audio and video calling features.
+<table>
+<tr>
+<td rowspan="1" colSpan="1" >Video Call</td>
+
+<td rowspan="1" colSpan="1" >Group call</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >![](https://write-document-release-1258344699.cos.ap-guangzhou.tencentcos.cn/100027182394/1390039d18d011ef9ff4525400f65c2a.png)</td>
+
+<td rowspan="1" colSpan="1" >![](https://write-document-release-1258344699.cos.ap-guangzhou.tencentcos.cn/100027182394/4cd1634b18ce11efb8185254005ac0ca.png)</td>
+</tr>
+</table>
+
+
+## Environment Preparations
+
+Flutter 3.0 or higher version.
+
+## Step 1. Activate the service
+
+Before using the audio and video services provided by Tencent Cloud, you need to go to the console to activate the audio and video services for your application, and obtain `SDKAppID, SDKSecretKey`. They will be used in [Step 5](https://write.woa.com/document/113558560409751552). For specific steps, please refer to [activate the Service.](https://write.woa.com/document/140196392040579072)
+
+## Step 2. Import the component
+
+Execute the following command in the command line to install the [tencent_calls_uikit](https://pub.dev/packages/tencent_calls_uikit) plugin.
+``` bash
+flutter pub add tencent_calls_uikit
+```
+
+## Step 3. Configure the project
+
+
+
+【Android】
+1. If you need to compile and run on the Android platform, since the SDK uses Java's reflection feature internally, certain classes in the SDK must be added to the non-aliasing list.
+
+  - First, configure and enable obfuscation rules in the `android/app/build.gradle` file of the project:
+
+``` java
+  android {
+    ......    
+    buildTypes {  
+        release {  
+            ......
+            minifyEnabled true  
+            proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'  
+        } 
+    }
+}
+```
+  - Create a `proguard-rules.pro` file in the `android/app` directory of the project, and add the following code in the `proguard-rules.pro` file:
+
+``` java
+-keep class com.tencent.** { *; }
+```
+2. Configure to enable Multidex support in the `android/app/build.gradle` file of your project.
+
+``` java
+  android {  
+    ......
+    defaultConfig {
+      ......
+      multiDexEnabled true
+    } 
+}
+```
+
+【iOS】
+
+Since TUICallKit uses iOS's audio and video features, you need to grant permissions for the use of the microphone and camera.
+
+Authorization Operation Method: In your iOS project's `Info.plist`, under the first-level `<dict>` directory, add the following two items. They correspond to the system's prompt messages when asking for microphone and camera permissions.
+``` java
+<key>NSCameraUsageDescription</key>
+<string>CallingApp needs to access your camera to capture video.</string>
+<key>NSMicrophoneUsageDescription</key>
+<string>CallingApp needs to access your microphone to capture audio.</string>
+```
+
+## Step 4: Set up navigatorObservers
+1. In the Flutter application framework, add TUICallKit.navigatorObserver to navigatorObservers. For example, using the MaterialApp framework, the code is as follows:
+
+   ``` java
+   import 'package:tencent_calls_uikit/tencent_calls_uikit.dart';
+   
+    ......
+   
+   class XXX extends StatelessWidget {
+     const XXX({super.key});
+   
+    @override
+     Widget build(BuildContext context) {
+       return MaterialApp(
+         navigatorObservers: [TUICallKit.navigatorObserver],
+         ......
+       );
+     }
+   }
+   ```
+
+## Step 5: Log in to the TUICallKit Component
+
+Use the [login](https://write.woa.com/document/114033067004104704) interface to complete the log-in. For specific usage, refer to the following code:
+``` java
+import 'package:tencent_calls_uikit/tencent_calls_uikit.dart';
+import 'package:tencent_calls_uikit/debug/generate_test_user_sig.dart';
+......
+
+final String userID    = 'xxxxx'; // Please replace with your UserId
+final int    sdkAppID  = 0;       // Please replace with the SDKAppID you got from the console in step 1
+final String secretKey = 'xxxx';  // Please replace with the SecretKey you got from the console in step 1
+
+void login() async {
+    String userSig  = GenerateTestUserSig.genTestSig(userID, sdkAppID, secretKey);
+    TUIResult result = await TUICallKit.instance.login(sdkAppID, userID, userSig);
+    if (result.code.isEmpty) {
+      print('Login success');
+    } else {
+      print('Login failed: ${result.code} ${result.message}');
+    }
+}
+```
+<table>
+<tr>
+<td rowspan="1" colSpan="1" >Parameter</td>
+
+<td rowspan="1" colSpan="1" >Type</td>
+
+<td rowspan="1" colSpan="1" >Description</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >userID</td>
+
+<td rowspan="1" colSpan="1" >String</td>
+
+<td rowspan="1" colSpan="1" >Customers define their own User ID based on their business. You can only include letters (a-z, A-Z), digits (0-9), underscores, and hyphens.</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >sdkAppID</td>
+
+<td rowspan="1" colSpan="1" >int</td>
+
+<td rowspan="1" colSpan="1" >The unique identifier of the audio and video application created in the [Tencent RTC Console](https://console.trtc.io/).</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >secretKey</td>
+
+<td rowspan="1" colSpan="1" >String</td>
+
+<td rowspan="1" colSpan="1" >SDKSecretKey for the audio and video application created in [Tencent RTC Console](https://console.trtc.io/).</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >userSig</td>
+
+<td rowspan="1" colSpan="1" >String</td>
+
+<td rowspan="1" colSpan="1" >A security protection signature used for user log in authentication to confirm the user's identity and prevent malicious attackers from stealing your cloud service usage rights.</td>
+</tr>
+</table>
+
+
+> **Note:**
+> 
+> - **Development Environment**: If you are in the local development and debugging stage, you can use the local `GenerateTestUserSig.genTestSig` function to generate userSig. In this method, the SDKSecretKey is vulnerable to decompilation and reverse engineering, and once your key is leaked, attackers can steal your Tencent Cloud traffic.
+> - **Production Environment**: If your project is going to be launched, please adopt the method of [Server-side Generation of UserSig](https://www.tencentcloud.com/document/product/647/35166?lang=en&pg=#how-do-i-calculate-.60usersig.60-in-a-production-environment.3F).
+
+
+## Step 6. Make your first phone call
+
+After both the caller and callee have successfully signed in, the caller can initiate an audio or video call by calling the TUICallKit's call method and specifying the call type and the callee's userId. At this point, the callee will receive an incoming call invitation.
+``` java
+
+import 'package:tencent_calls_uikit/tencent_calls_uikit.dart';
+......
+
+void call() {
+    List<String> userIdList = ['Android'];
+    TUICallKit.instance.calls(userIdList, TUICallMediaType.audio);
+}
+```
+<table>
+<tr>
+<td rowspan="1" colSpan="1" >![](https://write-document-release-1258344699.cos.ap-guangzhou.tencentcos.cn/100027182394/9a7977f7ec0f11ee896d5254005cb287.png)</td>
+
+<td rowspan="1" colSpan="1" >![](https://write-document-release-1258344699.cos.ap-guangzhou.tencentcos.cn/100027182394/96d0cc00ec0f11eeb5dc525400aa857d.png)</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >Caller</td>
+
+<td rowspan="1" colSpan="1" >Callee</td>
+</tr>
+</table>
+
+
+## Additional Features
+- [Customize Interface](https://write.woa.com/document/119356800679190528)
+
+- [Offline Push](https://write.woa.com/document/142911918280658944)
+
+- [Group Call](https://write.woa.com/document/140196498678116352)
+
+- [Floating Window](https://write.woa.com/document/140196506800930816)
+
+- [Custom Ringtone](https://write.woa.com/document/140196510742061056)
+
+- [Call Status Monitoring](https://write.woa.com/document/140196527978475520)
+
+- [Cloud Recording](https://write.woa.com/document/95824491274473472)
+
+- [Beauty Effects](https://write.woa.com/document/133965491956793344)
+
+
+## FAQs
+
+If you encounter any issues during integration and use, please refer to [Frequently Asked Questions](https://write.woa.com/document/121896145600688128).
+
+## Suggestions and Feedback
+
+If you have any suggestions or feedback, please contact info_rtc@tencent.com.

package/resource/doc/tuicallkit/flutter/how_to_run_flutter_callkit_demo.md

@@ -0,0 +1,101 @@
+This article will guide you on how to quickly run through the Audio and Video Call Demo. By following this document, you can have the Demo up and running in 10 minutes, and ultimately experience an Audio and Video Call feature with a complete UI interface.
+<table>
+<tr>
+<td rowspan="1" colSpan="1" >1v1 Video Call</td>
+
+<td rowspan="1" colSpan="1" >Group call</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >![](https://write-document-release-1258344699.cos.ap-guangzhou.tencentcos.cn/100027164818/b8670a89190311ef957f525400f65c2a.png)</td>
+
+<td rowspan="1" colSpan="1" >![](https://write-document-release-1258344699.cos.ap-guangzhou.tencentcos.cn/100027164818/5866a4f4190311efa1975254005ac0ca.png)</td>
+</tr>
+</table>
+
+
+## Environment preparations
+
+### Flutter
+
+Flutter 3.0 or later.
+
+### Android 
+- Android Studio 3.5 or above.
+
+- Android devices with Android 4.1 or higher versions.
+
+
+### iOS
+- Xcode 13.0 or above.
+
+- Please ensure your project is set up with a valid developer signature.
+
+
+## Step 1: Download the Demo
+1. Download the [TUICallKit Demo](https://github.com/Tencent-RTC/TUICallKit/tree/main) source code from GitHub, or directly run the following command in the command line:
+
+   ``` bash
+     git clone 
+   ```
+2. Open the TUICallKit Flutter example in Android Studio or VSCode. The following process will take Android Studio as an example:
+
+
+   ![](https://write-document-release-1258344699.cos.ap-guangzhou.tencentcos.cn/100032451803/34ec5a44126311efa2935254005ac0ca.png)
+
+
+## Step 2: Configure the Demo
+1. [Activate the audio and video services](https://write.woa.com/document/140196392040579072), to obtain the **SDKAppID** and **SDKSecretKey**.
+
+
+   ![](https://write-document-release-1258344699.cos.ap-guangzhou.tencentcos.cn/100032451803/350369ae126311ef9fa952540019e87e.png)
+
+2. Open the `Flutter/example/lib/debug/generate_test_user_sig.dart` file and fill in the SDKAppID and SDKSecretKey obtained when [Activating the Service](https://write.woa.com/document/140196392040579072):
+
+
+   ![](https://write-document-release-1258344699.cos.ap-guangzhou.tencentcos.cn/100032451803/a8926a892d3911ef9bb3525400ab9413.png)
+
+
+## Step 3: Running the Demo
+1. In the top right corner of Android Studio, select the device you want to run the Demo on as shown below:
+
+
+   ![](https://write-document-release-1258344699.cos.ap-guangzhou.tencentcos.cn/100032451803/6e880f462d3f11efa4f552540077de32.png)
+
+2. After selecting, click Run to execute the TUICallKit Android Demo on the target device.
+
+
+   ![](https://write-document-release-1258344699.cos.ap-guangzhou.tencentcos.cn/100032451803/79760e132d3f11ef97da5254007d9c55.png)
+
+
+## Make the first call
+
+> **Note:**
+> 
+
+> To experience the complete audio and video calling process, please log into the Demo on two devices as two different users, with one acting as the caller and the other as the callee.
+> 
+
+1. Log in & Signup
+
+
+   Please enter the ID at the `User ID`. If your current User ID has not been used before, you will be taken to the **Signup** screen, where you can set your own avatar and nickname.
+
+
+   ![](https://write-document-release-1258344699.cos.ap-guangzhou.tencentcos.cn/100032451803/b51ef4631e6911ef860b52540049c929.png)
+   
+
+   > **Note:**
+   > 
+
+   > Try to avoid setting your User ID to simple strings like "1", "123", "111", as TRTC does not support the same User ID being logged into from multiple devices. Such User IDs like "1", "123", "111" are easily occupied by your colleagues during collaborative development, leading to login failures. Therefore, we recommend setting highly recognizable User IDs while debugging.
+   > 
+
+2. Make a phone call
+
+  1. The caller should click **1V1 Call** on the interface, enter the callee's User ID in the pop-up interface, and select the desired call type.
+
+  2. Click **Initiate Call**.
+
+
+      ![](https://write-document-release-1258344699.cos.ap-guangzhou.tencentcos.cn/100032451803/ac43fa871e6a11efbef6525400a8a0fb.png)