@tencent-rtc/mcp 1.3.8 → 1.3.9

package/resource/doc/tuicallkit/android/integration.md

@@ -1,40 +1,35 @@
-This article will guide you through the quick integration of the TUICallKit component. You will complete several key steps within 10 minutes, ultimately obtaining a video call feature with a complete UI interface.
-<table>
-<tr>
-<td rowspan="1" colSpan="1" >1v1 Video Call</td>
+This document describes how to rapidly integrate the TUICallKit component. You can complete the following key steps within 10 minutes and obtain a complete audio and video call interface.
 
-<td rowspan="1" colSpan="1" >Group call</td>
-</tr>
+![](https://write-document-release-1258344699.cos.ap-guangzhou.tencentcos.cn/100032357901/3be225d7b0b011f099275254005ef0f7.png)
 
-<tr>
-<td rowspan="1" colSpan="1" >![](https://write-document-release-1258344699.cos.ap-guangzhou.tencentcos.cn/100027119876/eb424eb7190311ef8a48525400762795.png)</td>
 
-<td rowspan="1" colSpan="1" >![](https://write-document-release-1258344699.cos.ap-guangzhou.tencentcos.cn/100027119876/eb45d2e8190311efa1975254005ac0ca.png)</td>
-</tr>
-</table>
+## Preparations
 
+### **Environmental Requirements**
+- **Android Version Requirements**: Android 5.0 (SDK API Level 21) and above.
 
-## Environment Preparations
-- Android 5.0 (SDK API level 21) or later.
+- **Gradle Version Requirements**: Gradle 4.2.1 and above.
 
-- Gradle 4.2.1 or later
+- **Device Requirements**: Mobile devices running Android 5.0 or higher.
 
-- Mobile phone on Android 5.0 or later.
+- **Networking Requirements**: The device must be able to connect to the public network.
 
 
-## Step 1. Activate the service
+### Service Activation
 
-Before using the Audio and Video Services provided by Tencent Cloud, you need to go to the Console and activate the service for your application. For detailed steps, refer to [Activate Service](https://write.woa.com/document/140196392040579072). Please record the `SDKAppID` and `SDKSecretKey`, they will be used for the following steps.
+Please refer to the [Service Activation](https://write.woa.com/document/140196392040579072) documentation to obtain your SDKAppID and SDKSecretKey. These credentials will be required in the subsequent [login](https://write.woa.com/#b83bb482-a7f3-4dd7-9fab-fdb92749432e) step.
 
-## Step 2. Download and import the component
+## Implementation
 
-Go to [GitHub](https://github.com/tencentyun/TUICalling), clone or download the code, and copy the `tuicallkit-kt` subdirectory in the `Android` directory to the directory at the same level as `app` in your current project, as shown below.
+### Step 1.Importing Components
 
-![](https://write-document-release-1258344699.cos.ap-guangzhou.tencentcos.cn/100027119876/730f6f49e10a11eeb419525400ea3514.png)
+Clone or download the code from [GitHub](https://github.com/Tencent-RTC/TUIKit_Android). Then, copy the `atomic_x` directory (under `TUIKit_Android`) and the `tuicallkit-kt` subdirectory (under `call`) to the directory at the same level as your project's app directory, as shown below.
 
+![](https://write-document-release-1258344699.cos.ap-guangzhou.tencentcos.cn/100032357901/246ca1dcf08111f0a94d52540073fd3b.png)
 
-## Step 3. Configure the project
-1. Find the `settings.gradle.kts(or settings.gradle)` file in the project root directory and add the following code to import the `tuicallkit-kt` component.
+
+### Step 2.Project Configuration
+1. Locate the `settings.gradle.kts` (or s`ettings.gradle`) file in the project root directory. Add the following code to import the `tuicallkit-kt` and `atomic_x` components into your project.
 
 
    
@@ -43,15 +38,17 @@ Go to [GitHub](https://github.com/tencentyun/TUICalling), clone or download the
 【setting.gradle.kts】
 ``` java
 include(":tuicallkit-kt")
+include(":atomic_x")
 ```
 
 
 【settings.gradle】
 ``` java
 include ':tuicallkit-kt'
+include ':atomic_x'
 ```
 
-2. Find the `build.gradle.kts`(or `build.gradle`) file in the `app` directory, add the following code to its `dependencies` section. This is to declare the current app's dependency on the newly added components.
+2. Locate the `build.gradle.kts (or build.gradle)` file under the app directory, and add the following code in `dependencies` to declare the app's dependency on the component.
 
 
    
@@ -76,21 +73,20 @@ dependencies {
    > **Note:**
    > 
 
-   > The `TUICallKit` project depends on `TRTC SDK`, `Chat SDK`, `tuicallengine`, and the `tuicore` public library internally by default. To upgrade the version, modify the version in `tuicallkit-kt/build.gradle` file.
+   > The TUICallKit project internally depends on `TRTC SDK`,`IM SDK`,`tuicallengine` and public library `tuicore` by default. Developers do not need to configure them separately. If needed, just modify the version number in `tuicallkit-kt/build.gradle` file to upgrade.
    > 
 
-3. Since the SDK uses Java's reflection feature internally, you need to add certain classes in the SDK to the obfuscation allowlist. Therefore, you should add the following code to the `proguard-rules.pro` file in the `app` directory. After adding, click on the upper right corner "**Sync Now**" to synchronize the code.
+3. `proguard-rules.pro`**Configuration**:Since the SDK internally uses Java reflection, certain classes must be added to the non-obfuscation list (ProGuard exclusion list). Please add the following configuration to the end of the `proguard-rules.pro` file:
 
    ``` java
    -keep class com.tencent.** { *; }
    ```
-4. In the app directory, find the `AndroidManifest.xml` file and add `tools:replace="android:allowBackup"` within the application node to override the settings inside the components, using your own settings.
+4. `AndroidManifest.xml`**Configuration**:In the AndroidManifest.xml file within the app directory, add `tools:replace="android:allowBackup"` within the <application> node to overwrite the component's default settings and apply your own configuration.
 
    ``` java
      // app/src/main/AndroidManifest.xml
-     
-     <application
-       android:name=".DemoApplication"
+      <application
+       android:name=".BaseApplication"
        android:allowBackup="false"
        android:icon="@drawable/app_ic_launcher"
        android:label="@string/app_name"
@@ -98,16 +94,17 @@ dependencies {
        android:theme="@style/AppTheme"
        tools:replace="android:allowBackup">
    ```
-5. We suggest you compile and run once. If you encounter any issues, you may try our [Github demo](https://github.com/Tencent-RTC/TUICallKit/tree/main/Android). By comparison, you can identify potential differences and resolve encountered issues. During integration and use, if any issues arise, you are welcome to provide [feedback](https://github.com/Tencent-RTC/TUICallKit/issues) to us.
 
+### Step 3.Login
 
-## Step 4. Log in to the TUICallKit component
+Add the following code in your project. It enables logging in to the TUI component by calling the relevant APIs in TUICore. This procedure is critical. Only after a successful login can you properly use the features provided by TUICallKit.
 
-Add the following code to your project. It works by calling the relevant interfaces in TUICore to complete the login to TUI Component. This step is very important, only after successfully logging in, you can normally use the features offered by TUICallKit.
 
 
 
-【Kotlin】
+
+
+【Android（Kotlin）】
 ``` java
 import com.tencent.qcloud.tuicore.TUILogin
 import com.tencent.qcloud.tuicore.interfaces.TUICallback
@@ -117,25 +114,23 @@ class MainActivity : ComponentActivity() {
     override fun onCreate(savedInstanceState: Bundle?) {
         super.onCreate(savedInstanceState)
 
-        // begin  
-        val userID = "denny"     // Please replace with your UserId
-        val sdkAppID = 0         // Please replace with the SDKAppID obtained from the console in step 1
-        val secretKey = "****"   // Please replace with the SecretKey obtained from the console in step 1
-        
-        val userSig = GenerateTestUserSig.genTestUserSig(userId, sdkAppId, secretKey)
-        
+
+        val userId = "denny"     // replace with your UserId
+        val sdkAppId = 0         // replace with the SDKAppID obtained from the console
+        val secretKey = "****"   // replace with the SecretKey obtained from the console
+        val userSig = GenerateTestUserSig.genTestUserSig(userId, sdkAppId, secretKey) 
         TUILogin.login(this, sdkAppId, userId, userSig, object : TUICallback() {
             override fun onSuccess() {
             }
             override fun onError(errorCode: Int, errorMessage: String) {
             }
-         })    
-        // end
+         }) 
     }
 }
 ```
 
-【Java】
+
+【Android（Java）】
 ``` java
 import com.tencent.qcloud.tuicore.TUILogin;
 import com.tencent.qcloud.tuicore.interfaces.TUICallback;
@@ -145,14 +140,11 @@ public class MainActivity extends AppCompatActivity {
     @Override
     public void onCreate(Bundle savedInstanceState) {
         super.onCreate(savedInstanceState);
-
-        //begin
-        String userID = "denny";     // Please replace with your UserId
-        int sdkAppID = 0;            // Please replace with the SDKAppID obtained from the console in step 1
-        String secretKey = "****";   // Please replace with the SecretKey obtained from the console in step 1
         
+        String userId = "denny";     // replace with your UserId
+        int sdkAppId = 0;            // replace with the SDKAppID obtained in step 1 on the console
+        String secretKey = "****";   // replace with the SecretKey obtained in step 1 on the console
         String userSig = GenerateTestUserSig.genTestUserSig(userId, sdkAppId, secretKey);
-        
         TUILogin.login(this, sdkAppId, userId, userSig, new TUICallback() {
             @Override
             public void onSuccess() {
@@ -162,9 +154,9 @@ public class MainActivity extends AppCompatActivity {
             public void onError(int errorCode, String errorMessage) {
             }
         });
-        //end
     }
 }
+
 ```
 <table>
 <tr>
@@ -180,7 +172,7 @@ public class MainActivity extends AppCompatActivity {
 
 <td rowspan="1" colSpan="1" >String</td>
 
-<td rowspan="1" colSpan="1" >your own User ID based on your business. It can only include letters (a-z, A-Z), digits (0-9), underscores, and hyphens.</td>
+<td rowspan="1" colSpan="1" >Only allowing a combination of uppercase and lowercase letters (a-z A-Z), numbers (0-9), hyphens, and underscores.</td>
 </tr>
 
 <tr>
@@ -188,7 +180,7 @@ public class MainActivity extends AppCompatActivity {
 
 <td rowspan="1" colSpan="1" >int</td>
 
-<td rowspan="1" colSpan="1" >The unique identifier SDKAppID for the audio and video application created in [Tencent RTC Console](https://console.trtc.io/).</td>
+<td rowspan="1" colSpan="1" >The unique identifier SDKAppID of the audio and video application created in the [Tencent Real-Time Communication (TRTC) Console](https://trtc.io/login?fro=gt&s_url=https%3A%2F%2Fconsole.trtc.io%2F).</td>
 </tr>
 
 <tr>
@@ -196,7 +188,7 @@ public class MainActivity extends AppCompatActivity {
 
 <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>
+<td rowspan="1" colSpan="1" >The SDKSecretKey of the audio/video application created in the [Tencent Real-Time Communication (TRTC) Console](https://trtc.io/login?fro=gt&s_url=https%3A%2F%2Fconsole.trtc.io%2F).</td>
 </tr>
 
 <tr>
@@ -204,83 +196,547 @@ public class MainActivity extends AppCompatActivity {
 
 <td rowspan="1" colSpan="1" >String</td>
 
-<td rowspan="1" colSpan="1" >A security signature for user login to verify identity and prevent unauthorized access to cloud services.</td>
+<td rowspan="1" colSpan="1" >A security protection signature used to authenticate user login, confirm whether the user is genuine, and prevent malicious attackers from misappropriating your cloud service usage rights.</td>
 </tr>
 </table>
 
 
-> **Note:**
+> **Note :**
 > 
-> - **Development Environment**: During local development and debugging, use the local `GenerateTestUserSig.genTestSig` function to create a userSig. But be careful, the SDKSecretKey can be decompiled and reverse-engineered. If leaked, it could allow theft of 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).
+> - **Development environment**: If you are in the local development and debugging stage, you can adopt the local [GenerateTestUserSig.genTestUserSig](https://github.com/Tencent-RTC/TUIKit_Android/blob/main/application/debug/src/main/java/com/tencent/qcloud/tuikit/debug/GenerateTestUserSig.java) function to generate userSig. In this method, the SDKSecretKey is very easy to decompile and reverse engineer. Once your key is leaked, attackers can steal your Tencent Cloud traffic.
+> - **Production environment**: If your project is ready to launch, use [server-side generation of UserSig](https://write.woa.com/document/89644530319802368).
+
+
+### Step 4.Set Nickname and Avatar [Optional]
+
+After a successful login, you can call the `setSelfInfo` function to set your nickname and avatar. The set nickname and avatar will be displayed on the caller/callee interface.
+
+
+
+
+
+
+【Android（Kotlin）】
+``` java
+import com.tencent.qcloud.tuikit.tuicallkit.TUICallKit
+
+val nickname = "jack"
+val avatar = "https:/****/user_avatar.png"
+TUICallKit.createInstance(context).setSelfInfo(nickname, avatar, null)
+```
+
+
+【Android（Java）】
+``` java
+import com.tencent.qcloud.tuikit.tuicallkit.TUICallKit;
+
+String nickname = "jack";
+String avatar = "https:/****/user_avatar.png";
+TUICallKit.createInstance(context).setSelfInfo(nickname, avatar, null);
+```
+<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" >nickname</td>
+
+<td rowspan="1" colSpan="1" >String</td>
+
+<td rowspan="1" colSpan="1" >Target user's nickname</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >avatar</td>
+
+<td rowspan="1" colSpan="1" >String</td>
+
+<td rowspan="1" colSpan="1" >Target user's avatar</td>
+</tr>
+</table>
+
+
+### Step 5.Initiating a Call
+
+The caller initiates a call by invoking the `calls` function and specifying the media type (voice or video) and the callee's User ID list (userIdList). The calls interface supports both one-to-one and group calls. A one-to-one call is initiated when the userIDList contains only a single User ID; a group call is initiated when it contains multiple User IDs.
+
+
+
+
+
+
+【Kotlin】
+``` java
+import com.tencent.qcloud.tuikit.tuicallkit.TUICallKit
+import io.trtc.tuikit.atomicxcore.api.call.CallMediaType
+import io.trtc.tuikit.atomicxcore.api.call.CallParams
+
+val userIdList = mutableListOf<String>()
+userIdList.add("mike")
+val mediaType = CallMediaType.Audio
+val callParams = CallParams()
+TUICallKit.createInstance(context).calls(userIdList, mediaType, params, null)
+```
+
+
+【Java】
+``` java
+
+import com.tencent.qcloud.tuikit.tuicallkit.TUICallKit;
+import io.trtc.tuikit.atomicxcore.api.call.CallMediaType;
+import io.trtc.tuikit.atomicxcore.api.call.CallParams;
+
+List<String> userIdList = new ArrayList<>();
+userIdList.add("mike");
+CallMediaType mediaType = CallMediaType.Audio;
+CallParams params = new CallParams();
+TUICallKit.createInstance(this).calls(userIdList, mediaType, params, null);
+```
+<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" >userIdList</td>
+
+<td rowspan="1" colSpan="1" >List<String></td>
+
+<td rowspan="1" colSpan="1" >Target user ID list</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >mediaType</td>
+
+<td rowspan="1" colSpan="1" >[CallMediaType](https://liteav.sdk.cloudcachetci.com/doc/product/tuikit/atomic-x/android/en/-atomic-x%20-core%20-a-p-i/io.trtc.tuikit.atomicxcore.api.call/-call-media-type/index.html)</td>
+
+<td rowspan="1" colSpan="1" >Media type of the call, such as video call, voice call</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >params</td>
+
+<td rowspan="1" colSpan="1" >[CallParams](https://liteav.sdk.cloudcachetci.com/doc/product/tuikit/atomic-x/android/en/-atomic-x%20-core%20-a-p-i/io.trtc.tuikit.atomicxcore.api.call/-call-params/index.html)</td>
+
+<td rowspan="1" colSpan="1" >Call extension parameters, such as room number, call invitation timeout.</td>
+</tr>
+</table>
+
+
+### Step 6.Answering a Call
+
+Once the callee successfully logs in, the caller can initiate a call, and the callee will receive the call invitation, accompanied by a ringtone and vibration.
+
+## More Features
+
+### Enabling Floating Window
+
+You can enable/disable the floating window feature by calling [enableFloatWindow](https://write.woa.com/document/95824745037205504). This feature should be enabled when initializing the TUICallKit component, with the default status being Off (false).
+
+![](https://write-document-release-1258344699.cos.ap-guangzhou.tencentcos.cn/100032357901/9355568fb0b111f097b152540099c741.png)
 
 
-## Step 5. Make your first phone call
 
-After user login success,  invoke the [calls](https://write.woa.com/document/95824745037205504) method  of TUICallKit, specifying the callee's userID and the type of call, to initiate an audio/video call. The callee will receive an incoming call invitation.
 
 
 
 
 【Kotlin】
 ``` java
-import com.tencent.qcloud.tuikit.tuicallengine.TUICallDefine
 import com.tencent.qcloud.tuikit.tuicallkit.TUICallKit
 
-val list = mutableListOf<String>()
-list.add("mike")
-TUICallKit.createInstance(context).calls(list, TUICallDefine.MediaType.Audio, null, null)
+TUICallKit.createInstance(this).enableFloatWindow(true)
 ```
 
 
 【Java】
 ``` java
-import com.tencent.qcloud.tuikit.tuicallengine.TUICallDefine;
 import com.tencent.qcloud.tuikit.tuicallkit.TUICallKit;
 
-List<String> list = new ArrayList<>();
-list.add("mike")
-TUICallKit.createInstance(context).calls(list, TUICallDefine.MediaType.Audio, null, null);
+TUICallKit.createInstance(this).enableFloatWindow(true);
+```
+
+**Details:** Default false, the floating window button in the top-left corner of the call interface is hidden. Set to true to display.
+
+### Enabling Banner
+
+You can enable or disable the incoming call banner display by calling `enableIncomingBanner`. By default, this feature is disabled (false). When the callee receives an inbound call, the full-screen call waiting interface is shown first. When the banner is enabled, a notification banner will display initially, switching to the full-screen view as required. Note that displaying the banner requires floating window permission. The exact display behavior depends on permission settings and whether the app is running in the foreground or background. For details, refer to the [incoming call display policy for the callee](https://write.woa.com/document/145196717502525440).
+
+![](https://write-document-release-1258344699.cos.ap-guangzhou.tencentcos.cn/100032357901/c6054e19b0b111f0b96752540044a08e.png)
+
+
+
+
+
+
+
+【Android（Kotlin）】
+``` java
+import com.tencent.qcloud.tuikit.tuicallkit.TUICallKit
+
+TUICallKit.createInstance(context).enableIncomingBanner(true)
+```
+
+
+【Android（Java）】
+``` java
+import com.tencent.qcloud.tuikit.tuicallkit.TUICallKit;
+
+TUICallKit.createInstance(context).enableIncomingBanner(true);
+```
+
+**Details:** Default false. The callee side pops up the full-screen call waiting interface by default when receiving an invitation. When enabled, a banner is displayed first, then the full-screen call interface is pulled up as needed.
+
+### Multi-Person Calling
+
+When the caller uses the `calls` method to initiate a call, if the list of called users exceeds one person, it is automatically recognized as a multi-person call. Other members can then join this multi-person call using the `join` method.
+- **Initiating a Multi-person Call:** When the `calls` method is used to initiate a call, if the callee User ID list (userIdList) contains more than one user, it will be automatically deemed a multi-person call.
+
+
+   
+
+
+
+
+【Android（Kotlin）】
+``` java
+import com.tencent.cloud.tuikit.engine.call.TUICallDefine
+import com.tencent.qcloud.tuikit.tuicallkit.TUICallKit
+import io.trtc.tuikit.atomicxcore.api.call.CallMediaType
+import io.trtc.tuikit.atomicxcore.api.call.CallParams
+
+val userIdList = mutableListOf<String>()
+userIdList.add("mike")
+userIdList.add("tate")
+val mediaType = CallMediaType.Audio
+val params = CallParams()
+TUICallKit.createInstance(context).calls(userIdList, mediaType, params, null)
+```
+
+
+【Android（Java）】
+``` java
+import com.tencent.cloud.tuikit.engine.call.TUICallDefine;
+import com.tencent.qcloud.tuikit.tuicallkit.TUICallKit;
+import io.trtc.tuikit.atomicxcore.api.call.CallMediaType;
+import io.trtc.tuikit.atomicxcore.api.call.CallParams;
+
+List<String> userIdList = new ArrayList<>();
+userIdList.add("mike");
+userIdList.add("tate");
+CallMediaType mediaType = CallMediaType.Audio;
+CallParams params = new CallParams();
+TUICallKit.createInstance(context).calls(userIdList, mediaType, params, null);
 ```
 <table>
 <tr>
-<td rowspan="1" colSpan="1" >Caller initiates an audio call</td>
+<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" >userIdList</td>
+
+<td rowspan="1" colSpan="1" >List<String></td>
 
-<td rowspan="1" colSpan="1" >Callee receives an audio call request</td>
+<td rowspan="1" colSpan="1" >Target user ID list</td>
 </tr>
 
 <tr>
-<td rowspan="1" colSpan="1" >![](https://write-document-release-1258344699.cos.ap-guangzhou.tencentcos.cn/100027119876/078b6eea190411ef8a48525400762795.png)</td>
+<td rowspan="1" colSpan="1" >mediaType</td>
+
+<td rowspan="1" colSpan="1" >[CallMediaType](https://liteav.sdk.cloudcachetci.com/doc/product/tuikit/atomic-x/android/en/-atomic-x%20-core%20-a-p-i/io.trtc.tuikit.atomicxcore.api.call/-call-media-type/index.html)</td>
 
-<td rowspan="1" colSpan="1" >![](https://write-document-release-1258344699.cos.ap-guangzhou.tencentcos.cn/100027119876/077a2a05190411ef88ad5254002977b6.png)</td>
+<td rowspan="1" colSpan="1" >Media type of the call, such as video call, voice call</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >params</td>
+
+<td rowspan="1" colSpan="1" >[CallParams](https://liteav.sdk.cloudcachetci.com/doc/product/tuikit/atomic-x/android/en/-atomic-x%20-core%20-a-p-i/io.trtc.tuikit.atomicxcore.api.call/-call-params/index.html)</td>
+
+<td rowspan="1" colSpan="1" >Call extension parameters, such as room number, call invitation timeout.</td>
 </tr>
 </table>
 
 
-## 
+- **Joining a Multi-person Call:** You can use the `join` method to enter the specified multi-person call.
 
-## Additional Features
-- [Setting Nickname, Avatar](https://write.woa.com/document/140283519901868032)
 
-- [Customize Interface](https://write.woa.com/document/95821305653407744)
+   
+
 
-- [Offline Push](https://write.woa.com/document/95821638488313856)
 
-- [Group Call](https://write.woa.com/document/140196498678116352)
 
-- [Floating Window](https://write.woa.com/document/140196506800930816)
+【Android（Kotlin）】
+``` java
+import com.tencent.qcloud.tuikit.tuicallkit.TUICallKit
 
-- [Custom Ringtone](https://write.woa.com/document/140196520174002176)
+val callId = "123456"
+TUICallKit.createInstance(this).join(callId, null)
+```
 
-- [Call Status Monitoring](https://write.woa.com/document/140196527978475520)
 
-- [Cloud Recording](https://write.woa.com/document/95824491274473472)
+【Android（Java）】
+``` java
+import com.tencent.qcloud.tuikit.tuicallkit.TUICallKit;
+
+String callId = "123456";
+TUICallKit.createInstance(this).join(callId, null);
+```
+<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" >callId</td>
+
+<td rowspan="1" colSpan="1" >String</td>
+
+<td rowspan="1" colSpan="1" >The unique ID for this call.</td>
+</tr>
+</table>
+
+
+
+### Language Settings
+- **Supported Languages:** We currently support Simplified Chinese, Traditional Chinese, English, Japanese, and Arabic.
+
+- **Switching Languages:** By default, the language of TUICallKit is consistent with the mobile operating system's language setting. To switch the language, you can use the `TUIThemeManager.getInstance().changeLanguage` method.
+
+
+   
+
+
+
+
+【Android（Kotlin）】
+``` java
+import com.tencent.qcloud.tuicore.TUIThemeManager;
+
+public class MainActivity extends BaseActivity {
+    @Override
+  public void onCreate(Bundle savedInstanceState) {
+      super.onCreate(savedInstanceState)
+      
+      val language = TUIThemeManager.LANGUAGE_ZH_CN
+      TUIThemeManager.getInstance().changeLanguage(applicationContext, language)
+    }
+}
+```
+
+
+【Android（Java）】
+``` java
+import com.tencent.qcloud.tuicore.TUIThemeManager;
+
+public class MainActivity extends BaseActivity {
+    @Override
+  public void onCreate(Bundle savedInstanceState) {
+      super.onCreate(savedInstanceState);
+      String language = TUIThemeManager.LANGUAGE_EN;
+      TUIThemeManager.getInstance().changeLanguage(getApplicationContext(), language);
+    }
+}
+```
+<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" >language</td>
+
+<td rowspan="1" colSpan="1" >String</td>
+
+<td rowspan="1" colSpan="1" >- TUIThemeManager.LANGUAGE_EN: English.<br>- TUIThemeManager.LANGUAGE_AR: Arabic.<br>- TUIThemeManager.LANGUAGE_ZH_HK: Traditional Chinese.<br>- TUIThemeManager.LANGUAGE_ZH_CN: Simplified Chinese.</td>
+</tr>
+</table>
+
+
+> **Note：**
+> 
+
+> If you need to set up other languages, please contact us at **info_rtc@tencent.com** for assistance.
+> 
+
+
+
+### Ringtone Setting
+
+You can set the default ringtone, incoming call silent mode, and Offline Push Ringtone in the following ways:
+- **Setting Default Ringtone (Method 1):** If you include TUICallKit component via source code, you can replace the resource file ([ringtone when initiating a call](https://github.com/Tencent-RTC/TUIKit_Android/tree/main/call/tuicallkit-kt/src/main/res/raw), [ringtone when receiving a call](https://github.com/Tencent-RTC/TUIKit_Android/blob/main/call/tuicallkit-kt/src/main/res/raw/phone_ringing.mp3)) to set a custom default ringtone.
+
+- **Setting Default Ringtone (Method 2):** Use the `setCallingBell` interface to set the incoming call ringtone received by the callee.
+
+
+   
+
+
+
+
+【Android（Kotlin）】
+``` java
+import com.tencent.qcloud.tuikit.tuicallkit.TUICallKit
+
+val filePath = "***/callingBell.mp3"
+TUICallKit.createInstance(context).setCallingBell(filePath)
+```
+
+
+【Android（Java）】
+``` java
+import com.tencent.qcloud.tuikit.tuicallkit.TUICallKit;
+
+String filePath = "***/callingBell.mp3";
+TUICallKit.createInstance(context).setCallingBell(filePath);
+```
+
+**Details:**The local file path of the ringtone. Only local file paths can be imported here. Ensure the file directory is accessible to the app. The ringtone setting is bound to the device. Replacing the user will not affect the ringtone. To restore the default ringtone, pass an empty string ("") as the filePath.
+<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" >filePath</td>
+
+<td rowspan="1" colSpan="1" >String</td>
+
+<td rowspan="1" colSpan="1" >ringtone file path</td>
+</tr>
+</table>
+
+
+- **Incoming call silent mode:** You can set mute mode through `enableMuteMode`.
+
+
+   
+
+
+
+
+【Android（Kotlin）】
+``` java
+import com.tencent.qcloud.tuikit.tuicallkit.TUICallKit
+
+TUICallKit.createInstance(context).enableMuteMode(true)
+```
+
+
+【Android（Java）】
+``` java
+import com.tencent.qcloud.tuikit.tuicallkit.TUICallKit;
+
+TUICallKit.createInstance(context).enableMuteMode(true);
+```
+
+**Details:** When set to true, incoming call requests will not trigger ringtone playback (silent mode).
+
+- **Custom offline push ringtone**: Please refer to: [FCM Offline Push customizes incoming call ringtone](https://write.woa.com/document/95821638488313856).
+
+
+## Customizing Your UI
+
+### Replacing Icon Button
+
+You can directly replace the icons under the [res\drawable-xxhdpi](https://github.com/Tencent-RTC/TUIKit_Android/tree/main/atomic_x/src/main/res-callview/drawable-xxhdpi) folder to ensure the icon color and style remain consistent throughout the entire App. The following list shows basic feature buttons. You can replace the corresponding icons to fit your own business scenario.
+
+
+
+
+
+
+
+Commonly Used Icon File Name List
+<table>
+<tr>
+<td rowspan="1" colSpan="1" >Icon</td>
+
+<td rowspan="1" colSpan="1" >File name</td>
+
+<td rowspan="1" colSpan="1" >Description</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" >![](https://write-document-release-1258344699.cos.ap-guangzhou.tencentcos.cn/100032357901/ee93f5f6af1311f0b5345254005ef0f7.png)</td>
+
+<td rowspan="1" colSpan="1" >callview_ic_dialing.png</td>
+
+<td rowspan="1" colSpan="1" >Answer incoming call icon</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" ><br>![](https://write-document-release-1258344699.cos.ap-guangzhou.tencentcos.cn/100032357901/eeb7bf23af1311f09710525400e889b2.png)</td>
+
+<td rowspan="1" colSpan="1" >callview_ic_hangup.png</td>
+
+<td rowspan="1" colSpan="1" >Hang Up Call icon</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" ><br>![](https://write-document-release-1258344699.cos.ap-guangzhou.tencentcos.cn/100032357901/eeb279f7af1311f09710525400e889b2.png)</td>
+
+<td rowspan="1" colSpan="1" >callview_ic_mic_unmute.png</td>
+
+<td rowspan="1" colSpan="1" >Turn off the mic icon</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" ><br>![](https://write-document-release-1258344699.cos.ap-guangzhou.tencentcos.cn/100032357901/eec4442baf1311f0b08552540044a08e.png)</td>
+
+<td rowspan="1" colSpan="1" >callview_ic_handsfree_disable.png</td>
+
+<td rowspan="1" colSpan="1" >Turn off the speaker icon</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" ><br>![](https://write-document-release-1258344699.cos.ap-guangzhou.tencentcos.cn/100032357901/ee8f4bb6af1311f096c2525400454e06.png)</td>
+
+<td rowspan="1" colSpan="1" >callview_ic_camera_disable.png</td>
+
+<td rowspan="1" colSpan="1" >Camera Off icon</td>
+</tr>
+
+<tr>
+<td rowspan="1" colSpan="1" ><br>![](https://write-document-release-1258344699.cos.ap-guangzhou.tencentcos.cn/100032357901/ee8ff7beaf1311f0a0a052540099c741.png)</td>
+
+<td rowspan="1" colSpan="1" >callview_ic_add_user_black.png</td>
+
+<td rowspan="1" colSpan="1" >Invite user icon during call</td>
+</tr>
+</table>
 
 
 ## FAQs
 
 If you encounter any issues during integration and use, please refer to [Frequently Asked Questions](https://write.woa.com/document/145196717502525440).
 
-## Suggestions and Feedback
+## Contact Us
 
-If you have any suggestions or feedback, please contact `info_rtc@tencent.com`.
+If you have any questions or suggestions during integration or usage, feel free to join our [Telegram](https://t.me/+Lmw2MSqW6ethMGM1) group or [contact us](https://trtc.io/contact) for support.