You can download and install the demo we provide to try out TRTC’s duet features, including low-latency karaoke, seat management, gift sending and receiving, text chat, etc.
Room Owner
Listener
To quickly enable the duet feature, you can modify the demo app we provide and adapt it to your needs. You may also use the TUIChorus component and customize your own UI.
Using the App’s UI
Step 1. Create an application
1. In the TRTC console, select Development Assistance > Demo Quick Run.
2. Enter an application name such as TestChorus and click Create.
3. Click Next.
Note：
This feature uses two basic PaaS services of Tencent Cloud, namely TRTC and IM. When you activate TRTC, IM will be activated automatically. IM is a value-added service. See Pricing for its billing details.
Step 2. Download the application source code
Click TUIChorus to clone or download the source code.
Step 3. Configure application project files
1. In the Modify Configuration step, select your platform.
2. Find and open Android/Debug/src/main/java/com/tencent/liteav/debug/GenerateTestUserSig.java.
3. Set parameters in GenerateTestUserSig.java:
SDKAPPID: a placeholder by default. Set it to the actual `SDKAppID`.
SECRETKEY: a placeholder by default. Set it to the actual key.
4. Click Next to complete the creation.
5. After compilation, click Return to Overview Page.
Note：
The method for generating UserSig described in this document involves configuring SECRETKEY in client code. In this method, SECRETKEY may be easily decompiled and reversed, and if your key is disclosed, attackers can steal your Tencent Cloud traffic. Therefore, this method is suitable only for the local execution and debugging of the app.
The correct UserSig distribution method is to integrate the calculation code of UserSig into your server and provide an application-oriented API. When UserSig is needed, your application can send a request to the business server for a dynamic UserSig. For more information, see How do I calculate UserSig on the server?.
Step 4. Run the application
Open the source code project TUIChorus with Android Studio (version 3.5 or above) and click Run.
Step 5. Modify the app’s source code
The Source folder in the source code contains two subfolders: ui and model. The ui subfolder contains UI code. The table below lists the files (folders) and the UI views they represent. You can refer to it when making UI changes.
File or Folder
Description
base
Basic classes used by the UI
room
Main room views for room owner and listener
widget
Common controls
Tryout
Note：
You need at least two devices to try out the application.
User A
1. Enter a username (which must be unique) and log in.
2. Click Create Room.
3. Enter a room subject and tap Join.
User B
1. Enter a username (which must be unique) and log in.
2. Enter the ID of the room created by user A and tap Join.
Note：
You can find the room ID at the top of user A’s room view.
Customizing UI
The Source folder in the source code contains two subfolders: ui and model. The model subfolder contains the reusable open-source component TRTCChorusRoom. You can find the component’s APIs in TRTCChorusRoom.java and use them to customize your own UI.
Step 1. Integrate the SDKs
The TRTCChorusRoom component depends on the TRTC SDK and IM SDK. Follow the steps below to integrate them into your project.
Method 1: adding dependencies via Maven
1. Add the TRTC SDK and IM SDK dependencies to dependencies.
You can view the latest version numbers of the two SDKs by visiting their GitHub pages at TRTC and IM.
2. In defaultConfig, specify the CPU architecture to be used by your application.
defaultConfig {
ndk {
abiFilters "armeabi-v7a"
}
}
3. Click Sync Now to automatically download the SDKs and integrate them into your project.
Method 2: adding dependencies through local AAR files
If your access to the Maven repository is slow, you can download the ZIP files of the SDKs and manually integrate them into your project as instructed in the documents below.
Step 2. Configure permission requests and obfuscation rules
Configure permission requests for your app in AndroidManifest.xml. The SDKs need the following permissions (on Android 6.0 and above, the read storage permission must be requested at runtime.)
ID of the current user, which is a string that can contain letters (a-z and A-Z), digits (0-9), hyphens (-), and underscores (_). We recommend you set it based on your business account system.
userSig
Tencent Cloud's proprietary security signature. For the calculation method, please see UserSig.
callback
Login callback. The code is 0 if login is successful.
mTRTCChorusRoom.login(SDKAPPID, userId, userSig, new TRTCChorusRoomCallback.ActionCallback() {
@Override
public void onCallback(int code, String msg) {
if (code == 0) {
// Logged in
}
}
});
Step 5. Create a room and become a speaker
1. After performing step 4 to log in, call setSelfProfile to set your nickname and profile photo.
2. Call createRoom to create a room, passing in room attributes such as room ID, whether listeners need the room owner’s consent to speak, and the number of seats.
3. After creating the room, call enterSeat to take seat No. 1.
4. You will receive an onSeatListChanget notification about the change of the seat list, and can update the change to the UI.
5. You will also receive an onAnchorEnterSeat notification about the occupation of a seat, and mic capturing will be enabled automatically.
// 2. Call `createRoom` to create a room
final TRTCChorusRoomDef.RoomParam roomParam = new TRTCChorusRoomDef.RoomParam();
roomParam.roomName = "Room name";
roomParam.needRequest = false; // Whether your consent is required for listeners to speak
roomParam.seatCount = 7; // Number of room seats. In this example, the number is 7. 6 seats are available after you take one.
roomParam.coverUrl = "URL of room cover image";
mTRTCChorusRoom.createRoom(mRoomId, roomParam, new TRTCChorusRoomCallback.ActionCallback() {
@Override
public void onCallback(int code, String msg) {
if (code == 0) {
//3. Take seat 0
mTRTCChorusRoom.enterSeat(0, new TRTCChorusRoomCallback.ActionCallback() {
@Override
public void onCallback(int code, String msg) {
if (code == 0) {
}
}
});
}
}
});
// 4. After taking a seat, you receive an `onSeatListChange` notification
@Override
public void onSeatListChange(final List<TRTCChorusRoomDef.SeatInfo> seatInfoList) {
// Display the seat list
}
//5. You receive an `onAnchorEnterSeat` notification
@Override
public void onAnchorEnterSeat(TRTCChorusRoomDef.UserInfo userInfo) {
}
Step 6. Enter a room as a listener
1. After performing step 4 to log in, call setSelfProfile to set your nickname and profile photo.
2. Get the latest room list from the backend.
Note：
The room list in the demo app is for demonstration only. The business logic of room lists varies significantly. Tencent Cloud does not provide room list management services currently. Please manage the list by yourself.
3. Call getRoomInfoList to get short descriptions of the rooms, which are provided by room owners when they call createRoom.
Note：
If your room list already contains enough room information, you can skip the step of calling getRoomInfoList.
4. Select a room, and call enterRoom with the room ID passed in to enter.
5. After entering the room, you will receive an onRoomInfoChange notification about room change from the component. Record the room information, including room name, whether the room owner’s consent is required for listeners to speak, etc., and update it to the UI.
6. You will receive an onSeatListChange notification about seat change from the component. Update the change to the UI.
7. You will also receive an onAnchorEnterSeat notification that someone becomes a speaker.
// 1. Set your nickname and profile photo.
mTRTCChorusRoom.setSelfProfile("my_name", "my_face_url", null);
// 2. Get the room list from the backend. Suppose it is `roomList`.
List<Integer> roomList = GetRoomList();
// 3. Call `getRoomInfoList` to get details of the rooms.
mTRTCChorusRoom.getRoomInfoList(roomList, new TRTCChorusRoomCallback.RoomInfoCallback() {
@Override
public void onCallback(int code, String msg, List<TRTCChorusRoomDef.RoomInfo> list) {
if (code == 0) {
// Refresh the room list on your UI
}
}
});
// 4. Select a room, passing in `roomId` to enter
mTRTCChorusRoom.enterRoom(roomId, new TRTCChorusRoomCallback.ActionCallback() {
@Override
public void onCallback(int code, String msg) {
if (code == 0) {
//Entered room successfully
}
}
});
// 5. After successful room entry, you receive an `onRoomInfoChange` notification.
@Override
public void onRoomInfoChange(TRTCChorusRoomDef.RoomInfo roomInfo) {
mNeedRequest = roomInfo.needRequest;
mRoomName = roomInfo.roomName;
// The UI can display the title and other information
}
// 6. You receive an `onSeatListChange` notification
@Override
public void onSeatListChange(final List<TRTCChorusRoomDef.SeatInfo> seatInfoList) {
// Display the seat list
}
// 7. You receive an `onAnchorEnterSeat` notification
@Override
public void onAnchorEnterSeat(TRTCChorusRoomDef.UserInfo userInfo) {
}
Step 7. Manage seats
Room owner
Listener
1. Call pickSeat, passing in a seat number and the userId of a listener to place the listener in the seat. All users in the room will receive an onSeatListChange notification and an onAnchorEnterSeat notification.
2. Call kickSeat, passing in a seat number to remove the speaker from the seat. All users in the room will receive an onSeatListChange notification and an onAnchorLeaveSeat notification.
3. Call closeSeat, passing in a seat number to block/unblock the seat. Listeners cannot take a blocked seat, and all users in the room will receive an onSeatListChange notification and an onSeatClose notification.
1. Call enterSeat, passing in a seat number to take the seat. All users in the room will receive an onSeatListChange notification and an onAnchorEnterSeat notification.
2. Call leaveSeat to leave your seat. All users in the room will receive an onSeatListChange notification and an onAnchorLeaveSeat notification.
After a seat operation, the order in which different notifications are sent is: callbacks > onSeatListChange > independent events such as onAnchorEnterSeat.
// 1. The room owner places a user in seat No. 1
mTRTCChorusRoom.pickSeat(1, "123", new TRTCChorusRoomCallback.ActionCallback() {
@Override
public void onCallback(int code, String msg) {
// 2. A callback is returned.
if (code == 0) {
}
}
});
// 3. The listener receives the onSeatListChange callback, and refreshes the seat list
@Override
public void onSeatListChange(final List<TRTCChorusRoomDef.SeatInfo> seatInfoList) {
}
// 4. The room owner receives a notification about the change of a specific seat, which can be used to determine whether the user has taken the seat
public void onAnchorEnterSeat(int index, TRTCChorusRoomDef.UserInfo user) {
}
// 1. A listener takes the co-singer seat
mTRTCChorusRoom.enterSeat(1, new TRTCChorusRoomCallback.ActionCallback() {
@Override
public void onCallback(int code, String msg) {
// 2. A callback is returned.
if (code == 0) {
}
}
});
// 3. The listener receives the onSeatListChange callback, and refreshes the seat list
@Override
public void onSeatListChange(final List<TRTCChorusRoomDef.SeatInfo> seatInfoList) {
}
// 4. The listener receives a notification about the change of a specific seat and can determine whether he or she has taken the seat successfully
public void onAnchorEnterSeat(int index, TRTCChorusRoomDef.UserInfo user) {
}
Step 8. Use signaling for invitations
In seat management, listeners can take and leave seats without the room owner’s consent, and the room owner can put listeners in seats without the listeners’ consent.
If you want listeners and room owners to obtain each other’s consent before performing the above actions in your application, you can use signaling for invitation sending.
Listener requesting to take seat
Room owner inviting listener to take seat
1. A listener calls sendInvitation, passing in information including the room owner’s userId and custom command words. The API will return an inviteId, which should be recorded.
2. The room owner receives an onReceiveNewInvitation notification, and a window pops up on the UI asking the room owner whether to accept the request.
3. The room owner calls acceptInvitation with the inviteId passed in to accept the request.
4. The listener receives an onInviteeAccepted notification and calls enterSeat to become a speaker.
// Listener
// 1. Call sendInvitation to request to take seat 1
// 2. Place the user in the seat after the invitation is accepted
@Override
public void onInviteeAccepted(String id, String invitee) {
if(id.equals(inviteId)) {
mTRTCChorusRoom.enterSeat(1, null);
}
}
// Room owner
//1. The room owner receives the request.
@Override
public void onReceiveNewInvitation(final String id, String inviter, String cmd, final String content) {
if (cmd.equals("ENTER_SEAT")) {
// 2. The room owner accepts the request.
mTRTCChorusRoom.acceptInvitation(id, null);
}
}
1. The room owner calls sendInvitation, passing in information including the listener's userId and custom command words. The API will return an inviteId, which should be recorded.
2. The listener receives an onReceiveNewInvitation notification, and a window pops up asking the listener whether to agree to speak.
3. The listener calls acceptInvitation with the inviteId passed in to accept the invitation.
4. The room owner receives an onInviteeAccepted notification and calls pickSeat to make the listener a speaker.
// Room owner
// 1. Call sendInvitation to invite user 123 to take the co-singer seat
// 2. Place the user in the seat after the invitation is accepted
@Override
public void onInviteeAccepted(String id, String invitee) {
if(id.equals(inviteId)) {
mTRTCChorusRoom.pickSeat(2, null);
}
}
// Listener
// 1. The listener receives the invitation.
@Override
public void onReceiveNewInvitation(final String id, String inviter, String cmd, final String content) {
if (cmd.equals("PICK_SEAT")) {
// 2. The listener accepts the invitation.
mTRTCChorusRoom.acceptInvitation(id, null);
}
}
Step 9. Enable text chat and on-screen comments
Call sendRoomTextMsg to send common text messages. All users in the room will receive an onRecvRoomTextMsg callback.
IM has its default content moderation rules. Text messages that contain restricted terms will not be forwarded by the cloud.
Call sendRoomCustomMsg to send custom (signaling) messages. All users in the room will receive an onRecvRoomCustomMsg callback.
Custom messages are often used to transfer custom signals, e.g., to give and broadcast likes.
// A sender can customize CMD to distinguish on-screen comments and likes.
// For example, use "CMD_DANMU" to indicate on-screen comments and "CMD_LIKE" to indicate likes.
Yes
No
Was this page helpful?