RoomKit
  • iOS : Objective-C
  • Android
  • macOS
  • Windows
  • Web
  • 小程序
  • Flutter
  • React Native
  • 产品简介
    • 概述
    • 发布日志
  • 开通 RoomKit 服务
  • 下载
  • 体验 App
  • 快速开始
  • 进阶功能
  • 客户端 API
  • 服务端 API
  • 常见错误码
  • 常见问题
  • 文档中心
  • RoomKit
  • 开通 RoomKit 服务

开通 RoomKit 服务

更新时间:2024-01-05 11:04

本文介绍如何自助注册 RoomKit 控制台并创建项目,获取接入 RoomKit SDK 所需的信息。

注册账号

  1. 访问 Roomkit 官网,点击「免费体验」,即可前往注册。

    /Pics/RoomKit/AllPlatform/subscribe/1.png

  2. 使用手机号进行注册。

  3. 注册完账号之后需要完善信息。信息完善之后即可开始创建项目。

创建项目

  1. 注册成功后可进入 Roomkit 管理后台,点击右上角 “创建项目” 即可开始项目创建。

  2. 在 “配置项目” 页面中填写项目的基本信息。

    • 项目名称:自定义。
    • 使用场景:单选,含义如下。
      • 1V1课:1 位讲师对 1 名学员进行专属在线辅导教学。
      • 小班课:1 位讲师进行在线教学,多位学员实时观看和收听,课堂人数上限为 500。上课过程中,老师可邀请学生“上台”发言,与老师进行实时音视频互动。
      • 大班课:1 位讲师进行在线教学,多名学员实时观看和收听,课堂人数无上限。上课过程中,学生可“举手”请求发言,与老师进行实时音视频互动。
      • 语音直播:讲师可通过白板及语音方式进行在线教学,多名学员实时观看和收听。上课过程中,学生可以与老师进行实时音频互动。适合知识付费等场景。
    • 部署环境:若项目用户覆盖海内外群体,则建议选择「国外」部署环境。
    • 并发开播人数、最高在线人数、单房间最大人数:填写估算值即可,无需特别精确。
    • 产品覆盖平台:请根据项目实际应用选择平台。
  3. 信息填写完后,点击 “立即创建” 进行项目创建。

  • 项目创建成功后不可更改项目参数,若需要调整,则需重新创建项目。
  • 试用体验阶段,最多只允许创建 5 个项目。
  • 单个项目的有效体验期为 14 天,若需要延长项目体验期,请联系即构工作人员。

配置参数

项目创建完成后,点击项目右侧的 “配置参数” 配置项目高级参数。

事件回调配置

用于配置 RoomKit 事件通知的回调地址。对应事件发生后,RoomKit 后台会通过接口调用的方式通知到这里配置的地址。

  • 房间事件通知:监听房间状态、成员进出等通;。
  • 录制文件获取:有启动录制时,需要获取录制文件时需要监听。
  • 正在共享的白板获取:使用云录制功能时,需要监听,用于更新录制中的共享内容。

具体通知内容详见 服务端事件回调

CDN 功能配置

当使用场景为 “大班课” 或 “语音直播” 时,则需要进行 CDN 配置。

填写域名后系统将会自动分配推拉流及点播域名,请上传拉流域名、点播域名对应的证书密钥。

  1. 推流域名及点播域名的 SSL 证书公钥、私域均需上传,完成后方可进行下一步 CNAME 操作。
  2. 上传时请注意文件格式,上传界面上提示支持的格式的证书。
  3. CNAME 配置请参考 配置域名 CNAME,配置完成后即可开始项目集成。

获取接入信息

集成 RoomKit SDK 所需的信息如下:

  • ProductID:在 “项目列表” 页面获取。

    /Pics/RoomKit/AllPlatform/subscribe/9.png

  • secret_id、secret_sign、secret_key:在 “鉴权信息” 页面获取。

    /Pics/RoomKit/AllPlatform/subscribe/10.png

本篇目录