This article will guide you through the process of quickly integrating the TUILiveKit component. By following this document, you will complete the following key steps within an hour and ultimately obtain a video or voice live streaming function with a complete UI interface.
Environment Preparations
Android 5.0 (SDK API level 21) or above.
Android Studio 4.2.1 or above.
Devices with Android 5.0 or above.
If you have any questions during environment configuration or compilation and running, please refer to the FAQ.
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 the service
Step 2: Download TUILiveKit component
Java
Clone/download the code in Github , and then copy the tuilivekit subdirectory in the Android directory to the same level directory as the app in your current project, as shown below:
Step 3: Project configuration
Java
1. Add jitpack repository dependencies to your project (Download the three-party library SVGAPlayer that plays gift svg animation):
Gradle 7.0 earlier
gradle 7.0 or later
Add the address of the jitpack repository to the build.gradle file in the root directory of the project:
2. Find the settings.gradle file in the project root directory and add the following code to it. Its function is to import the tuilivekit component downloaded in Step 2 into your current project:
include ':tuilivekit'
3. Find the build.gradle file in the app directory and add the following code to it. Its function is to declare the dependence of the current app on the newly added tuilivekit component:
api project(':tuilivekit')
Note:
The TUILiveKit project has internal dependencies by default: TRTC SDK、IM SDK、tuiroomengineand the public library tuicore, and does not require separate configuration by developers. If you need to upgrade the version, just modify the tuilivekit/build.gradle file.
4. 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.** { *;}
5. In AndroidManifest.xml, set a Theme.AppCompat Theme to the android:theme attribute of application:
TUILiveKit will internally help you dynamically apply for camera, microphone, read storage permissions, etc. If you need to delete it due to your business problems, you can modify tuilivekit/src/main/AndroidManifest.xml。
If you encounter an allowBackup related exception prompted by AndroidManifest.xml, please refer to allowBackup Exceptions.
Before invoking the functions of the TUILiveKit component, you need to perform the login of the TUI component. In your project, it is recommended to add the following login code in your business login scenario or in the first startup activity of the app, which is used to complete the login of the TUI component by calling the relevant APIs in TUICore. This step is very important, because you can use all functions of TUILiveKit only after the login is successful. Therefore, please patiently check whether the relevant parameters are correctly configured.
java
TUILogin.login(context,
1400000001,// Replace it with the SDKAppID obtained in Step 1
"denny",// Please replace it with your UserID
"xxxxxxxxxxx",// You can calculate a UserSig in the console and fill it in
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 TUILiveKit component from the server.
Step 5. Enter the live preview screen
Note:
It's important to make sure you've followed Step 4 to complete the login. Only after you log in to TUILogin.login can you enter the live preview screen normally.
1. Create a new file named app_activity_start_live.xml (Default path: app/src/main/res/layout/app_activity_start_live.xml).
2. Create a new file named StartLiveActivity.java and register in the AndroidManifest.xml. By loading TUILiveKit TUILiveAnchorFragment page, you can pull up preview screen.
TUILiveAnchorFragment needs to pass in two parameters: liveRoomId and voiceRoomId, the naming convention of liveRoomId is "live_xxx", and the naming convention of voiceRoomId is "voice_xxx". You can use the generateId method of the utility class LiveIdentityGenerator to help generate the corresponding RoomId. For example, if you pass "123456" and RoomType.LIVE to the generateId method, you will get a RoomId of "live_123456".
Register StartLiveActivity in AndroidManifest.xml of the app Project (please use the actual package name of your StartLiveActivity):
Since StartLiveActivity inherited from AppCompatActivity, StartLiveActivity was given a Theme.AppCompattheme. You can modify it to your own Theme.AppCompat theme.
3. Where you need to start live streaming (depending on your business, it can be executed in a click event in MainActivity by default), perform the following operations to pull up the host start page:
It's important to make sure you've followed Step 4 to complete the login. Only after you log in to TUILogin.login can you enter the live preview screen normally.
1. Create a new file named app_activity_main.xml (Default path: app/src/main/res/layout/app_activity_main.xml).
2. Create a new file named MainActivity.java and register in the AndroidManifest.xml. By loading TUILiveKit TUILiveListFragment page, you can Present a list of rooms
Since MainActivity inherited from AppCompatActivity, MainActivity was given a Theme.AppCompattheme. You can modify it to your own Theme.AppCompat theme.