伯索开放平台
首页
API文档SDK文档伯索官网
首页
API文档SDK文档伯索官网
  1. SDK接入
  • 产品介绍
    • 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. SDK接入

SDK 接入总览

本文是伯索云学堂 SDK 接入入口。文档按功能模块组织,每个模块下再区分 Android / iOS / Harmony / Electron / Web 等端。服务端协议目录承载跨端共用的完整字段和接口说明;Electron / Web 安装、版本与通用 FAQ 见《接入基础(Electron & Web)》。
若产品方案是把云学堂业务页面(课堂列表、巩固、资料中心等)整体嵌入自有 App / PC 应用,请优先阅读《云学堂模块化SDK/00-概述》及对应端文档;若需要以签名 query 驱动的课堂引擎能力,再按下方功能模块阅读。

1. 目录结构(功能 → 端)#

功能模块说明
实时课堂互动直播进课;Web 为监课
极速课堂低延迟课堂(query 含 d_lowLatencyClass=1)
微课微课录制与上传(Harmony 暂不支持)
资料中心自有资料插入课堂
文件预解析PPT/PDF/Word/Excel 预解析
历史课堂回放各端 WebView 嵌入 + 播放器
云学堂模块化SDK业务页 Token 嵌入(Android / iOS / Harmony / PC)
接入基础(Electron & Web)Electron / Web 快速开始、API、错误码;[SDK 更新日志](../资源与支持/产品更新记录/SDK 更新日志.md)
服务端接口与协议签名与鉴权、签名示例、query、资料中心、文档预解析、历史课堂回调、转视频

2. 功能与端矩阵#

能力AndroidiOSHarmonyElectronWeb播放器服务端协议
实时课堂AndroidiOSHarmonyElectronWeb 监课不适用签名、query
极速课堂AndroidiOSHarmonyElectron不提供不适用签名、query
微课AndroidiOS暂不支持(见 Harmony 说明)Electron不支持不适用签名、OSS
资料中心AndroidiOSHarmonyElectronWeb(仅查看)回放按需 URL 回调文件 URL 协议
文件预解析AndroidiOSHarmonyElectron见资料中心 Web回放按需 URL 回调文档预解析服务
历史课堂回放AndroidiOSHarmonyElectron使用播放器播放器概述、WebView 嵌入历史课堂数据回调
历史课堂转视频/下载后端后端后端后端后端不负责转视频与下载

3. 按角色阅读#

角色先读还需要读
Android 开发(课堂引擎)实时课堂/Android同目录下极速课堂、微课、资料中心、预解析、回放
Android 开发(模块化 SDK)云学堂模块化SDK/00-概述 → 01-AndroidDemo:YXTSDK-Android-Demo
iOS 开发(课堂引擎)实时课堂/iOS按需阅读其它功能模块的 iOS 文档
iOS 开发(模块化 SDK)云学堂模块化SDK/00-概述 → 02-iOSDemo:YXTSDK-iOS-Demo
Harmony 开发(课堂引擎)实时课堂/Harmony极速课堂、资料中心、预解析、回放;当前仅学生端,微课暂不支持
Harmony 开发(模块化 SDK)云学堂模块化SDK/00-概述 → 03-HarmonyDemo:YXTSDK-Harmony-Demo
PC 开发(模块化 SDK)云学堂模块化SDK/00-概述 → 04-PCnpm @plasosdk/client-sdk
Electron 开发(课堂引擎)接入基础(Electron & Web)/Electron/00-概述 → 01-快速开始按需阅读各功能模块下的 Electron.md
Web 监课接入基础(Electron & Web)/Web/00-概述 → 实时课堂/WebURL 接入为主
历史课堂播放器历史课堂回放/播放器/00-概述服务端 query、资料中心 URL 协议
后端开发服务端接口与协议/00-阅读顺序签名与鉴权、签名示例、query、资料中心、预解析、回调、转视频
产品/项目负责人本文各端「联调检查清单」

