伯索开放平台
首页API文档SDK文档
伯索官网
首页API文档SDK文档
伯索官网
  1. 微课
  • 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 微课接入

适用版本:@plasosdk/plaso-electron-sdk ≥ 1.3.19(见 版本记录)
微课与实时课堂使用同一套 Electron SDK,但不需要实时课堂 query。

1. 快速接入#

安装、主进程初始化、日志和打包等公共步骤见《接入基础(Electron & Web)/Electron》,本文只说明打开微课录制窗口、保存与上传所需的参数与调用。
概述
快速开始
初始化与配置
完成公共接入后,调用 createLocalRecordWindow 打开微课录制窗口,制作完成后可调用 uploadMiniLesson 上传。
先准备当前用户的 loginName、userName,以及一份独立、可读写的本地录制目录。🔒 上传所需的 OSS 临时凭证必须由服务端签发。

2. 初始化 SDK#

初始化方式与实时课堂相同:主进程调用 initRemoteMain,渲染进程 window.require 同一份 SDK。完整步骤见 初始化与配置。
返回值见 错误码。事件与回调见 事件与回调。

3. 启动前准备#

创建微课前为每份微课分配独立、可读写的本地目录,作为 classOptions.path。不同微课不要共用目录。若要插入以 info 方式提供的私有文件或预解析 PPT/PDF/Word/Excel,请按 资料中心/Electron 和 文件预解析/Electron 实现回调。

4. 创建微课#

PlasoElectronSdk.createLocalRecordWindow({
  classOptions: { loginName: 'hello', userName: 'world', path: 'C:/temp/lesson_v7' },
  onClassWindowReadyFn: (winId) => {},
  onMiniLessonFinishedFn: (lessonInfo) => {},
  onMiniLessonSaveDraftFn: (lessonInfo) => {},
  onMiniLessonCancelFn: () => {},
});
通用窗口参数和共用 classOptions(如 supportShowResourceCenter)见 初始化与配置 §5、§6。

4.1 微课 classOptions#

参数类型必填默认值说明起始版本
loginNamestring是-用户唯一 ID1.3.19
userNamestring是-用户昵称1.3.19
pathstring否临时目录微课本地录制目录1.3.19
topicstring否微课录制标题1.3.19
enablePreviewboolean否false预览剪切1.3.19
enableDraftboolean否true草稿1.3.19

4.2 回调#

回调参数说明
onClassWindowReadyFnwinId: number窗口就绪
onClassWindowLeaveFnwinId: number窗口关闭
onOpenResourceCenterFn-点击资料中心入口;需传通用参数 supportShowResourceCenter = true,见 初始化与配置 §6
onMiniLessonFinishedFnLessonInfoFinished制作完成
onMiniLessonSaveDraftFnLessonInfoDraft保存草稿
onMiniLessonCancelFn-取消录制
interface LessonInfoDraft { cover: string; duration: number; size: number; topic: string }
interface LessonInfoFinished extends LessonInfoDraft { fileName: string; refFile: any[] }

5. 后续流程#

5.1 上传微课 uploadMiniLesson#

须在微课窗口仍打开时调用(onMiniLessonFinishedFn 之后、关闭窗口之前)。
function uploadMiniLesson(
  query: Record<string, any> | string,   // 需包含 recordId、signature 等签名参数
  path: string,                          // 微课本地目录
  options: { token: OssToken; autoDelete?: boolean; uploadStatus?: UploadMiniLessonStatus },
): Promise<{ code: number; path: string; cover: string }>;

interface OssToken {
  accessKeyId: string; accessKeySecret: string; stsToken: string;
  uploadPath: string; bucket: string; region: string; provider: string;
  expire: number;          // Unix 秒
  host?: string; endpoint?: string; cname?: boolean; authorizationV4?: boolean;
}
interface UploadMiniLessonStatus {
  onUploadProgress?: (uploadedLength: number, totalLength: number) => void; // 已上传文件数 / 总数
  onUploadFinished?: (status: { code: number; path: string; cover: string }) => void; // code 0 成功
}
失败时 reject { code },窗口未就绪或非微课窗口时 code = -99。🔒 OSS 临时凭证由服务端签发。

5.2 关闭#

关闭窗口可调用 closeLocalRecordWindow()。

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

微课窗口的资料中心与预解析接入方式与实时课堂相同:传 supportShowResourceCenter = true,在窗口就绪后 insertObject,并以 onGetExtFileNameFn / onGetPreParseFileNameFn 处理以 info 方式插入的资源。完整流程见:
资料中心/Electron
文件预解析/Electron

7. 联调检查#

已按《接入基础(Electron & Web)/Electron》完成安装与 initRemoteMain。
新建微课可进入录制窗口,草稿可保存。
onMiniLessonFinishedFn 能拿到微课信息。
上传须在关闭窗口前完成;凭证失败时有明确处理。
关闭窗口可调用 closeLocalRecordWindow()。
插入以 info 方式提供的私有文件或预解析课件时,能触发对应 URL 回调。
修改于 2026-11-18 03:45:46
上一页
iOS 微课接入
下一页
Android 资料中心接入
Built with