您可以 下载 安装我们的 App 体验语音沙龙的能力,包括语音聊天、上下麦、低延时语音互动等 TRTC 在语音聊天场景下的相关能力。
房主麦位操作 | 听众麦位操作 |
---|---|
![]() |
![]() |
如需快速接入语音沙龙功能,您可以直接基于我们提供的 App 进行修改适配,也可以使用我们提供的 TUIChatSalon 组件并实现自定义 UI 界面。
TestChatSalon
,单击 创建。注意:本功能同时使用了腾讯云 实时音视频 TRTC 和 即时通信 IM 两个基础 PaaS 服务,开通实时音视频后会同步开通即时通信 IM 服务。 即时通信 IM 属于增值服务,详细计费规则请参见 即时通信 IM 价格说明。
单击进入 TUIChatSalon,Clone 或者下载源码。
进入修改配置页,根据您下载的源码包,选择相应的开发环境。
找到并打开 TUIChatSalon/Debug/GenerateTestUserSig.swift
文件。
设置 GenerateTestUserSig.swift
文件中的相关参数:
粘贴完成后,单击 已复制粘贴,下一步 即创建成功。
编译完成后,单击 回到控制台概览 即可。
注意:
- 本文提到的生成 UserSig 的方案是在客户端代码中配置 SECRETKEY,该方法中 SECRETKEY 很容易被反编译逆向破解,一旦您的密钥泄露,攻击者就可以盗用您的腾讯云流量,因此该方法仅适合本地跑通 App 和功能调试。
- 正确的 UserSig 签发方式是将 UserSig 的计算代码集成到您的服务端,并提供面向 App 的接口,在需要 UserSig 时由您的 App 向业务服务器发起请求获取动态 UserSig。更多详情请参见 服务端生成 UserSig。
使用 Xcode(11.0及以上的版本)打开源码工程 TUIChatSalon/TUIChatSalonApp.xcworkspace
,单击 运行 即可开始调试本 App。
源码中的 Source
文件夹包含两个子文件夹 ui 和 model,ui 文件夹中均为界面代码以及涉及界面相关的逻辑,如下表格列出了各个 swift 文件或文件夹及其所对应的 UI 界面,以便于您进行二次调整:
文件或文件夹 | 功能描述 |
---|---|
TRTCChatSalonEnteryControl.swift | 该文件包含所有 ViewController 的初始化获取方法,您可以通过该实例,快速获取 ViewController 对象。 |
TRTCCreateChatSalonViewController | 创建房间页面逻辑。 |
TRTCChatSalonViewController | 主房间页面,包括房主和听众两种界面。 |
注意:体验应用至少需要两台设备。
输入用户名(请确保用户名唯一性,不能与其他用户重复)并登录。
单击 创建房间。
输入房间主题,单击 开始交谈。
输入用户名(请确保用户名唯一性,不能与其他用户重复)并登录。
输入用户 A 创建的房间号,单击 进入房间。
注意:房间号在用户 A 的房间顶部查看。
源码 中的 Source
文件夹包含两个子文件夹 ui 和 model,model 文件夹中包含可重用的开源组件 TRTCChatSalon,您可以在TRTCChatSalon.h
文件中看到该组件提供的接口函数,并使用对应接口实现自定义 UI 界面。
语音沙龙组件 TRTCChatSalon 依赖 TRTC SDK 和 IM SDK,您可以按照如下步骤将两个 SDK 集成到项目中。
方法一:通过 cocoapods 仓库依赖
pod 'TXIMSDK_iOS'
pod 'TXLiteAVSDK_TRTC'
方法二:通过本地依赖
如果您的开发环境访问 cocoapods 仓库较慢,您可以直接下载 ZIP 包,并按照集成文档手动集成到您的工程中。
SDK | 下载页面 | 集成指引 |
---|---|---|
TRTC SDK | DOWNLOAD | 集成文档 |
IM SDK | DOWNLOAD | 集成文档 |
在 info.plist
文件中需要添加 Privacy > Camera Usage Description
, Privacy > Microphone Usage Description
申请麦克风权限。
通过 cocoapods 导入组件,具体操作如下:
Source
、Resources
、TXAppBasic
文件夹、TUIChatSalon.podspec
文件拷贝到您的工程目录下。Podfile
文件中添加以下依赖。之后执行 pod install
命令,完成导入。pod 'TXAppBasic', :path => "TXAppBasic/"
pod 'TXLiteAVSDK_TRTC'
pod 'TUIChatSalon', :path => "./", :subspecs => ["TRTC"]
sharedInstance
类方法可以创建一个 TRTCChatSalon 的实例对象。setDelegate
方法注册组件的事件回调通知。login
方法完成组件的登录,请参考下表填写关键参数:参数名 | 作用 |
---|---|
sdkAppId | 您可以在 实时音视频控制台 中查看 SDKAppID。 |
userId | 当前用户的 ID,字符串类型,只允许包含英文字母(a-z、A-Z)、数字(0-9)、连词符(-)和下划线(_)。建议结合业务实际账号体系自行设置。 |
userSig | 腾讯云设计的一种安全保护签名,获取方式请参见 如何计算及使用 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) in
guard let `self` = self else { return }
// 您的回调业务逻辑
}
setSelfProfile
设置自己的昵称和头像。createRoom
创建新的语音沙龙,此时传入房间 ID、上麦是否需要房主确认、房间类型等房间属性信息。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) in
guard code == 0 else { reutrn }
// 3.创建房间成功后开始占座
self.chatSalon.enterSeat { [weak self] (code, message) in
guard let `self` = self else { return }
if code == 0 {
// 房主占座成功
} else {
// 房主占座失败
}
}
}
// 4.占座成功后,收到 onAnchorEnterSeat 事件通知
func onAnchorEnterSeat(user: ChatSalonUserInfo) {
}
setSelfProfile
设置自己的昵称和头像。说明:App 中的语音沙龙列表仅做演示使用,语音沙龙列表的业务逻辑千差万别,腾讯云暂不提供语音沙龙列表的管理服务,请自行管理您的语音沙龙列表。
getRoomInfoList
获取房间的详细信息,该信息是在房主端调用 createRoom
创建语音沙龙时设置的简单描述信息。
注意:如果您的语音沙龙列表包含了足够全面的信息,可跳过调用
getRoomInfoList
相关步骤。
enterRoom
并传入房间号即可进入该房间。onRoomInfoChange
房间属性变化事件通知,此时可以记录房间属性并做相应改变,例如 UI 展示房间名、记录上麦是否需要请求房主同意等。onAnchorEnterSeat
的事件通知。// 1.听众设置昵称和头像
self.chatSalon.setSelfProfile(userName: userName, avatarUrl: avatarURL) { (code, message) in
// 结果回调
}
// 2.假定您从业务后台获取房间列表为 roomList
let 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) {
// 处理上麦事件
}
pickSeat
传入听众 userId, 可以抱人上麦,房间内所有成员会收到 onAnchorEnterSeat
的事件通知。kickSeat
传入对应用户的 userId 后,可以踢人下麦,房间内所有成员会收到 onAnchorLeaveSeat
的事件通知。// 1.房主抱人上麦位
self.chatSalon.pickSeat(userID: "123") { (code, message) in
// 2.收到 callback 回调
}
// 3.听众成为主播,进入麦位通知,可以在这里判断听众是不是真的上麦成功
func onAnchorEnterSeat(user: ChatSalonUserInfo) {
// 处理上麦事件
}
如果您的 App 需要对方同意才能进行下一步操作的业务流程,那么邀请信令可以提供相应支持。
sendInvitation
传入房主的 userId 和业务的自定义命令字等,此时函数会返回一个 inviteId,记录该 inviteId。onReceiveNewInvitation
的事件通知,此时 UI 可以弹窗并询问房主是否同意。acceptInvitation
并传入 inviteId。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)
}
}
通过 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" {
// 收到点赞消息
}
}
本页内容是否解决了您的问题?