tencent cloud

TRTCVoiceRoom is based on Tencent Real-Time Communication (TRTC) and Instant Messaging (IM). Its features include:

• A user can create an audio chat room and become a speaker, or enter an audio chat room as a listener.
• The room owner can invite a listener to speak as well as remove a speaker.
• The room owner can also block a seat. Listeners cannot request to take a blocked seat.
• A listener can request to speak and become a speaker. A speaker can also become a listener.
• All users can send text and custom messages. Custom messages can be used to send on-screen comments, give likes, and send gifts.

TRTCVoiceRoom is an open-source class depending on two closed-source Tencent Cloud SDKs. For the specific implementation process, please see Audio Chat Room (Android).

• TRTC SDK: the TRTC SDK is used as a low-latency audio chat component.
• IM SDK: the AVChatRoom feature of the IM SDK is used to implement chat rooms. The attribute APIs of IM are used to store room information such as the seat list, and invitation signaling is used to send requests to speak or invite others to speak.

TRTCVoiceRoom API Overview

Basic SDK APIs

API	Description
sharedInstance	Gets a singleton object.
destroySharedInstance	Terminates a singleton object.
setDelegate	Sets event callbacks.
setDelegateHandler	Sets the thread where event callbacks are.
login	Logs in.
logout	Logs out.
setSelfProfile	Sets profile.

Room APIs

API	Description
createRoom	Creates a room (called by room owner). If the room does not exist, the system will automatically create a room.
destroyRoom	Terminates a room (called by room owner).
enterRoom	Enters a room (called by listener).
exitRoom	Exits a room (called by listener).
getRoomInfoList	Gets room list details.
getUserInfoList	Gets the user information of the specified userId. If the value is null, the information of all users in the room is obtained.

Seat management APIs

API	Description
enterSeat	Becomes a speaker (called by room owner or listener).
moveSeat	Changes the seat (called by speaker).
leaveSeat	Becomes a listener (called by speaker).
pickSeat	Places a user in a seat (called by room owner).
kickSeat	Removes a speaker (called by room owner).
muteSeat	Mutes/Unmutes a seat (called by room owner).
closeSeat	Blocks/Unblocks a seat (called by room owner).

Local audio APIs

API	Description
startMicrophone	Starts mic capturing.
stopMicrophone	Stops mic capturing.
setAudioQuality	Sets audio quality.
muteLocalAudio	Mutes/Unmutes local audio.
setSpeaker	Sets whether to use the speaker or receiver.
setAudioCaptureVolume	Sets mic capturing volume.
setAudioPlayoutVolume	Sets playback volume.
setVoiceEarMonitorEnable	Enables/Disables in-ear monitoring.

Remote audio APIs

API	Description
muteRemoteAudio	Mutes/Unmutes a specified member.
muteAllRemoteAudio	Mutes/Unmutes all members.

Background music and audio effect APIs

API	Description
getAudioEffectManager	Gets the background music and audio effect management object TXAudioEffectManager.

Message sending APIs

API	Description
sendRoomTextMsg	Broadcasts a text message in a room. This API is generally used for on-screen comments.
sendRoomCustomMsg	Sends a custom text message.

Invitation signaling APIs

API	Description
sendInvitation	Sends an invitation.
acceptInvitation	Accepts an invitation.
rejectInvitation	Declines an invitation.
cancelInvitation	Cancels an invitation.

TRTCVoiceRoomDelegate API Overview

Common event callback APIs

API	Description
onError	Error
onWarning	Warning
onDebugLog	Log

Room event callback APIs

API	Description
onRoomDestroy	The room was terminated.
onRoomInfoChange	The room information changed.
onUserVolumeUpdate	User volume

Seat list change callback APIs

API	Description
onSeatListChange	All seat changes
onAnchorEnterSeat	Someone became a speaker or was made a speaker by the room owner.
onAnchorLeaveSeat	Someone became a listener or was moved to listeners by the room owner.
onSeatMute	The room owner muted a seat.
onUserMicrophoneMute	Whether a user’s mic is muted
onSeatClose	The room owner blocked a seat.

Callback APIs for room entry/exit by listener

API	Description
onAudienceEnter	A listener entered the room.
onAudienceExit	A listener exited the room.

