TUIKaraoke
is an open-source audio/video UI component. After integrating it into your project, you can make your application support the online karaoke scenario and try out the TRTC capabilities such as karaoke, seat management, gift giving/receiving, and text chat simply by writing a few lines of code. It also supports the iOS platform. Its basic features are as shown below:
Chat | Sound Effect Management |
---|---|
![]() |
![]() |
TUIKaraoke
componentGo to GitHub, clone or download the code, copy the Source
and Debug
directories in the Android
directory to your project, and complete the following import operations:
Complete import in setting.gradle
as shown below:
include ':Source'
include ':Debug'
Add dependencies on TUIKaraoke
to the build.gradle
file in app
:
api project(':Source')
Add dependencies on TRTC SDK
and IM SDK
to the build.gradle
file in the root directory:
ext {
liteavSdk = "com.tencent.liteav:LiteAVSDK_TRTCl:latest.release"
imSdk = "com.tencent.imsdk:imsdk-plus:latest.release"
}
Configure permission requests for your app in AndroidManifest.xml
. The SDKs need the following permissions (on Android 6.0 and later, the mic access and storage read permission must be requested at runtime):
<uses-permission android:name="android.permission.SYSTEM_ALERT_WINDOW" /> // Use case: This permission is required for the floating window
<uses-permission android:name="android.permission.INTERNET" />
<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />
<uses-permission android:name="android.permission.ACCESS_WIFI_STATE" />
<uses-permission android:name="android.permission.RECORD_AUDIO" />
<uses-permission android:name="android.permission.MODIFY_AUDIO_SETTINGS" />
<uses-permission android:name="android.permission.BLUETOOTH" /> // Use case: This permission is required when a Bluetooth headset is used
In the proguard-rules.pro
file, add the SDK classes to the "do not obfuscate" list.
-keep class com.tencent.** { *;}
For more information on relevant APIs, see TUIKaraoke.
// 1. Initialize
TRTCKaraokeRoom mTRTCKaraokeRoom = TRTCKaraokeRoom.sharedInstance(this);
mTRTCKaraokeRoom.setDelegate(this);
// 2. Log in
mTRTCKaraokeRoom.login(SDKAppID, UserID, UserSig, new TRTCKaraokeRoomCallback.ActionCallback() {
@Override
public void onCallback(int code, String msg) {
if (code == 0) {
// Logged in
}
}
});
Parameter description:
SDKAppID
is as shown below:SDKAppID
. On the Application Management page in the TRTC console, the SecretKey
is as shown below:SDKAppID
, userId
, and Secretkey
. You can click here to directly generate a debugging userSig
online or calculate it on your own by referring to the TUIKaraoke demo project. For more information, see UserSig.The anchor creates a room through TUIKaraoke.createRoom.
int roomId = "Room ID";
TRTCKaraokeRoomDef.RoomParam roomParam = new TRTCKaraokeRoomDef.RoomParam();
roomParam.roomName = "Room name";
roomParam.needRequest = false; // Whether your consent is required for listeners to speak
roomParam.seatCount = 8; // Number of seats in the room. Set it to `8`
roomParam.coverUrl = "URL of room cover image";
mTRTCKaraokeRoom.createRoom(roomId, roomParam, new TRTCKaraokeRoomCallback.ActionCallback() {
@Override
public void onCallback(int code, String msg) {
if (code == 0) {
// Room created successfully
}
}
});
A listener enters the room through TUIKaraoke.enterRoom.
mTRTCKaraokeRoom.enterRoom(roomId, new TRTCKaraokeRoomCallback.ActionCallback() {
@Override
public void onCallback(int code, String msg) {
if (code == 0) {
// Entered room successfully
}
}
});
*A listener mics on through TUIKaraoke.enterSeat.
// 1. A listener calls an API to mic on
int seatIndex = 1;
mTRTCKaraokeRoom.enterSeat(seatIndex, new TRTCKaraokeRoomCallback.ActionCallback() {
@Override
public void onCallback(int code, String msg) {
if (code == 0) {
// Mic turned on successfully
}
}
});
// 2. The listener receives the `onSeatListChange` callback and refreshes the seat list
@Override
public void onSeatListChange(final List<TRTCKaraokeRoomDef.SeatInfo> seatInfoList) {
}
Note:You can implement other seat management operations as instructed in TRTCKaraoke (Android) or by referring to the TUIKaraoke demo project.
// Play back the music
mTRTCKaraokeRoom.startPlayMusic(musicID,url);
// Stop the music
mTRTCKaraokeRoom.stopPlayMusic();
After completing the previous steps, you can implement the basic karaoke features. If your business needs more features such as text chat and gift giving, you can integrate the following capabilities:
If you want the text chat feature between anchors and listeners, implement message sending/receiving as follows:
For more information on relevant APIs, see sendRoomTextMsg.
// Sender: Sends text messages
mTRTCKaraokeRoom.sendRoomTextMsg("Hello Word!", new TRTCKaraokeRoomCallback.ActionCallback() {
@Override
public void onCallback(int code, String msg) {
if (code == 0) {
// Sent successfully
}
}
});
// Receiver: Listens for text messages
mTRTCKaraokeRoom.setDelegate(new TRTCKaraokeRoomDelegate() {
@Override
public void onRecvRoomTextMsg(String message, TRTCKaraokeRoomDef.UserInfo userInfo) {
Log.d(TAG, "Received a message from" + userInfo.userName + ": " + message);
}
});
If you want the gift giving and receiving features, implement gift giving, receiving, and displaying as follows:
// Sender: Customize `CMD_GIFT` to distinguish between gift messages
mTRTCKaraokeRoom.sendRoomCustomMsg("CMD_GIFT",date, new TRTCKaraokeRoomCallback.ActionCallback() {
@Override
public void onCallback(int code, String msg) {
if (code == 0) {
// Sent successfully
}
}
});
// Receiver: Listens for gift messages
mTRTCKaraokeRoom.setDelegate(new TRTCKaraokeRoomDelegate() {
@Override
public void onRecvRoomCustomMsg(String cmd, String message, TRTCKaraokeRoomDef.UserInfo userInfo) {
if ("CMD_GIFT".equals(cmd)) {
// Received a gift message
Log.d(TAG, "Received a gift from" + userInfo.userName + ": " + message);
}
}
});
TUIKaraoke
component support sound effect features such as voice change, tone change, and reverb?Yes. For more information, see the TUIKaraoke demo project.
Note:If you have any requirements or feedback, contact colleenyu@tencent.com.
Was this page helpful?