腾讯云多人音视频房间SDK快速接入(iOS)_音视频解决方案_同尘科技
本文将介绍如何用最短的时间完成TUIRoomKit
组件的接入,跟随本文档,您将在一个小时的时间内完成如下几个关键步骤,并最终得到一个包含完备 UI 界面的音视频会议功能。产品计费及功能说明请参见 计费概述。
环境准备
iOS 12.0及更高。
步骤一:开通服务
在使用 TUIRoomKit 发起会议前,您需要开通 TUIRoomKit 专属的多人音视频互动服务,详细步骤如下:1. 登录 腾讯云视立方 SDK 控制台,单击创建项目按钮后,选择多人音视频互动场景和集成方式,这里我们推荐“含 UI 快速集成”,即 TUIRoomKit。2. 在选定接入场景和集成方式以后,您需要开通多人音视频房间 SDK 使用的两项腾讯云基础的 PaaS 能力,即 即时通信 IM 和 实时音视频 TRTC,开通后,单击创建项目并下一步按钮。
3. 在项目创建完成以后,您需要为该项目匹配一个 IM 应用,因为多人音视频房间 SDK 依赖了 IM SDK 提供的基础能力,这里创建或者管理已有的 IM 应用均可,在关联成功后,就可以领取7天的免费体验版,用于后续的开发调试工作,当然如果您之前已经体验过,也可以直接在该页面单击 购买正式版本。
4. 单击前往集成按钮,选择项目配置,查看详细的配置页面,找到 SDKAppID 和密钥并记录下来,它们会在后续的 步骤四:登录 TUIRoomKit 组件中被用到,至此多人音视频房间 SDK 服务开通完成。
步骤二:集成 TUIRoomKit 组件
使用 CocoaPods 导入组件,具体步骤如下:1. 在您的 Podfile
文件中添加以下依赖。
pod 'TUIRoomKit'pod 'TUIVideoSeat' # 视频位视图挂件
2. 执行以下命令,安装组件。
pod install
如果无法安装 TUIRoomKit 最新版本,执行以下命令更新本地的 CocoaPods 仓库列表。
pod repo update
步骤三:完成工程配置
使用音视频功能,需要授权麦克风和摄像头的使用权限。在 App 的 Info.plist 中添加以下两项,分别对应麦克风和摄像头在系统弹出授权对话框时的提示信息。
NSCameraUsageDescriptionTUIRoom需要访问您的相机权限NSMicrophoneUsageDescriptionTUIRoom需要访问您的麦克风权限NSPhotoLibraryUsageDescriptionTUIRoom需要访问您的相册
步骤四:初始化 TUIRoomKit 组件
在您的项目中添加如下代码,它的作用是通过调用 TUIRoomKit 中的相关接口完成组件的初始化。这个步骤非常关键,因为只有在初始化后才能正常使用 TUIRoomKit 的各项功能,故请您耐心检查相关参数是否配置正确:
TUIRoomKit.sharedInstance.login(sdkAppId: 1400000001, // 请替换为步骤一取到的 SDKAppID userId: "xxxxxxxxxx",// 请替换为您的 UserID userSig: "998") // 您可以在控制台中计算一个 UserSig 并填在这个位置
参数说明
这里详细介绍一下 login 函数中所需要用到的几个关键参数:SDKAppID:在 步骤一 中的第4步中您已经获取到,这里不再赘述。UserID:当前用户的 ID,字符串类型,只允许包含英文字母(a-z 和 A-Z)、数字(0-9)、连词符(-)和下划线(_)。UserSig:使用 步骤一 的第4步中获取的 SecretKey 对 SDKAppID、UserID 等信息进行加密,就可以得到 UserSig,它是一个鉴权用的票据,用于腾讯云识别当前用户是否能够使用 TRTC 的服务。您可以通过控制台中的 辅助工具 生成一个临时可用的 UserSig。更多信息请参见 如何计算及使用 UserSig。注意:这个步骤也是目前我们收到的开发者反馈最多的步骤,常见问题如下:SDKAppID 设置错误,国内站的 SDKAppID 一般是以140开头的10位整数。UserSig 被错配成了加密密钥(SecretKey),UserSig 是用 SecretKey 把 SDKAppID、UserID 以及过期时间等信息加密得来的,而不是直接把 SecretKey 配置成 UserSig。UserID 被设置成“1”、“123”、“111”等简单字符串,由于 TRTC 不支持同一个 UserID 多端登录,所以在多人协作开发时,形如 “1”、“123”、“111” 这样的 UserID 很容易被您的同事占用,导致登录失败,因此我们建议您在调试的时候设置一些辨识度高的 UserID。Github 中的示例代码使用了 genTestUserSig 函数在本地计算 UserSig 是为了更快地让您跑通当前的接入流程,但该方案会将您的 SecretKey 暴露在 App 的代码当中,这并不利于您后续升级和保护您的 SecretKey,所以我们强烈建议您将 UserSig 的计算逻辑放在服务端进行,并由 App 在每次使用 TUIRoomKit 组件时向您的服务器请求实时计算出的 UserSig。
步骤五:使用 TUIRoomKit
设置用户信息
通过调用 TUIRoomKit 的 setSelfInfo 即可设置用户的用户名、头像。
TUIRoomKit.sharedInstance.setSelfInfo(userName: "xx", avatarURL: "xx")
参数 | 类型 | 含义 |
userName | String | 用户名 |
avatarURL | String | 用户头像 URL |
准备页面(可选)
通过调用 TUIRoomKit 的 enterPrepareView 就可以进入准备页面。
TUIRoomKit.sharedInstance.enterPrepareView(enablePreview: true)
参数 | 类型 | 含义 |
enablePreview | Bool | 是否开启视频预览 |
创建房间
通过调用 TUIRoomKit 的 createRoom 函数并指定房间的类型为 TUIRoomKit.RoomScene.meeting,就可以创建房间。进会参数说明:
public enum RoomScene { case meeting case live}
public class RoomInfo { public var ownerId: String // 主持人id public var name: String // 房间名称,仅主持人可设置 public var roomId: String // 房间号 public var isOpenCamera: Bool // 进会是否开启摄像头 public var isOpenMicrophone: Bool // 进会是否开启麦克风 public var isUseSpeaker: Bool // 进会是否开启扬声器 public var isCameraDisableForAllUser: Bool = false // 会话期间是否禁止打开摄像头,仅房主可设置,默认不禁止,中途可修改 public var isMicrophoneDisableForAllUser: Bool = false // 会话期间是否禁止打开麦克风,仅房主可设置,默认不禁止,中途可修改 public var isMessageDisableForAllUser: Bool = false // 会话期间是否禁止发送消息,仅房主可设置,默认不禁止,中途可修改 public var speechMode: TUISpeechMode //房间发言模式,仅房主可设置 }
示例代码:
let roomInfo = RoomInfo()roomInfo.name = "xx"; // 请设置为您需要的房间名称roomInfo.roomId = "998" // 请设置为您需要的房间号roomInfo.isOpenCamera = true // 请按照您的业务需求设置roomInfo.isOpenMicrophone = true // 请按照您的业务需求设置roomInfo.isUseSpeaker = true // 请按照您的业务需求设置roomInfo.speechMode = .freeToSpeak // 请按照您的业务需求设置TUIRoomKit.sharedInstance.createRoom(roomInfo: roomInfo, type: .meeting)
参数 | 类型 | 含义 |
roomInfo | RoomInfo | 房间的基本信息 |
scene | TUIRoomKit.RoomScene | 房间类型,示例:.meeting |
加入多人音视频房间
通过调用 TUIRoomKit 的 enterRoom 函数并指定房间类型与房间号,就可以进入指定房间。
let roomInfo = RoomInfo()roomInfo.roomId = "998" // 请设置为您要进入的房间号roomInfo.isOpenCamera = true // 请按照您的业务需求设置roomInfo.isOpenMicrophone = true // 请按照您的业务需求设置roomInfo.isUseSpeaker = true // 请按照您的业务需求设置TUIRoomKit.sharedInstance.enterRoom(roomInfo: roomInfo)
参数 | 类型 | 含义 |
roomInfo | RoomInfo | 房间的基本信息 |
说明:加入房间时的 RoomInfo 参数只需关注roomId、isOpenCamera、isUseSpeaker、isOpenMicrophone
四个字段,其他字段无需设置。
步骤六:更多特性
UI 挂件接入
使用 CocoaPods 导入美颜挂件,具体步骤如下:1. 在您的 Podfile
文件中添加以下依赖。
pod 'TUIBeauty' # [可选] 美颜挂件
2.执行以下命令,安装组件。
pod install
常见问题
如果您选择同时集成 RoomKit 与 CallKit, 可以参考以下集成方式,后续我们会尽快优化多组件之间的集成方式。
# CallKitpod 'TUICallKit', '~> 1.4.0.256' # 同时集成RoomKit与CallKit,推荐TUICallKit 1.4.0.256及以上版本 # RoomKitpod 'TUIRoomKit', '~> 1.0.1' # 同时集成RoomKit与CallKit,推荐TUIRoomKit 1.0.1 及以上版本
# Kingfisher(swift 网络图片缓存库) 版本号设置参考:https://github.com/onevcat/Kingfisher# iOS 10+ Xcode 12 推荐选择 pod 'Kingfisher', '~> 6.3.1'# iOS 11+ Xcode 13 推荐选择 pod 'Kingfisher', 'version6-xcode13'# iOS 12+ Xcode 13 推荐选择 pod 'Kingfisher', '~> 7.0'pod 'Kingfisher', '~> 6.3.1'
交流与反馈
如果您在使用过程中,有什么建议或者意见,欢迎您加入我们的 TUIRoomKit 技术交流 QQ 群:770645461,进行技术交流和产品沟通。
对音视频的解决方案有疑惑?想了解解决方案收费? 联系解决方案专家
腾讯云限时活动1折起,即将结束: 马上收藏
同尘科技为腾讯云授权服务中心,购买腾讯云享受折上折,更有现金返利:同意关联,立享优惠
阿里云解决方案也看看?: 点击对比阿里云的解决方案
暂无评论,你要说点什么吗?