This section summarizes some common business processes in live showroom, helping you better understand the implementation process of the entire scenario.
Anchor starts and ends the live streaming.
The anchor initiates the cross-room competition.
The RTC audience enters the room for mic-connection.
The CDN audience enters the room for mic-connection.
The following figure shows the process of an anchor (room owner) local preview, creating a room, entering the room to start the live streaming, and leaving the room to end the live streaming.
The following figure shows the process of Anchor A inviting Anchor B for a cross-room competition. During the cross-room competition, the audiences in both rooms can see the PK mic-connection live streaming of the two room owners.
The following figure shows the process for RTC live interactive streaming audience to enter the room, apply for the mic-connection, end the mic-connection, and exit the room.
The following figure shows the process for RTC CDN live streaming audience to enter the room, apply for the mic-connection, end the mic-connection, and exit the room.
Integration Preparation
Step 1. Activating the service.
Live showroom scenarios usually require two paid PaaS services from Tencent Cloud Tencent Real-Time Communication (TRTC) and Tencent Effect for construction. TRTC is responsible for providing real-time audio and video interaction capabilities. Tencent Effect is responsible for providing beauty effects capabilities. If you use a third-party beauty effect product, you can disregard the Tencent Effect integration part.
Activate TRTC service.
Activate Tencent Effect service.
1. First, you need to log in to the Tencent Real-Time Communication (TRTC) console to create an application. You can choose to upgrade the TRTC application version according to your needs. For example, the professional edition unlocks more value-added feature services.
Note:
It is recommended to create two applications for testing and production environments, respectively. Each Tencent Cloud account (UIN) is given 10,000 minutes of free duration every month for one year.
TRTC offers monthly subscription plans including the experience edition (default), basic edition, and professional edition. Different value-added feature services can be unlocked. For details, see Version Features and Monthly Subscription Plan Instructions.
2. After an application is created, you can see the basic information of the application in the Application Management - Application Overview section. It is important to keep the SDKAppID and SDKSecretKey safe for later use and to avoid key leakage that could lead to traffic theft.
1. Log in to Tencent Cloud Tencent Effect console > Mobile License. Click Create Trial License (the free trial validity period for the trial version License is 14 days. It is extendable once for a total of 28 days). Fill in the actual requirements for App Name, Package Name and Bundle ID. Choose Tencent Effect, and choose the capabilities to be tested: Advanced Package S1-07, Atomic Capability X1-01, Atomic Capability X1-02, and Atomic Capability X1-03. After checking, accurately fill in the company name, and industry type. Upload company service license, click Confirm to submit the review application, and wait for the manual review process.
2. After the trial version License is successfully created, the page will display the generated License information. At this time, the License URL and License Key parameters are not yet effective and will only become active after the submission is approved. When configuring SDK initialization, you need to input both the License URL and License Key parameters. Keep the following information secure.
Step 2: Importing SDK.
The TRTC SDK and the Tencent Effect SDK have been released to the mavenCentral repository. You can configure Gradle to download and update automatically.
1. Add the dependency for the appropriate version of the SDK in dependencies.
dependencies {
// TRTC Lite SDK. It includes TRTC and live streaming playback features and is compact in size.
2. Specify the CPU architecture used by the app in defaultConfig.
defaultConfig {
ndk {
abiFilters "armeabi-v7a","arm64-v8a"
}
}
Note:
The TRTC SDK supports architectures including armeabi, armeabi-v7a and arm64-v8a. Additionally, it supports architectures for simulators including x86 and x86_64.
The Tencent Effect SDK currently only supports architectures including armeabi-v7a and arm64-v8a.
3. Click Sync Now to automatically download the SDK and integrate it into your project. If your Tencent effect package includes dynamic effect and filter features, then you need to download the corresponding package from the SDK Download Page. Unzip the free filters (./assets/lut) and animated stickers (./MotionRes) from the package and place them in the following directories in your project:
Dynamic Effect: ../assets/MotionRes.
Filter: ../assets/lut.
Step 3: Project configuration.
1. Configure permissions.
To configure app permissions in AndroidManifest.xml, for live showroom scenarios, both the TRTC SDK and the Tencent Effect SDK require the following permissions:
Do not set android:hardwareAccelerated="false". Disabling hardware acceleration will result in failure to render the other party's video stream.
The TRTC SDK does not have built-in permission request logic. You need to declare the corresponding permissions and features yourself. Some permissions (such as storage, recording and camera), also require runtime dynamic requests.
If the Android project's targetSdkVersion is 31 or higher, or if the target device runs Android 12 or a newer version, the official requirement is to dynamically request android.permission.BLUETOOTH_CONNECT permission in the code to use the Bluetooth feature properly. For more information, see Bluetooth Permissions.
2. Obfuscation configuration.
Since we use Java's reflection features inside the SDK, you need to add relevant SDK classes to the non-obfuscation list in the proguard-rules.pro file:
-keep class com.tencent.**{*;}
-keep class org.light.**{*;}
-keep class org.libpag.**{*;}
-keep class org.extra.**{*;}
-keep class com.gyailib.**{*;}
-keep class androidx.exifinterface.**{*;}
Step 4: Authentication and authorization.
TRTC authentication credential.
Tencent Effect authentication license.
UserSig is a security protection signature designed by Tencent Cloud to prevent malicious attackers from misappropriating your cloud service usage rights. TRTC validates this authentication credential when it enters the room.
Debugging Stage: UserSig can be generated through two methods for debugging and testing purposes only: client sample code and console access.
Formal Operation Stage: It is recommended to use a higher security level server computation for generating UserSig. This is to prevent key leakage due to client reverse engineering.
The specific implementation process is as follows:
1. Before calling the SDK's initialization function, your app must first request UserSig from your server.
2. Your server computes the UserSig based on the SDKAppID and UserID.
3. The server returns the computed UserSig to your app.
4. Your app passes the obtained UserSig into the SDK through a specific API.
5. The SDK submits the SDKAppID + UserID + UserSig to Tencent Cloud CVM for verification.
6. Tencent Cloud verifies the UserSig and confirms its validity.
7. After the verification is passed, real-time audio and video services will be provided to the TRTC SDK.
Note:
The local computation method of UserSig during the debugging stage is not recommended for application in an online environment. It is prone to reverse engineering, leading to key leakage.
We provide server computation source code for UserSig in multiple programming languages (Java/GO/PHP/Nodejs/Python/C#/C++). For details, see Server Computation of UserSig.
Before using Tencent Effect, you need to verify the license credential with Tencent Cloud. Configuring the License requires License Key and License Url. Sample code is as follows.
// If the purpose is just to trigger the download or update of the License, and not to care about the authentication result, then null is passed in for the fourth parameter.
// Note: This callback does not necessarily be called on the calling thread.
if(errorCode ==TELicenseCheck.ERROR_OK){
// Authentication successful.
}else{
// Authentication failed.
}
}
});
Note:
It is recommended to trigger the authentication permission in the initialization code of related business modules. Ensure to avoid having to download the License temporarily before use. Additionally, during authentication, network permissions must be ensured.
The actual application's Package Name must match exactly with the Package Name associated with the creation of License. Otherwise, it will lead to License verification failure. For details, see Authentication Error Code.
// During development and debugging, you can set the log level to DEBUG. For release packages, set it to WARN to avoid impacting performance.
mXmagicApi.setXmagicLogLevel(Log.WARN);
// Release the beauty SDK. This method needs to be called on the GL thread.
mXmagicApi.onDestroy();
Note:
Before the Tencent Effect SDK is initialized, resource copying and other preparatory work are needed. For detailed steps, see Using the Tencent Effect SDK.
Integration Process
API sequence diagram.
Step 1: The anchor enters the room to push streams.
The control used by the TRTC SDK to display video streams only supports passing in a TXCloudVideoView type. Therefore, you need to first define the view rendering control in the layout file.
Call the above API before enterRoom. The SDK will only start the camera preview and audio capture, and wait until you call enterRoom to start streaming.
Call the above API after enterRoom. The SDK will start the camera preview and audio capture and automatically start streaming.
2. The anchor sets rendering parameters for the local video, and the encoder output video mode (optional).
// Event callback for the result of entering the room.
@Override
publicvoidonEnterRoom(long result){
if(result >0){
// result indicates the time taken (in milliseconds) to join the room.
Log.d(TAG,"Enter room succeed");
}else{
// result indicates the error code when you fail to enter the room.
Log.d(TAG,"Enter room failed");
}
}
Note:
TRTC room IDs are divided into integer type roomId and string type strRoomId. The rooms of these two types are not interconnected. It is recommended to unify the room ID type.
TRTC user roles are divided into anchors and audiences. Only anchors have streaming permissions. It is necessary to specify the user role when entering the room. If not specified, the default will be the anchor role.
In live showroom scenarios, it is recommended to choose TRTC_APP_SCENE_LIVE as the room entry mode.
Step 2: The audience enters the room to pull streams.
Log.d(TAG,"Actively call exitRoom to exit the room.");
}elseif(reason ==1){
Log.d(TAG,"Removed from the current room by the server.");
}elseif(reason ==2){
Log.d(TAG,"The current room has been dissolved.");
}
}
Note:
After all resources occupied by the SDK are released, the SDK will throw the onExitRoom callback notification to inform you.
If you want to call enterRoom again or switch to another audio/video SDK, wait for the onExitRoom callback before proceeding. Otherwise, you may encounter exceptions such as the camera or microphone being forcefully occupied.
2. Dissolve the room.
Server Dissolvement: TRTC provides the Server dissolves the room API DismissRoom (differentiating between numeric room ID and string room ID). You can call this API to remove all users from the room and dissolve the room.
Client Dissolvement: Through the exitRoom API of each client, all the anchors and audiences in the room can be completed of room exit. After room exit, according to TRTC room lifecycle rules, the room will automatically be dissolved. For details, see Exit Room.
Warning:
It is recommended that after the end of live streaming, you call the room dissolvement API on the server to ensure the room is dissolved. This will prevent audiences from accidentally entering the room and incurring unexpected charges.
Alternative solutions
API sequence diagram.
Step 1: The anchor relays the streams to CDN.
1. Related configurations for relaying to live streaming CDN.
Global automatic relayed push
If you need to automatically relay all anchors' audio and video streams in the room to live streaming CDN, you just need to enable Relay to CDN in the TRTC consoleAdvanced Features page.
Relayed push of the specified streams
If you need to manually specify the audio and video streams to be published to live streaming CDN, or publish the mixed audio and video streams to live streaming CDN, you can do so by calling the startPublishMediaStream API. In this case, you do not need to activate global automatically relaying to CDN in the console. For detailed introduction, see Publish Audio and Video Streams to Live Streaming CDN.
2. The anchor activates local video preview and audio capture before entering the room.
The control used by the TRTC SDK to display video streams only supports passing in a TXCloudVideoView type. Therefore, you need to first define the view rendering control in the layout file.
Call the above API before enterRoom. The SDK will only start the camera preview and audio capture, and wait until you call enterRoom to start streaming.
Call the above API after enterRoom. The SDK will start the camera preview and audio capture and automatically start streaming.
3. The anchor sets rendering parameters for the local screen, and the encoder output video mode.
// Event callback for the result of entering the room.
@Override
publicvoidonEnterRoom(long result){
if(result >0){
// result indicates the time taken (in milliseconds) to join the room.
Log.d(TAG,"Enter room succeed");
}else{
// result indicates the error code when you fail to enter the room.
Log.d(TAG,"Enter room failed");
}
}
Note:
TRTC room IDs are divided into integer type roomId and string type strRoomId. The rooms of these two types are not interconnected. It is recommended to unify the room ID type.
TRTC user roles are divided into anchors and audiences. Only anchors have streaming permissions. It is necessary to specify the user role when entering the room. If not specified, the default will be the anchor role.
In live showroom scenarios, it is recommended to choose TRTC_APP_SCENE_LIVE as the room entry mode.
5. The anchor relays the audio and video streams to the live streaming CDN.
long txTime =(System.currentTimeMillis()/1000)+(24*60*60);
// Generate authentication information. The getSafeUrl method can be obtained in the CSS console - Domain Name Management - Push Configuration - Sample Code for Push URLs.
During single-anchor live streaming, only initiate the relayed push task. When there is an audience co-broadcasting or anchor PK, update this task to a mixed-stream transcoding task.
Information of push authentication KEY LIVE_URL_KEY and push domain name PUSH_DOMAIN are required to obtain in the CSS consoleDomain Management page.
After the media stream is published, SDK will provide the backend-initiated task identifier (taskId) through the callback onStartPublishMediaStream.
// taskId: When the request is successful, TRTC backend will provide the taskId of this task in the callback. You can later use this taskId with updatePublishMediaStream and stopPublishMediaStream to update and stop.
// code: Callback result. 0 means success and other values mean failure.
}
Step 2: The audience pulls streams for playback.
CDN audiences do not need to enter the TRTC room. They can directly pull the anchor's CDN stream for playback.
The live streaming feature requires setting the License before success in playback. Otherwise, playback will fail (black screen). It needs to be set globally only once. If you have not obtained the License, you can freely apply for a Trial Version License for normal playback. The Official Version License requires purchase.
// The SDK starts rendering the first frame of the local or remote user's video.
if(!userId.isEmpty()){
// Stop playing the CDN stream upon receiving the first frame of the anchor's video.
mLivePlayer.stopPlay();
}
}
Note:
TRTC stream pulling startRemoteView can directly reuse the video rendering control previously used by the CDN stream pullingsetRenderView.
To avoid video interruptions when switching between stream pullers, it is recommended to wait until the TRTC first frame callback onFirstVideoFrame is received before stopping the CDN stream pulling.
3. The anchor updates the publication of mixed media streams.
// Event callback for the mic-connection audience's room entry.
// When you call the publish media stream API (updatePublishMediaStream), the taskId you provide will be returned to you through this callback. It is used to identify which update request the callback belongs to.
// code: Callback result. 0 means success and other values mean failure.
}
// Update the publication of mixed media streams to the live streaming CDN.
long txTime =(System.currentTimeMillis()/1000)+(24*60*60);
// Generate authentication information. The getSafeUrl method can be obtained in the CSS console - Domain Name Management - Push Configuration - Sample Code for Push URLs.
To ensure continuous CDN playback without stream disconnection, you need to keep the media stream encoding output parameter trtcStreamEncoderParam and the stream name streamName unchanged.
Media stream encoding output parameters and mixed display layout parameters can be customized according to business needs. Currently, up to 16 channels of audio and video input are supported. If a user only provides audio, it will still be counted as one channel.
Switching between audio only, audio and video, and video only is not supported within the same task.
4. The off-streaming audience exit the room, and the anchor updates the mixed stream task.
To avoid video interruptions when switching the stream puller, it is recommended to wait for the player's video playback event onVideoPlaying before exiting the TRTC room.
// Event callback for the mic-connection audience's room exit.
// When you call the publish media stream API (updatePublishMediaStream), the taskId you provide will be returned to you through this callback. It is used to identify which update request the callback belongs to.
// code: Callback result. 0 means success and other values mean failure.
}
Step 4: The anchor stops the live streaming and exits the room.
// When you call the stop publishing media stream API (stopPublishMediaStream), the taskId you provide will be returned to you through this callback. It is used to identify which stop request the callback belongs to.
// code: Callback result. 0 means success and other values mean failure.
}
// Event callback for exiting the room.
@Override
publicvoidonExitRoom(int reason){
if(reason ==0){
Log.d(TAG,"Actively call exitRoom to exit the room.");
}elseif(reason ==1){
Log.d(TAG,"Removed from the current room by the server.");
}elseif(reason ==2){
Log.d(TAG,"The current room has been dissolved.");
}
}
Note:
To stop publishing media streams, fill in an empty string for taskId. This will stop all the media streams you have published.
After all resources occupied by the SDK are released, the SDK will throw the onExitRoom callback notification to inform you.
Advanced Features
The anchor initiates the cross-room competition.
1. Either party initiates the cross-room competition.
After calling DisconnectOtherRoom(), you may exit the cross-room competition with all other room anchors.
Either the initiator or the receiver can call DisconnectOtherRoom() to exit the cross-room competition.
Integrate the third-party beauty features.
TRTC supports integrating third-party beauty effect products. Use the example of Tencent Effect to demonstrate the process of integrating the third-party beauty features.
1. Integrate the Tencent Effect SDK, and apply for an authorization license. For details, see Integration Preparation for steps.
2. Resource copying (if any). If your resource files are built in the assets directory, you need to copy them to the App's private directory before use.
XmagicResParser.setResPath(local path of the downloaded resource file);
3. Set the video data callback for third-party beauty features. Pass the results of the beauty SDK processing each frame of data into the TRTC SDK for rendering processing.
// The OpenGL environment has already been set up internally within the SDK. At this point, the initialization of third-party beauty features can be done.
// The internal OpenGL environment within the SDK has been terminated. At this point, proceed to clean up resources for third-party beauty features.
mXmagicApi.onDestroy();
}
});
Note:
Steps 1 and 2 vary depending on the different third-party beauty products. And Step 3 is a general and important step for integrating third-party beauty features into TRTC.
When the dual-stream encoding mode is enabled, the current user's encoder will output two video streams, a high-definition large screen, and a low-definition small screen, at the same time (but only one audio stream). In this way, other users in the room can choose to subscribe to the high-definition large screen or low-definition small screen based on their network conditions or screen sizes.
When the dual-stream encoding mode is enabled, it will consume more CPU and network bandwidth. Therefore, it may be considered for use on Mac, Windows, or high-performance Pads. It is not recommended for mobile devices.
2. Choose the type of remote user's video stream to pull.
// Optional video stream types when subscribing to a remote user's video stream.
When the dual-stream encoding mode is enabled, you can specify the video stream type as TRTC_VIDEO_STREAM_TYPE_SMALL with streamType to pull a low-quality small video for viewing.
View rendering control
In TRTC, there are many APIs that require you to control the video screen. All these APIs require you to specify a video rendering control. On the Android platform, TXCloudVideoView is used as the video rendering control, and both SurfaceView and TextureView rendering schemes are supported. Below are the methods for specifying the type of rendering control and updating the video rendering control.
1. If you want mandatory use of a certain scheme, or to convert the local video rendering control to TXCloudVideoView, you can code as follows.
2. If your business involves scenarios of switching display zones, you can use the TRTC SDK to update the local preview screen and update the remote user's video rendering control feature.
// Update local preview screen rendering control.
mTRTCCloud.updateLocalView(videoView);
// Update the remote user's video rendering control.
1. The liker sends custom group messages related to likes through the client. After it is sended successfully, the business party renders the likes effect locally.
// Construct the likes message body.
JSONObject jsonObject =newJSONObject();
try{
jsonObject.put("cmd","like_msg");
JSONObject msgJsonObject =newJSONObject();
msgJsonObject.put("type",1);// Likes type.
msgJsonObject.put("likeCount",10);// Number of likes.
jsonObject.put("msg", msgJsonObject);
}catch(JSONException e){
e.printStackTrace();
}
String data = jsonObject.toString();
// Send custom group messages (it is recommended that likes messages should be set to low priority).
int type = messageJsonObject.getInt("type");// Likes type.
int likeCount = messageJsonObject.getInt("likeCount");// Number of likes.
// Render likes effect based on likes type and count.
}
}catch(JSONException e){
e.printStackTrace();
}
}
}
});
Gift messages
1. The sender initiates a request to the business server. Upon completing the billing and settlement, the business server calls the REST API to send a custom message to the group.
int type = messageJsonObject.getInt("type");// Gift type.
int giftCount = messageJsonObject.getInt("giftCount");// Number of gifts.
String giftUrl = messageJsonObject.getString("giftUrl");// Gift resource URL.
String giftName = messageJsonObject.getString("giftName");// Gift name.
// Render gift effects based on gift type, count, resource URL, and name.
}
}catch(JSONException e){
e.printStackTrace();
}
}
}
});
Bullet screen messages
Live showroom usually have text-based bullet screen message interactions. This can be achieved through the sending and receiving of group chat regular text messages via IM.
// Render bullet screen messages based on sender and message text.
}
});
Note:
The recommended priority setting is as follows. Gift messages should be set to high priority. Bullet screen messages should be set to medium priority. Like messages should be set to low priority.
Sending group chat messages from the client will not trigger the message reception callback. Only other users within the group can receive them.
Exception Handling
Exception error handling
When the TRTC SDK encounters an unrecoverable error, the error will be thrown in the onError callback. For details, see Error Code Table.
1. UserSig related
UserSig verification failure will lead to room-entering failure. You can use the UserSig tool for verification.
Enumeration
Value
Description
ERR_TRTC_INVALID_USER_SIG
-3320
Room entry parameter userSig is incorrect. Check if TRTCParams.userSig is empty.
ERR_TRTC_USER_SIG_CHECK_FAILED
-100018
UserSig verification failed. Check if the parameter TRTCParams.userSig is filled in correctly or has expired.
2. Room entry and exit related
If failed to enter the room, you should first verify the correctness of the room entry parameters. It is essential that the room entry and exit APIs are called in a paired manner. This means that, even in the event of a failed room entry, the room exit API must still be called.
Enumeration
Value
Description
ERR_TRTC_CONNECT_SERVER_TIMEOUT
-3308
Room entry request timed out. Check if your internet connection is lost or if a VPN is enabled. You may also attempt to switch to 4G for testing.
ERR_TRTC_INVALID_SDK_APPID
-3317
Room entry parameter sdkAppId is incorrect. Check if TRTCParams.sdkAppId is empty.
ERR_TRTC_INVALID_ROOM_ID
-3318
Room entry parameter roomId is incorrect. Check if TRTCParams.roomId or TRTCParams.strRoomId is empty. Note that roomId and strRoomId cannot be used interchangeably.
ERR_TRTC_INVALID_USER_ID
-3319
Room entry parameter userId is incorrect. Check if TRTCParams.userId is empty.
ERR_TRTC_ENTER_ROOM_REFUSED
-3340
Room entry request is denied. Check if enterRoom is called consecutively to enter rooms with the same ID.
3. Device related
Errors for relevant monitoring devices. Prompt the user via UI in case of relevant errors.
Enumeration
Value
Description
ERR_CAMERA_START_FAIL
-1301
Failed to open the camera. For example, if there is an exception for the camera's configuration program (driver) on a Windows or macOS device, you should try disabling then re-enabling the device, restarting the machine, or updating the configuration program.
ERR_MIC_START_FAIL
-1302
Failed to open the mic. For example, if there is an exception for the mic's configuration program (driver) on a Windows or macOS device, you should try disabling then re-enabling the device, restarting the machine, or updating the configuration program.
ERR_CAMERA_NOT_AUTHORIZED
-1314
The device of camera is unauthorized. This typically occurs on mobile devices and may be due to the user having denied the permission.
ERR_MIC_NOT_AUTHORIZED
-1317
The device of mic is unauthorized. This typically occurs on mobile devices and may be due to the user having denied the permission.
ERR_CAMERA_OCCUPY
-1316
The camera is occupied. Try a different camera.
ERR_MIC_OCCUPY
-1319
The mic is occupied. This occurs when, for example, the user is currently having a call on the mobile device.
Issues with the remote mirror mode not functioning properly.
In TRTC, video mirror settings are divided into local preview mirror setLocalRenderParams and video encoding mirror setVideoEncoderMirror. These settings individually affect the mirror effect of the local preview and the output of the video encoding (the mirror mode affects remote viewers and cloud recordings). If you expect the mirror effect seen in the local preview to also take effect on the remote viewer's end, follow these encoding procedures.
// Set the rendering parameters for the local video.
params.mirrorType =TRTCCloudDef.TRTC_VIDEO_MIRROR_TYPE_ENABLE;// Video mirror mode
params.fillMode =TRTCCloudDef.TRTC_VIDEO_RENDER_MODE_FILL;// Video fill mode
params.rotation =TRTCCloudDef.TRTC_VIDEO_ROTATION_0;// Video rotation angle
mTRTCCloud.setLocalRenderParams(params);
// Set the video mirror mode for the encoder output.
mTRTCCloud.setVideoEncoderMirror(true);
Issues with camera scale, focus, and switch.
In live showroom scenarios, the anchor may need to custom adjust the camera settings. The TRTC SDK's device management class provides APIs for these needs.
1. Query and set the zoom factor for the camera.
// Get the maximum zoom factor for the camera (only for mobile devices).
// Set the zoom factor for the camera (only for mobile devices).
// Value range is 1 - 5. 1 means the furthest field of view (normal lens), and 5 means the closest field of view (zoom lens). The maximum recommended value is 5, exceeding this may result in blurry video.
Yes
No
Was this page helpful?