伯索开放平台
首页API文档SDK文档伯索官网
首页API文档SDK文档伯索官网
  1. Web SDK
  • 产品介绍
    • SDK简介
    • SDK支持的业务场景
    • 产品特色
  • 产品功能
    • 实时课堂功能介绍
    • 微课功能介绍
    • 作业批改功能介绍
    • 上传课件功能介绍
    • SDK后台功能介绍
  • 接入指引
    • SDK对接标准流程说明
    • 关键概念
  • 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播放器
  • 最佳实践
  • Open API帮助文档
    • Open API 主要功能
    • Open API集成常用场景
    • 数据字典
    • 接入须知
      • 调用流程
      • 在线调试
      • 通用错误码
    • 用户信息管理
      • 添加用户
      • 修改密码
      • 删除用户
      • 更新用户
      • 用户精确查询
      • 查询多个用户
      • 用户访问Token
      • 验证用户Token有效期
      • 批量添加用户
      • 恢复删除的用户
      • 随机分配课程顾问
      • 批量设置学生属性(是否跟随/是否加联)
    • 教材包管理
      • 查询机构教材包
      • 查询教材包内教材
      • 向学生分发教材包
    • 实时课堂管理
      • 创建实时课堂
      • 创建实时课堂(班)
      • 更新实时课堂
      • 更新实时课堂(班)
      • 删除实时课堂
      • 查询实时课堂列表
      • 更新实时课堂下听众用户
      • 获取实时课堂监控地址
      • 控制单个学员是否可以回看单次课
      • 获取单个课堂的回看地址
      • 删除单个历史课堂
      • 获取课堂考勤数据
      • 获取历史课堂信息
      • 获取历史课堂观看数据
      • 获取课堂互动信息
      • 获取课堂列表(新)
      • 获取实时课堂旁听链接
      • 获取极速直播推流地址
      • 获取课堂下板书图片
    • 班级管理
      • 创建班级
      • 更新班级
      • 删除班级
      • 查询班级列表
      • 向班级中添加学生
      • 从班级中移除学生
      • 更换学生所在班级
      • 老师列表中查询机构分校学科
      • 根据班级获取获取班级详情和人员信息
    • 学情数据
      • 获取学生课堂明细数据
      • 获取学生巩固明细数据
      • 获取学生测验明细数据
      • 获取学生辅导明细数据
      • 获取学生积分明细数据
    • 商城管理
      • 获取商品详情
      • 获取商品列表
      • 获取分校自定义商品栏目列表
      • 订单查询
      • 订单详情查询
    • 作业管理
      • 查询学生作业列表
      • 查询老师作业列表
    • 测验管理
      • 查询机构测评列表
      • 获取测评统计
      • 查询机构测验列表
      • 获取测验明细
    • 积分管理
      • 机构积分规则
      • 查下学生当前积分数
      • 查下机构每天的积分明细记录
    • 课程顾问
      • 新建课程顾问
      • 列表查询课程顾问
      • 更新课程顾问
      • 停用/启用课程顾问
      • 更新密码课程顾问
  • 产品更新记录
    • Open API 更新日志
    • SDK 更新日志
  • 常见问题
    • PPT制作事项
    • 课件常见问题与解决方法
    • 网络相关问题
    • 声音相关问题
    • 网络测速
  • 推荐
    • 浏览器推荐
    • 常见软件推荐
    • 教育硬件推荐
  • 历史课堂视频
    POST
  • 查询历史课堂
    POST
  1. Web SDK

接入预解析能力 (Web端)

技术原理#

预解析方案.jpg
1.
老师点击工具栏中的资料中心功能
2.
sdk 调用前端传入的 showResourceCenter 回调
3.
在 showResourceCenter 函数中,前端应展示资料中心页面/弹窗
4.
老师选择资料中心中准备好的预解析资源
5.
前端调用 sdk 实例的 insertObject 函数,向课堂中插入预解析资源
6.
sdk 调用 getPreParseFileName 函数,获取预解析资源的 URL 全地址,以加载预解析资源。由于一个预解析资源中包含多个文件,所以插入一个资源时,这个函数会被调用多次。
7.
前端向后端拿到全地址后,把全地址作为 getPreParseFileName 的返回值,返回给 sdk
8.
预解析资源所涉及文件 sdk 都拿到后,展示预解析资源

接入预解析能力#

接入预解析需要搞明白三个函数
直播 sdk 接入预解析:涉及 showResourceCenter、insertObject、getPreParseFileName 三个函数,对应上文时序图 1~8 点
播放器 sdk 接入预解析:涉及 getPreParseFileName 一个函数,对应上文时序图 6~8 点
下面详细讲解三个函数的作用

回调函数 showResourceCenter#

老师点击课堂中的“资料中心”按钮时,会触发该回调,见上文时序图第2步。
前端需要在该函数中写下展示资料中心的逻辑,如demo。
该回调函数需要在创建课堂时传入

实例函数 insertObject#

老师选择资料中心中的资源后,前端要向课堂中插入该资源,通过 sdk 的实例函数 insertObject实现
insertObject 函数可以用来插入普通资源,也可以用来插入预解析资源。各自的插入方法详见云盘接入文档、插入预解析资源demo、插入普通资源demo

回调函数 getPreParseFileName#

预解析资源中包含多个文件,sdk 需要得到几个关键文件的 URL 全地址并加载好后,才能将预解析资源展示出来。这个文件 URL 全地址就是通过回调函数 getPreParseFileName 获取的,见时序图第6步。
函数定义详见demo、云盘接入文档、直播SDK文档、Electron SDK文档、播放器SDK文档
该回调函数需要在创建课堂/播放器时传入

使用 JS-SDK#

预解析能力只支持 JS-SDK 方式接入 SDK
对照下表来检查代码中是否存在url接入方式,如果有,需要调整接入方式
⚠️ JS-SDK 是较为底层的接入方式,以 JS-SDK 方式接入的播放器没有进度条等播放控件,需要用户自己实现。实现方式可以参考 demo。
sdk平台接入方式支持预解析如何接入
直播sdkweb sdkurl×文档
js-sdk√文档
electron sdkjs-sdk√文档
播放器sdkweb sdkurl×文档
js-sdk√文档

JS-SDK demo#

为方便迁移到 JS-SDK 接入方式,此处提供了一些各场景下的 demo 供参考。

上课 (with 直播 sdk)#

web-sdk demo、electron-sdk demo

监课 (with 直播 sdk)#

demo

历史课堂播放 (with 播放器 sdk)#

demo

历史课堂录制 (导出mp4) (with 播放器 sdk)#

demo
历史课堂录制页面是给录制服务调用来实现录制的,为了配合录制服务,对页面实现有特殊要求:
需要提供一个单独的 html 页面供录制使用
录制服务打开该页面时,会传入 recordId 参数,告知前端页面要录制的是哪个课堂
前端页面需要读取该参数,加载对应的历史课堂
播放器应撑满页面
window.upimePlayReady。准备好播放后调用该方法
window.upimePlayStart。开始播放时调用该方法,通知服务端开始录制
window.upimePlayEnd。播放结束后调用该方法,通知服务端结束录制
window.plasoUpimePlayerController.play。函数定义为 () => void,请实现并暴露该方法,在方法中执行播放,服务端会调用该方法(详细流程见上文时序图)。
修改于 2025-11-11 07:17:04
上一页
云盘接入
下一页
快速接入
Built with