Message event callback APIs

API	Description
onRecvRoomTextMsg	Receipt of a text message
onRecvRoomCustomMsg	A custom message was received.

Signaling Event Callback APIs

API	Description
onReceiveNewInvitation	Receipt of an invitation
onInviteeAccepted	Invitation accepted by invitee
onInviteeRejected	Invitation declined by invitee
onInvitationCancelled	The inviter canceled the invitation.

Basic SDK APIs

sharedInstance

This API is used to get a TRTCVoiceRoom singleton object.

public static synchronized TRTCVoiceRoom sharedInstance(Context context);

The parameters are as detailed below:

Parameter	Type	Description
context	Context	Android context, which will be converted to ApplicationContext for the calling of system APIs

destroySharedInstance

This API is used to terminate a TRTCVoiceRoom singleton object.

Note：

After the instance is terminated, the externally cached TRTCVoiceRoom instance can no longer be used. You need to call sharedInstance again to get a new instance.

public static void destroySharedInstance();

setDelegate

This API is used to set the event callback of TRTCVoiceRoom. You can use TRTCVoiceRoomDelegate to get different status notifications of TRTCVoiceRoom.

public abstract void setDelegate(TRTCVoiceRoomDelegate delegate);

Note：

setDelegate is the delegate callback of TRTCVoiceRoom.

setDelegateHandler

This API is used to set the thread where event callbacks are.

public abstract void setDelegateHandler(Handler handler);

The parameters are as detailed below:

Parameter	Type	Description
handler	Handler	The status notifications of TRTCVoiceRoom are sent to the handler thread you specify.

login

This API is used to log in to the Tencent backend server.

public abstract void login(int sdkAppId,
String userId, String userSig,
TRTCVoiceRoomCallback.ActionCallback callback);

The parameters are as detailed below:

Parameter	Type	Description
sdkAppId	int	You can view SDKAppID in Application Management > Application Info of the TRTC console.
userId	String	ID of current user, which is a string that can contain only letters (a-z and A-Z), digits (0-9), hyphens (-), and underscores (_).
userSig	String	Tencent Cloud's proprietary security protection signature. For more information on how to get it, please see How to Calculate UserSig.
callback	ActionCallback	Callback for login. The code is 0 if login succeeds.

logout

This API is used to log out of the Tencent backend server.

public abstract void logout(TRTCVoiceRoomCallback.ActionCallback callback);

The parameters are as detailed below:

Parameter	Type	Description
callback	ActionCallback	Callback for logout. The code is 0 if logout succeeds.

setSelfProfile

This API is used to set the profile.

public abstract void setSelfProfile(String userName, String avatarURL, TRTCVoiceRoomCallback.ActionCallback callback);

The parameters are as detailed below:

Parameter	Type	Description
userName	String	Username
avatar	String	Profile photo address
callback	ActionCallback	Callback for profile setting. The code is 0 if the operation succeeds.

Room APIs

createRoom

This API is used to create a room (called by room owner).

public abstract void createRoom(int roomId, TRTCVoiceRoomDef.RoomParam roomParam, TRTCVoiceRoomCallback.ActionCallback callback);

The parameters are as detailed below:

Parameter	Type	Description
roomId	int	Room ID. You need to assign and manage the IDs in a centralized manner. Multiple roomID values can be aggregated into a karaoke room list. Currently, Tencent Cloud does not provide management services for room lists. Please manage the list on your own.
roomParam	TRTCCreateRoomParam	Room information, such as room name, seat list information, and cover information. To manage seats, you must enter the number of seats in the room.
callback	ActionCallback	Callback for room creation. The code is 0 if the operation succeeds.

The process of creating a karaoke room and becoming a speaker is as follows:

1. A user calls createRoom to create an audio chat room, passing in room attributes (e.g. room ID, whether listeners require room owner’s consent to speak, number of seats).
2. After creating the room, the user calls enterSeat to become a speaker.
3. The user will receive an onSeatListChanget notification about the change of the seat list, and can update the change to the UI.
4. The user will also receive an onAnchorEnterSeat notification that someone became a speaker, and mic capturing will be enabled automatically.

destroyRoom

This API is used to terminate a room (called by room owner).

