伯索开放平台
首页
API文档SDK文档伯索官网
首页
API文档SDK文档伯索官网
  1. 实时课堂
  • 产品介绍
    • SDK简介
    • SDK支持的业务场景
    • 产品特色
  • 产品功能
    • 实时课堂功能介绍
    • 微课功能介绍
    • 上传课件功能介绍
    • SDK后台功能介绍
  • 接入指引
    • SDK对接标准流程说明
    • 关键概念
  • SDK接入
    • SDK 接入总览
    • 实时课堂
      • Android 实时课堂接入
      • Harmony 实时课堂接入
      • iOS 实时课堂接入
      • Electron 实时课堂接入
      • Web 实时课堂监课接入
    • 极速课堂
      • Android 极速课堂接入
      • Harmony 极速课堂接入
      • iOS 极速课堂接入
      • Electron 极速课堂接入
    • 微课
      • Android 微课接入
      • Harmony 微课接入
      • iOS 微课接入
      • Electron 微课接入
    • 资料中心
      • Android 资料中心接入
      • Harmony 资料中心接入
      • iOS 资料中心接入
      • Electron 资料中心接入
      • Web 资料中心接入
    • 文件预解析
      • Android 文件预解析接入
      • Harmony 文件预解析
      • iOS 文件预解析接入
      • Electron 文件预解析接入
    • 历史课堂回放
      • Android 历史课堂回放
      • Harmony 历史课堂回放
      • iOS 历史课堂回放
      • Electron 历史课堂回放
      • 播放器
        • 播放器 SDK 概述
        • 播放器 SDK 快速开始
        • 播放器 SDK 初始化与配置
        • 播放器 SDK 历史课堂回放
        • 播放器 SDK 移动端 WebView 嵌入
        • 播放器 SDK API 参考
        • 播放器 SDK 事件
        • 播放器 SDK 错误码
        • 播放器 SDK 常见问题
    • 云学堂模块化SDK
      • 云学堂模块化 SDK 概述
      • 云学堂模块化 SDK · Android 接入
      • 云学堂模块化 SDK · iOS 接入
      • 云学堂模块化 SDK · Harmony 接入
      • 云学堂模块化 SDK · PC 接入
      • 伯索云学堂跳转接入
    • 服务端接口与协议
      • 服务端接口与协议阅读顺序
      • 签名与鉴权
      • 签名示例
      • query 参数
      • 资料中心与文件 URL
      • 文档预解析
      • 历史课堂数据回调
      • 历史课堂转视频与下载
    • 接入基础(Electron & Web)
      • Web
        • Web 概述
        • Web 快速开始:URL 接入监课
        • Web 初始化与配置(监课)
        • Web API 参考(监课)
        • Web 事件与回调(监课)
        • Web 错误码(监课)
        • Web 常见问题(监课)
      • Electron
        • Electron 概述
        • Electron 快速开始
        • Electron 初始化与配置
        • Electron API 参考
        • Electron 事件与回调
        • Electron 错误码
        • Electron 常见问题
  • Open API
    • Open API 主要功能
    • Open API集成常用场景
    • 数据字典
    • 接入须知
      • 调用流程
      • 在线调试
      • 通用错误码
    • 用户管理
      • 添加用户
      • 修改密码
      • 删除用户
      • 更新用户
      • 用户精确查询
      • 查询多个用户
      • 用户访问Token
      • 验证用户Token有效期
      • 批量添加用户
      • 恢复删除的用户
      • 设置学生属性(是否跟随/是否加联/分配课程顾问)
      • 学生随机分配课程顾问(V2)
      • 根据ids,批量查询用户
    • 班级管理
      • 创建班级
      • 更新班级
      • 删除班级
      • 查询班级列表
      • 向班级中添加学生
      • 从班级中移除学生
      • 更换学生所在班级
      • 老师列表中查询机构分校学科
      • 根据班级获取获取班级详情和人员信息
      • 批量绑定老师到班级
    • 实时课堂管理
      • 创建实时课堂
      • 创建实时课堂(班)
      • 更新实时课堂
      • 更新实时课堂(班)
      • 删除实时课堂
      • 查询实时课堂列表
      • 更新实时课堂下听众用户
      • 获取实时课堂监控地址
      • 控制单个学员是否可以回看单次课
      • 获取单个课堂的回看地址
      • 删除单个历史课堂
      • 查询课堂下历史课堂信息
      • 获取课堂考勤数据
      • 获取历史课堂信息
      • 获取历史课堂观看数据
      • 获取课堂互动信息
      • 获取课堂列表(新)
      • 获取实时课堂旁听链接
      • 获取极速直播推流地址
      • 获取课堂下板书图片
      • 获取课堂中引用的课件列表
    • 学情数据
      • 获取学生课堂明细数据
      • 获取学生巩固明细数据
      • 获取学生测验明细数据
      • 获取学生辅导明细数据
      • 获取学生积分明细数据
      • 获取学生课程统计数据
      • 获取学生课程详情统计数据
    • 商城管理
      • 获取商品详情
      • 获取商品列表
      • 获取分校自定义商品栏目列表
      • 订单查询
      • 订单详情查询
    • 作业管理
      • 查询学生作业列表
      • 查询老师作业列表
    • 测验管理
      • 查询机构测评列表
      • 获取测评统计
      • 查询机构测验列表
      • 获取测验明细
    • 积分管理
      • 机构积分规则
      • 查下学生当前积分数
      • 查下机构每天的积分明细记录
    • 课程顾问
      • 新建课程顾问
      • 编辑课程顾问
      • 查询课程顾问
      • 停用/启用课程顾问
      • 更新课程顾问密码
    • 课程管理
      • 创建课程
      • 单次创建直播/实时课堂
      • 查询课程列表
      • 新增课程下发学生
      • 删除课程下发学生
      • 查询课程下发学生列表
      • 下发课程到班级
      • 移除课程班级绑定
      • 查询课程绑定班级IDs
      • 查询课程任务列表
      • 更新课程
      • 查询课程学生
      • 查询学生作业
      • 查询订单详情
    • 校区管理
      • 创建校区
      • 编辑校区
      • 关闭校区
    • 事件推送
      • 事件推送机制
      • 事件推送接入指南
    • 其他接口
      • 三方系统唤起客户端上课方案说明
      • 唤起客户端URL
  • 产品更新记录
    • Open API 更新日志
    • SDK 更新日志
  • 常见问题
    • PPT制作事项
    • 课件常见问题与解决方法
    • 网络相关问题
    • 声音相关问题
    • 网络测速
  • 推荐配置
    • 浏览器推荐
    • 常见软件推荐
    • 教育硬件推荐
  1. 实时课堂

