伯索开放平台
首页
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 资料中心接入

0. 版本说明#

项说明
SDK 版本@plasosdk/plaso-electron-sdk ≥ 1.3.18
依赖@plasosdk/plaso-electron-sdk、@electron/remote
接入性质可选能力
入口supportShowResourceCenter、insertObject、onOpenResourceCenterFn、onGetExtFileNameFn
本文只说明 Electron 端资料中心闭环。安装、主进程初始化和通用窗口参数见《接入基础(Electron & Web)/Electron》;课堂启动方式见《实时课堂/Electron》;服务端 URL 契约见《服务端接口与协议/04-资料中心与文件URL》。

1. 接入前准备#

需要准备:
自有资料中心页面;
资料中心选中文件后的业务文件 ID;
业务服务端根据文件 ID 签发短时 URL 的接口;
Electron 端 onOpenResourceCenterFn、onGetExtFileNameFn 实现(若使用预解析资源,还需实现 onGetPreParseFileNameFn);
普通文件类型和文件名。
不接自有资料中心时,不要传 classOptions.supportShowResourceCenter = true,此时不显示入口,也不会触发 onOpenResourceCenterFn。若仍会插入以 info 方式提供的私有文件或预解析文件,对应 URL 回调仍需实现。

2. 实现资料中心入口#

创建实时课堂或微课窗口时开启资料中心入口,并实现打开回调。通用参数见 初始化与配置 §6。
const PlasoElectronSdk = window.require('@plasosdk/plaso-electron-sdk');

const code = PlasoElectronSdk.createLiveClassWindow({
  classOptions: {
    query,
    supportShowResourceCenter: true,
  },
  onClassWindowReadyFn: (winId: number) => {
    // 窗口就绪后可调用 insertObject
    // 推荐把资料中心作为课堂窗口的子窗口打开:
    // const classWin = require('@electron/remote').BrowserWindow.fromId(winId);
  },
  onOpenResourceCenterFn: () => {
    // 打开业务资料中心页面;选中文件后调用 insertObject
  },
  onGetExtFileNameFn: async (info: any, option: any) => api.fetchSignedFileUrl(info),
  onGetPreParseFileNameFn: async (info: any, option: { suffix: string }) =>
    api.fetchParsedFileUrl(info, option.suffix),
});
api.* 均为业务后端接口,非 SDK API。用户点击资料中心入口后触发 onOpenResourceCenterFn,由宿主打开自有资料中心窗口。
insertObject 适用于实时课堂、微课窗口;须在 onClassWindowReadyFn 之后调用,否则会被静默忽略(无返回值,异常时返回 -99)。
回调必须满足:
1.
成功时返回完整可访问 URL;
2.
超时、文件不存在、无权限时 reject;
3.
不要把 appKey、OSS 私钥或永久下载地址放入客户端;
4.
info 只作为业务文件标识,服务端负责鉴权。

3. 非预解析文件接入#

非预解析文件是指 SDK 可以直接加载的 PPT、图片、文档、音频或视频。资料中心选择文件后,在 onClassWindowReadyFn 之后调用 insertObject。
const { FILE_TYPE } = window.require('@plasosdk/plaso-electron-sdk');
PlasoElectronSdk.insertObject({
  type: FILE_TYPE.PDF,
  title: '文件展示名称',
  // url 与 info 二选一
});
FILE_TYPE值适用文件
PPT1普通 PPT
IMAGE2图片
PDF3PDF
WORD4普通 Word
EXCEL5普通 Excel
AUDIO6音频
VIDEO7视频
insertObject 的参数为 FileDataObj:
参数类型必填说明
typenumber是使用 SDK 导出的 FILE_TYPE
titlestring否显示在文件窗口标题栏,建议带扩展名;GIF 必须带 .gif
urlstring否公开可访问的完整地址(建议 HTTPS)
infoany[]否业务自定义资源标识,回调中原样回传
totalPagesnumber否预解析 PDF/DOC/XLS 的总页数
url 与 info 二选一;同时传入时以 info 为准,url 会被忽略。预解析类型见 §4。

3.1 使用可直接访问的 URL#

当文件 URL 可由 SDK 直接访问时,将完整地址写入 url。SDK 不会调用 onGetExtFileNameFn。
PlasoElectronSdk.insertObject({
  type: FILE_TYPE.PDF,
  title: '第一章.pdf',
  url: 'https://cdn.example.com/courseware/chapter-1.pdf',
});
PlasoElectronSdk.insertObject({
  type: FILE_TYPE.IMAGE,
  title: '图片.png',
  url: 'https://example.com/image.png',
});
URL 应使用 HTTPS,且在课堂使用期间保持可访问。仅适合公开文件或已由业务方预签名、有效期足够的短时 URL。

3.2 使用业务文件标识换取 URL#

