伯索开放平台
首页API文档SDK文档
伯索官网
首页API文档SDK文档
伯索官网
  1. 实时课堂
  • 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 接入
    • 伯索云学堂跳转接入
  • 接入基础(Electron & Web)
    • Web
      • Web 概述
      • Web 快速开始:URL 接入监课
      • Web 初始化与配置(监课)
      • Web API 参考(监课)
      • Web 事件与回调(监课)
      • Web 错误码(监课)
      • Web 常见问题(监课)
    • Electron
      • Electron 概述
      • Electron 快速开始
      • Electron 初始化与配置
      • Electron API 参考
      • Electron 事件与回调
      • Electron 错误码
      • Electron 常见问题
  • 服务端接口与协议
    • 服务端接口与协议阅读顺序
    • 签名与鉴权
    • 签名示例
    • query 参数
    • 资料中心与文件 URL
    • 文档预解析
    • 课堂进行中数据回调
    • 课堂结束数据回调
    • 历史课堂转视频与下载
  1. 实时课堂

Android 实时课堂接入

1. 快速接入#

本文适用于 cn.plaso:styleupime:1.68.110。完成以下步骤后,可通过服务端签发的 query 启动实时课堂。
要求值
最低系统版本minSdkVersion >= 26
目标系统版本targetSdkVersion >= 33
JavaJava 17
支持库AndroidX
先准备伯索分配的 appId、课堂服务地址,以及业务服务端提供的课堂 query 接口。线上课堂服务地址为 https://www.plaso.cn。正式环境中,appKey 只能保存在服务端,不能写入 APK。
在项目仓库和 App 模块中配置:
仓库 必须 配置 https://storage.googleapis.com/download.flutter.io。StyleUpime 通过 Maven 拉取内嵌 Flutter 引擎与 flutter_release 模块,缺少该源会导致依赖无法解析。

内嵌 Flutter(重要)#

课堂 UI(含实时课堂 / 极速课堂 / 微课相关页面)以内嵌 Flutter 模块交付,不是可选插件。
项说明
引擎版本随 styleupime:1.68.110 固定;当前对应 Flutter 3.22.3(引擎 commit 235db911ba279722f5e685f38b0ed30fa7e8570a,以 Maven 坐标 io.flutter:*:1.0.0-<engineHash> 为准)
链接方式Maven AAR:cn.plaso.upime_sdk_module:flutter_release + io.flutter 各 ABI / embedding 产物,随 implementation 'cn.plaso:styleupime:…' 传递依赖引入
与宿主 Flutter不能共存。宿主 App 若已使用 Flutter(自有 Flutter 工程 / 已嵌入另一套 Flutter Engine),无法接入本 SDK;两套引擎与符号会冲突
接入前请确认对接方是原生 Android 工程(Java/Kotlin),不要在已有 Flutter 宿主上叠加本 SDK。
如果工程仍使用 Android Support Library,先迁移到 AndroidX。为支持课堂截图保存,在 AndroidManifest.xml 的 <application> 中加入:
<meta-data
    android:name="ScopedStorage"
    android:value="true" />

权限#

实时课堂依赖麦克风、摄像头、蓝牙音频与通知。SDK AAR 会合并部分 Manifest 权限,宿主仍须在 App AndroidManifest.xml 中声明下列项,并在进课前完成危险权限的运行时申请。
<!-- 网络 -->
<uses-permission android:name="android.permission.INTERNET" />
<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />
<uses-permission android:name="android.permission.ACCESS_WIFI_STATE" />

<!-- 麦克风 / 摄像头(危险权限,须运行时申请) -->
<uses-permission android:name="android.permission.RECORD_AUDIO" />
<uses-permission android:name="android.permission.CAMERA" />
<uses-permission android:name="android.permission.MODIFY_AUDIO_SETTINGS" />

