步骤一:下载并导入 TUIKaraoke 组件
单击进入 Github ,选择克隆/下载代码,然后拷贝 iOS目录下的
Source
、Resources
、TXAppBasic
文件夹和 TUIKaraoke.podspec
文件到您的工程中,并完成如下导入动作:1. 在您的
Podfile
文件内添加导入命令,参考如下:pod 'TUIKaraoke', :path => "./", :subspecs => ["TRTC"]pod 'TXLiteAVSDK_TRTC'pod 'TXAppBasic', :path => "TXAppBasic/"
2. 打开终端,进入 Podfile 文件所在目录下执行安装命令,参考如下:
pod install
步骤二:配置权限
在您的工程的 info.plist文件中配置 App 的权限,SDK 需要以下权限(iOS 系统需要动态申请麦克风):
<key>NSMicrophoneUsageDescription</key><string>Karaoke 需要访问您的麦克风权限</string>
步骤三:初始化并登录
// 1.初始化let karaokeRoom = TRTCKaraokeRoom.shared()karaokeRoom.setDelegate(delegate: self)// 2.登录karaokeRoom.login(SDKAppID: Int32(SDKAppID), UserId: UserId, UserSig: ProfileManager.shared.curUserSig()) { code, message inif code == 0 {//登录成功}}
参数说明:
SDKAppID:TRTC 应用ID,如果您未开通腾讯云 TRTC 服务,可进入 腾讯云实时音视频控制台,创建一个新的 TRTC 应用后,单击应用信息。SDKAppID 信息如下图所示:
Secretkey:TRTC 应用密钥,和 SDKAppId 对应,进入 TRTC 应用管理 后,SecretKey 信息如上图所示。
userId:当前用户的 ID,字符串类型,长度不超过32字节,不支持使用特殊字符,建议使用英文或数字,可结合业务实际账号体系自行设置。
userSig:根据 SDKAppId、userId,Secretkey 等信息计算得到的安全保护签名,您可以单击 这里 直接在线生成一个调试的 UserSig,也可以参照我们的 TUICalling示例工程自行计算,更多信息见 如何计算及使用 UserSig。
步骤四:实现在线KTV场景
1. 主播创建房间 TUIKaraoke.createRoom
int roomId = "房间ID";let param = RoomParam.init()param.roomName = "房间名称";param.needRequest = false; // 上麦是否需要房主确认param.seatCount = 8; // 房间座位数,一共8个座位param.coverUrl = "房间封面图URL";karaokeRoom.createRoom(roomID: Int32(roomInfo.roomID), roomParam: param) { [weak self] (code, message) inguard let `self` = self else { return }if code == 0 {//创建成功}}
2. 听众进入房间 TUIKaraoke.enterRoom
karaokeRoom.enterRoom(roomID: roomInfo.roomID) { [weak self] (code, message) inguard let `self` = self else { return }if code == 0 {//进房成功}}
3. 听众主动上麦 TUIKaraoke.enterSeat
// 1.听众调用上麦int seatIndex = 1;karaokeRoom.enterSeat(seatIndex: seatIndex) { [weak self] (code, message) inguard let `self` = self else { return }if code == 0 {//上麦成功}}// 2.收到 onSeatListChange 回调,刷新麦位列表func onSeatListChange(seatInfoList: [SeatInfo]) {}
说明:
其他关于麦位管理的相关操作,您可参考 TUIKaraoke 接口文档 按需实现,或者可以参考我们的 TUIKaraoke示例工程。
4. 实现音乐播放并体验 KTV 场景
您可以根据自己的业务获取音乐 ID 和 URL 链接,播放歌曲。详情请参见 TUIKaraoke 音乐播放接口。
//播放音乐karaokeRoom.startPlayMusic(musicID: musicID, originalUrl: muscicLocalPath, accompanyUrl: accompanyLocalPath);//停止音乐karaokeRoom.stopPlayMusic();
完成以上步骤,就可以实现 KTV 基本功能。如果您的业务还需要聊天、发送礼物等功能,可以接入以下能力。
步骤五:文字聊天功能(可选)
// 发送端:发送文本消息karaokeRoom.sendRoomTextMsg(message: message) { [weak self] (code, message) inif code == 0 {//发送成功}}// 接收端:监听文本消息karaokeRoom.setDelegate(delegate: self)func onRecvRoomTextMsg(message: String, userInfo: UserInfo) {debugPrint("收到来自:" + userInfo.userName + "的消息:" + message)}
步骤六:礼物发送功能(可选)
如果您需要实现礼物发送和接收功能,可以通过以下方法发送礼物或接收礼物并展示。
// 发送端:通过自定义 "IMCMD_GIFT" 来区分礼物消息karaokeRoom.sendRoomCustomMsg(cmd: kSendGiftCmd, message: message) { code, msg inif (code == 0) {//发送成功}}// 接收端:监听礼物消息karaokeRoom.setDelegate(delegate: self)func onRecvRoomCustomMsg(cmd: String, message: String, userInfo: UserInfo) {if cmd == kSendGiftCmd {debugPrint("收到来自:" + userInfo.userName + "的礼物:" + message)}}