伯索开放平台
首页API文档SDK文档
伯索官网
首页API文档SDK文档
伯索官网
  1. Electron
  • 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 接入
    • 伯索云学堂跳转接入
  • 接入基础(Electron & Web)
    • Web
      • Web 概述
      • Web 快速开始:URL 接入监课
      • Web 初始化与配置(监课)
      • Web API 参考(监课)
      • Web 事件与回调(监课)
      • Web 错误码(监课)
      • Web 常见问题(监课)
    • Electron
      • Electron 概述
      • Electron 快速开始
      • Electron 初始化与配置
      • Electron API 参考
      • Electron 事件与回调
      • Electron 错误码
      • Electron 常见问题
  • 服务端接口与协议
    • 服务端接口与协议阅读顺序
    • 签名与鉴权
    • 签名示例
    • query 参数
    • 资料中心与文件 URL
    • 文档预解析
    • 课堂进行中数据回调
    • 课堂结束数据回调
    • 历史课堂转视频与下载
  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否-见 事件与回调-
browserOptionsBrowserOptionsType否-内置浏览器配置,见 051.3.17

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

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