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

iOS 微课接入

1. 快速接入#

本文适用于 PlasoStyleUpime / PlasoUpimeSdkModule 1.68.110。完成本文后,App 可以创建微课、保存草稿、预览、上传和删除微课。
要求值
最低系统版本iOS 12.0
推荐集成CocoaPods
PodPlasoStyleUpime、PlasoUpimeSdkModule、PlasoProgressHUD
入口 APIPlasoStyleUpimeClient.createRecorder(withPath:)
准备伯索分配的 appId、微课草稿本地目录和业务服务端签名接口。正式环境中,appKey 只能保存在服务端,不能写入 App。
在 Podfile 中配置:
StyleUpime 内嵌 Flutter,与宿主自有 Flutter 不能共存;须设置 FLTEnableImpeller=false。详见《实时课堂/iOS》「内嵌 Flutter」。
使用对外 Demo 验证时,下载 PlasoSdkIosSample,在 AppConfig.swift 填入测试用 appId 和 appKey。Demo 的本地签名仅限测试;生产 App 必须改为服务端签名。

2. 启动前准备#

创建微课前为每份微课分配独立、可读写的草稿目录。若要插入私有文件或预解析 PPT/PDF/Word/Excel,请按《资料中心/iOS》实现资料中心、普通资源和预解析资源回调。
如需管理草稿列表,可先初始化客户端:

3. 创建或继续编辑微课#

createRecorder(withPath:) 支持新建微课和从草稿继续编辑。path 必须指向可读写的本地目录。

3.1 UpimeRecordProtocol 参数#

以下参数与对外微课接入保持一致;不包含 Demo 或 SDK 源码中的内部扩展字段。
参数类型必填默认值说明
pathString是-通过 createRecorder(withPath:) 传入的草稿和微课资源目录
defaultRecordNameString?否-课程名称
openFileModeUpimeOpenFileMode否-文件打开模式
supportDraftBool否true是否允许保存草稿
enableInteractPPTBool否false是否开启交互 PPT
teachToolTypesPureUpimeTeachToolType否0教具配置
supportUndoBool否false是否支持撤销
recordTypePureUpimeRecordType否-.audio 音频微课,.video 视频微课
supportHighlighterBool否false是否支持荧光笔
litModeUInt否0点擦为 0;对象擦取值 1/3/5/7
supportCloudBoxBool否-是否显示资料中心入口
delegateUpimeRecordDelegate是-录制代理

3.2 回调#

回调用途
miniLessonReadyWithEvent页面就绪;可插入资料
upimeShowCloudDisk(_:checkAi:)点击资料中心,打开业务资料中心
didSavedDraftWithInfo保存草稿,落库并记录本地路径
getSignQueryByParamsSDK 请求签名 query;由服务端完成签名
didFinishWithInfo录制完成,获取微课信息
uploadProgess / uploadDidFinish上传进度与完成
upimeVCOnClosed页面退出
正式环境的签名应由服务端完成,客户端只回传服务端生成的 query。

4. 后续流程#

4.1 预览微课#

保存的微课可以通过本地路径预览:

4.2 上传微课#

SDK 提供 uploadRecord(_:delegate:) 上传微课目录。didFinishWithInfo 返回 UpimeRecordInfo 后,先保存其 recordId 和本地路径,再请求业务服务端获取上传所需的签名 query 和可选的 OSS 临时凭证。
signedQuery 必须包含 recordId、appId、op=2、validBegin、validTime 和 signature。上传到自有对象存储时,ossToken 使用服务端签发的临时 keyId、keySecret、stsToken、bucket、path、region 和 provider;不要下发长期密钥。
上传结果中 0 表示成功;1 为签名校验失败,2 为网络异常,3 为微课内容无效,4 为其他异常,98 为 OSS Token 无效。autoDelete 默认可保持 false,建议在业务侧确认上传结果已持久化后再清理本地目录。

4.3 删除微课#

编辑状态或录制状态的微课使用客户端草稿接口删除:
已上传资源应按业务 OSS 策略单独删除,避免误删远端微课。

5. 可选能力:资料中心和预解析#

微课页面中的资料中心、普通文件和预解析文件与直播课堂使用同一套回调契约:
自有资料中心:supportCloudBox、upimeShowCloudDisk;
普通私有文件:getExtFileName;
预解析文件:getPreParseFileName;
失败时必须回调空字符串,不能让 SDK 一直等待。
完整字段和服务端时序见:
《资料中心/iOS》
《文件预解析/iOS》

6. 联调检查#

Pod 安装、编译和真机运行正常。
新建微课可进入编辑页面。
草稿可保存并再次打开。
didFinishWithInfo 能拿到微课信息。
本地微课可预览。
上传凭证过期时有明确失败处理。
删除草稿不会误删已上传资源。
插入私有文件时能触发 URL 回调。
微课页面退出后资源和回调已释放。
修改于 2026-11-17 07:47:57
上一页
Harmony 微课接入
下一页
Electron 微课接入
Built with