伯索开放平台
首页
API文档SDK文档伯索官网
首页
API文档SDK文档伯索官网
  1. Electron
  • 产品介绍
    • 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

Electron 初始化与配置

适用版本:≥ 1.3.18

1. 接入前准备#

Node.js、Electron(14.0.0 ~ 24.8.8,最高支持 24.8.8)及目标平台编译环境;
appId、课堂 ID、用户 ID、角色;业务服务端签名接口(🔒 appKey 仅保存在服务端);
允许 npm install 生命周期脚本联网;
macOS 麦克风、屏幕录制权限。

2. 安装#

安装过程需要联网下载原生依赖。⚠️ 以下方式会得到缺少原生依赖的不可用包:npm ci --ignore-scripts、断网安装、CI 禁止 install scripts。自 1.3.18 起,原生依赖下载失败时 npm install 会报错退出。
CI 必须跳过脚本时,部署前补执行:
💡 不要跨平台/跨架构复用安装生成的 lib/ 目录。

3. 进程初始化#

3.1 主进程#

const remoteMain = require('@electron/remote/main');
remoteMain.initialize();
remoteMain.enable(mainWindow.webContents);
const { initRemoteMain } = require('@plasosdk/plaso-electron-sdk');
initRemoteMain(remoteMain);
@electron/remote 必须由宿主安装(1.3.18 起作为可选 peer 依赖),顶层 node_modules 中不能存在多份。基于本包二次封装时,@electron/remote 需与新包处于同级目录。
1.3.19 起,课堂窗口打开期间用户关闭宿主窗口时,会先退出课堂窗口再关闭宿主窗口。

3.2 日志#

PlasoElectronSdk.initLogConfig(logDir); // 应在创建课堂窗口前调用
默认目录 path.join(app.getPath('userData'), 'P403FileTemp')。classOptions.enableUploadLog(默认 true,1.3.15+)开启时,进入/退出课堂自动压缩上传日志并清理 7 天前文件;关闭后需自行上传与清理。

4. electron-builder 打包#

4.1 ≥ 1.3.12#

agora-v4 位于 SDK 的 lib/agora-v4,需从 files 排除并用 extraResources 拷贝:
{
  "files": ["!node_modules/@plasosdk/plaso-electron-sdk/lib/agora-v4/*"],
  "extraResources": [
    {
      "from": "node_modules/@plasosdk/plaso-electron-sdk/lib/agora-v4",
      "to": "app/node_modules/@plasosdk/plaso-electron-sdk/lib/agora-v4",
      "filter": ["**/*"]
    },
    {
      "from": "node_modules/@plasosdk/plaso-electron-sdk/lib/agora-v4/node_modules",
      "to": "app/node_modules/@plasosdk/plaso-electron-sdk/lib/agora-v4/node_modules",
      "filter": ["**/*"]
    }
  ]
}

4.2 1.3.7 ~ 1.3.11#

⚠️ 1.3.7 起 agora-electron-sdk-v4 不再移动到宿主顶层 node_modules:
{
  "extraResources": [
    {
      "from": "node_modules/@plasosdk/plaso-electron-sdk/node_modules/agora-electron-sdk-v4",
      "to": "app/node_modules/@plasosdk/plaso-electron-sdk/node_modules/agora-electron-sdk-v4",
      "filter": ["**/*"]
    },
    {
      "from": "node_modules/@plasosdk/plaso-electron-sdk/node_modules/agora-electron-sdk-v4/node_modules",
      "to": "app/node_modules/@plasosdk/plaso-electron-sdk/node_modules/agora-electron-sdk-v4/node_modules",
      "filter": ["**/*"]
    }
  ]
}
≤ 1.3.6 的 Agora 目录在宿主 node_modules/agora-electron-sdk-v4。升级时不要混用旧配置。

4.3 asar 与 macOS#

原生资源加载失败时关闭 asar:{ "asar": false }。macOS 打包前授权:
打包后至少验证:截图、桌面共享、共享声音回放。

5. 窗口通用参数#

参数类型必填默认值说明起始版本
classOptionsClassOptionsType是-各窗口配置,见下文及各功能模块下的 Electron 文档-
electronWinOptionsobject否-即将弃用,不建议传入;如需覆盖必须保留 nodeIntegration、enableRemoteModule 等-
回调 on*Fnfunction否-见 04-事件与回调-
browserOptionsBrowserOptionsType否-内置浏览器配置,见 051.3.17

6. 通用 classOptions(实时课堂 / 微课共用)#

参数类型必填默认值说明起始版本
topicstring否微课默认“微课录制”窗口标题-
memoryConfigKeystring否回退为 loginName本地缓存 key1.3.13
supportShowResourceCenterboolean否-显示资料中心入口;开启后点击入口触发 onOpenResourceCenterFn(实时课堂、微课均适用)-
实时课堂、微课的专有参数分别见各功能模块下的 Electron 文档。
修改于 2026-11-17 07:47:57
上一页
Electron 快速开始
下一页
Electron API 参考
Built with