Electron 实时课堂接入

适用版本:@plasosdk/plaso-electron-sdk ≥ 1.3.18

1. 快速接入#

实时课堂、极速课堂和微课使用同一套 Electron SDK。安装依赖、主进程初始化 @electron/remote、日志和 electron-builder 打包等公共步骤见《接入基础(Electron & Web)/Electron》,本文只说明打开实时课堂窗口所需的参数与调用。
概述:支持环境与使用约束
快速开始:最少代码打开课堂窗口
初始化与配置:安装、进程初始化与打包
完成公共接入后,通过服务端签发的 query 调用 createLiveClassWindow 启动实时课堂。极速课堂与本文流程相同,只需在 query 中增加 d_lowLatencyClass=1,见 极速课堂/Electron。
先准备伯索分配的 appId 与 appKey,以及业务服务端的课堂 query 接口。课堂 ID、用户角色等由业务侧自行定义;🔒 appKey 只能保存在服务端,不能写入客户端。

2. 初始化 SDK#

在宿主主进程初始化 @electron/remote 并调用 initRemoteMain,渲染进程使用 window.require('@plasosdk/plaso-electron-sdk') 取得同一份 SDK。创建窗口前建议调用 initLogConfig。完整步骤、日志目录和打包配置见 初始化与配置。
打开窗口的返回值见 错误码。事件与回调见 事件与回调。

3. 服务端生成课堂 query#

客户端向业务服务端提交课堂和用户信息,服务端按《服务端接口与协议/01-签名与鉴权》生成并返回完整 query。客户端不要修改已签名参数;拿到 query 后原样放入 classOptions.query。
字段定义以《服务端接口与协议/03-query参数》为准,下表与之对齐,便于 Electron 接入时对照。

3.1 最小必填参数#

参数类型必填说明
appIdstring是伯索分配的应用标识
appTypestring是实时课堂固定为 liveclassSDK
validBeginnumber是签名生效时间,Unix 秒级时间戳
validTimenumber是query 有效期,单位秒
signaturestring是签名值;由服务端生成,客户端不能生成、修改或拼接
mediaTypestring是audio 或 video
meetingTypestring是通常为 public;如使用会议模式,按 SDK 能力约定
meetingIdstring是课堂 ID,建议只使用 ASCII 字符,不包含 /、\、空格,长度不超过 40 字节
userTypestring是speaker 主讲、assistant 助教、listener 听众;一堂课通常只能有一个主讲
loginNamestring是用户唯一 ID;同一 loginName 重复进入会顶掉前一个登录
userNamestring是用户昵称
d_dimensionstring是固定 1280x720

3.2 常用可选参数#

