TRTCChatSalon 是基于腾讯云实时音视频（TRTC）和即时通信 IM 服务组合而成的组件，支持以下功能：
房主创建新的语音沙龙开播，听众进入语音沙龙收听/互动。
房主可以同意听众上麦、将麦上主播踢下麦。
听众可以申请上麦，变成麦上主播，可以和其他人语音互动，也可以随时下麦成为普通的听众。
支持发送各种文本消息。
TRTC SDK：使用 TRTC SDK 作为低延时语音聊天组件。
IM SDK：使用 IM SDK 的 AVChatroom 实现聊天室的功能，同时，通过 IM 的属性接口来存储麦位表等房间信息，邀请信令可以用于上麦申请/抱麦申请。
TRTCChatSalon API 概览
SDK 基础函数
API | 描述 |
获取单例对象。 | |
销毁单例对象。 | |
设置事件监听。 | |
销毁事件监听。 | |
登录。 | |
登出。 | |
修改个人信息。 |
房间相关接口函数
API | 描述 |
创建房间（房主调用），若房间不存在，系统将自动创建一个新房间。 | |
销毁房间（房主调用）。 | |
进入房间（听众调用）。 | |
退出房间（听众调用）。 | |
获取房间列表的详细信息。 | |
获取房间内所有用户信息。 | |
获取房间主播列表。 | |
获取指定 userId 的用户信息。 |
上下麦接口
本地音频操作接口
API | 描述 |
开启麦克风采集。 | |
停止麦克风采集。 | |
开启/关闭本地静音。 | |
设置开启扬声器。 | |
设置麦克风采集音量。 | |
设置播放音量。 |
远端用户音频操作接口
API | 描述 |
静音/解除静音指定成员。 | |
静音/解除静音所有成员。 |
背景音乐音效相关接口
API | 描述 |
消息发送相关接口
API | 描述 |
在房间中广播文本消息，一般用于弹幕聊天。 |
申请上麦信令相关接口
API | 描述 |
听众申请上麦。 | |
房主同意上麦。 | |
房主拒绝上麦。 |
TRTCChatSalonDelegate API 概览
通用事件回调
API | 描述 |
错误回调。 | |
警告回调。 | |
被踢下线。 |
房间事件回调
API | 描述 |
房间被销毁的回调。 | |
主播列表发生变化的回调。 | |
用户通话音量回调。 |
麦位变更回调
API | 描述 |
有成员上麦（主动上麦/房主抱人上麦）。 | |
有成员下麦（主动下麦/房主踢人下麦）。 | |
主播禁麦。 |
听众进出事件回调
API | 描述 |
收到听众进房通知。 | |
收到听众退房通知。 |
消息事件回调
API | 描述 |
收到文本消息。 |
申请上麦信令事件回调
API | 描述 |
有听众举手，申请上麦。 | |
听众申请举手后，收到房主同意举手的回调。 | |
听众申请举手后，房主拒绝举手的回调。 |
SDK 基础函数
sharedInstance
获取 TRTCChatSalon 单例对象。
static Future<TRTCChatSalon> sharedInstance()
destroySharedInstance
销毁 TRTCChatSalon 单例对象。
说明
static void destroySharedInstance()
registerListener
设置事件监听
void registerListener(VoiceListenerFunc func)
说明
setDelegate 是 TRTCChatSalon 的代理回调。
unRegisterListener
移除组件事件监听接口。
void unRegisterListener(VoiceListenerFunc func)
参数如下表所示：
参数 | 类型 | 含义 |
func | VoiceListenerFunc | TRTCChatSalon 中的各种状态通知，会派发到您指定的 func函数 |
login
登录。
Future<ActionCallback> login(int sdkAppId, String userId, String userSig)
参数如下表所示：
参数 | 类型 | 含义 |
sdkAppId | int | |
userId | String | 当前用户的 ID，字符串类型，只允许包含英文字母（a-z 和 A-Z）、数字（0-9）、连词符（-）和下划线（_）。 |
userSig | String |
logout
登出。
Future<ActionCallback> logout()
setSelfProfile
修改个人信息。
Future<ActionCallback> setSelfProfile(String userName, String avatarURL)
参数如下表所示：
参数 | 类型 | 含义 |
userName | String | 昵称。 |
avatarURL | String | 头像地址。 |
房间相关接口函数
createRoom
创建房间（新建房间时调用）。
Future<ActionCallback> createRoom(int roomId, RoomParam roomParam)
参数如下表所示：
参数 | 类型 | 含义 |
roomId | int | 房间标识，需要由您分配并进行统一管理。多个 roomID 可以汇总成一个语音沙龙房间列表，腾讯云暂不提供语音沙龙房间列表的管理服务，请自行管理您的语音沙龙房间列表。 |
roomParam | RoomParam | 房间信息，用于房间描述的信息。例如房间名称、封面信息等。 |
房主开播的正常调用流程如下：
1. 房主调用
createRoom 创建新的语音沙龙，此时传入房间 ID等房间属性信息。2. 房主还会收到麦位表有成员进入的
onAnchorEnterMic 的事件通知，此时会自动打开麦克风采集。destroyRoom
销毁房间（房主调用）。房主在创建房间后，可以调用这个函数来销毁房间。
Future<ActionCallback> destroyRoom()
enterRoom
进入房间（听众调用）。
Future<ActionCallback> enterRoom(int roomId)
参数如下表所示：
参数 | 类型 | 含义 |
roomId | int | 房间标识。 |
听众进房收听的正常调用流程如下：
1. 听众向您的服务端获取最新的语音沙龙列表，可能包含多个语音沙龙房间的 roomId 和房间信息。
2. 听众选择一个语音沙龙，调用
enterRoom 并传入房间号即可进入该房间。3. 进房后会可查询
getArchorInfoList 获取主播列表，并根据 getRoomMemberList 获取房间所有用户列表，减去主播列表可以得到听众列表。4. 进房后还会收到麦位表有主播进入的
onAnchorEnterMic 的事件通知。exitRoom
退出房间。
Future<ActionCallback> exitRoom()
getRoomInfoList
获取房间列表的详细信息，其中房间名称、房间封面是房主在创建
createRoom() 时通过 roomInfo 设置的。说明
如果房间列表和房间信息都由您自行管理，可忽略该函数。
Future<RoomInfoCallback> getRoomInfoList(List<String> roomIdList)
参数如下表所示：
参数 | 类型 | 含义 |
roomIdList | List<String> | 房间号列表。 |
getRoomMemberList
获取房间内所有成员列表。
说明
IM 直播聊天群默认只能拉取最近31个成员列表。
Future<MemberListCallback> getRoomMemberList(double nextSeq)
参数如下表所示：
参数 | 类型 | 含义 |
nextSeq | double | 分页拉取标志，第一次拉取填0，回调成功如果 nextSeq 不为零，需要分页，传入再次拉取，直至为0。 |
getArchorInfoList
获取房间内主播列表。
Future<UserListCallback> getArchorInfoList()
getUserInfoList
获取指定 userId 的用户信息。
Future<UserListCallback> getUserInfoList(List<String> userIdList)
参数如下表所示：
参数 | 类型 | 含义 |
userIdList | List<String> | 需要获取的用户 ID 列表，如果为 null，则获取房间内所有人的信息。 |
上下麦接口
enterMic
上麦（听众端和房主均可调用）。
说明
上麦成功后，房间内所有成员会收到
onAnchorEnterSeat 的事件通知。Future<ActionCallback> enterMic();
调用该接口会立即修改麦位表。听众需先调用
raiseHand 向房主申请，收到 onAgreeToSpeak后再调用该函数。leaveMic
主播下麦。
说明
下麦成功后，房间内所有成员会收到
onAnchorLeaveMic 的事件通知。Future<ActionCallback> leaveMic()
muteMic
静音/解除静音某个麦位（房主调用）。
说明
改变麦位的状态后，房间内所有成员会收到
onAnchorListChange 和 onMicMute 的事件通。Future<ActionCallback> muteMic(bool mute)
kickMic
踢人下麦（房主调用）。
说明
房主踢人下麦，房间内所有成员会收到
onAnchorLeaveMic 的事件通知。Future<ActionCallback> kickMic(String userId)
参数如下表所示：
参数 | 类型 | 含义 |
userId | String | 需要踢下麦的用户 ID。 |
调用该接口会立即修改麦位表。
本地音频操作接口
startMicrophone
开启麦克风采集。
void startMicrophone(int quality)
参数如下表所示：
参数 | 类型 | 含义 |
quality | int |
stopMicrophone
停止麦克风采集。
void stopMicrophone()
muteLocalAudio
静音/取消静音本地的音频。
void muteLocalAudio(bool mute)
参数如下表所示：
参数 | 类型 | 含义 |
mute | bool |
setSpeaker
设置开启扬声器。
void setSpeaker(bool useSpeaker)
参数如下表所示：
参数 | 类型 | 含义 |
useSpeaker | bool | true：扬声器；false：听筒。 |
setAudioCaptureVolume
设置麦克风采集音量。
void setAudioCaptureVolume(int volume)
参数如下表所示：
参数 | 类型 | 含义 |
volume | int | 采集音量，0 - 100， 默认100。 |
setAudioPlayoutVolume
设置播放音量。
void setAudioPlayoutVolume(int volume)
参数如下表所示：
参数 | 类型 | 含义 |
volume | int | 播放音量，0 - 100， 默认100。 |
muteRemoteAudio
静音/解除静音指定成员。
void muteRemoteAudio(String userId, bool mute)
参数如下表所示：
参数 | 类型 | 含义 |
userId | String | 指定的用户 ID。 |
mute | bool | true：开启静音；false：关闭静音。 |
muteAllRemoteAudio
静音/解除静音所有成员。
void muteAllRemoteAudio(bool mute)
参数如下表所示：
参数 | 类型 | 含义 |
mute | bool | true：开启静音；false：关闭静音。 |
背景音乐音效相关接口函数
getAudioEffectManager
TXAudioEffectManager getAudioEffectManager()
消息发送相关接口函数
sendRoomTextMsg
在房间中广播文本消息，一般用于弹幕聊天。
Future<ActionCallback> sendRoomTextMsg(String message)
参数如下表所示：
参数 | 类型 | 含义 |
message | String | 文本消息。 |
申请上麦信令相关接口
raiseHand
听众申请上麦。
void raiseHand()
agreeToSpeak
房主同意上麦。
Future<ActionCallback> agreeToSpeak(String userId)
参数如下表所示：
参数 | 类型 | 含义 |
userId | String | 用户 ID。 |
refuseToSpeak
房主拒绝用户上麦。
Future<ActionCallback> refuseToSpeak(String userId)
参数如下表所示：
参数 | 类型 | 含义 |
userId | String | 用户 ID。 |
TRTCChatSalonDelegate 事件回调
通用事件回调
onError
错误回调。
说明
SDK 不可恢复的错误，一定要监听，并分情况给用户适当的界面提示。
参数如下表所示：
参数 | 类型 | 含义 |
errCode | int | 错误码。 |
errMsg | String | 错误信息。 |
extraInfo | String | 扩展信息字段，个别错误码可能会带额外的信息帮助定位问题。 |
onWarning
警告回调。
参数如下表所示：
参数 | 类型 | 含义 |
warningCode | int | 错误码。 |
warningMsg | String | 警告信息。 |
extraInfo | String | 扩展信息字段，个别错误码可能会带额外的信息帮助定位问题。 |
onKickedOffline
其他用户登录了同一账号，被踢下线。
房间事件回调
onRoomDestroy
房间被销毁的回调。房主解散房间时，房间内的所有用户都会收到此通知。
onAnchorListChange
主播列表发生变化的通知。
参数如下表所示：
参数 | 类型 | 含义 |
userId | String | 用户 ID。 |
mute | bool | 静音状态。 |
onUserVolumeUpdate
启用音量大小提示，会通知每个成员的音量大小。
参数如下表所示：
参数 | 类型 | 含义 |
userId | String | 用户 ID。 |
volume | int | 音量大小，取值：0 - 100。 |
麦位回调
onAnchorEnterMic
有成员上麦。
参数如下表所示：
参数 | 类型 | 含义 |
userId | String | 进房的用户 ID。 |
userName | String | 用户昵称。 |
userAvatar | String | 头像地址。 |
mute | bool | 麦位状态，默认开麦。 |
onAnchorLeaveMic
有成员下麦。
参数如下表所示：
参数 | 类型 | 含义 |
userId | String | 退房的用户 ID。 |
onMicMute
房主是否禁麦。
参数如下表所示：
参数 | 类型 | 含义 |
userId | String | 下麦的用户 ID。 |
mute | bool | 麦位状态。 |
听众进出事件回调
onAudienceEnter
收到听众进房通知。
参数如下表所示：
参数 | 类型 | 含义 |
userId | String | 上麦的用户 ID。 |
userName | String | 用户昵称。 |
userAvatar | String | 头像地址。 |
onAudienceExit
收到听众退房通知。
参数如下表所示：
参数 | 类型 | 含义 |
userId | String | 下麦的用户 ID。 |
消息事件回调
onRecvRoomTextMsg
收到文本消息。
参数如下表所示：
参数 | 类型 | 含义 |
message | String | 文本消息。 |
sendId | String | 发送者用户 ID。 |
userAvatar | String | 发送者用户头像。 |
userName | String | 发送者用户昵称。 |
申请举手信令事件回调
onRaiseHand
收到新的上麦请求。
参数如下表所示：
参数 | 类型 | 含义 |
userId | String | 申请举手的用户 ID。 |
onAgreeToSpeak
房主同意上麦的回调。
参数如下表所示：
参数 | 类型 | 含义 |
userId | String | 房主的用户 ID。 |
onRefuseToSpeak
房主拒绝上麦的回调。
参数如下表所示：
参数 | 类型 | 含义 |
userId | String | 房主的用户 ID。 |