public abstract void destroyRoom(TRTCVoiceRoomCallback.ActionCallback callback);

The parameters are as detailed below:

Parameter	Type	Description
callback	ActionCallback	Callback for room termination. The code is 0 if the operation succeeds.

enterRoom

This API is used to enter a room (called by listener).

public abstract void enterRoom(int roomId, TRTCVoiceRoomCallback.ActionCallback callback);

The parameters are as detailed below:

Parameter	Type	Description
roomId	int	Room ID
callback	ActionCallback	Callback for room entry. The code is 0 if the operation succeeds.

The process of entering a room as a listener is as follows:

1. A user gets the latest audio chat room list from your server. The list may contain the roomId and room information of multiple audio chat rooms.
2. The user selects a room, and calls enterRoom with the room ID passed in to enter the room.
3. After entering the room, the user receives an onRoomInfoChange notification about room attribute change from the component. The attributes can be recorded, and corresponding changes can be made to the UI, including room name, whether room owner’s consent is required for listeners to speak, etc.
4. The user will receive an onSeatListChange notification about the change of the seat list and can update the change to the UI.
5. The user will also receive an onAnchorEnterSeat notification that someone became a speaker.

exitRoom

This API is used to exit a room.

public abstract void exitRoom(TRTCVoiceRoomCallback.ActionCallback callback);

The parameters are as detailed below:

Parameter	Type	Description
callback	ActionCallback	Callback for room exit. The code is 0 if the operation succeeds.

getRoomInfoList

This API is used to get room list details. The room name and cover are set by the room owner via roomInfo when calling createRoom().

Note：

You don’t need this API if both the room list and room information are managed on your server.

public abstract void getRoomInfoList(List<Integer> roomIdList, TRTCVoiceRoomCallback.RoomInfoCallback callback);

The parameters are as detailed below:

Parameter	Type	Description
roomIdList	List<Integer>	Room ID list
callback	RoomInfoCallback	Callback of room details

getUserInfoList

This API is used to get the user information of a specified userId.

public abstract void getUserInfoList(List<String> userIdList, TRTCVoiceRoomCallback.UserListCallback userlistcallback);

The parameters are as detailed below:

Parameter	Type	Description
userIdList	List<String>	IDs of the users to query. If this parameter is null, the information of all users in the room is queried.
userlistcallback	UserListCallback	Callback of user details

Seat Management APIs

enterSeat

This API is used to become a speaker (called by room owner or listener).

Note：

After a user becomes a speaker, all members in the room will receive an onSeatListChange notification and an onAnchorEnterSeat notification.

public abstract void enterSeat(int seatIndex, TRTCVoiceRoomCallback.ActionCallback callback);

The parameters are as detailed below:

Parameter	Type	Description
seatIndex	int	The number of the seat to take
callback	ActionCallback	Callback for the operation

Calling this API will immediately modify the seat list. In cases where listeners need the room owner’s consent to take a seat, you can call sendInvitation first to send a request and, after receiving onInvitationAccept, call this API.

moveSeat

This API is used to change one’s seat (called by speaker).

Note：

After the seat change, all users in the room will receive the onSeatListChange, onAnchorLeaveSeat, and onAnchorEnterSeat notifications. This API will only change the user’s seat number, not the user role.

public abstract int moveSeat(int seatIndex, TRTCVoiceRoomCallback.ActionCallback callback);

The parameters are as detailed below:

Parameter	Type	Description
seatIndex	int	The number of the seat to change to
callback	ActionCallback	Callback for the operation

Response parameters:

Parameter	Type	Description
code	int	Result of seat change. 0: operation successful; 10001: API rate limit exceeded; other values: operation failed

Calling this API will immediately modify the seat list. In cases where listeners need the room owner’s consent to take a seat, you can call sendInvitation first to send a request and, after receiving onInvitationAccept, call this API.

leaveSeat

This API is used to become a listener (called by speaker).

Note：

After a speaker becomes a listener, all members in the room will receive an onSeatListChange notification and an onAnchorLeaveSeat notification.

public abstract void leaveSeat(TRTCVoiceRoomCallback.ActionCallback callback);

The parameters are as detailed below:

Parameter	Type	Description
callback	ActionCallback	Callback for the operation

pickSeat

