伯索开放平台
首页
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。完成以下步骤后,可通过服务端签发的 query 启动实时课堂。
要求值
最低系统版本iOS 12.0(与对外 Demo 一致)
推荐集成CocoaPods
PodPlasoStyleUpime、PlasoUpimeSdkModule、PlasoProgressHUD
入口 APIPlasoStyleUpimeClient.createLive(withQuery:)
先准备伯索分配的 appId、课堂服务地址,以及业务服务端提供的课堂 query 接口。线上课堂服务地址为 https://www.plaso.cn。正式环境中,appKey 只能保存在服务端,不能写入 App。
在 Podfile 中配置:
执行 pod install 后打开生成的 .xcworkspace。如果 Xcode 报 libarclite 错误,再提高当前 Target 的最低部署版本。

内嵌 Flutter(重要)#

课堂相关页面通过 PlasoUpimeSdkModule 内嵌 Flutter 交付(与 Android StyleUpime 同源能力),随 CocoaPods 以动态 Framework(use_frameworks! :linkage => :dynamic)链入。
项说明
引擎版本与 SDK 1.68.110 绑定;与 Android 侧内嵌引擎一致,对应 Flutter 3.22.3(以当前发版的 PlasoUpimeSdkModule 为准,升级 SDK 时引擎一并升级)
链接方式CocoaPods 动态 Framework,勿改为静态链接混用另一套 Flutter
与宿主 Flutter不能共存。宿主 App 若已使用 Flutter(自有 Flutter 工程 / 已嵌入另一套 Flutter Engine),无法接入本 SDK
ImpellerDemo / 正式接入须在 Info.plist 关闭 Impeller:FLTEnableImpeller = false(布尔)
接入前请确认对接方是原生 iOS 工程(Objective-C / Swift),不要在已有 Flutter 宿主上叠加本 SDK。
按实际能力在 Info.plist 声明权限:
权限 Key场景
NSCameraUsageDescription视频课堂、头像采集
NSMicrophoneUsageDescription音视频课堂
NSPhotoLibraryUsageDescription / NSPhotoLibraryAddUsageDescription上传或保存图片
NSBluetoothAlwaysUsageDescription / NSBluetoothPeripheralUsageDescription蓝牙手写板
NSLocalNetworkUsageDescription局域网连通性检测
FLTEnableImpeller设为 false,关闭 Impeller(内嵌 Flutter 要求)

使用对外 Demo 验证#

对外 Demo 下载地址:PlasoSdkIosSample。
下载并打开 Demo 后:
1.
在 Podfile 中确认依赖版本为 1.68.110,执行 pod install。
2.
修改 PlasoSdkDemoForiOS/AppConfig.swift 中的 appId 和 appKey,填入伯索分配的测试凭证:
3.
使用真机编译并运行 Demo,选择实时课堂进行验证。
Demo 为便于体验,会在客户端使用 appKey 生成签名。该做法仅限测试;生产 App 必须删除本地签名逻辑,由业务服务端保存 appKey 并生成课堂 query、窗口模式签名和微课上传签名。

2. 服务端生成课堂 query#

客户端向业务服务端提交课堂和用户信息,服务端按《服务端接口与协议/01-签名与鉴权》生成并返回完整 query。客户端不要修改服务端返回的已签名参数。
最小 query 必须包含以下字段。服务端将字段按签名规则生成 signature 后,客户端应原样传给 createLive(withQuery:)。
参数类型示例 / 取值说明
appIdStringyour-app-id伯索分配的应用标识。
appTypeStringliveclassSDK实时课堂固定值。
validBeginLongInt(Date().timeIntervalSince1970)签名生效时间,Unix 秒级时间戳。
validTimeInt10800query 有效期,单位秒;由业务服务端按安全策略设置。
signatureString服务端生成对 query 参数生成的签名值;客户端不能生成、修改或拼接该字段。
meetingIdStringclass-001课堂唯一 ID;建议仅使用 ASCII 字符,不包含 /、\ 或空格,长度不超过 40 字节。
meetingTypeStringpublic课堂类型;通常使用 public,会议模式按业务能力传入 meeting。
mediaTypeStringvideo课堂媒体类型:audio 或 video。
loginNameStringteacher-001当前用户唯一 ID;同一 loginName 重复进入会顶掉前一个登录。
userNameString张老师当前用户在课堂内展示的昵称。
userTypeStringspeaker用户角色:speaker 主讲、assistant 助教、listener 听众。
d_dimensionString1280x720课堂分辨率,推荐固定为 1280x720。
Demo 常见附加字段包括 beginTime、endTime、topic、onlineMode、d_sharpness、enableNewClassExam、d_enableObjectEraser 和 d_lowLatencyClass;其中 enableNewClassExam 取值 0/1/2/3(不支持 / 选择题 / 填空题 / 两者,见 query 专文),d_lowLatencyClass=0 关闭极速课堂、=1 开启。仅在业务需要时加入,并一并参与服务端签名。极速课堂的完整接入流程见《极速课堂/iOS》。
完整字段、取值和签名规则见《服务端接口与协议/03-query参数》。

