伯索开放平台
首页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 API 参考

适用版本:≥ 1.3.18
// 主进程
const { initRemoteMain } = require('@plasosdk/plaso-electron-sdk');
// 渲染进程
const PlasoElectronSdk = window.require('@plasosdk/plaso-electron-sdk');
API进程返回值起始版本
initRemoteMain(remoteMain)主--
getVersion()渲染string(异常 -99)-
initLogConfig(logDir)渲染--
createLiveClassWindow(params)渲染number 错误码(实时课堂 / 极速课堂)-
createLocalRecordWindow(params)渲染number 错误码1.3.19
insertObject(fileObject)渲染无(异常 -99)-
uploadMiniLesson(query, path, options)渲染Promise<{code,path,cover}>1.3.19
updateProhibitedWords(words)渲染无(异常 -99)1.3.16
closeLiveClassWindow()渲染number 错误码1.3.19
closeLocalRecordWindow()渲染number 错误码1.3.19
FILE_TYPE渲染常量-

initRemoteMain#

function initRemoteMain(remoteMain: typeof import('@electron/remote/main')): void;
主进程调用,传入已 initialize() 的 @electron/remote/main。

getVersion#

function getVersion(): string;
返回 SDK 的 npm 包版本。

initLogConfig#

function initLogConfig(logFilePath: string): void;
设置日志目录(同时作为 crashDumps 目录)。应在创建窗口前调用。

createLiveClassWindow / createLocalRecordWindow#

function createLiveClassWindow(params: ClassWindowType): number;
function createLocalRecordWindow(params: ClassWindowType): number;
参数见 初始化与配置 与各功能模块下的 Electron 文档;返回值见 错误码。同一时刻只能存在一个窗口。

insertObject#

function insertObject(fileData: FileDataObj): void;
须在 onClassWindowReadyFn 之后调用,见 资料中心。

uploadMiniLesson (微课)#

见 微课 §5.1。

updateProhibitedWords (课堂)#

function updateProhibitedWords(words: string[]): void;
运行中动态更新违禁词,仅对学生(userType=listener)生效;
须在 onClassWindowReadyFn 之后调用。

close*Window#

function closeLiveClassWindow(): number;
function closeLocalRecordWindow(): number;
触发与标题栏关闭按钮相同的退出流程(含确认弹窗)。调用后窗口不会立即关闭,实际关闭以 onClassWindowLeaveFn 回调为准。
方法对应窗口
closeLiveClassWindow()实时课堂窗口
closeLocalRecordWindow()微课录制窗口
返回值情况
0已发起退出流程;退出流程已在进行中时重复调用也返回 0
-99当前没有打开的窗口,或窗口尚未就绪(onClassWindowReadyFn 之前)
-99当前打开的窗口类型与方法不匹配(如微课窗口打开时调用 closeLiveClassWindow())
-99发起退出时发生其他异常
修改于 2026-11-18 03:45:46
上一页
Electron 初始化与配置
下一页
Electron 事件与回调
Built with