快速启动房间

1. 功能介绍

RoomKit 提供的接入方案，为不同的业务方案提供了适配方式：

1. 如果您的产品已具备用户系统和房间系统（房间也可以是频道、小组、群等），可自行管理用户 ID与房间 ID。
2. 如果您的产品没有自己的房间系统，我们提供了教育云服务帮助您进行房间管理，集成方法请参考文档 使用教育云 API 管理房间。

本篇文档基于上述的第一种场景介绍实现流程。

接入架构图：

在这个架构中，您需要通过您自己的业务系统实现以下业务逻辑：

1. 搭建用户管理逻辑，并下发用户 ID 给客户端用于加入房间。
2. 搭建房间管理逻辑，并下发房间 ID 给客户端用户加入房间。
3. 鉴权 Token，建议由您的业务后台向 RoomKit 服务器请求 SDK Token 以保证鉴权数据安全。

加入房间后，您就可以开始使用 RoomKit 提供的房间功能，实现效果示意图如下：

2. 前提条件

在实现基本的功能之前，请确保：

• 已经在项目中集成了 RoomKit SDK，详情请参考 快速开始 - 集成。
• 已在 RoomKit 管理后台 创建项目，并获取初始化 RoomKit SDK 所必须的 SecretID、SecretSign、ProductID等信息。详见 开通 RoomKit 服务。

3. 实现步骤

使用 RoomKit SDK 只需三步，即可快速搭建一个音视频应用，流程图如下：

3.1 初始化 SDK

1. 导入头文件。

#import <ZegoRoomKitUI/ZegoRoomKitUI.h>

2. 导入 SDK 后，若要使用 SDK 的相关功能，需要初始化 SDK，初始化所需配置信息如下：

@interface ZegoInitConfig : NSObject

/// 由Zego后台分配
@property (nonatomic, assign) NSInteger secretID;

@end

3. 根据以上信息构建 config，并调用 initWithConfig 接口进行初始化。

// 构建 ZegoInitConfig 实例
ZegoInitConfig *config = [[ZegoInitConfig alloc] init];
config.secretID = 123456; // ZEGO 分配的 secretID

// 初始化 SDK
[[ZegoRoomKit sharedInstance] initWithConfig:config completion:^(ZegoRoomKitError error) {

}];

3.2 获取 SDK Token

您可以通过调用 RoomKit 服务端 API 获取 SDK Token 接口 获取 SDK Token。

• 请求字段 secret_id 和 secret_sign 通过 RoomKit 管理后台 获取。
• 请求字段 device_id 通过 RoomKit SDK 获取 deviceID 接口 获取。

我们提供了 服务端 API 调测指南 帮助您使用 Postman 快速调用接口进行调试。

3.3 加入房间

加入房间需要以下信息：

• 鉴权信息：token，productID
• 房间信息：roomID
• 用户信息：userID，userName，role

RoomKit SDK 支持使用任意用户 ID（64位数值型）和房间 ID（64位数值型）加入房间。

使用上述信息，设置 加入房间配置对象。

/// 加入房间配置对象
///
@interface ZegoJoinRoomConfig : NSObject

/// 房间号
@property (nonatomic, copy) NSString *roomID;

/// 项目 ID
@property (nonatomic, assign) NSInteger productID;

/// token
@property (nonatomic, copy) NSString *token;

/// 用户名
@property (nonatomic, copy) NSString *userName;

/// 用户 ID
@property (nonatomic, assign) NSInteger userID;

/// 加入房间时的角色
@property (nonatomic, assign) ZegoRoomKitRole role;

@end

2. 根据以信息上构建 config, 并调用 joinRoomWithConfig 加入房间，即可完成音视频应用搭建。

// 实例化 config
ZegoJoinRoomConfig *config = [ZegoJoinRoomConfig new];
config.roomID = @"123456789"; // 房间 ID
config.productID = 1234; // productID
config.userName = @"anne"; // 用户名
config.userID = 123456789; // 用户 ID
config.role = ZegoRoomKitRoleAttendee; // 以观众身份加入房间
config.token = @"qwertyuiop"; // token，调用对应 Server API 获取

// 加入房间
[[ZegoRoomKit sharedInstance].inRoomService joinRoomWithConfig:config
                                                        fromVC:fromVC
                                                    completion:^(ZegoRoomKitError errorCode) {
}];

相关文档

• iOS 12 系统真机调试的时候出现 Metal 相关的 crash 怎么解决？
• 如何获取日志？
• 如何清理缓存？