| 项 | 说明 |
|---|---|
| SDK 版本 | @plasosdk/plaso-electron-sdk ≥ 1.3.18 |
| 依赖 | @plasosdk/plaso-electron-sdk、@electron/remote |
| 接入性质 | 可选能力 |
| 入口 | supportShowResourceCenter、insertObject、onOpenResourceCenterFn、onGetExtFileNameFn |
onOpenResourceCenterFn、onGetExtFileNameFn 实现(若使用预解析资源,还需实现 onGetPreParseFileNameFn);classOptions.supportShowResourceCenter = true,此时不显示入口,也不会触发 onOpenResourceCenterFn。若仍会插入以 info 方式提供的私有文件或预解析文件,对应 URL 回调仍需实现。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)。appKey、OSS 私钥或永久下载地址放入客户端;info 只作为业务文件标识,服务端负责鉴权。onClassWindowReadyFn 之后调用 insertObject。const { FILE_TYPE } = window.require('@plasosdk/plaso-electron-sdk');
PlasoElectronSdk.insertObject({
type: FILE_TYPE.PDF,
title: '文件展示名称',
// url 与 info 二选一
});FILE_TYPE | 值 | 适用文件 |
|---|---|---|
PPT | 1 | 普通 PPT |
IMAGE | 2 | 图片 |
PDF | 3 | |
WORD | 4 | 普通 Word |
EXCEL | 5 | 普通 Excel |
AUDIO | 6 | 音频 |
VIDEO | 7 | 视频 |
insertObject 的参数为 FileDataObj:| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
type | number | 是 | 使用 SDK 导出的 FILE_TYPE |
title | string | 否 | 显示在文件窗口标题栏,建议带扩 展名;GIF 必须带 .gif |
url | string | 否 | 公开可访问的完整地址(建议 HTTPS) |
info | any[] | 否 | 业务自定义资源标识,回调中原样回传 |
totalPages | number | 否 | 预解析 PDF/DOC/XLS 的总页数 |
url 与 info 二选一;同时传入时以 info 为准,url 会被忽略。预解析类型见 §4。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',
});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),info 会在回调中原样回传。无论服务端请求结果如何,Promise 都必须完成:成功返回完整 URL,失败 reject。onGetPreParseFileNameFn 请求每个解析产物的短时 URL。FileDataObj 并通过 insertObject 插入。onGetPreParseFileNameFn(info, { suffix }) 请求页面或资源。suffix 提交业务服务端,服务端鉴权后返回该产物的短时 URL。info 传入资源标识。PDF、Word 和 Excel 必须填写解析总页数到 totalPages。type | 必填字段 | 说明 |
|---|---|---|
FILE_TYPE.ISPRINGPPT | info、title | 预解析 PPT(1.3.8+) |
FILE_TYPE.PDF | info、title、totalPages | 预解析 PDF |
FILE_TYPE.DOC、FILE_TYPE.XLS | info、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。onGetPreParseFileNameFn: async (info: any, option: { suffix: string }) =>
api.fetchParsedFileUrl(info, option.suffix),| 参数 | 使用方式 |
|---|---|
info | insertObject 传入的原值。可从中取出解析文件 ID。 |
option.suffix | SDK 请求的解析产物相对路径,例如 /index.html、/info.json、/1.jpg。原样提交业务服务端。每个 suffix 调用一次,同一文件会多次调用。 |
| 返回值 | 成功时返回完整的短时 URL;任何失败场景 reject。 |
fileId + suffix 请求业务服务端;服务端负责鉴权、校验 suffix、定位解析产物和签发 URL。classOptions.supportShowResourceCenter = true,并实现 onOpenResourceCenterFn;在 onClassWindowReadyFn 之后调用 insertObject;insertObject 同样适用于微课窗口,须在窗口就绪后调用;onGetExtFileNameFn 与 onGetPreParseFileNameFn 换取私有资源 URL;info 方式插入的资源时,回放页也必须实现对应 URL 回调,见 历史课堂回放/Electron;以 url 方式插入的资源无需回调。supportShowResourceCenter 为 true 时课堂能显示入口。onOpenResourceCenterFn 能打开资料中心,关闭后不会重复创建窗口。url 直接加载。onGetExtFileNameFn,并由 insertObject 正确插入 ;info 原样回传。insertObject 仅在 onClassWindowReadyFn 之后调用。info、type 和 totalPages 插入。onGetPreParseFileNameFn 能按 suffix 返回短时 URL;异常时 reject。