效果展示
您可以 下载 安装我们的 Demo 体验语音聊天室的能力，包括麦位管理、低延时语音互动、文字聊天等 TRTC 在语音聊天场景下的相关能力。
| 主播麦位操作 | 观众麦位操作 |
|---|---|
 |
 |
如需快速接入语音聊天室功能，您可以直接基于我们提供的 Demo 进行修改适配，也可以使用我们提供的 TRTCVoiceRoom 组件并实现自定义 UI 界面。
复用 Demo 的 UI 界面
步骤1：创建新的应用
- 登录实时音视频控制台，选择【开发辅助】>【快速跑通Demo】。
- 输入应用名称，例如
TestVoiceRoom，单击【创建】。
说明：本功能同时使用了腾讯云 实时音视频 TRTC 和 即时通信 IM 两个基础 PAAS 服务，开通实时音视频后会同步开通即时通信 IM 服务。 即时通信 IM 属于增值服务，详细计费规则请参见 即时通信 IM 价格说明。
步骤2：下载 SDK 和 Demo 源码
- 根据实际业务需求下载 SDK 及配套的 Demo 源码。
- 下载完成后，单击【已下载，下一步】。
步骤3：配置 Demo 工程文件
- 进入修改配置页，根据您下载的源码包，选择相应的开发环境。
- 找到并打开
iOS/TRTCScenesDemo/TXLiteAVDemo/Debug/GenerateTestUserSig.h文件。 - 设置
GenerateTestUserSig.h文件中的相关参数：
-SDKAPPID：默认为0，请设置为实际的 SDKAppID。
-SECRETKEY：默认为空字符串，请设置为实际的密钥信息。
- 粘贴完成后，单击【已复制粘贴，下一步】即创建成功。
- 编译完成后，单击【回到控制台概览】即可。
注意：本文提到的生成 UserSig 的方案是在客户端代码中配置 SECRETKEY，该方法中 SECRETKEY 很容易被反编译逆向破解，一旦您的密钥泄露，攻击者就可以盗用您的腾讯云流量，因此该方法仅适合本地跑通 Demo 和功能调试。
正确的 UserSig 签发方式是将 UserSig 的计算代码集成到您的服务端，并提供面向 App 的接口，在需要 UserSig 时由您的 App 向业务服务器发起请求获取动态 UserSig。更多详情请参见 服务端生成 UserSig。
步骤4：运行 Demo
使用 Xcode（11.0及以上的版本）打开源码工程 iOS/TRTCScenesDemo/TXLiteAVDemo.xcworkspace，单击【运行】即可开始调试本 Demo。
步骤5：修改 Demo 源代码
源码中的 TRTCVoiceRoomDemo 文件夹包含两个子文件夹 ui 和 model，ui 文件夹中均为界面代码以及涉及界面相关的逻辑，如下表格列出了各个 swift 文件或文件夹及其所对应的 UI 界面，以便于您进行二次调整：
| 文件或文件夹 | 功能描述 |
|---|---|
| TRTCVoiceRoomEnteryController | 该文件包含所有 ViewController 的初始化获取方法，您可以通过该实例，快速获取 ViewController 对象。 |
| NetworkRoomManager | 业务后台交互相关。 |
| TRTCCreateVoiceRoomViewController | 创建语音聊天室页面逻辑。 |
| TRTCVoiceRoomListViewController | 列表页面逻辑。 |
| TRTCVoiceRoomViewController | 主房间页面，包括主播和观众两种界面。 |
每个TRTC'XXXX'ViewController文件夹下均包含ViewController、RootView和ViewModel，各个文件的作用如下表所示：
| 文件 | 功能描述 |
|---|---|
| ViewController | 页面控制器，负责页面路由工作，以及 RootView 和 ViweModel 的绑定工作。 |
| RootView | 视图，所有的视图布局。 |
| ViewModel | 视图控制器，负责响应视图交互，返回视图响应状态。 |
实现自定义 UI 界面
源码 中的 TRTCVoiceRoomDemo 文件夹包含两个子文件夹 ui 和 model，model 文件夹中包含可重用的开源组件 TRTCVoiceRoom，您可以在TRTCVoiceRoom.swift文件中看到该组件提供的接口函数，并使用对应接口实现自定义 UI 界面。
步骤1：集成 SDK
语音聊天组件 TRTCVoiceRoom 依赖 TRTC SDK 和 IM SDK，您可以按照如下步骤将两个 SDK 集成到项目中。
方法一：通过 cocoapods 仓库依赖
pod 'TXIMSDK_iOS'
pod 'TXLiteAVSDK_TRTC'说明：两个 SDK 产品的最新版本号，可以在 TRTC 和 IM 的 Github 首页获取。
方法二：通过本地依赖
如果您的开发环境访问 cocoapods 仓库较慢，您可以直接下载 ZIP 包，并按照集成文档手动集成到您的工程中。
| SDK | 下载页面 | 集成指引 |
|---|---|---|
| TRTC SDK | DOWNLOAD | 集成文档 |
| IM SDK | DOWNLOAD | 集成文档 |
步骤2：配置权限
在 info.plist 文件中需要添加 Privacy > Camera Usage Description， Privacy > Microphone Usage Description 申请摄像头和麦克风权限。
步骤3：导入 TRTCVoiceRoom 组件
拷贝iOS/TRTCScenesDemo/TXLiteAVDemo/TRTCVoiceRoomDemo/model目录中的所有文件到您的项目中。
步骤4：创建并登录组件
- 调用 TRTCVoiceRoom 的
sharedInstance类方法可以创建一个遵守 TRTCVoiceRoom 协议的实例对象。也可以使用调用shared类方法，获取 TRTCVoiceRoomImp实例对象直接使用，二者在 TRTCVoiceRoom 的接口使用上没有任何区别。 - 调用
setDelegate函数注册组件的事件回调通知。 - 调用
login函数完成组件的登录，请参考下表填写关键参数：参数名 作用 sdkAppId 您可以在 实时音视频控制台 中查看 SDKAppID。 userId 当前用户的 ID，字符串类型，只允许包含英文字母（a-z、A-Z）、数字（0-9）、连词符（-）和下划线（_）。 userSig 腾讯云设计的一种安全保护签名，获取方式请参考 如何计算 UserSig。 callback 登录回调，成功时 code 为0。 // Swift 示例
// 您代码里负责业务逻辑的类
class YourController {
// 计算属性获取单例对象
var voiceRoom: TRTCVoiceRoomImp {
return TRTCVoiceRoomImp.shared()
}
// 其他代码逻辑
......
}
// 设置 voiceroom 代理
self.vocieRoom. setDelegate(delegate: voiceRoomDelegate)
// 调用方式如下,闭包内建议使用 weak self 防止循环引用（下面示例代码省略 weak self 示例）
self.vocieRoom.login(sdkAppId: sdkAppID, userId: userId, userSig: userSig) { [weak self] (code, message) in
guard let `self` = self else { return }
// 您的回调业务逻辑
}
步骤5：主播端开播
- 主播执行 步骤4 登录后，可以调用
setSelfProfile设置自己的昵称和头像。 - 主播调用
createRoom创建新的语音聊天室，此时传入房间 ID、上麦是否需要房主确认、麦位数等房间属性信息。 - 主播创建房间成功后，调用
enterSeat进入座位。 - 主播收到组件的
onSeatListChange麦位表变化事件通知，此时可以将麦位表变化刷新到 UI 界面上。 - 主播还会收到麦位表有成员进入的
onAnchorEnterSeat的事件通知，此时会自动打开麦克风采集。
示例代码：
// 1.主播设置昵称和头像
self.voiceRoom.setSelfProfile(userName: userName, avatarUrl: avatarURL) { (code, message) in
// 结果回调
}
// 2.主播端创建房间
let param = VoiceRoomParam.init()
param.roomName = "房间名称"
param.needRequest = true // 观众上麦是否需要主播同意
param.coverUrl = "封面URL"
param.seatCount = 7 // 房间座位数，这里一共7个座位，房主占了一个后观众剩下6个座位
param.seatInfoList = []
for _ in 0..<param.seatCount {
let seatInfo = VoiceRoomSeatInfo.init()
param.seatInfoList.append(seatInfo)
}
self.voiceRoom.createRoom(roomID: yourRoomID, roomParam: param) { (code, message) in
guard code == 0 else { reutrn }
// 创建房间成功后开始占座
self.voiceRoom.enterSeat(seatIndex: 0) { [weak self] (code, message) in
guard let `self` = self else { return }
if code == 0 {
// 房主占座成功
} else {
// 房主占座失败
}
}
}
// 3.占座成功后，收到 onSeatListChange 事件通知
func onSeatListChange(seatInfoList: [VoiceRoomSeatInfo]) {
// 刷新您的麦位列表
}
// 4. 收到 onAnchorEnterSeat 事件通知
func onAnchorEnterSeat(index: Int, user: VoiceRoomUserInfo) {
// 处理主播上麦事件
}步骤6：观众端观看
- 观众端执行 步骤4 登录后，可以调用
setSelfProfile设置自己的昵称和头像。 - 观众端向业务后台获取最新的语音聊天室房间列表。
说明：
Demo 中的语音聊天室列表仅做演示使用，语音聊天室列表的业务逻辑千差万别，腾讯云暂不提供语音聊天室列表的管理服务，请自行管理您的语音聊天室列表。
- 观众端调用
getRoomInfoList获取房间的详细信息，该信息是在主播端调用createRoom创建语音聊天室时设置的简单描述信息。注意：如果您的语音聊天室列表包含了足够全面的信息，可跳过调用
getRoomInfoList相关步骤。 - 观众选择一个语音聊天室，调用
enterRoom并传入房间号即可进入该房间。 - 进房后会收到组件的
onRoomInfoChange房间属性变化事件通知，此时可以记录房间属性并做相应改变，例如 UI 展示房间名、记录上麦是否需要请求主播同意等。 - 进房后会收到组件的
onSeatListChange麦位表变化事件通知，此时可以将麦位表变化刷新到 UI 界面上。 - 进房后还会收到麦位表有主播进入的
onAnchorEnterSeat的事件通知。
// 1.观众设置昵称和头像
self.voiceRoom.setSelfProfile(userName: userName, avatarUrl: avatarURL) { (code, message) in
// 结果回调
}
// 2.假定您从业务后台获取房间列表为 roomList
let roomList: [Int] = getRoomIDList() // 您获取房间ID列表的函数
// 3.通过调用 getRoomInfoList 获取房间的详细信息
self.voiceRoom.getRoomInfoList(roomIdList: roomIdsInt) { (code, message, roomInfos: [VoiceRoomInfo]) in
// 获取结果，此时可以刷新UI
}
// 4.选择语音聊天室后，传入 roomid 进入房间
self.voiceRoom.enterRoom(roomID: roomInfo.roomID) { (code, message) in
// 进入房间结果回调
if code == 0 {
// 进房成功
}
}
// 5.进房成功后，收到 onRoomInfoChange 事件通知
func onRoomInfoChange(roomInfo: VoiceRoomInfo) {
// 可以更新房间名称等信息
}
// 6.进房成功后，收到 onSeatListChange 事件通知
func onSeatListChange(seatInfoList: [VoiceRoomSeatInfo]) {
// 刷新麦位列表
}
// 7. 收到 onAnchorEnterSeat 事件通知
func onAnchorEnterSeat(index: Int, user: VoiceRoomUserInfo) {
// 处理上麦事件
}步骤7：麦位管理
- 主播端
- 观众端
pickSeat传入对应的麦位和观众 userId, 可以抱人上麦，房间内所有成员会收到onSeatListChange和onAnchorEnterSeat的事件通知。kickSeat传入对应麦位后，可以踢人下麦，房间内所有成员会收到onSeatListChange和onAnchorLeaveSeat的事件通知。muteSeat传入对应麦位后，可以静音/解除静音，房间内所有成员会收到onSeatListChange和onSeatMute的事件通知。closeSeat传入对应麦位后，可以封禁/解禁某个麦位，封禁后观众端将不能再上麦，房间内所有成员会收到onSeatListChange和onSeatClose的事件通知。
步骤8：邀请信令的使用
在 麦位管理 中，观众上下麦、主播抱人上麦都不需要经过对方的同意就可以直接操作。
如果您的 App 需要对方同意才能进行下一步操作的业务流程，那么邀请信令可以提供相应支持。
- 观众主动申请上麦
- 主播邀请观众上麦
- 观众端调用
sendInvitation传入主播的 userId 和业务的自定义命令字等，此时函数会返回一个 inviteId，记录该 inviteId。 - 主播端收到
onReceiveNewInvitation的事件通知，此时 UI 可以弹窗并询问主播是否同意。 - 主播选择同意后，调用
acceptInvitation并传入 inviteId。 - 观众端收到
onInviteeAccepted的事件通知，调用enterSeat进行上麦。
// 观众端视角
// 1.调用 sendInvitation，请求上1号麦位
let inviteId = self.voiceRoom.sendInvitation(cmd: "ENTER_SEAT", userId: ownerUserId, content: "1") { (code, message) in
// 发送结果回调
}
// 4.收到邀请的同意请求, 正式上麦
func onInviteeAccepted(identifier: String, invitee: String) {
if identifier == selfID {
self.voiceRoom.enterSeat(seatIndex: ) { (code, message) in
// 上麦结果回调
}
}
}
// 主播端视角
// 2.主播收到请求
func onReceiveNewInvitation(identifier: String, inviter: String, cmd: String, content: String) {
if cmd == "ENTER_SEAT" {
// 3.主播同意观众请求
self.voiceRoom.acceptInvitation(identifier: identifier, callback: nil)
}
}
步骤9：实现文字聊天和弹幕消息
- 通过
sendRoomTextMsg可以发送普通的文本消息，所有在该房间内的主播和观众均可以收到onRecvRoomTextMsg回调。
即时通信 IM 后台有默认的敏感词过滤规则，被判定为敏感词的文本消息不会被云端转发。
// 发送端：发送文本消息
self.voiceRoom.sendRoomTextMsg(message: message) { (code, message) in
}
// 接收端：监听文本消息
func onRecvRoomTextMsg(message: String, userInfo: VoiceRoomUserInfo) {
//收到的message信息处理方法
}- 通过
sendRoomCustomMsg可以发送自定义（信令）的消息，所有在该房间内的主播和观众均可以收到onRecvRoomCustomMsg回调。
自定义消息常用于传输自定义信令，例如用于点赞消息的发送和广播。// 例如：发送端：您可以通过自定义Cmd来区分弹幕和点赞消息 // eg:"CMD_DANMU"表示弹幕消息，"CMD_LIKE"表示点赞消息 self.vocieRoom.sendRoomCustomMsg(cmd: “CMD_DANMU”, message: "hello world", callback: nil) self.voiceRoom.sendRoomCustomMsg(cmd: "CMD_LIKE", message: "", callback: nil) // 接收端：监听自定义消息 func onRecvRoomCustomMsg(cmd: String, message: String, userInfo: VoiceRoomUserInfo) { if cmd == "CMD_DANMU" { // 收到弹幕消息 } if cmd == "CMD_LIKE" { // 收到点赞消息 } }
相关文章
精彩导读
热门资讯