伯索开放平台
首页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. 服务端接口与协议

资料中心与文件 URL

本文定义 SDK 插入普通资源时的跨端协议。Android、iOS、Electron、Web SDK 和播放器 SDK 各端如何实现回调,以对应平台/能力文档为准。

1. 适用场景#

当客户需要在课堂中接入自有资料中心,或历史课堂播放时需要重新加载课堂中插入过的文件,就需要实现文件 URL 获取逻辑。
典型流程:
1.
老师点击课堂工具栏中的“资料中心”。
2.
SDK 回调业务方打开自有资料中心。
3.
用户选择文件。
4.
业务方调用 SDK 的插入资源方法,例如 Electron 的 PlasoElectronSdk.insertObject(fileObject)。
5.
若资源使用 url,SDK 直接访问该 URL。
6.
若资源使用 info,普通资源通过 getExtFileName 获取 URL,预解析资源通过 getPreParseFileName 获取 URL。
7.
SDK 使用返回的 URL 展示资源。
资料中心插入时序(sequenceDiagram)
资源可以有两种来源:
方式说明适用
url插入时直接给 SDK 一个可访问完整 URL长期公开可访问文件
info插入时给 SDK 一个业务标识,SDK 需要访问时回调业务方换取 URL私有文件、短时签名 URL、需要鉴权的文件
如果文件不是公开长期 URL,推荐使用 info 方式。

2. FileObject 通用字段#

不同端对象名略有差异,例如 iOS 为 UpimeFile,Electron 为 FileObject,但核心字段一致:
字段说明
type资源类型,取值以各端 SDK 枚举为准
title文件显示标题;建议带扩展名;gif 必须带 .gif,否则可能被当作 jpeg
url完整文件 URL,SDK 直接访问
info业务自定义资源标识,SDK 通过回调换取 URL
totalPages预解析 PDF/DOC/XLS 页数;预解析 PDF/DOC/XLS 场景必填
url 和 info 通常二选一。若都传,具体优先级以 SDK 当前版本为准;建议不要同时传,避免行为不清晰。

3. 普通资源插入示例#

图片:
{
  type: FILE_TYPE.IMAGE,
  title: '图片.png',
  url: 'https://example.com/image.png'
}

{
  type: FILE_TYPE.IMAGE,
  title: '图片.png',
  info: ['file', { id: 'image-001' }]
}
PPT:
{
  type: FILE_TYPE.PPT,
  title: '课件.pptx',
  url: 'https://example.com/demo.pptx'
}
音视频:
{
  type: FILE_TYPE.VIDEO,
  title: '视频.mp4',
  info: ['file', { id: 'video-001' }]
}
PDF:
{
  type: FILE_TYPE.PDF,
  title: '讲义.pdf',
  info: ['file', { id: 'pdf-001' }]
}
Word/Excel/DOC/XLS:
{
  type: FILE_TYPE.WORD,
  title: '资料.docx',
  url: 'https://example.com/demo.docx'
}
具体资源类型是否支持 url 或 info,以各端 SDK 当前版本为准。

4. 预解析资源插入示例#

预解析 PPT:
{
  type: FILE_TYPE.ISPRINGPPT,
  title: '课件.pptx',
  info: ['parsed', { id: 'ppt-001' }]
}
预解析 PDF:
{
  type: FILE_TYPE.PDF,
  title: '讲义.pdf',
  info: ['parsed', { id: 'pdf-001' }],
  totalPages: 12
}
预解析 DOC/XLS:
{
  type: FILE_TYPE.DOC,
  title: '资料.docx',
  info: ['parsed', { id: 'doc-001' }],
  totalPages: 12
}

5. 普通资源 URL 回调#

不同端命名略有差异,但语义一致:
平台回调
AndroidgetExtFileName(info, callback)
iOSgetExtFileName info, result
ElectrononGetExtFileNameFn(info)
播放器 SDKgetExtFileName(info)
回调流程:
1.
SDK 需要加载资源。
2.
SDK 把插入时传入的 info 原样回调给接入方。
3.
接入方客户端把 info 传给客户服务端。
4.
客户服务端校验权限并生成短时可访问 URL。
5.
客户端把 URL 返回给 SDK。

6. URL 要求#

必须是 SDK 所在运行环境可访问的完整 URL。
正式环境建议使用 HTTPS。
私有文件建议使用短时签名 URL。
URL 有效期应覆盖 SDK 当前加载过程,建议不少于数分钟。
不要把永久私有资源直接暴露为公开 URL。

7. 失败处理#

如果无法获取 URL:
Android 回调 onFilePath(null)。
iOS 回调空字符串或按 SDK 支持的失败值返回,并确保只回调一次。
Electron/Web Promise 应 reject 或返回空字符串,具体以 SDK 行为约定为准。
端侧必须设置请求超时,避免 SDK 一直等待资源 URL。

8. 预解析资源 URL 回调#

预解析资源包含多个解析产物,SDK 会按需多次回调,携带不同 suffix。
项说明
入参 info来自插入资源时的 info
入参 suffix当前要加载的解析产物路径,如 /info.json、/1.jpg、/index.html
返回值对应文件的公网可访问 URL 或短时签名 URL
预解析 URL 的服务端签发和 suffix 安全规则见《文档预解析》。

9. 历史课堂影响#

如果上课时通过 info 插入过文件,历史课堂播放时仍然需要获取这些文件的 URL。此时播放器必须使用 jssdk 接入,并实现 getExtFileName。纯 URL 接入无法处理这类资源回调。
修改于 2026-11-17 07:47:57
上一页
query 参数
下一页
文档预解析
Built with