This document describes how to quickly integrate the TUICallKit component. Performing the following key steps generally takes about ten minutes after which you can implement the video call feature with complete UIs.
Environment Preparations
Android 5.0 (SDK API level 21) or later.
Gradle 4.2.1 or later
Mobile phone on Android 5.0 or later.
Step 1. Activate the service
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.
Step 2. Download and import the component
Go to GitHub, 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 3. Configure the project
1. Find the settings.gradle(or settings.gradle.kts) file in the project root directory and add the following code to import the component downloaded in step 2 to your current project:
settings.gradle
settings.gradle.kts
include ':tuicallkit-kt'
include(":tuicallkit-kt")
2. Find the build.gradle(or build.gradle.kts) file in the app directory and add the following code to declare the dependencies of the current application on the component just added:
build.gradle
build.gradle.kts
api project(':tuicallkit-kt')
api(project(":tuicallkit-kt"))
Note
The TUICallKit project depends on TRTC SDK, Chat SDK, tuicallengine, and the tuicore public library internally by default with no need of additional configuration. To upgrade the version, modify the version in tuicallkit-kt/build.gradle file.
3. As the SDK uses Java's reflection feature internally, you need to add certain classes in the SDK to the obfuscation allowlist by adding the following code to the proguard-rules.pro file:
-keep class com.tencent.** { *;}
Note
TUICallKit helps you apply for camera, mic, and bluetooth permissions internally. If you need more or fewer permissions based on your actual business conditions, you can modify tuicallkit-kt/src/main/AndroidManifest.xml.
Step 4. Log in to the TUICallKit component
Add the following code to your project to call the relevant APIs in TUICore to log in to the TUICallKit component. This step is very important, as the user can use the component features properly only after a successful login. Carefully check whether the relevant parameters are correctly configured:
TUILogin.login(context,
1400000001,// Replace it with the `SDKAppID` obtained in step 1.
"denny",// Replace it with your `UserID`.
"xxxxxxxxxxx",// You can calculate a `UserSig` in the console and enter it here.
object :TUICallback(){
override fun onSuccess(){
}
override fun onError(errorCode:Int, errorMessage:String){
}
})
}
Parameter description:
The key parameters used by the login function are as detailed below:
SDKAppID: Obtained in the last step in step 1 and not detailed here.
UserID: The ID of the current user, which is a string that can contain only letters (a–z and A–Z), digits (0–9), hyphens (-), or underscores (_).
UserSig: The authentication credential used by Tencent Cloud to verify whether the current user is allowed to use the TRTC service. You can get it by using the SDKSecretKey to encrypt the information such as SDKAppID and UserID. You can generate a temporary UserSig by clicking the UserSig Generate button in the console.
Many developers have contacted us with many questions regarding this step. Below are some of the frequently encountered problems:
SDKAppID is invalid.
userSig is set to the value of Secretkey mistakenly. The userSig is generated by using the SecretKey for the purpose of encrypting information such as sdkAppId, userId, and the expiration time. But the value of the userSig that is required cannot be directly substituted with the value of the SecretKey.
userId is set to a simple string such as 1, 123, or 111, and your colleague may be using the same userId while working on a project simultaneously. In this case, login will fail as TRTC doesn't support login on multiple terminals with the same UserID. Therefore, we recommend you use some distinguishable userId values during debugging.
The sample code on GitHub uses the genTestUserSig function to calculate UserSig locally, so as to help you complete the current integration process more quickly. However, this scheme exposes your SecretKey in the application code, which makes it difficult for you to upgrade and protect your SecretKey subsequently. Therefore, we strongly recommend you run the UserSig calculation logic on the server and make the application request the UserSig calculated in real time every time the application uses the TUICallKit component from the server.
Step 5. 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.
Kotlin
Java
// Initiate a one-to-one video call (assuming UserID is mike)
Yes
No
Was this page helpful?