TRTCKaraoke 相关接口

TRTCKaraokeRoom 是基于腾讯云实时音视频（TRTC）和即时通信 IM 服务组合而成的组件，支持以下功能：

• 房主创建新的 Karaoke 房间开播，听众进入 Karaoke 房间收听/互动。
• 房主可以管理点歌、将座位上的麦上主播踢下麦。
• 房主还能对座位进行封禁，其他听众就不能再进行申请上麦了。
• 听众可以申请上麦，变成麦上主播，上麦后可以点歌和唱歌，也可以随时下麦成为普通的听众。
• 支持发送礼物和各种文本、自定义消息，自定义消息可用于实现弹幕、点赞等。

说明：

TUIKit 系列组件同时使用了腾讯云 实时音视频 TRTC 和 即时通信 IM 两个基础 PaaS 服务，开通实时音视频后会同步开通即时通信IM服务。即时通信 IM 服务详细计费规则请参见 即时通信 - 价格说明，TRTC 开通会默认关联开通 IM SDK 的体验版，仅支持100个 DAU。

TRTCKaraokeRoom 是一个开源的 Class，依赖腾讯云的两个闭源 SDK，具体的实现过程请参见 Karaoke（Android）。

• TRTC SDK：使用 TRTC SDK 作为低延时语音聊天组件。
• IM SDK：使用 IM SDK 的 AVChatroom 实现聊天室的功能，同时，通过 IM 的属性接口来存储麦位表等房间信息，邀请信令可以用于上麦申请/抱麦申请。

TRTCKaraokeRoom API 概览

SDK 基础函数

房间相关接口函数

音乐播放接口

麦位管理接口

本地音频操作接口

远端用户音频操作接口

背景音乐音效相关接口

消息发送相关接口

邀请信令相关接口

TRTCKaraokeRoomDelegate API 概览

通用事件回调

房间事件回调

麦位变更回调

听众进出事件回调

消息事件回调

信令事件回调

歌曲事件回调

SDK 基础函数

sharedInstance

获取 TRTCKaraokeRoom 单例对象。

public static synchronized TRTCKaraokeRoom sharedInstance(Context context);

参数如下表所示：

destroySharedInstance

销毁 TRTCKaraokeRoom 单例对象。

说明：

销毁实例后，外部缓存的 TRTCKaraokeRoom 实例无法再使用，需要重新调用 sharedInstance 获取新实例。

public static void destroySharedInstance();

setDelegate

TRTCKaraokeRoom 事件回调，您可以通过 TRTCKaraokeRoomDelegate 获得 TRTCKaraokeRoom 的各种状态通知。

public abstract void setDelegate(TRTCKaraokeRoomDelegate delegate);

说明：

setDelegate 是 TRTCKaraokeRoom 的代理回调。

setDelegateHandler

设置事件回调所在的线程。

public abstract void setDelegateHandler(Handler handler);

参数如下表所示：

login

登录。

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

参数如下表所示：

logout

登出。

public abstract void logout(TRTCKaraokeRoomCallback.ActionCallback callback);

参数如下表所示：

setSelfProfile

修改个人信息。

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

参数如下表所示：

房间相关接口函数

createRoom

创建房间（房主调用）。

public abstract void createRoom(int roomId, TRTCKaraokeRoomDef.RoomParam roomParam, TRTCKaraokeRoomCallback.ActionCallback callback);

参数如下表所示：

房主开播的正常调用流程如下：

1. 房主调用createRoom创建新的 Karaoke 房间，此时传入房间 ID、上麦是否需要房主确认、麦位数等房间属性信息。
2. 房主创建房间成功后，调用enterSeat进入座位。
3. 房主收到组件的onSeatListChange麦位表变化事件通知，此时可以将麦位表变化刷新到 UI 界面上。
4. 房主还会收到麦位表有成员进入的onAnchorEnterSeat的事件通知，此时会自动打开麦克风采集。

destroyRoom

销毁房间（房主调用）。房主在创建房间后，可以调用这个函数来销毁房间。

public abstract void destroyRoom(TRTCKaraokeRoomCallback.ActionCallback callback);

参数如下表所示：

enterRoom

进入房间（听众调用）。

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

参数如下表所示：

听众进房收听的正常调用流程如下：

1. 听众向您的服务端获取最新的 Karaoke 房间列表，可能包含多个 Karaoke 房间的 roomId 和房间信息。
2. 听众选择一个 Karaoke 房间，调用enterRoom并传入房间号即可进入该房间。
3. 进房后会收到组件的onRoomInfoChange房间属性变化事件通知，此时可以记录房间属性并做相应改变，例如 UI 展示房间名、记录上麦是否需要请求房主同意等。
4. 进房后会收到组件的onSeatListChange麦位表变化事件通知，此时可以将麦位表变化刷新到 UI 界面上。
5. 进房后还会收到麦位表有主播进入的onAnchorEnterSeat的事件通知。