3. 启动课堂#

在获得服务端返回的 query 后创建课堂 VC 并展示:
createLive(withQuery:) 的 query 必填。除下表明确标识为必填的字段外,均可按需配置;未赋值时使用 SDK 默认值。
必须实现页面关闭回调;SDK 不主动关闭业务侧的导航或 present 栈:
课堂就绪后可插入资料:
窗口模式等需要二次签名时,实现:

3.1 对外课堂配置参数#

以下为当前对外支持的 UpimeLiveProtocol / UpimeEditorProtocol 配置项。Demo 或 SDK 源码中的其他字段属于内部实现、实验能力或由服务端控制,不作为对外集成配置使用。
参数类型默认值说明
queryString-必填。通过 createLive(withQuery:) 传入的服务端完整签名 query;不要在客户端修改其中任意参数。
userNameString-当前用户名称;通常与 query 中的 userName 保持一致。
members[UpimeUser]-预传课堂成员列表。
supportLocalFileBooltrue是否允许在课堂中插入本地文件。
enableUserVisibleBoolfalse为 true 时,UpimeUser.hidden 生效。
endRemindTimeInt0下课提醒时间,单位秒;不传表示不提醒。
redPacketLimitInt320红包雨数量上限;大于 0 时生效。
defaultPermissionInt320会议模式默认权限。
openFileModeUpimeOpenFileMode.picture文件打开模式:.picture 图片、.window 窗口。
toolBoxTypesPureUpimeToolBoxType.none百宝箱工具位掩码;.all 为全部工具。
enableInteractPPTBoolfalse是否开启交互 PPT。
teachToolTypesPureUpimeTeachToolType0教具位掩码。
supportUndoBoolfalse是否支持撤销。
useNewSmallboardBoolfalse是否使用新版小黑板。
supportHighlighterBoolfalse是否支持荧光笔。
shouldForbiddenScreenShotBoolfalse是否禁止截屏。
enableVoteBoolfalse是否支持投票工具。
enableSaveBoardBoolfalse是否开启保存板书。
chatAlertConfigUInt0学生端消息弹框:0 使用本地记录,1 远端开启,2 远端关闭;教师不受影响。
enableCtlANSBooltrue是否开启降噪。
enableStarShowBoolfalse是否显示积分排行榜。
recordingPreparationTipString?nil服务端录制开始前的延时提示文案。
hideRecordingIndicatorBoolfalse是否隐藏课堂中的“录制中”状态。
showStudentClassElapsedTimeBoolfalse学生端是否显示已开课时长。
supportCloudBoxBool-是否显示资料中心入口;开启后需实现 upimeShowCloudDisk。
enableBrowserBool-是否显示浏览器工具。

4. 可选配置#

在启动课堂前可设置水印、日志和违禁词:

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

课堂页面中的资料中心、普通私有文件和预解析文件都使用 UpimeDelegate / UpimeEditorDelegate 回调:
自有资料中心:supportCloudBox = true,并实现 upimeShowCloudDisk(_:checkAi:);
非预解析私有文件:upimeVC(_:getExtFileName:result:);
预解析文件:upimeVC(_:getPreParseFileName:suffix:result:);
失败时必须回调空字符串 "",不能让 SDK 一直等待。
完整的资料中心插入、非预解析文件和预解析文件接入流程见:
《资料中心/iOS》
《文件预解析/iOS》

6. 联调检查#

Pod 安装、签名配置和真机编译通过;Info.plist 已设 FLTEnableImpeller=false。
宿主为原生 iOS 工程,未与自有 Flutter 混用。
所需系统权限已声明并能正常授权。
服务端 query 能通过验签,且 validBegin 为 Unix 秒级时间戳。
主讲、助教和听众以预期权限进入课堂。
课堂正常退出,upimeVCOnClosed 已恢复业务页面,并按需调用 dispose()。
使用私有资料或预解析课件时,已实现对应 URL 回调。
修改于 2026-11-17 07:47:57
上一页
Harmony 实时课堂接入
下一页
Electron 实时课堂接入
Built with