This API is used to place a user in a seat (called by room owner).

Note：

After the room owner places a user in a seat, all members in the room will receive an onSeatListChange notification and an onAnchorEnterSeat notification.

public abstract void pickSeat(int seatIndex, String userId, TRTCVoiceRoomCallback.ActionCallback callback);

The parameters are as detailed below:

Parameter	Type	Description
seatIndex	int	The number of the seat to place the listener in
userId	String	User ID
callback	ActionCallback	Callback for the operation

Calling this API will immediately modify the seat list. In cases where the room owner needs listeners’ consent to make them speakers, you can call sendInvitation first to send a request and, after receiving onInvitationAccept, call pickSeat.

kickSeat

This API is used to remove a speaker (called by room owner).

Note：

After a speaker is removed, all members in the room will receive an onSeatListChange notification and an onAnchorLeaveSeat notification.

public abstract void kickSeat(int seatIndex, TRTCVoiceRoomCallback.ActionCallback callback);

The parameters are as detailed below:

Parameter	Type	Description
seatIndex	int	The number of the seat to remove the speaker from
callback	ActionCallback	Callback for the operation

Calling this API will immediately modify the seat list.

muteSeat

This API is used to mute/unmute a seat (called by room owner).

Note：

After a seat is muted/unmuted, all members in the room will receive an onSeatListChange notification and an onSeatMute notification.

public abstract void muteSeat(int seatIndex, boolean isMute, TRTCVoiceRoomCallback.ActionCallback callback);

The parameters are as detailed below:

Parameter	Type	Description
seatIndex	int	The number of the seat to block/unblock
isMute	boolean	true: mute; false: unmute
callback	ActionCallback	Callback for the operation

Calling this API will immediately modify the seat list. The speaker on the seat specified by seatIndex will call muteAudio to mute/unmute his or her audio.

closeSeat

This API is used to block/unblock a seat (called by room owner).

Note：

After a seat is blocked/unblocked, all members in the room will receive an onSeatListChange notification and an onSeatClose notification.

public abstract void closeSeat(int seatIndex, boolean isClose, TRTCVoiceRoomCallback.ActionCallback callback);

The parameters are as detailed below:

Parameter	Type	Description
seatIndex	int	The number of the seat to block/unblock
isClose	boolean	true: block; false: unblock
callback	ActionCallback	Callback for the operation

Calling this API will immediately modify the seat list. The speaker on the seat specified by seatIndex will leave the seat.

Local Audio APIs

startMicrophone

This API is used to start mic capturing.

public abstract void startMicrophone();

stopMicrophone

This API is used to stop mic capturing.

public abstract void stopMicrophone();

setAudioQuality

This API is used to set audio quality.

public abstract void setAudioQuality(int quality);

The parameters are as detailed below:

Parameter	Type	Description
quality	int	Audio quality. For more information, please see setAudioQuality().

muteLocalAudio

This API is used to mute/unmute local audio.

public abstract void muteLocalAudio(boolean mute);

The parameters are as detailed below:

Parameter	Type	Description
mute	boolean	Whether to mute or unmute audio. For more information, please see muteLocalAudio().

setSpeaker

This API is used to set whether to use the speaker or receiver.

public abstract void setSpeaker(boolean useSpeaker);

The parameters are as detailed below:

Parameter	Type	Description
useSpeaker	boolean	true: speaker; false: receiver

setAudioCaptureVolume

This API is used to set the mic capturing volume.

public abstract void setAudioCaptureVolume(int volume);

The parameters are as detailed below:

Parameter	Type	Description
volume	int	Capturing volume. Value range: 0-100 (default: 100)

setAudioPlayoutVolume

This API is used to set the playback volume.

public abstract void setAudioPlayoutVolume(int volume);

The parameters are as detailed below:

Parameter	Type	Description
volume	int	Playback volume. Value range: 0-100 (default: 100)

muteRemoteAudio

This API is used to mute/unmute a specified user.

public abstract void muteRemoteAudio(String userId, boolean mute);

The parameters are as detailed below:

Parameter	Type	Description
userId	String	User ID
mute	boolean	true: mute; false: unmute

muteAllRemoteAudio

This API is used to mute/unmute all users.