exitRoom

退出房间。

public abstract void exitRoom(TRTCKaraokeRoomCallback.ActionCallback callback);

参数如下表所示：

getRoomInfoList

获取房间列表的详细信息，其中房间名称、房间封面是房主在创建 createRoom() 时通过 roomInfo 设置的。

说明：

如果房间列表和房间信息都由您自行管理，可忽略该函数。

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

参数如下表所示：

getUserInfoList

获取指定userId的用户信息。

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

参数如下表所示：

音乐播放接口

startPlayMusic

播放音乐（上麦后调用）。

说明：

• 播放音乐后，自身会收到 onMusicPrepareToPlay 的事件通知。
• 音乐播放中，房间内所有成员会不断收到 onMusicProgressUpdate 的事件通知。
• 音乐播放完成，自身会收到 onMusicCompletePlaying 的事件通知。

public abstract void startPlayMusic(int musicID, String originalUrl, String accompanyUrl);

参数如下表所示：

调用该接口后会停止上一个正在播放的歌曲。

stopPlayMusic

停止播放音乐（播放音乐时调用）。

说明：

停止播放后，会收到 onMusicCompletePlaying 的事件通知。

public abstract void stopPlayMusic();

pausePlayMusic

暂停正在播放的音乐（播放音乐时调用）。

说明：

• onMusicProgressUpdate 的事件通知会暂停
• 不会收到 onMusicCompletePlaying 的事件通知。

public abstract void pausePlayMusic();

resumePlayMusic

恢复暂停过的音乐（暂停后调用）。

说明：

不会收到 onMusicPrepareToPlay 的事件通知。

public abstract void resumePlayMusic();

麦位管理接口

enterSeat

主动上麦（听众端和房主均可调用）。

说明：

上麦成功后，房间内所有成员会收到onSeatListChange和onAnchorEnterSeat的事件通知。

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

参数如下表所示：

调用该接口会立即修改麦位表。如果是听众申请上麦需要房主同意的场景，可以先调用 sendInvitation 向房主申请，收到 onInvitationAccept后再调用该函数。

leaveSeat

主动下麦（主播调用）。

说明：

下麦成功后，房间内所有成员会收到onSeatListChange和onAnchorLeaveSeat的事件通知。

public abstract void leaveSeat(TRTCKaraokeRoomCallback.ActionCallback callback);

参数如下表所示：

pickSeat

抱人上麦（房主调用）。

说明：

房主抱人上麦，房间内所有成员会收到onSeatListChange和onAnchorEnterSeat的事件通知。

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

参数如下表所示：

调用该接口会立即修改麦位表。如果是房主需要听众同意，听众才会上麦的场景，可以先调用 sendInvitation 向听众申请，收到 onInvitationAccept后再调用该函数。

kickSeat

踢人下麦（房主调用）。

说明：

房主踢人下麦，房间内所有成员会收到 onSeatListChange 和 onAnchorLeaveSeat 的事件通知。

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

参数如下表所示：

调用该接口会立即修改麦位表。

muteSeat

静音/解除静音某个麦位（房主调用）。

说明：

静音/解除静音某个麦位，房间内所有成员会收到 onSeatListChange 和 onSeatMute 的事件通知。

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

参数如下表所示：

调用该接口会立即修改麦位表。对应 seatIndex 座位上的主播，会自动调用 muteAudio 进行静音/解禁。

closeSeat

封禁/解禁某个麦位（房主调用）。

说明：

房主封禁/解禁对应麦位，房间内所有成员会收到 onSeatListChange 和 onSeatClose 的事件通知。

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

参数如下表所示：

调用该接口会立即修改麦位表。封禁对应 seatIndex 座位上的主播，会自动下麦。

本地音频操作接口

startMicrophone

开启麦克风采集。

public abstract void startMicrophone();

stopMicrophone

停止麦克风采集。

public abstract void stopMicrophone();

setAudioQuality

设置音质。

public abstract void setAudioQuality(int quality);

参数如下表所示：

muteLocalAudio

静音/取消静音本地的音频。

public abstract void muteLocalAudio(boolean mute);

参数如下表所示：

setSpeaker

设置开启扬声器。

public abstract void setSpeaker(boolean useSpeaker);

参数如下表所示：

setAudioCaptureVolume

设置麦克风采集音量。

