文档中心
RoomKit RoomKit
文档中心
体验 App
SDK 中心
API 中心
常见问题
代码市场
进入控制台
立即注册
登录
中文站 English
  • 文档中心
  • RoomKit
  • 快速开始
  • 跑通示例源码
Web
示例源码
本地下载
  • 本地下载
说明
H5 移动端
示例源码
本地下载
  • 本地下载
说明

1 示例源码运行指引

本文介绍如何快速跑通示例源码,体验基础的 RoomKit 服务。

1.1 准备环境

  1. 已安装 node 环境 。

可以到 node 官网 下载后参考 教程 安装。

  1. Web 端:已安装 74 或以上版本的 Chrome 浏览器。

  2. H5 移动端:

平台 浏览器 备注
iOS Chrome 支持 iOS 10.0 或以上版本。
iOS Safari 支持 iOS 10.0 或以上版本。
iOS 微信内嵌浏览器 支持 iOS 10.0 或以上版本。
Android Chrome 支持 Android 8.0 或以上版本。
Android 微信内嵌浏览器 支持 Android 8.0 或以上版本。

只支持 SSL 的 Web 服务器(https),localhost,127.0.0.1 等同于 https。

1.2 前提条件

已在 RoomKit 管理后台 创建项目,并获取初始化 RoomKit SDK 所必须的 SecretID、SecretSign、ProductID等信息。详见 开通 RoomKit 服务。

1.3 示例源码文件说明

示例源码主要文件结构和说明如下。

/Pics/RoomKit/Web/demo_file.png

  • assets 文件夹存放示例源码的资源文件。

  • iconfont、img、video 文件夹存放的是 SDK 的资源文件(请不要更改这里的任何文件)。

  • html 文件为示例源码的展示页面:

    • login.html 为登录入口页面文件;
    • classList.html 为课程管理页面文件(可创建、删除、查询课程列表,包含文件预览入口);
    • demo.html 为上课页面文件;
    • fileView.html 为文件预览页面文件。
    • browserCheck.html 为浏览器不兼容时的提示页面。
  • js 文件为实现示例源码运行的 JavaScript 代码:

    • config.js 为示例源码公共信息配置文件;
    • public.js 为示例源码中一些公共方法的封装;
    • ZegoRoomKit.js 为 SDK 文件。

1.4 运行示例源码

  1. 打开 Terminal ,执行 npm install --global http-server 命令全局安装 http-server 工具。

如果在 macOS 或 Linux 系统中执行 npm 命令失败,提示 “permission denied”,请在 npm 命令前加上 sudo 重新执行即可。

  1. 下载的示例源码中缺少 SDK 初始化所需的信息,需要 config.js 中必须的信息修改为 前提条件 中获取的信息,否则示例源码无法正确运行。

    /Pics/RoomKit/Web/config.png

  2. 在 Terminal 中切换到项目所在目录下,执行 http-server -o login.html 命令启动本地服务,会自动在默认浏览器中打开登录页面。

  • 如果浏览器自动打开登录页面失败或者获取摄像头、麦克风等权限全部失败,请手动在 Chrome 浏览器中打开 http://127.0.0.1:8080/login.html。

  • 在 Terminal 中执行 Control+C 命令停止 server。

本篇目录
  • 免费试用
  • 提交工单
    咨询集成、功能及报价等问题
    电话咨询
    400 1006 604
    咨询客服
    微信扫码,24h在线

    联系我们

  • 文档反馈