快速开始

最近更新时间:2025-01-14 11:54:42

我的收藏
说明:
阅读本章节前,请确保您已经看完 Web 和 H5 的集成指引。

通过自定义能实现什么?

课堂的 iOS/Android/Electron 用户界面都基于网页实现,自定义能根据您的需要修改所有端界面补充业务逻辑。业务中主要有以下使用场景:

业务场景
业务举例
自定义样式
关键概念文案替换
页面展示的信息更新为行业内专有名称,例如将“课堂”更新为“会议”等。可参考 操作示例
自定义页面布局
竖屏布局下修改样式、调整界面 icon 样式(如摄像头、麦克风)等。
修改弹窗按钮的行为。可参考 操作示例
自定义虚拟背景。可参考 操作示例
自定义功能
屏蔽无关业务功能
隐藏头像区域,隐藏在线人数等。可参考 操作示例
配置业务功能
分角色设置下课倒计时提醒。可参考操作示例
配置白板功能权限。可参考 操作示例
查询事件信息
展示和查询课堂信息,可参考 基本概念介绍
在特定事件发生时,进行与业务相关的处理。如查询摄像头/麦克风状态上报后台;进入房间后展示弹窗等。事件监听 列表罗列了当前支持的所有事件类型。

方式1:自定义 js 调试

为了简化您开发自定义界面的流程,我们准备了常用的自定义 js 示例,您可以到 github 地址 获取。您可以通过以下命令快速启动一个 demo:
git clone https://github.com/InteractiveClassroom/tcic-custom-demo.git
pnpm i
cd ./demos/{SOME_DEMO} # SOME_DEMO 为 demos 目录下的某个 demo
pnpm dev
进入课堂后,在上课地址后面添加 &debugjs=http://localhost:3000/custom.js ,如果有 css,再拼接 &debugcss=http://localhost:3000/custom.css,即 &debugjs=http://localhost:3000/custom.js&debugcss=http://localhost:3000/custom.css,课堂页面将会加载本地自定义的 js 和 css,从而可以进行自定义调试。

发布到生产环境

在本地调试完成后,通过npm run build打包出 js 和 css 文件,通过 自定义场景配置 上传打包的 js 和 css 文件,并在创建课堂时传入对应的场景名称,即可在课堂中生效。

方式2:页面调试(需准备开发环境)

在进行调整前,需要您先准备好开发环境,请按照下文指引操作。

一、准备开发环境

在本文假定您已经具备以下技能:
1. 搭建本地静态服务器。
2. 了解浏览器端的 js/css 开发和运作原理。
参见 Web 和 H5 集成指引,假设您的本地服务器运行在8080端口,根目录下已创建文件 test.js,test.css。

二、准备测试课堂

1. 单击课堂演示的 登录页面,选择创建课堂,然后单击立即进入,将会跳转到课程页面。



2. 进入课程页面,您将看到如下图效果。请复制课程页面的 URL。



3. 将 JS/CSS 字符串附加到 URL 后面,附加字符串如下所示。
debugjs=http://localhost:8080/test.js&debugcss=http://localhost:8080/test.css
4. 将修改后的 URL 粘贴回浏览器,打开浏览器的控制台,检查网络请求。如果出现 localhost 文件,那么就表示操作成功,如下图所示:



完成上述步骤准备好环境后,则可以开始进行功能开发。
注意:
用 vue 或者 react 开发自定义 js 的时候,不要把自定义应用挂载到#app的 DOM 节点上面,需要自己创建一个 div,插到 DOM 中再进行挂载。