私有文件不要把地址、访问密钥或签名规则放入 info。应传入稳定的业务文件标识;SDK 需要加载文件时,会将原始 info 回调给 onGetExtFileNameFn,由宿主向业务服务端换取短时 URL。
PlasoElectronSdk.insertObject({
  type: FILE_TYPE.VIDEO,
  title: '讲解.mp4',
  info: ['file', { id: 'file-001' }],
});

onGetExtFileNameFn: async (info: any, option: any) => api.fetchSignedFileUrl(info),
成功返回完整可访问 URL;无权限、不存在、超时时 reject;
🔒 不在客户端保存 OSS 永久密钥,URL 应有有效期。
info 会在回调中原样回传。无论服务端请求结果如何,Promise 都必须完成:成功返回完整 URL,失败 reject。

4. 预解析文件接入#

预解析文件是业务服务端已完成转换的 PPT、PDF、Word 或 Excel。资料中心选择这类文件时,插入的不是文件 URL,而是解析文件 ID;SDK 按需通过 onGetPreParseFileNameFn 请求每个解析产物的短时 URL。
完整流程:
1.
业务服务端上传原始文件、创建解析任务,并在完成后保存解析文件 ID、类型、产物目录和页数。
2.
资料中心返回解析文件 ID、类型和页数。
3.
宿主将这些信息封装为 FileDataObj 并通过 insertObject 插入。
4.
SDK 回调 onGetPreParseFileNameFn(info, { suffix }) 请求页面或资源。
5.
宿主将解析文件 ID 和原始 suffix 提交业务服务端,服务端鉴权后返回该产物的短时 URL。

4.1 插入预解析文件#

通过 info 传入资源标识。PDF、Word 和 Excel 必须填写解析总页数到 totalPages。
type必填字段说明
FILE_TYPE.ISPRINGPPTinfo、title预解析 PPT(1.3.8+)
FILE_TYPE.PDFinfo、title、totalPages预解析 PDF
FILE_TYPE.DOC、FILE_TYPE.XLSinfo、title、totalPages预解析 Word / Excel
const { FILE_TYPE } = window.require('@plasosdk/plaso-electron-sdk');
PlasoElectronSdk.insertObject({
  type: FILE_TYPE.ISPRINGPPT,
  title: '课件.pptx',
  info: ['parsed', { id: 'ppt-001' }],
});
PlasoElectronSdk.insertObject({
  type: FILE_TYPE.PDF,
  title: '讲义.pdf',
  info: ['parsed', { id: 'pdf-001' }],
  totalPages: 12,
});
页数字段名必须是 totalPages。

4.2 预解析资源 URL 回调#

当 SDK 需要加载预解析文件的某一页、HTML 页面或元数据时,会调用:
onGetPreParseFileNameFn: async (info: any, option: { suffix: string }) =>
  api.fetchParsedFileUrl(info, option.suffix),
参数使用方式
infoinsertObject 传入的原值。可从中取出解析文件 ID。
option.suffixSDK 请求的解析产物相对路径,例如 /index.html、/info.json、/1.jpg。原样提交业务服务端。每个 suffix 调用一次,同一文件会多次调用。
返回值成功时返回完整的短时 URL;任何失败场景 reject。
该回调不是创建解析任务的入口,也不是客户端拼接 OSS 地址的位置。客户端只负责提取解析文件 ID,并把 fileId + suffix 请求业务服务端;服务端负责鉴权、校验 suffix、定位解析产物和签发 URL。
解析任务、回调和 URL 签发接口的详细约定见《文件预解析/Electron》和《服务端接口与协议/05-文档预解析》。

5. 和直播课堂、微课的关系#

直播课堂 / 极速课堂:创建窗口时传 classOptions.supportShowResourceCenter = true,并实现 onOpenResourceCenterFn;在 onClassWindowReadyFn 之后调用 insertObject;
微课:insertObject 同样适用于微课窗口,须在窗口就绪后调用;
非预解析与预解析文件:都从资料中心选择后插入,分别使用 onGetExtFileNameFn 与 onGetPreParseFileNameFn 换取私有资源 URL;
历史课堂:含预解析或以 info 方式插入的资源时,回放页也必须实现对应 URL 回调,见 历史课堂回放/Electron;以 url 方式插入的资源无需回调。

6. 联调检查清单#

supportShowResourceCenter 为 true 时课堂能显示入口。
onOpenResourceCenterFn 能打开资料中心,关闭后不会重复创建窗口。
公开文件能通过 url 直接加载。
私有文件能触发 onGetExtFileNameFn,并由 insertObject 正确插入;info 原样回传。
insertObject 仅在 onClassWindowReadyFn 之后调用。
预解析文件能使用正确的 info、type 和 totalPages 插入。
onGetPreParseFileNameFn 能按 suffix 返回短时 URL;异常时 reject。
URL 失败时 SDK 能结束等待并显示失败。
业务服务端没有把永久密钥下发到客户端。
课堂结束后资料中心窗口和网络请求已释放。
修改于 2026-11-17 07:47:57
上一页
iOS 资料中心接入
下一页
Web 资料中心接入
Built with