4. 按场景阅读#

4.1 只接实时课堂#

1.
后端准备 appId、appKey,实现服务端签名 query。
2.
阅读本端《实时课堂》文档的准备、安装、初始化和启动章节。
3.
联调进课、角色权限、音视频、录制和退出。
4.
如需课后数据,后端接入历史课堂数据回调。

4.2 接入自有资料中心#

1.
阅读对应端《资料中心》文档,开启资料中心入口。
2.
用户选择文件后,端侧调用 SDK 插入资源。
3.
私有文件由端侧实现资源 URL 回调,向业务服务端换取短时可访问 URL。
4.
规则以《资料中心与文件 URL》为准。

4.3 接入预解析课件#

1.
阅读对应端《文件预解析》;后端创建解析任务。
2.
接收解析完成回调,保存 taskId、targetPath 等。
3.
端侧插入预解析资源时传入资源标识,并在回调中返回带签名的产物 URL。
4.
全量 API 与 OSS 规则见《文档预解析》。

4.4 播放历史课堂#

1.
后端通过历史课堂数据回调获得 recordId 等。
2.
Web / Electron / 业务页使用《历史课堂回放/播放器》播放。
3.
Android / iOS / Harmony 通过 WebView / Web 嵌入播放页,见各端《历史课堂回放》与《历史课堂回放/播放器/03-移动端WebView嵌入》。
4.
含 info 方式插入的私有/预解析资源时,须用播放器 jssdk 并实现资源 URL 回调。

4.5 转视频与下载#

1.
后端阅读《历史课堂转视频与下载》,按平台导出 API 接入。
2.
提交任务、查询状态或接收回调,处理结果与失败重试。

5. 版本与依赖速查#

各端版本号不是同一套体系,不要互相替代:
模块依赖 / 版本说明
Android 课堂引擎cn.plaso:styleupime:1.68.110AndroidX、Java 17、minSdk >= 26;内嵌 Flutter,不能与宿主 Flutter 共存;须加 storage.googleapis.com/download.flutter.io;版本记录见 [SDK 更新日志](../资源与支持/产品更新记录/SDK 更新日志.md#android-课堂引擎)
iOS 课堂引擎Pod PlasoStyleUpime / PlasoUpimeSdkModule ~> 1.68.110iOS >= 12.0;内嵌 Flutter,不能与宿主 Flutter 共存;须 FLTEnableImpeller=false;[版本记录](../资源与支持/产品更新记录/SDK 更新日志.md#ios-课堂引擎)
Harmony 课堂引擎OHPM styleupime@1.68.100HarmonyOS >= 5.0(API >= 12);当前仅学生端;[版本记录](../资源与支持/产品更新记录/SDK 更新日志.md#harmony-课堂引擎)
Electron 课堂引擎npm @plasosdk/plaso-electron-sdk@1.3.20Electron 14.0.0 ~ 24.8.8;先读 接入基础(Electron & Web)/Electron
Web 监课styleupime/1.68.110/ 或 plaso_style_upime-1.68.110.js仅监课;接入基础(Electron & Web)/Web
播放器plaso_upime_player-1.72.402.js历史课堂回放;播放器概述
模块化 SDK · Androidcn.plaso:yxtsdk:2.0.21YXTSDK-Android-Demo
模块化 SDK · iOSPlasoFeaturedSDK 0.5.1 等YXTSDK-iOS-Demo
模块化 SDK · HarmonyOHPM yxtsdk@1.0.27YXTSDK-Harmony-Demo
模块化 SDK · PCnpm @plasosdk/client-sdk@3.1.0npm
说明:1.68.110(Web / Android / iOS StyleUpime)是课堂引擎版本;1.3.20 是 Electron 课堂引擎 npm 版本;1.72.402 是播放器独立版本线;模块化 SDK 为另一套版本线。互不等价。
修改于 2026-11-17 07:54:45
上一页
关键概念
下一页
Android 实时课堂接入
Built with