public abstract void muteAllRemoteAudio(boolean mute);

The parameters are as detailed below:

Parameter	Type	Description
mute	boolean	true: mute; false: unmute

setVoiceEarMonitorEnable

This API is used to enable/disable in-ear monitoring.

public abstract void setVoiceEarMonitorEnable(boolean enable);

The parameters are as detailed below:

Parameter	Type	Description
enable	boolean	true: enable; false: disable

Background Music and Audio Effect APIs

getAudioEffectManager

This API is used to get the background music and audio effect management object TXAudioEffectManager.

public abstract TXAudioEffectManager getAudioEffectManager();

Message Sending APIs

sendRoomTextMsg

This API is used to broadcast a text message in a room, which is generally used for on-screen comments.

public abstract void sendRoomTextMsg(String message, TRTCVoiceRoomCallback.ActionCallback callback);

The parameters are as detailed below:

Parameter	Type	Description
message	String	Text message
callback	ActionCallback	Callback for the operation

sendRoomCustomMsg

This API is used to send a custom text message.

public abstract void sendRoomCustomMsg(String cmd, String message, TRTCVoiceRoomCallback.ActionCallback callback);

The parameters are as detailed below:

Parameter	Type	Description
cmd	String	Custom command word used to distinguish between different message types
message	String	Text message
callback	ActionCallback	Callback for the operation

Invitation Signaling APIs

sendInvitation

This API is used to send an invitation.

public abstract String sendInvitation(String cmd, String userId, String content, TRTCVoiceRoomCallback.ActionCallback callback);

The parameters are as detailed below:

Parameter	Type	Description
cmd	String	Custom command of business
userId	String	Invitee’s user ID
content	String	Invitation content
callback	ActionCallback	Callback for the operation

Response parameters:

Returned Value	Type	Description
inviteId	String	Invitation ID

acceptInvitation

This API is used to accept an invitation.

public abstract void acceptInvitation(String id, TRTCVoiceRoomCallback.ActionCallback callback);

The parameters are as detailed below:

Parameter	Type	Description
id	String	Invitation ID
callback	ActionCallback	Callback for the operation

rejectInvitation

This API is used to decline an invitation.

public abstract void rejectInvitation(String id, TRTCVoiceRoomCallback.ActionCallback callback);

The parameters are as detailed below:

Parameter	Type	Description
id	String	Invitation ID
callback	ActionCallback	Callback for the operation

cancelInvitation

This API is used to cancel an invitation.

public abstract void cancelInvitation(String id, TRTCVoiceRoomCallback.ActionCallback callback);

The parameters are as detailed below:

Parameter	Type	Description
id	String	Invitation ID
callback	ActionCallback	Callback for the operation

TRTCVoiceRoomDelegate Event Callback APIs

Common Event Callback APIs

onError

Callback for error.

This callback indicates that the SDK encountered an unrecoverable error. Such errors must be listened for, and UI reminders should be sent to users depending if necessary.

void onError(int code, String message);

The parameters are as detailed below:

Parameter	Type	Description
code	int	Error code
message	String	Error message

onWarning

Callback for warning.

void onWarning(int code, String message);

The parameters are as detailed below:

Parameter	Type	Description
code	int	Error code
message	String	Warning message

onDebugLog

Callback for log.

void onDebugLog(String message);

The parameters are as detailed below:

Parameter	Type	Description
message	String	Log information

Room Event Callback APIs

onRoomDestroy

Callback for room termination. When the owner terminates the room, all users in the room will receive this callback.

void onRoomDestroy(String roomId);

The parameters are as detailed below:

Parameter	Type	Description
roomId	String	Room ID

onRoomInfoChange

Callback for change of room information. This callback is sent after successful room entry. The information in roomInfo is passed in by the room owner during room creation.

void onRoomInfoChange(TRTCVoiceRoomDef.RoomInfo roomInfo);

The parameters are as detailed below:

Parameter	Type	Description
roomInfo	RoomInfo	Room information

onUserMicrophoneMute

Callback of whether a user’s mic is muted. When a user calls muteLocalAudio, all members in the room will receive this callback.

void onUserMicrophoneMute(String userId, boolean mute);

The parameters are as detailed below:

Parameter	Type	Description
userId	String	User ID
mute	boolean	true: muted; false: unmuted