public abstract void setAudioCaptureVolume(int volume);

参数如下表所示：

setAudioPlayoutVolume

设置播放音量。

public abstract void setAudioPlayoutVolume(int volume);

参数如下表所示：

muteRemoteAudio

静音/解除静音指定成员。

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

参数如下表所示：

muteAllRemoteAudio

静音/解除静音所有成员。

public abstract void muteAllRemoteAudio(boolean mute);

参数如下表所示：

setVoiceEarMonitorEnable

开启/关闭 耳返。

public abstract void setVoiceEarMonitorEnable(boolean enable);

参数如下表所示：

背景音乐音效相关接口函数

getAudioEffectManager

获取背景音乐音效管理对象 TXAudioEffectManager。

public abstract TXAudioEffectManager getAudioEffectManager();

消息发送相关接口函数

sendRoomTextMsg

在房间中广播文本消息，一般用于弹幕聊天。

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

参数如下表所示：

sendRoomCustomMsg

发送自定义文本消息。

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

参数如下表所示：

邀请信令相关接口

sendInvitation

向用户发送邀请。

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

参数如下表所示：

返回值：

acceptInvitation

接受邀请。

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

参数如下表所示：

rejectInvitation

拒绝邀请。

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

参数如下表所示：

cancelInvitation

取消邀请。

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

参数如下表所示：

TRTCKaraokeRoomDelegate 事件回调

通用事件回调

onError

错误回调。

说明：

SDK 不可恢复的错误，一定要监听，并分情况给用户适当的界面提示。

void onError(int code, String message);

参数如下表所示：

onWarning

警告回调。

void onWarning(int code, String message);

参数如下表所示：

onDebugLog

Log 回调。

void onDebugLog(String message);

参数如下表所示：

房间事件回调

onRoomDestroy

房间被销毁的回调。房主解散房间时，房间内的所有用户都会收到此通知。

void onRoomDestroy(String roomId);

参数如下表所示：

onRoomInfoChange

进房成功后会回调该接口，roomInfo 中的信息在房主创建房间的时候传入。

void onRoomInfoChange(TRTCKaraokeRoomDef.RoomInfo roomInfo);

参数如下表所示：

onUserMicrophoneMute

用户麦克风是否静音回调，当用户调用 muteLocalAudio，房间内的其他用户都会收到此通知。

void onUserMicrophoneMute(String userId, boolean mute);

参数如下表所示：

onUserVolumeUpdate

启用音量大小提示，会通知每个成员的音量大小。

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

参数如下表所示：

麦位回调

onSeatListChange

全量的麦位列表变化，包含了整个麦位表。

void onSeatListChange(List<SeatInfo> seatInfoList);

参数如下表所示：

onAnchorEnterSeat

有成员上麦(主动上麦/房主抱人上麦)。

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

参数如下表所示：

onAnchorLeaveSeat

有成员下麦(主动下麦/房主踢人下麦)。

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

参数如下表所示：

onSeatMute

房主禁麦。

void onSeatMute(int index, boolean isMute);

参数如下表所示：

onSeatClose

房主封麦。

void onSeatClose(int index, boolean isClose);

参数如下表所示：

听众进出事件回调

onAudienceEnter

收到听众进房通知。

void onAudienceEnter(TRTCKaraokeRoomDef.UserInfo userInfo);

参数如下表所示：

onAudienceExit

收到听众退房通知。

void onAudienceExit(TRTCKaraokeRoomDef.UserInfo userInfo);

参数如下表所示：

消息事件回调

onRecvRoomTextMsg

收到文本消息。

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

参数如下表所示：

onRecvRoomCustomMsg

收到自定义消息。

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

参数如下表所示：

邀请信令事件回调

onReceiveNewInvitation

收到新的邀请请求。

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

参数如下表所示：

onInviteeAccepted

被邀请者接受邀请。

void onInviteeAccepted(String id, String invitee);

参数如下表所示：

onInviteeRejected

被邀请者拒绝邀请。

void onInviteeRejected(String id, String invitee);

参数如下表所示：

onInvitationCancelled

邀请人取消邀请。

void onInvitationCancelled(String id, String inviter);

参数如下表所示：

音乐播放状态回调

onMusicPrepareToPlay

准备播放音乐的回调

void onMusicPrepareToPlay(int musicID);

参数如下表所示：

onMusicProgressUpdate

歌曲播放进度的回调

void onMusicProgressUpdate(int musicID, long progress, long total);

参数如下表所示：

onMusicCompletePlaying

播放完成音乐的回调

void onMusicCompletePlaying(int musicID);

参数如下表所示：