tencent cloud

文档反馈

集成 TUIKaraoke (iOS)

最后更新时间:2022-09-06 14:50:47

    组件介绍

    TUIKaraoke 是一个开源的音视频 UI 组件,通过在项目中集成 TUIKaraoke 组件,您只需要编写几行代码就可以为您的应用添加在线 K 歌场景,体验 K 歌、麦位管理、收发礼物、文字聊天等 TRTC 在 KTV 场景下的相关能力。TUIKaraoke 同时支持 Android 平台的源代码,基本功能如下图所示:

    说明:

    TUIKit 系列组件同时使用了腾讯云 实时音视频 TRTC即时通信 IM 两个基础 PaaS 服务,开通实时音视频后会同步开通即时通信IM服务。即时通信 IM 服务详细计费规则请参见 即时通信 - 价格说明,TRTC 开通会默认关联开通 IM SDK 的体验版,仅支持100个 DAU。

    组件集成

    步骤一:下载并导入 TUIKaraoke 组件

    单击进入 Github ,选择克隆/下载代码,然后拷贝 iOS目录下的 SourceResourcesTXAppBasic文件夹和 TUIKaraoke.podspec文件到您的工程中,并完成如下导入动作:

    • 在您的 Podfile 文件内添加导入命令,参考如下:

      pod 'TUIKaraoke', :path => "./", :subspecs => ["TRTC"]
      pod 'TXLiteAVSDK_TRTC'
      pod 'TXAppBasic', :path => "TXAppBasic/"
      
    • 打开终端,进入 Podfile 文件所在目录下执行安装命令,参考如下:

      pod install
      

    步骤二:配置权限

    在您的工程的 info.plist文件中配置 App 的权限,SDK 需要以下权限(iOS 系统需要动态申请麦克风):

    <key>NSMicrophoneUsageDescription</key>
       <string>Karaoke 需要访问您的麦克风权限</string>
    

    步骤三:初始化并登录

    相关接口说明请参见 TUIKaraoke

     // 1.初始化
     let karaokeRoom = TRTCKaraokeRoom.shared()
     karaokeRoom.setDelegate(delegate: self)
     // 2.登录
     karaokeRoom.login(SDKAppID: Int32(SDKAppID), UserId: UserId, UserSig: ProfileManager.shared.curUserSig()) { code, message in
        if code == 0 {
            //登录成功
        }
     }
    

    参数说明

    • SDKAppIDTRTC 应用ID,如果您未开通腾讯云 TRTC 服务,可进入 腾讯云实时音视频控制台,创建一个新的 TRTC 应用后,单击应用信息,SDKAppID 信息如下图所示:
    • SecretkeyTRTC 应用密钥,和 SDKAppId 对应,进入 TRTC 应用管理 后,SecretKey 信息如上图所示。
    • userId:当前用户的 ID,字符串类型,长度不超过32字节,不支持使用特殊字符,建议使用英文或数字,可结合业务实际账号体系自行设置。
    • userSig:根据 SDKAppId、userId,Secretkey 等信息计算得到的安全保护签名,您可以单击 这里 直接在线生成一个调试的 UserSig,更多信息见 如何计算及使用 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) in
      guard let `self` = self else { return }
      if code == 0 {
          //创建成功
      }
      }
      
    2. 听众进入房间 TUIKaraoke.enterRoom

      karaokeRoom.enterRoom(roomID: roomInfo.roomID) { [weak self] (code, message) in
      guard let `self` = self else { return }
      if code == 0 {
       //进房成功
      }
      }
      
    3. 听众主动上麦 TUIKaraoke.enterSeat

      // 1.听众调用上麦
      int seatIndex = 1; 
      karaokeRoom.enterSeat(seatIndex: seatIndex) { [weak self] (code, message) in
      guard let `self` = self else { return }
      if code == 0 {
       //上麦成功
      }
      }
      // 2.收到 onSeatListChange 回调,刷新麦位列表
      func onSeatListChange(seatInfoList: [SeatInfo]) {
      }
      
    说明:

    其他关于麦位管理的相关操作,您可参考 TUIKaraoke接口文档 按需实现,或者可以参考 TUIKaraoke 示例工程

    1. 实现音乐播放并体验 KTV 场景
      您可以根据自己的业务获取音乐 ID 和 URL 链接,播放歌曲。详情请参见 TUIKaraoke 音乐播放接口
      //播放音乐
      karaokeRoom.startPlayMusic(musicID: musicID, originalUrl: muscicLocalPath, accompanyUrl: accompanyLocalPath);
      //停止音乐
      karaokeRoom.stopPlayMusic();
      

    完成以上步骤,就可以实现 KTV 基本功能。如果您的业务还需要聊天、发送礼物等功能,可以接入以下能力。

    步骤五:文字聊天功能(可选)

    如果您需要实现各主播或听众之间文字聊天的功能,可以通过以下方法发送或接收聊天信息。
    相关接口说明请参见 TRTCKaraokeRoom.sendRoomTextMsg

    // 发送端:发送文本消息
    karaokeRoom.sendRoomTextMsg(message: message) { [weak self] (code, message) in
    if 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 in
    if (code == 0) {
        //发送成功
    }
    }
    // 接收端:监听礼物消息
    karaokeRoom.setDelegate(delegate: self)
    func onRecvRoomCustomMsg(cmd: String, message: String, userInfo: UserInfo) {
    if cmd == kSendGiftCmd {
        debugPrint("收到来自:" + userInfo.userName + "的礼物:" + message)
    }
    }
    

    常见问题

    TUIKaraoke 组件支持变声、变调、混响等音效功能吗?

    支持,具体请参见 TUIKaraoke 示例工程

    ? 如果有任何需要或者反馈,您可以联系:colleenyu@tencent.com。

    联系我们

    联系我们,为您的业务提供专属服务。

    技术支持

    如果你想寻求进一步的帮助,通过工单与我们进行联络。我们提供7x24的工单服务。

    7x24 电话支持