<!-- 蓝牙(耳机 / 音频路由;Android 12+ 的 CONNECT 须运行时申请) -->
<uses-permission android:name="android.permission.BLUETOOTH" android:maxSdkVersion="30" />
<uses-permission android:name="android.permission.BLUETOOTH_CONNECT" />

<!-- 通知(Android 13+ 须运行时申请) -->
<uses-permission android:name="android.permission.POST_NOTIFICATIONS" />

<!-- 前台服务;Android 14+ 麦克风类型前台服务须声明 MICROPHONE -->
<uses-permission android:name="android.permission.FOREGROUND_SERVICE" />
<uses-permission android:name="android.permission.FOREGROUND_SERVICE_MICROPHONE" />
权限用途说明
RECORD_AUDIO上课发言 / 录制危险权限,进课前申请
CAMERA视频上课危险权限,进课前申请
BLUETOOTH / BLUETOOTH_CONNECT蓝牙耳机等音频设备CONNECT 自 Android 12 起为运行时权限
POST_NOTIFICATIONS课堂相关通知自 Android 13 起为运行时权限
FOREGROUND_SERVICE / FOREGROUND_SERVICE_MICROPHONE麦克风前台服务Android 14+ 使用麦克风类型前台服务时必声明
未授予麦克风或摄像头时,进课后对应音视频能力不可用;未授予通知权限时可能收不到课堂相关通知。

使用对外 Demo 验证#

对外 Demo 下载地址:PlasoSdkAndroidSample。
下载并打开 Demo 后:
1.
在 Demo 的 app/build.gradle 中确认依赖版本为 cn.plaso:styleupime:1.68.110。
2.
修改 app/src/main/java/cn/plaso/liveclasssdkdemo/Config.kt 中的 appId 和 appKey,填入伯索分配的测试凭证:
3.
编译并运行 Demo,选择实时课堂或微课功能进行验证。
Demo 为便于体验,会在 DemoApp.kt、实时课堂和微课示例中使用 Config.appKey 生成签名。该做法仅限测试;生产 App 必须删除本地签名逻辑,由业务服务端保存 appKey 并生成课堂 query、窗口模式签名和微课上传签名。

2. 初始化 SDK#

StyleUpime 必须使用非空的 IResourceProvider 创建。未使用资料中心或预解析能力时,也要立即回调失败,避免 SDK 一直等待。
StyleUpime.create 的第二个参数是伯索分配的 appId,必须与服务端签名 query 中的 appId 一致。
资料中心、普通私有文件和预解析文件的回调实现分别见《资料中心/Android》和《文件预解析/Android》。

3. 服务端生成课堂 query#

客户端向业务服务端提交课堂和用户信息,服务端按《服务端接口与协议/签名与鉴权》生成并返回完整 query。客户端不要修改服务端返回的已签名参数。
最小 query 必须包含以下字段。服务端将字段按签名规则生成 signature 后,客户端应原样传给 ClassConfig.classURL。
参数类型示例 / 取值说明
appIdStringyour-app-id伯索分配的应用标识;必须与 StyleUpime.create 的第二个参数一致。
appTypeStringliveclassSDK实时课堂固定值。
validBeginLongSystem.currentTimeMillis() / 1000签名生效时间,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、onlineMode、d_sharpness、enableNewClassExam、d_enableObjectEraser 和 d_lowLatencyClass;其中 enableNewClassExam 取值 0/1/2/3(不支持 / 选择题 / 填空题 / 两者,见 query 专文),d_lowLatencyClass=0 关闭极速课堂、=1 开启。仅在业务需要时加入,并一并参与服务端签名。极速课堂的完整接入流程见《极速课堂/Android》。
完整字段、取值和签名规则见《服务端接口与协议/query参数》。

4. 启动课堂#

在获得服务端返回的 query 后创建 ClassConfig 并启动课堂:
classURL 和 host 必填。除下表明确标识为必填的字段外,均可按需配置;未赋值时使用 SDK 默认值。

4.1 对外 ClassConfig 参数#