参数类型必填说明
topicstring否课堂名称
endTimenumber否课堂结束时间,Unix 秒级时间戳;不传默认 5 小时后结束
recordTimenumber否开始录制时间,Unix 秒级时间戳
onlineModenumber否视频课堂中 listener 可开摄像头数量,如 1、6、12;默认 6
d_sharpnessnumber否清晰度:10 为 360p,20 为 720p,30 为 1080p
d_switchnumber否功能开关位,按二进制标志位换算为十进制
enableNewClassExamnumber否新版随堂测题型:0 不支持(沿用老版随堂测)、1 选择题、2 填空题、3 选择题+填空题(建议传 3)
d_enableObjectErasernumber否是否启用新版板书(橡皮擦支持对象擦除);默认不启用,传入大于 0 的值启用。取值:0 不启用(点擦),1 对象擦除手写,3 手写+文本,5 手写+图形,7 手写+文本+图形
showHisChatMsgnumber否历史课堂是否记录消息,0 否,1 是
d_delayEndTimesnumber否单节课最大延时下课次数,默认 1;小于等于 0 时会被重置为 1
d_delayEndnumber否单次延时时间,单位秒,常见值 300、600 等
d_enableAvatarFreeScalenumber否是否开启头像任意比例缩放,0 关闭,1 开启
d_voteStarAwardnumber否投票积分,默认 0
isNewMTnumber否是否支持移动授课模式,建议传 1
recordAvatorstring否传入老师或助教的 loginName,表示录制对应人的头像
recordScreenstring否传入 screen 表示录制屏幕
d_enableReRecordingnumber否是否允许重新录制:0 不允许,1 老师,2 助教,3 老师和助教;默认允许老师与助教重新录制
d_restrictAssistantPermnumber否是否限制助教权限,0 否,1 是
极速课堂另须在 query 中增加 d_lowLatencyClass=1(并参与签名),见 极速课堂/Electron。
🔒 query 必须由服务端排序、签名和编码;对照结果见《签名示例》;全量字段与角色说明见《03-query参数》。

4. 启动课堂#

const PlasoElectronSdk = window.require('@plasosdk/plaso-electron-sdk');
// 业务后端接口,非 SDK API
const query = await api.createPlasoLiveQuery({ /* 业务参数 */ }); 

const code = PlasoElectronSdk.createLiveClassWindow({
  classOptions: { query },
  onClassWindowReadyFn: (winId: number) => {},
  onClassFinishedFn: (meetingId: string) => {},
});
返回值见 错误码。关闭窗口可调用 closeLiveClassWindow()(1.3.19 起)。
通用窗口参数和共用 classOptions(如 supportShowResourceCenter)见 初始化与配置 §5、§6。

4.1 实时课堂 classOptions#

参数类型必填默认值说明起始版本
querystring是-服务端生成的签名 query-
displayAvatarUrlstring否-当前用户头像(HTTPS 全地址)-
classMembersUserInfo[]否-成员列表;超过 2000 人需另行申请-
enableRTC3Aboolean否true回音消除、降噪、自动增益-
enableENCboolean否true降噪-
enableLiveNewShareboolean否false新桌面共享-
enableLiveNewShareInTouchboolean否false触屏设备新桌面共享-
enableLiveNewShareRegionboolean否false区域共享-
enableLiveSignboolean否false签到-
supportSaveBoardboolean否false保存板书(配合 onSaveBoardFn)-
residentCameraboolean否false学生/游客常驻摄像头-
enableUploadLogboolean否true进入/退出课堂自动上传日志1.3.15
enableBrowserboolean否-课堂内置浏览器工具1.3.17
starShow0 | 1否0积分排行榜1.3.17

5. 运行中操作#

操作API时机
插入资源insertObject(fileObject)onClassWindowReadyFn 之后
更新违禁词updateProhibitedWords(words)onClassWindowReadyFn 之后;仅对学生(userType=listener)生效
关闭窗口closeLiveClassWindow()窗口打开期间(1.3.19 起)

6. 可选能力:资料中心和预解析#

实时课堂窗口中的资料中心、普通私有文件和预解析文件通过回调接入:
显示资料中心入口:创建窗口时传 classOptions.supportShowResourceCenter = true,并实现 onOpenResourceCenterFn;
插入资源:在 onClassWindowReadyFn 之后调用 insertObject;
以 info 方式插入的普通资源:实现 onGetExtFileNameFn;
预解析资源:实现 onGetPreParseFileNameFn。
完整流程见:
资料中心/Electron
文件预解析/Electron

7. 联调检查#

已按《接入基础(Electron & Web)/Electron》完成安装、主进程 initRemoteMain,渲染进程与宿主共用同一份 @electron/remote。
安装脚本已执行,原生依赖已下载;打包后 extraResources、asar、macOS 权限验证通过。
服务端 query 能通过验签;URL 中所有参数均参与签名。
同时只打开一个课堂窗口;宿主主窗口关闭时课堂窗口同步退出。
老师、助教、学生角色进入正常;macOS 已授予麦克风权限。
课堂可正常退出;使用以 info 方式插入的私有资料或预解析课件时,已实现对应 URL 回调。
修改于 2026-11-17 07:47:57
上一页
iOS 实时课堂接入
下一页
Web 实时课堂监课接入
Built with