This article will introduce how to complete the integration of the TUIRoomKit Component in the shortest time. By following this document, you will complete the following key steps within ten minutes and ultimately obtain an audio/video conference function with a complete UI interface.
Conference interface and partial function display
Environment preparation
Minimum compatibility with Android 4.4 (SDK API Level 19), recommended to use Android 5.0 (SDK API Level 21) and above.
Android Studio 3.5 and above (Gradle 3.5.4 and above).
Mobile devices with Android 4.4 and above.
Step 1: Activate the service
Before initiating a meeting with TUIRoomKit, you need to activate the exclusive multi-person audio and video interaction service for TUIRoomKit on the console. For specific steps, please refer to Activate Service.
Step 2: Download the TUIRoomKit component
1. Clone/download the code in Github, and then copy the timcommon and tuiroomkit subdirectories in the Android directory to the same level directory as the app in your current project.
Step 3: Project configuration
1. Find the setting.gradle (or settings.gradle.kts) file in the project root directory and add the following code to it. Its function is to import the tuiroomkit component into your current project.
setting.gradle
settings.gradle.kts
include ':timcommon'
include ':tuiroomkit'
include (":timcommon")
include (":tuiroomkit")
2. Find the build.gradle (or build.gradle.kts) file in the app directory and add the following code to it. Its function is to declare the current app's dependence on the newly added tuiroomkit component.
build.gradle
build.gradle.kts
api project(':tuiroomkit')
api(project(":tuiroomkit"))
3. Since we use the reflection feature of Java inside the SDK, we need to add some classes in the SDK to the unobfuscated list, so you need to add the following code to the proguard-rules.pro file:
-keep class com.tencent.**{*;}
4. Find the AndroidManifest.xml file in the app directory, and add tools:replace="android:allowBackup" to the application node to override the settings within the component and use your own settings.
Add the following code to your project. Its function is to complete the component login by calling the relevant interface in TUILogin. This step is extremely critical, because you can only use the various functions of TUIRoomKit normally after logging in, so please be patient and check whether the relevant parameters are configured correctly:
UserID：The ID of the current user, a string type, only allowed to contain English letters (a-z and A-Z), numbers (0-9), hyphens (-) and underscores (_).
UserSig：Use the SDKSecretKey obtained in step 4 of activating the service to encrypt the SDKAppID, UserID and other information to obtain the UserSig, which is an authentication ticket used by Tencent Cloud to identify whether the current user can use TRTC services. You can generate a temporarily available UserSig through the auxiliary tools in the console.
Note：
Development environment：If you are in the local development and debugging stage, you can use the local GenerateTestUserSig.genTestUserSig() function to generate a userSig. The SDKSecretKey in this method can be easily decompiled and reverse-engineered. Once your key is leaked, attackers can steal your Tencent Cloud traffic.
2. ConferenceMainFragment is the main interface of the conference. You only need to call quickStartConference to initiate a quick conference (passing in the custom room number in this function) and add ConferenceMainFragment to the current Activity in the quick conference callback onConferenceStarted to initiate a quick conference.
Create a new ConferenceOwnerActivity.java file in the project.
<!-- Add the following code to register ConferenceOwnerActivity --><activity android:name=".ConferenceOwnerActivity" /></application></manifest>
Note
ConferenceOwnerActivity must inherit AppCompatActivity, otherwise the interface will not be displayed.
ConferenceOwnerActivity must be registered in the AndroidManifest.xml file.
3. After you call the TUILogin.login function, you can jumo to the ConferenceOwnerActivity conference interface based on your business. For example, the sample code for launching the conference interface in MainActivity.java of an empty project is as follows:
// Jump to ConferenceOwnerActivityIntent intent =newIntent(MainActivity.this,ConferenceOwnerActivity.class);startActivity(intent);}}
importandroid.content.Intent
importandroid.os.Bundle
importandroidx.appcompat.app.AppCompatActivity
classMainActivity:AppCompatActivity(){
override fun onCreate(savedInstanceState:Bundle?){
super.onCreate(savedInstanceState)
setContentView(R.layout.activity_main)
// Jump to ConferenceOwnerActivity
val intent =Intent(this,ConferenceOwnerActivity::class.java)
startActivity(intent)
}
}
Step 6: General members join the meeting
1. ConferenceMainFragment is the main interface of the conference. You only need to call joinConference (passing in the room number you want to join in this function)to join the conference and add ConferenceMainFragment to the current Activity in the onConferenceJoined callback to join the conference to participate in the current conference.
Create a new ConferenceGeneralActivity.java file in the project.
// Replace "123456" with the corresponding conference number
fragment.joinConference("123456");
}
}
classConferenceGeneralActivity:AppCompatActivity(){private val tag:String="ConferenceGeneralActivity"privatevar mConferenceObserver :ConferenceObserver?=null
override fun onCreate(savedInstanceState:Bundle?){super.onCreate(savedInstanceState)setContentView(R.layout.activity_conference)var fragment =ConferenceMainFragment()
mConferenceObserver = object:ConferenceObserver(){
override fun onConferenceJoined(conferenceId:String?, error:ConferenceError?){super.onConferenceJoined(conferenceId, error)if(error !=ConferenceError.SUCCESS){Log.e(tag,"Error : $error")return}
val fragmentManager = supportFragmentManager
val transaction = fragmentManager.beginTransaction()
transaction.add(R.id.conference_container, fragment)
transaction.commitAllowingStateLoss()}}
fragment.setConferenceObserver(mConferenceObserver)// Replace "123456" with the corresponding conference number
fragment.joinConference("123456")}}
Register ConferenceGeneralActivity in the app/src/main/AndroidManifest.xml file.
ConferenceGeneralActivity must inherit AppCompatActivity, otherwise the interface will not be displayed.
ConferenceGeneralActivity must be registered in the AndroidManifest.xml file.
2. After you call the TUILogin.login function, you can jump to the ConferenceGeneralActivity conference interface where you need to join a conference. For example, the sample code for launching the conference interface in MainActivity.java of an empty project is as follows:
