效果展示
房主麦位操作 | 听众麦位操作 |
| |
如需快速接入语音沙龙功能,您可以直接基于我们提供的 App 进行修改适配,也可以使用我们提供的 TUIChatSalon 组件并实现自定义 UI 界面。
复用 App 的 UI 界面
步骤1:创建新的应用
1. 登录实时音视频控制台,选择 开发辅助 > 快速跑通Demo。
2. 输入应用名称,例如
TestChatSalon
,单击 创建。3. 单击 已下载,下一步,跳过此步骤。
注意
本功能同时使用了腾讯云 实时音视频 TRTC 和 即时通信 IM 两个基础 PaaS 服务,开通实时音视频后会同步开通即时通信 IM 服务。 即时通信 IM 属于增值服务,详细计费规则请参见 即时通信 IM 价格说明。
步骤2:下载 App 源码
步骤3:配置 App 工程文件
1. 进入修改配置页,根据您下载的源码包,选择相应的开发环境。
2. 找到并打开
TUIChatSalon/Debug/GenerateTestUserSig.swift
文件。3. 设置
GenerateTestUserSig.swift
文件中的相关参数:SDKAPPID:默认为0,请设置为实际的 SDKAppID。
SECRETKEY:默认为空字符串,请设置为实际的密钥信息。
4. 粘贴完成后,单击 已复制粘贴,下一步 即创建成功。
5. 编译完成后,单击 回到控制台概览 即可。
注意
本文提到的生成 UserSig 的方案是在客户端代码中配置 SECRETKEY,该方法中 SECRETKEY 很容易被反编译逆向破解,一旦您的密钥泄露,攻击者就可以盗用您的腾讯云流量,因此该方法仅适合本地跑通 App 和功能调试。
正确的 UserSig 签发方式是将 UserSig 的计算代码集成到您的服务端,并提供面向 App 的接口,在需要 UserSig 时由您的 App 向业务服务器发起请求获取动态 UserSig。更多详情请参见 服务端生成 UserSig。
步骤4:运行 App
使用 Xcode(11.0及以上的版本)打开源码工程
TUIChatSalon/TUIChatSalonApp.xcworkspace
,单击 运行 即可开始调试本 App。步骤5:修改 App 源代码
源码中的
Source
文件夹包含两个子文件夹 ui 和 model,ui 文件夹中均为界面代码以及涉及界面相关的逻辑,如下表格列出了各个 swift 文件或文件夹及其所对应的 UI 界面,以便于您进行二次调整:文件或文件夹 | 功能描述 |
TRTCChatSalonEnteryControl.swift | 该文件包含所有 ViewController 的初始化获取方法,您可以通过该实例,快速获取 ViewController 对象。 |
TRTCCreateChatSalonViewController | 创建房间页面逻辑。 |
TRTCChatSalonViewController | 主房间页面,包括房主和听众两种界面。 |
体验应用
注意
体验应用至少需要两台设备。
用户 A
1. 输入用户名(请确保用户名唯一性,不能与其他用户重复)并登录,如图示:
2. 单击 创建房间,如下图示:
3. 输入房间主题,单击 开始交谈。
用户 B
1. 输入用户名(请确保用户名唯一性,不能与其他用户重复)并登录,如图示:
2. 输入用户 A 创建的房间号,单击 进入房间。
注意
房间号在用户 A 的房间顶部查看,如下图示:
实现自定义 UI 界面
源码 中的
Source
文件夹包含两个子文件夹 ui 和 model,model 文件夹中包含可重用的开源组件 TRTCChatSalon,您可以在TRTCChatSalon.h
文件中看到该组件提供的接口函数,并使用对应接口实现自定义 UI 界面。
步骤1:配置权限
需要授权麦克风和摄像头的使用权限。在 App 的 Info.plist 中添加以下两项,分别对应麦克风和摄像头在系统弹出授权对话框时的提示信息。
Privacy - Microphone Usage Description,并填入麦克风使用目的提示语。
Privacy - Camera Usage Description,并填入摄像头使用目的提示语。
步骤2:导入 TUIChatSalon 组件
通过 cocoapods 导入组件,具体操作如下:
1. 将工程目录下的
Source
、Resources
、TXAppBasic
文件夹、TUIChatSalon.podspec
文件拷贝到您的工程目录下。2. 在您的
Podfile
文件中添加以下依赖。之后执行 pod install
命令,完成导入。# :path => "指向TXAppBasic.podspec所在目录的相对路径"pod 'TXAppBasic', :path => "TXAppBasic/"# :path => "指向TUIChatSalon.podspec所在目录的相对路径"pod 'TUIChatSalon', :path => "./", :subspecs => ["TRTC"]
注意
Source
、Resources
文件夹 和 TUIChatSalon.podspec
文件必需在同一目录下。TXAppBasic.podspec 在TXAppBasic文件夹下。
步骤3:创建并登录组件
1. 调用 TRTCChatSalon 的
sharedInstance
类方法可以创建一个 TRTCChatSalon 的实例对象。2. 调用
setDelegate
方法注册组件的事件回调通知。3. 调用
login
方法完成组件的登录,请参考下表填写关键参数:参数名 | 作用 |
sdkAppId | |
userId | 当前用户的 ID,字符串类型,只允许包含英文字母(a-z、A-Z)、数字(0-9)、连词符(-)和下划线(_)。建议结合业务实际账号体系自行设置。 |
userSig | |
callback | 登录回调,成功时 code 为0。 |
// Swift 示例// 您代码里负责业务逻辑的类class YourController {// 计算属性获取单例对象var chatSalon: TRTCChatSalon {return TRTCChatSalon.shared()}// 其他代码逻辑......}// 设置 chatSalon 代理self.chatSalon.setDelegate(delegate: self)// 调用方式如下,闭包内建议使用 weak self 防止循环引用(下面示例代码省略 weak self 示例)self.chatSalon.login(sdkAppID: sdkAppID, userID: userId, userSig: userSig) { [weak self] (code, message) inguard let `self` = self else { return }// 您的回调业务逻辑}
步骤4:房主端开播
1. 房主执行 步骤4 登录后,可以调用
setSelfProfile
设置自己的昵称和头像。2. 房主调用
createRoom
创建新的语音沙龙,此时传入房间 ID、上麦是否需要房主确认、房间类型等房间属性信息。3. 房主会收到有成员进入的
onAnchorEnterSeat
的事件通知,此时会自动打开麦克风采集。
// 1.房主设置昵称和头像self.chatSalon.setSelfProfile(userName: userName, avatarUrl: avatarURL) { (code, message) in// 结果回调}// 2.房主端创建房间let param = ChatSalonParam.init()param.roomName = "房间名称"param.needRequest = true // 听众上麦是否需要房主同意param.coverUrl = "封面URL"param.seatInfoList = []self.chatSalon.createRoom(roomID: yourRoomID, roomParam: param) { (code, message) inguard code == 0 else { reutrn }// 3.创建房间成功后开始占座self.chatSalon.enterSeat { [weak self] (code, message) inguard let `self` = self else { return }if code == 0 {// 房主占座成功} else {// 房主占座失败}}}// 4.占座成功后,收到 onAnchorEnterSeat 事件通知func onAnchorEnterSeat(user: ChatSalonUserInfo) {}
步骤5:听众端观看
1. 听众端执行 步骤4 登录后,可以调用
setSelfProfile
设置自己的昵称和头像。2. 听众端向业务后台获取最新的语音沙龙房间列表。
说明
App 中的语音沙龙列表仅做演示使用,语音沙龙列表的业务逻辑千差万别,腾讯云暂不提供语音沙龙列表的管理服务,请自行管理您的语音沙龙列表。
3. 听众端调用
getRoomInfoList
获取房间的详细信息,该信息是在房主端调用 createRoom
创建语音沙龙时设置的简单描述信息。注意
如果您的语音沙龙列表包含了足够全面的信息,可跳过调用
getRoomInfoList
相关步骤。4. 听众选择一个语音沙龙,调用
enterRoom
并传入房间号即可进入该房间。5. 进房后会收到组件的
onRoomInfoChange
房间属性变化事件通知,此时可以记录房间属性并做相应改变,例如 UI 展示房间名、记录上麦是否需要请求房主同意等。6. 进房后还会收到麦位表有主播进入的
onAnchorEnterSeat
的事件通知。
// 1.听众设置昵称和头像self.chatSalon.setSelfProfile(userName: userName, avatarUrl: avatarURL) { (code, message) in// 结果回调}// 2.假定您从业务后台获取房间列表为 roomListlet roomList: [Int] = getRoomIDList() // 您获取房间ID列表的函数// 3.通过调用 getRoomInfoList 获取房间的详细信息self.chatSalon.getRoomInfoList(roomIdList: roomIdsInt) { (code, message, roomInfos: [ChatSalonInfo]) in// 获取结果,此时可以刷新UI}// 4.传入 roomId 进入房间self.chatSalon.enterRoom(roomID: roomInfo.roomID) { (code, message) in// 进入房间结果回调if code == 0 {// 进房成功}}// 5.进房成功后,收到 onRoomInfoChange 事件通知func onRoomInfoChange(roomInfo: ChatSalonInfo) {// 可以更新房间名称等信息}// 6.收到 onAnchorEnterSeat 事件通知func onAnchorEnterSeat(user: ChatSalonUserInfo) {// 处理上麦事件}
步骤6:上下麦
1.
pickSeat
传入听众 userId, 可以抱人上麦,房间内所有成员会收到 onAnchorEnterSeat
的事件通知。2.
kickSeat
传入对应用户的 userId 后,可以踢人下麦,房间内所有成员会收到 onAnchorLeaveSeat
的事件通知。
麦位操作后的事件通知顺序如下:callback > onAnchorEnterSeat 等独立事件。
// 1.房主抱人上麦位self.chatSalon.pickSeat(userID: "123") { (code, message) in// 2.收到 callback 回调}// 3.听众成为主播,进入麦位通知,可以在这里判断听众是不是真的上麦成功func onAnchorEnterSeat(user: ChatSalonUserInfo) {// 处理上麦事件}
1.
enterSeat
可以进行上麦,房间内所有成员会收到 onAnchorEnterSeat
的事件通知。2.
leaveSeat
主动下麦,房间内所有成员会收到 onAnchorLeaveSeat
的事件通知。
麦位操作后的事件通知顺序如下:callback > onAnchorEnterSeat 等独立事件。// 1.听众主动上麦self.chatSalon.enterSeat { (code, message) in// 2.收到 callback 回调}// 3.听众成为主播,进入麦位通知,可以在这里判断是不是自己并进行相应处理func onAnchorEnterSeat(user: ChatSalonUserInfo) {// 处理上麦事件}
步骤7:邀请信令的使用
如果您的 App 需要对方同意才能进行下一步操作的业务流程,那么邀请信令可以提供相应支持。
1. 听众端调用
sendInvitation
传入房主的 userId 和业务的自定义命令字等,此时函数会返回一个 inviteId,记录该 inviteId。2. 房主端收到
onReceiveNewInvitation
的事件通知,此时 UI 可以弹窗并询问房主是否同意。3. 房主选择同意后,调用
acceptInvitation
并传入 inviteId。4. 听众端收到
onInviteeAccepted
的事件通知,调用enterSeat
进行上麦。
// 听众端视角// 1.调用 sendInvitation,请求上麦let inviteId = self.chatSalon.sendInvitation(cmd: "ENTER_SEAT", userID: ownerUserId, content: "1") { (code, message) in// 发送结果回调}// 2.收到邀请的同意请求, 正式上麦func onInviteeAccepted(identifier: String, invitee: String) {if identifier == selfID {self.chatSalon.enterSeat { (code, message) in// 上麦结果回调}}}// 房主端视角// 1.房主收到请求func onReceiveNewInvitation(identifier: String, inviter: String, cmd: String, content: String) {if cmd == "ENTER_SEAT" {// 2.房主同意听众请求self.chatSalon.acceptInvitation(identifier: identifier, callback: nil)}}
1. 房主端调用
sendInvitation
传入听众的 userId 和业务的自定义命令字等,此时函数会返回一个 inviteId,记录该 inviteId。2. 听众端收到
onReceiveNewInvitation
的事件通知,此时 UI 可以弹窗并询问听众是否同意上麦。3. 听众选择同意后,调用
acceptInvitation
并传入 inviteId。4. 房主端收到
onInviteeAccepted
的事件通知,调用 pickSeat
抱听众上麦。
// 房主端视角// 1.房主调用 sendInvitation,请求抱听众“123”上麦let inviteId = self.chatSalon.sendInvitation(cmd: "PICK_SEAT", userID: ownerUserId, content: "2") { (code, message) in// 发送结果回调}// 2.收到邀请的同意请求, 正式上麦func onInviteeAccepted(identifier: String, invitee: String) {if identifier == selfID {self.chatSalon.pickSeat(userID: ) { (code, message) in// 上麦结果回调}}}// 听众端视角// 1.听众收到请求func onReceiveNewInvitation(identifier: String, inviter: String, cmd: String, content: String) {if cmd == "PICK_SEAT" {// 2.听众同意房主请求self.chatSalon.acceptInvitation(identifier: identifier, callback: nil)}}
步骤8:实现文字聊天和弹幕消息
通过
sendRoomTextMsg
可以发送普通的文本消息,所有在该房间内的主播和听众均可以收到 onRecvRoomTextMsg
回调。
即时通信 IM 后台有默认的敏感词过滤规则,被判定为敏感词的文本消息不会被云端转发。// 发送端:发送文本消息self.chatSalon.sendRoomTextMsg(message: message) { (code, message) in}// 接收端:监听文本消息func onRecvRoomTextMsg(message: String, userInfo: ChatSalonUserInfo) {//收到的message信息处理方法}
通过
sendRoomCustomMsg
可以发送自定义(信令)的消息,所有在该房间内的主播和听众均可以收到 onRecvRoomCustomMsg
回调。
自定义消息常用于传输自定义信令,例如用于点赞消息的发送和广播。// 例如:发送端:您可以通过自定义Cmd来区分弹幕和点赞消息// eg:"CMD_DANMU"表示弹幕消息,"CMD_LIKE"表示点赞消息self.chatSalon.sendRoomCustomMsg(cmd: “CMD_DANMU”, message: "hello world", callback: nil)self.chatSalon.sendRoomCustomMsg(cmd: "CMD_LIKE", message: "", callback: nil)// 接收端:监听自定义消息func onRecvRoomCustomMsg(cmd: String, message: String, userInfo: ChatSalonUserInfo) {if cmd == "CMD_DANMU" {// 收到弹幕消息}if cmd == "CMD_LIKE" {// 收到点赞消息}}