伯索开放平台
首页API文档SDK文档伯索官网
首页API文档SDK文档伯索官网
  1. Web SDK
  • 历史课堂数据回调接入
  • 签名示例
  • 历史课堂转视频接入方式
  • 历史课堂/微课下载接口
  • query参数说明
  • 文档解析接口
  • SDK预解析服务接入说明
  • 「伯索云学堂」跳转接入指南
  • Web SDK
    • PlasoStyleUpime API说明
    • 云盘接入
    • 接入预解析能力 (Web端)
    • 直播SDK
      • 快速接入
    • 微课SDK
      • 快速接入
    • 批注SDK
      • 快速接入
  • Electron SDK
    • 快速接入
  • Android SDK
    • 直播SDK
      • 快速接入
    • 微课SDK
      • 快速接入
    • 批注SDK
      • 快速接入
  • iOS SDK
    • 直播SDK
      • 快速接入
    • 微课SDK
      • 快速接入
    • 批注SDK
      • 快速接入
  • 播放器SDK
    • Web播放器
首页API文档SDK文档伯索官网
首页API文档SDK文档伯索官网
  1. Web SDK

云盘接入

demo#

Web SDK:https://github.com/PlasoOpenPlatform/PlasoSdkPcSample/blob/main/live/web/live.js
Electron SDK:https://github.com/PlasoOpenPlatform/PlasoSdkPcSample/blob/main/live/electron/render/app.js
播放器 SDK:https://github.com/PlasoOpenPlatform/PlasoSdkPcSample/blob/main/player/player.js

流程#

直播:客户端在创建sdkClient时,传入showResourceCenter回调函数,实时课堂speaker/assitant角色界面、微课界面会增加“资料中心”按钮,点击工具栏的文件图标后显示。点击该按钮后会执行showResourceCenter回调函数。客户端可以在sdk界面上层显示资料中心窗口,当用户选择资源后,客户端再调用sdkClient.insertObject方法将资料中心的资源以fileObject的结构插入sdk。插入的资源需要拿取资源文件的URL地址来加载,普通资源会调用getExtFileName来获取URL,预解析资源会调用getPreParseFileName来获取URL。
播放器:历史课堂的内容如果包含上课时通过insertObject插入ppt、音视频等资源,那么播放时需要调用getExtFileName(对于普通资源)或者getPreParseFileName(对于预解析资源)来获取资源文件URL以加载

关键函数#

showResourceCenter#

在创建课堂时传入该回调函数,上课时在文件选择处会多出一个“资料中心”按钮,点击该按钮后会触发此回调,见上文时序图第2步。
在这个回调中可以打开自己的云盘,选择云盘中的文件,调用 insertObject 方法插入云盘文件,如Web SDK demo、Electron SDK demo
注:Electron SDK的相关参数略有不同,它是通过supportShowResourceCenter和onOpenResourceCenterFn控制的,详见Electron SDK 文档

insertObject#

老师选择资料中心中的资源后,前端要向课堂中插入该资源,通过 sdk 的实例函数 insertObject 实现

FileObject 定义#

type —— 资源类型
可选值见上文 FILE_TYPE
请引用 PlasoStyleUpime.FILETYPE (Electron SDK 为 window.require('@plasosdk/plaso-electron-sdk').FILE_TYPE) 里的暴露的枚举对 type 属性进行赋值
title —— 资源名称
传入后会显示在文件窗口标题栏上
默认名称为文件类型
建议带上扩展名后缀。如果是 gif 图必须带上 .gif 后缀,否则会被当做 jpeg 图
url 或 info —— 资源信息
传 url 或 info,二选一。如果两个都传,url 属性会被忽略
url
值为资源文件 URL 全地址
SDK 内部会直接访问该地址以获取资源文件,所以使用此种方法需要公开 URL 地址访问权限
建议使用 https 协议的全地址
info
值为用数组表示的资源信息,数组的内容由 SDK 用户自行定义
SDK 内部会通过调用 SDK 用户传入的 getExtFileName / getPreParseFileName 回调来拿到文件全地址,所以此种方法适用于插入的资源文件有签名时效(每次访问资源文件时,文件地址都是在回调函数里动态获取、经过签名的)
涉及场景。保证直播课堂的老师端/学生端、历史课堂、微课里调用的 getExtFileName / getPreParseFileName 回调都正确返回文件的有效路径
选择限制。插入的资源类型对 url 和 info 的选用也是有限制的。比如,某类型资源只能通过 url 方式插入,某类型资源只能通过 info 方式插入,某类型两者都支持。具体用法不用多虑,直接参考下文列举的各类型资源 obj 的写法和注释说明即可。
totalPages - 预解析结果的页数
插入预解析 PDF/DOC/XLS 时需要提供该字段,否则不会被识别成预解析资源

FileObject 示例 (插入普通资源)#

FileObject 示例 (插入预解析资源)#

getExtFileName#

当以info方式插入(即fileObject中用了info字段),且插入的是普通资源时,sdk会回调这个接口,拿资源文件的全地址
info参数:来自insertObject(obj)的obj.info,详见上文insertObject章节
返回值:可访问的可下载文件路径(公网地址)

getPreParseFileName#

当以info方式插入(即fileObject中用了info字段),且插入的是预解析资源时,sdk会回调这个接口,拿资源文件的全地址
info参数:来自insertObject(obj)的obj.info,详见上文insertObject章节
suffix:预解析资源中包含多个文件,sdk 需要得到几个关键文件的 URL 全地址并加载好后,才能将预解析资源展示出来。这个文件 URL 全地址就是通过回调函数 getPreParseFileName 获取的。那么要加载预解析资源中具体哪一个文件,通过 suffix 来表明,如,'/info.json'、'data/img1.png'。
返回值:可访问的可下载文件路径(公网地址)
修改于 2025-11-14 01:14:57
上一页
PlasoStyleUpime API说明
下一页
接入预解析能力 (Web端)
Built with