以下为当前对外支持的 ClassConfig 配置项。Demo 或 SDK 源码中的其他字段属于内部实现、实验能力或由服务端控制,不作为对外集成配置使用。
参数类型默认值说明
classURLString-必填。服务端生成的完整签名 query;不要在客户端修改其中任意参数。
hostString-必填。线上课堂服务地址为 https://www.plaso.cn。
userNameString-当前用户名称;通常与 query 中的 userName 保持一致。
classMemberArrayList<User>-预传课堂成员列表。
allowLocalPPTBooleantrue是否允许在课堂中插入本地 PPT。
hideOtherClientBooleanfalse是否隐藏不在当前班级的学生和助教。
endRemindTimeInt0下课提醒时间,单位秒。
redPacketLimitInt0红包雨数量上限;大于 0 时生效。
defaultPermissionInt0会议模式默认权限。
openFileModeInt0文件打开模式:OPEN_FILE_MODE_IMAGE=0、OPEN_FILE_MODE_WINDOW=1、OPEN_FILE_MODE_SELECTABLE=2。
toolboxItemsInt127百宝箱工具位掩码,使用 UpimeConfig.ToolBoxItem 组合;ALL.value 为全部工具。
enableInteractPptBooleanfalse是否开启交互 PPT。
teachToolTypesInt0教具位掩码,使用 UpimeConfig.TeacherToolType 组合;PureUpimeTeachToolTypeAll.value 为全部教具。
supportUndoBooleanfalse是否支持撤销和反撤销。
useNewSmallBoardBooleanfalse是否使用新版小黑板。
supportHighlighterBooleanfalse是否支持荧光笔。
forbiddenScreenShotBooleanfalse是否禁止截屏。
enableVoteBooleanfalse是否支持投票工具。
enableSaveBoardBooleanfalse是否开启保存板书;开启后必须在 onUpimeBoardSaved 中保存数据并完成回调。
chatMsgPopupInt0学生端消息弹框:0 使用本地记录,1 远端开启,2 远端关闭;教师不受影响。
enableAnsBooleantrue是否开启降噪。
enableStarShowBooleanfalse是否显示积分排行榜。
recordingPreparationTipString-服务端录制开始前的延时提示文案。
hideRecordingIndicatorBooleanfalse是否隐藏课堂中的“录制中”状态。
showStudentClassElapsedTimeBooleanfalse学生端是否显示已开课时长。

5. 可选配置#

在启动课堂前可设置水印、日志和违禁词:
logLevel 分别为 DEBUG=0、INFO=1、WARN=2、ERROR=3;默认值为 -1。水印还可通过 waterMarkOpacity(0.0-1.0)设置透明度,通过 waterMarkDynamic 开启动态水印。

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

课堂页面中的资料中心、普通私有文件和预解析文件都使用 IResourceProvider 回调:
自有资料中心:supportResourceCenter、showResourceCenter、dismissResourceCenter;
非预解析私有文件:getExtFileName(info, callback);
预解析文件:getPreParseFileName(info, suffix, callback);
失败时必须调用 onFilePath(null),不能让 SDK 一直等待。
完整的资料中心插入、非预解析文件和预解析文件接入流程见:
《资料中心/Android》
《文件预解析/Android》

7. 联调检查#

依赖、AndroidX、Java 17 和 Manifest 配置完成,真机可启动;已配置 download.flutter.io。
宿主为原生 Android 工程,未与自有 Flutter 混用。
已声明并按系统版本申请 RECORD_AUDIO、CAMERA、蓝牙、POST_NOTIFICATIONS;Android 14+ 已声明 FOREGROUND_SERVICE_MICROPHONE。
服务端 query 能通过验签,且 validBegin 为 Unix 秒级时间戳。
主讲、助教和听众以预期权限进入课堂。
课堂正常退出,onExited 已恢复业务页面。
使用私有资料或预解析课件时,已实现对应 URL 回调。
修改于 2026-11-18 03:45:46
上一页
SDK 接入总览
下一页
Harmony 实时课堂接入
Built with