前言:
多人语音是音视频通话的常见应用场景之一,TRTC对着这方面的支持必不可少,本次我们学习如何使用TRTC快速开发语音聊天室功能。
第一步:集成SDK
音视频通话组件 TRTCCalling 依赖 TRTC SDK 和 IM SDK,可以参考官方提供的集成指引,完成集成 TRTC集成文档 和 IM集成文档
DEMO主要文件
文件或文件夹 | 功能描述 |
---|---|
base | UI 使用的基础类。 |
list | 列表页和创建房间页。 |
room | 主房间页面,包括主播和观众两种界面。 |
widget | 通用控件。 |
第二步:配置对应权限和混淆规则
<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.WRITE_EXTERNAL_STORAGE" />
<uses-permission android:name="android.permission.READ_EXTERNAL_STORAGE" />
<uses-permission android:name="android.permission.RECORD_AUDIO" />
<uses-permission android:name="android.permission.MODIFY_AUDIO_SETTINGS" />
<uses-permission android:name="android.permission.BLUETOOTH" />
<uses-permission android:name="android.permission.CAMERA" />
<uses-permission android:name="android.permission.READ_PHONE_STATE" />
<uses-feature android:name="android.hardware.camera"/>
<uses-feature android:name="android.hardware.camera.autofocus" />
在 proguard-rules.pro 文件,将 SDK 相关类加入不混淆名单:
-keep class com.tencent.** { *; }
第三步:在GenerateTestUserSig.java中配置SDKID和SECRETKEY
SDKAPPID:在音视频控制台中对应创建的应用的ID
SECRETKEY:音视频控制台对应的计算密钥,点击查看密钥获得
第四步:创建并登陆组件
1:初始化实例TRTCVoiceRoom.sharedInstance(context:Context)
2:调用setDelegate函数注册组件回调通知
3:调用login登陆组件
RTCVoiceRoom mTRTCVoiceRoom = TRTCVoiceRoom.sharedInstance(this);
mTRTCVoiceRoom.setDelegate(this);
mTRTCVoiceRoom.login(SDKAPPID, userId, userSig, new TRTCVoiceRoomCallback.ActionCallback() {
@Override
public void onCallback(int code, String msg) {
if (code == 0) {
//登录成功
}
}
});
第五步:主播建房
- 主播登录后,可以调用setProfile设置自己的昵称和头像。
- 主播调用createRoom创建新的语音聊天室,此时传入房间 ID、上麦是否需要房主确认、麦位数等房间属性信息。
- 主播创建房间成功后,调用enterSeat进入座位。
- 主播收到组件的onSeatListChange麦位表变化事件通知,此时可以将麦位表变化刷新到 UI 界面上。
- 主播还会收到麦位表有成员进入的onAnchorEnterSeat的事件通知,此时会自动打开麦克风采集。
// 1.主播设置昵称和头像
mTRTCVoiceRoom.setSelfProfile("my_name", "my_face_url", null);
// 2.主播调用 createRoom 创建房间
final TRTCVoiceRoomDef.RoomParam roomParam = new TRTCVoiceRoomDef.RoomParam();
roomParam.roomName = "房间名称";
roomParam.needRequest = false; // 上麦是否需要房主确认
roomParam.seatCount = 7; // 房间座位数,这里一共7个座位,房主占了一个后观众剩下6个座位
roomParam.coverUrl = "房间封面图的 URL 地址";
mTRTCVoiceRoom.createRoom(mRoomId, roomParam, new TRTCVoiceRoomCallback.ActionCallback() {
@Override
public void onCallback(int code, String msg) {
if (code == 0) {
//3. 占0号座位
mTRTCVoiceRoom.enterSeat(0, new TRTCVoiceRoomCallback.ActionCallback() {
@Override
public void onCallback(int code, String msg) {
if (code == 0) {
}
}
});
}
}
});
// 4.占座成功后,收到 onSeatListChange 事件通知
@Override
public void onSeatListChange(final List<TRTCVoiceRoomDef.SeatInfo> seatInfoList) {
// 展示您的麦位列表
}
// 5. 收到 onAnchorEnterSeat 事件通知
@Override
public void onAnchorEnterSeat(TRTCVoiceRoomDef.UserInfo userInfo) {
}
第六步:观众进房
- 观众端登录后,可以调用setSelProfile设置自己的昵称和头像。
- 观众端向业务后台获取最新的语音聊天室房间列表。
- 观众端调用getRoomInfoList获取房间的详细信息,该信息是在主播端调用creatRoom创建语音聊天室时设置的简单描述信息。
- 观众选择一个语音聊天室,调用enterRoom并传入房间号即可进入该房间。
- 进房后会收到组件的onRoomInfoChange房间属性变化事件通知,此时可以记录房间属性并做相应改变,例如 UI 展示房间名、记录上麦是否需要请求主播同意等。
- 进房后会收到组件的onSeatListChange麦位表变化事件通知,此时可以将麦位表变化刷新到 UI 界面上。
- 进房后还会收到麦位表有主播进入的onAnchorEnterSeat的事件通知。
// 1.观众设置昵称和头像
mTRTCVoiceRoom.setSelfProfile("my_name", "my_face_url", null);
// 2.假定您从业务后台获取房间列表为 roomList
List<Integer> roomList = GetRoomList();
// 3.通过调用 getRoomInfoList 获取房间的详细信息
mTRTCVoiceRoom.getRoomInfoList(roomList, new TRTCVoiceRoomCallback.RoomInfoCallback() {
@Override
public void onCallback(int code, String msg, List<TRTCVoiceRoomDef.RoomInfo> list) {
if (code == 0) {
// 此时可以刷新您自己的 UI 房间列表
}
}
});
// 4.选择语音聊天室后,传入 roomid 进入房间
mTRTCVoiceRoom.enterRoom(roomId, new TRTCVoiceRoomCallback.ActionCallback() {
@Override
public void onCallback(int code, String msg) {
if (code == 0) {
//进房成功
}
}
});
// 5.进房成功后,收到 onRoomInfoChange 事件通知
@Override
public void onRoomInfoChange(TRTCVoiceRoomDef.RoomInfo roomInfo) {
mNeedRequest = roomInfo.needRequest;
mRoomName = roomInfo.roomName;
// UI 可以展示标题等
}
// 6.进房成功后,收到 onSeatListChange 事件通知
@Override
public void onSeatListChange(final List<TRTCVoiceRoomDef.SeatInfo> seatInfoList) {
// 展示您的麦位列表
}
// 7. 收到 onAnchorEnterSeat 事件通知
@Override
public void onAnchorEnterSeat(TRTCVoiceRoomDef.UserInfo userInfo) {
}
第七步:麦序管理
主播端:
- pickSeat传入对应的麦位和观众 userId, 可以抱人上麦,房间内所有成员会收到onSeatListChange和onAnchorEnterSeat的事件通知。
- kickSeat传入对应麦位后,可以踢人下麦,房间内所有成员会收到onSeatListChange和onAnchorLeaveSeat的事件通知。
- muteSeat传入对应麦位后,可以静音/解除静音,房间内所有成员会收到 onSeatListChange 和 onSeatMute 的事件通知。
- closeSeat传入对应麦位后,可以封禁/解禁某个麦位,封禁后观众端将不能再上麦,房间内所有成员会收到onSeatListChange和onSeatClose的事件通知。
观众端:
- enterSeat传入对应的麦位后,可以进行上麦,房间内所有成员会收到onSeatListChange和onAnchorEnterSeat的事件通知。
- leaveSeat主动下麦,房间内所有成员会收到onSeatListChange和onAnchorLeaveSeat的事件通知。
麦位操作后的事件通知顺序如下:
callback > onSeatListChange > onAnchorEnterSeat 等独立事件
// case1: 主播抱人上1号麦位
mTRTCVoiceRoom.pickSeat(1, "123", new TRTCVoiceRoomCallback.ActionCallback() {
@Override
public void onCallback(int code, String msg) {
// 2.收到 callback 回调
if (code == 0) {
}
}
});
// 3.收到 onSeatListChange 回调,刷新您的麦位列表
@Override
public void onSeatListChange(final List<TRTCVoiceRoomDef.SeatInfo> seatInfoList) {
}
// 4.单个麦位变化的通知,可以在这里判断观众是不是真的上麦成功
public void onAnchorEnterSeat(int index, TRTCVoiceRoomDef.UserInfo user) {
}
// case2: 观众主动上2号麦位
mTRTCVoiceRoom.enterSeat(2, new TRTCVoiceRoomCallback.ActionCallback() {
@Override
public void onCallback(int code, String msg) {
// 2.收到 callback 回调
if (code == 0) {
}
}
});
// 3.收到 onSeatListChange 回调,刷新您的麦位列表
@Override
public void onSeatListChange(final List<TRTCVoiceRoomDef.SeatInfo> seatInfoList) {
}
// 4.单个麦位变化的通知,可以在这里判断是不是自己并进行相应处理
public void onAnchorEnterSeat(int index, TRTCVoiceRoomDef.UserInfo user) {
}
第八步:邀请信令的使用
在 麦位管理 中,观众上下麦、主播抱人上麦都不需要经过对方的同意就可以直接操作。
如果您的 App 需要对方同意才能进行下一步操作的业务流程,那么邀请信令可以提供相应支持。
如果您的观众上麦需要申请:
- 观众端调用sendInvitation传入主播的 userId 和业务的自定义命令字等,此时函数会返回一个 inviteId,记录该 inviteId。
- 主播端收到onReceiveNewInvitation的事件通知,此时 UI 可以弹窗并询问主播是否同意。
- 主播选择同意后,调用acceptInvitation并传入 inviteId。
- 观众端收到onInviteeAccepted的事件通知,调用enterSeat进行上麦。
// 观众端视角
// 1.调用 sendInvitation,请求上1号麦位
String inviteId = mTRTCVoiceRoom.sendInvitation("ENTER_SEAT", ownerUserId, "1", null);
// 4.收到邀请的同意请求, 正式上麦
@Override
public void onInviteeAccepted(String id, String invitee) {
if(id.equals(inviteId)) {
mTRTCVoiceRoom.enterSeat(1, null);
}
}
// 主播端视角
// 2.主播收到请求
@Override
public void onReceiveNewInvitation(final String id, String inviter, String cmd, final String content) {
if (cmd.equals("ENTER_SEAT")) {
// 3.主播同意观众请求
mTRTCVoiceRoom.acceptInvitation(id, null);
}
}
如果您的主播需要发送邀请才能抱观众上麦:
- 主播端调用sendInvitation传入观众的 userId 和业务的自定义命令字等,此时函数会返回一个 inviteId,记录该 inviteId。
- 观众端收到onReceiveNewInvitation的事件通知,此时 UI 可以弹窗并询问观众是否同意上麦。
- 观众选择同意后,调用acceptInvitation并传入 inviteId。
- 主播端收到onInviteeAccepted的事件通知,调用pickSeat抱观众上麦。
// 主播端视角
// 1.主播调用 sendInvitation,请求抱观众123上2号麦
String inviteId = mTRTCVoiceRoom.sendInvitation("PICK_SEAT", "123", "2", null);
// 4.收到邀请的同意请求, 正式上麦
@Override
public void onInviteeAccepted(String id, String invitee) {
if(id.equals(inviteId)) {
mTRTCVoiceRoom.pickSeat(2, null);
}
}
// 观众端视角
// 2.观众收到请求
@Override
public void onReceiveNewInvitation(final String id, String inviter, String cmd, final String content) {
if (cmd.equals("PICK_SEAT")) {
// 3.观众同意主播请求
mTRTCVoiceRoom.acceptInvitation(id, null);
}
}
步骤9:实现文字聊天和弹幕消息
- 通过sendRoomTextMsg可以发送普通的文本消息,所有在该房间内的主播和观众均可以收到onRecvRoomTextMsg回调。
即时通信 IM 后台有默认的敏感词过滤规则,被判定为敏感词的文本消息不会被云端转发。
// 发送端:发送文本消息
mTRTCVoiceRoom.sendRoomTextMsg("Hello Word!", null);
// 接收端:监听文本消息
mTRTCVoiceRoom.setDelegate(new TRTCVoiceRoomDelegate() {
@Override
public void onRecvRoomTextMsg(String message, TRTCVoiceRoomDef.UserInfo userInfo) {
Log.d(TAG, "收到来自" + userInfo.userName + "的消息:" + message);
}
});
- 通过sendRoomCustomMsg可以发送自定义(信令)的消息,所有在该房间内的主播和观众均可以收到onRecvRoomCustomMsg回调。
自定义消息常用于传输自定义信令,例如用于点赞消息的发送和广播。
// 发送端:您可以通过自定义 Cmd 来区分弹幕和点赞消息
// eg:"CMD_DANMU"表示弹幕消息,"CMD_LIKE"表示点赞消息
mTRTCVoiceRoom.sendRoomCustomMsg("CMD_DANMU", "Hello world", null);
mTRTCVoiceRoom.sendRoomCustomMsg("CMD_LIKE", "", null);
// 接收端:监听自定义消息
mTRTCVoiceRoom.setDelegate(new TRTCVoiceRoomDelegate() {
@Override
public void onRecvRoomCustomMsg(String cmd, String message, TRTCVoiceRoomDef.UserInfo userInfo) {
if ("CMD_DANMU".equals(cmd)) {
// 收到弹幕消息
Log.d(TAG, "收到来自" + userInfo.userName + "的弹幕消息:" + message);
} else if ("CMD_LIKE".equals(cmd)) {
// 收到点赞消息
Log.d(TAG, userInfo.userName + "给您点了个赞!");
}
}
});