伯索开放平台
首页
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. 实时课堂

Harmony 实时课堂接入

Harmony SDK 使用 OHPM 包 styleupime@1.68.100,当前仅支持学生端实时课堂。服务端 query 必须使用 userType=listener;不支持老师端、助教端和微课。历史课堂回放不在本 SDK 内,App 可通过 Web 嵌入前端播放器,见《历史课堂回放/Harmony》。

1. 快速接入#

要求值
HarmonyOS>= 5.0(API >= 12)
DevEco Studio>= 5.0
开发语言ArkTS
在根目录 build-profile.json5 设置 compatibleSdkVersion >= 5.0.0(12),并在 .ohpmrc 将伯索仓库置于首位:
在 entry/oh-package.json5 添加依赖后执行 ohpm install:
{
  "dependencies": {
    "styleupime": "1.68.100"
  }
}
在 entry/src/main/module.json5 的 requestPermissions 声明 ohos.permission.INTERNET、ohos.permission.CAMERA 和 ohos.permission.MICROPHONE,并在 string.json 提供摄像头、麦克风权限用途文案。
Demo:PlasoSdkHosSample。在 entry/src/main/ets/config/Config.ets 配置 appId 和 appKey 可体验 Demo。本地 appKey 签名仅限 Demo;生产环境必须由业务服务端保存 appKey 并签发 query。

2. 初始化 SDK#

在 EntryAbility 转发生命周期,并注册非空的 IResourceProvider:
import { AbilityConstant, UIAbility, Want } from '@kit.AbilityKit';
import { window } from '@kit.ArkUI';
import {
  IResourceCallback, IResourceProvider, IUrlCallback, SignCallback,
  StyleUpime, StyleUpimeAbilityHelper
} from 'styleupime';

class AppResourceProvider implements IResourceProvider {
  supportResourceCenter(): boolean = false;
  showResourceCenter(_checkAi: boolean): void {}
  dismissResourceCenter(): void {}
  getExtFileName(_info: Object | null, callback: IResourceCallback): void {
    callback.onFilePath(null);
  }
  getPreParseFileName(_info: Object | null, _suffix: string | null, callback: IResourceCallback): void {
    callback.onFilePath(null);
  }
  signQuery(_query: Map<string, Object> | null, callback: SignCallback): boolean {
    callback.onSignCompleted(null);
    return true;
  }
  getWebviewUrl(_type: number, callback: IUrlCallback): void {
    callback.onGetUrl(null);
  }
}

export default class EntryAbility extends UIAbility {
  onCreate(_want: Want, _launch: AbilityConstant.LaunchParam): void {
    StyleUpimeAbilityHelper.onAbilityCreate(this);
    StyleUpime.getInstance().setResourceProvider(new AppResourceProvider());
  }
  onDestroy(): void { StyleUpimeAbilityHelper.onAbilityDestroy(this); }
  onWindowStageCreate(stage: window.WindowStage): void {
    StyleUpimeAbilityHelper.onWindowStageCreate(this, stage);
    stage.loadContent('pages/Index', () => {});
  }
  onWindowStageDestroy(): void { StyleUpimeAbilityHelper.onWindowStageDestroy(this); }
}
新建并在 entry/src/main/resources/base/profile/main_pages.json 登记固定路径 pages/PlasoLiveClassPage:
import { LiveClassBackPressBridge, PlasoLiveClassView } from 'styleupime';

@Entry
@Component
struct PlasoLiveClassPage {
  build() {
    Stack() { PlasoLiveClassView() }.width('100%').height('100%')
  }
  onBackPress(): boolean {
    return LiveClassBackPressBridge.handleBackPress();
  }
}

3. 服务端生成课堂 query#

客户端提交课堂信息,业务服务端按《服务端接口与协议/01-签名与鉴权》签发完整 query;客户端不得修改签名后的任意参数。
参数类型示例 / 取值说明
appIdStringyour-app-id伯索分配的应用标识。
appTypeStringliveclassSDK固定值。
validBegin / validTimeLong / IntUnix 秒 / 10800签名生效时间和有效期。
signatureString服务端生成客户端不可生成或修改。
meetingId / meetingTypeStringclass-001 / public课堂 ID 和课堂类型。
mediaTypeStringvideoaudio 或 video。
loginName / userNameStringstudent-001 / 小明学生唯一 ID 和显示名称。
userTypeStringlistenerHarmony SDK 当前必须传学生端角色。
d_dimensionString1280x720推荐课堂分辨率。
d_lowLatencyClassInt0普通实时课堂传 0;极速课堂传 1。
完整字段和签名规则见《服务端接口与协议/03-query参数》。