onUserVolumeUpdate

Notification to all members of the volume after the volume reminder is enabled.

void onUserVolumeUpdate(List<TRTCCloudDef.TRTCVolumeInfo> userVolumes, int totalVolume);

The parameters are as detailed below:

Parameter	Type	Description
userVolumes	ListList<trtcclouddef.trtcvolumeinfo>	List of user IDs
totalVolume	int	Total volume. Value range: 0-100

Seat Callback APIs

onSeatListChange

Callback for all seat changes.

void onSeatListChange(List<SeatInfo> seatInfoList);

The parameters are as detailed below:

Parameter	Type	Description
seatInfoList	List<SeatInfo>	Full seat list

onAnchorEnterSeat

Someone became a speaker or was made a speaker by the room owner.

void onAnchorEnterSeat(int index, TRTCVoiceRoomDef.UserInfo user);

The parameters are as detailed below:

Parameter	Type	Description
index	int	The seat taken
user	UserInfo	Details of the user who took the seat

onAnchorLeaveSeat

A speaker became a listener or was moved to listeners by the room owner.

void onAnchorLeaveSeat(int index, TRTCVoiceRoomDef.UserInfo user);

The parameters are as detailed below:

Parameter	Type	Description
index	int	The seat previously occupied by the speaker
user	UserInfo	Details of the user who took the seat

onSeatMute

The room owner muted/unmuted a seat.

void onSeatMute(int index, boolean isMute);

The parameters are as detailed below:

Parameter	Type	Description
index	int	The seat muted/unmuted
isMute	boolean	true: muted; false: unmuted

onSeatClose

The room owner blocked/unblocked a seat.

void onSeatClose(int index, boolean isClose);

The parameters are as detailed below:

Parameter	Type	Description
index	int	The seat blocked/unblocked
isClose	boolean	true: blocked; false: unblocked

Callback APIs for Room Entry/Exit by Listener

onAudienceEnter

A listener entered the room.

void onAudienceEnter(TRTCVoiceRoomDef.UserInfo userInfo);

The parameters are as detailed below:

Parameter	Type	Description
userInfo	UserInfo	Information of the listener who entered the room

onAudienceExit

A listener exited the room.

void onAudienceExit(TRTCVoiceRoomDef.UserInfo userInfo);

The parameters are as detailed below:

Parameter	Type	Description
userInfo	UserInfo	Information of the listener who exited the room

Message Event Callback APIs

onRecvRoomTextMsg

Callback for receiving a text message.

void onRecvRoomTextMsg(String message, TRTCVoiceRoomDef.UserInfo userInfo);

The parameters are as detailed below:

Parameter	Type	Description
message	String	Text message
userInfo	UserInfo	Information of the sender

onRecvRoomCustomMsg

Callback for receiving a custom message.

void onRecvRoomCustomMsg(String cmd, String message, TRTCVoiceRoomDef.UserInfo userInfo);

The parameters are as detailed below:

Parameter	Type	Description
cmd	String	Custom command word used to distinguish between different message types
message	String	Text message
userInfo	UserInfo	Information of the sender

Invitation Signaling Callback APIs

onReceiveNewInvitation

An invitation was received.

void onReceiveNewInvitation(String id, String inviter, String cmd, String content);

The parameters are as detailed below:

Parameter	Type	Description
id	String	Invitation ID
inviter	String	Inviter’s user ID
cmd	String	Custom command word specified by business
content	String	Content specified by business

onInviteeAccepted

The invitee accepted the invitation

void onInviteeAccepted(String id, String invitee);

The parameters are as detailed below:

Parameter	Type	Description
id	String	Invitation ID
invitee	String	Invitee’s user ID

onInviteeRejected

The invitee declined the invitation

void onInviteeRejected(String id, String invitee);

The parameters are as detailed below:

Parameter	Type	Description
id	String	Invitation ID
invitee	String	Invitee’s user ID

onInvitationCancelled

The inviter canceled the invitation.

void onInvitationCancelled(String id, String inviter);

The parameters are as detailed below:

Parameter	Type	Description
id	String	Invitation ID
inviter	String	Inviter’s user ID
</trtcclouddef.trtcvolumeinfo>