快速启动房间

---

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. 修改 config.js 文件，添加初始化 SDK 的配置信息。请使用本文 前提条件 中获取的信息正确填写。

   

2. 创建 ZegoRoomKit 实例。

   //初始化实例
   const zg = new ZegoRoomKit();
   //初始化配置信息
   zg.init({
       secretID: SecretID
   })

3.2 获取 SDK Token

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

• 请求字段 secret_id 和 secret_sign 通过 RoomKit 管理后台 获取。
• 请求字段 device_id 通过 RoomKit SDK 的静态方法 deviceID() 获取。

const deviceId = ZegoRoomKit.deviceID();

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

3.3 加入房间

加入房间需要以下信息：

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

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

调用 joinRoomWithConfig 加入房间。

//参数赋值
const config = {};
config.userID = 123; // 用户 ID
confg.productID = 1111; // productID
config.userName = 'www'; // 用户名
config.roomID = '11111'; // 房间 ID
config.token = 'xxxxxxx'; // token，调用对应 Server API 获取
config.role = 2; // 以参会成员身份加入房间

//调用方法
const res = await zg.inRoomService().joinRoomWithConfig(config, 'app');

相关文档

• 调用编译打包后 SDK 的接口时报错怎么处理？
• 在房间内点击离开课堂后页面未跳转怎么处理？
• Web端大班课，作为学生加入时看不到教师的画面如何处理？
• Web 端大班课，H5 端看不到教师的画面如何处理？