4. 启动课堂#

import { common } from '@kit.AbilityKit';
import { ClassConfig, StyleUpime, UpimeConfig } from 'styleupime';

async function launchLiveClass(
  context: common.UIAbilityContext, query: string, meetingId: string, userName: string
): Promise<void> {
  const config = new ClassConfig();
  config.classURL = query;
  config.query = query;
  config.host = 'https://www.plaso.cn';
  config.taskId = meetingId;
  config.userName = userName;
  config.openFileMode = UpimeConfig.OPEN_FILE_MODE_WINDOW;
  config.toolboxItems = UpimeConfig.ToolBoxItem.ALL;
  await StyleUpime.getInstance().launchLiveClass(config, context, '/');
}
classURL、query 和 host 必填;前两个必须为同一份服务端签名结果。其余对外 ClassConfig 参数如下:
参数类型默认值说明
userNamestring-当前用户名称。
taskIdstring-课堂 ID。
classMemberUser[]-课堂成员列表。
allowLocalPPTbooleantrue是否允许插入本地 PPT。
hideOtherClientbooleanfalse是否隐藏不在班级的学生和助教。
endRemindTimenumber0下课提醒时间,单位秒。
redPacketLimitnumber0红包雨数量限制。
defaultPermissionnumber0会议模式默认权限。
openFileModenumber0文件打开模式,使用 UpimeConfig.OPEN_FILE_MODE_*。
toolboxItemsnumberUpimeConfig.ToolBoxItem.ALL百宝箱工具项。
enableInteractPptbooleanfalse是否开启交互 PPT。
teachToolTypesnumber0教具类型,使用 UpimeConfig.TeacherToolType。
supportUndobooleanfalse是否支持撤销。
useNewSmallBoardbooleanfalse是否使用新版小黑板。
supportHighlighterbooleanfalse是否支持荧光笔。
forbiddenScreenShotbooleanfalse是否禁止课堂截屏。
enableVotebooleanfalse是否支持投票。
enableSaveBoardbooleanfalse是否支持保存板书。
chatMsgPopupnumber0学生消息弹框:0 本地记录、1 远端开启、2 远端关闭。
enableAnsbooleantrue是否开启降噪。
enableStarShowbooleanfalse是否显示积分排行榜。
recordingPreparationTipstring-服务端录制开始前的提示文案。
hideRecordingIndicatorbooleanfalse是否隐藏“录制中”状态。
showStudentClassElapsedTimebooleanfalse学生端是否显示已开课时长。
logConfigUpimeLogConfig-日志配置。
waterMarkConfigUpimeWaterMarkConfig-水印配置。

5. 可选配置#

在启动课堂前可设置水印、日志和违禁词:
import {
  StyleUpime,
  UpimeLogConfig,
  UpimeWaterMarkConfig
} from 'styleupime';

const logConfig = new UpimeLogConfig();
logConfig.logDir = `${context.filesDir}/logs`;
logConfig.logLevel = UpimeLogConfig.DEBUG;
config.logConfig = logConfig;

const waterMarkConfig = new UpimeWaterMarkConfig();
waterMarkConfig.text = 'your-watermark';
waterMarkConfig.size = 14;
waterMarkConfig.opacity = 0.5;
config.waterMarkConfig = waterMarkConfig;

StyleUpime.getInstance().updateProhibitedWords(['违禁词1', '违禁词2']);
logLevel 分别为 DEBUG=0、INFO=1、WARN=2、ERROR=3;默认值为 INFO=1。水印可通过 text 设置内容、size 设置字号、opacity(0-1)设置透明度。

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

资料中心、私有普通文件和预解析文件通过 IResourceProvider 回调接入,见《资料中心/Harmony》和《文件预解析/Harmony》。

7. 联调检查#

已配置 API 12+、OHPM 仓库、依赖和权限。
已转发全部 StyleUpimeAbilityHelper 生命周期,并登记 pages/PlasoLiveClassPage。
服务端 query 使用 userType=listener,生产端未保存 appKey。
课堂可正常进入、返回和退出。
修改于 2026-11-17 07:47:57
上一页
Android 实时课堂接入
下一页
iOS 实时课堂接入
Built with