适用版本: @plasosdk/plaso-electron-sdk≥ 1.3.18
@electron/remote、日志和 electron-builder 打包等公共步骤见《接入基础(Electron & Web)/Electron》,本文只说明打开实时课堂窗口所需的参数与调用。createLiveClassWindow 启动实时课堂。极速课堂与本文流程相同,只需在 query 中增加 d_lowLatencyClass=1,见 极速课堂/Electron。appId 与 appKey,以及业务服务端的课堂 query 接口。课堂 ID、用户角色等由业务侧自行定义;🔒 appKey 只能保存在服务端,不能写入客户端。@electron/remote 并调用 initRemoteMain,渲染进程使用 window.require('@plasosdk/plaso-electron-sdk') 取得同一份 SDK。创建窗口前建议调用 initLogConfig。完整步骤、日志目录和打包配置见 初始化与配置。classOptions.query。| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
appId | string | 是 | 伯索分配的应用标识 |
appType | string | 是 | 实时课堂固定为 liveclassSDK |
validBegin | number | 是 | 签名生效时间,Unix 秒级时间戳 |
validTime | number | 是 | query 有效期,单位秒 |
signature | string | 是 | 签名值;由服务端生成,客户端不能生成、修改或拼接 |
mediaType | string | 是 | audio 或 video |
meetingType | string | 是 | 通常为 public;如使用会议模式,按 SDK 能力约定 |
meetingId | string | 是 | 课堂 ID,建议只使用 ASCII 字符,不包含 /、\、空格,长度不超过 40 字节 |
userType | string | 是 | speaker 主讲、assistant 助教、listener 听众;一堂课通常只能有一个主讲 |
loginName | string | 是 | 用户唯一 ID;同一 loginName 重复进入会顶掉前一个登录 |
userName | string | 是 | 用户昵称 |
d_dimension | string | 是 | 固定 1280x720 |
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
topic | string | 否 | 课堂名称 |
endTime | number | 否 | 课堂结束时间,Unix 秒级时间戳;不传默认 5 小时后结束 |
recordTime | number | 否 | 开始录制时间,Unix 秒级时间戳 |
onlineMode | number | 否 | 视频课堂中 listener 可开摄像头数量,如 1、6、12;默认 6 |
d_sharpness | number | 否 | 清晰度:10 为 360p,20 为 720p,30 为 1080p |
d_switch | number | 否 | 功能开关位,按二进制标志位换算为十进制 |
enableNewClassExam | number | 否 | 新版随堂测题型:0 不支持(沿用老版随堂测)、1 选择题、2 填空题、3 选择题+填空题(建议传 3) |
d_enableObjectEraser | number | 否 | 是否启用新版板书(橡皮擦支持对象擦除);默认不启用,传入大于 0 的值启用。取值:0 不启用(点擦),1 对象擦除手写,3 手写+文本,5 手写+图形,7 手写+文本+图形 |
showHisChatMsg | number | 否 | 历史课堂是否记录消息,0 否,1 是 |
d_delayEndTimes | number | 否 | 单节课最大延时下课次数,默认 1;小于等于 0 时会被重置为 1 |
d_delayEnd | number | 否 | 单次延时时间,单位秒,常见值 300、600 等 |
d_enableAvatarFreeScale | number | 否 | 是否开启头像任意比例缩放,0 关闭,1 开启 |
d_voteStarAward | number | 否 | 投票积分,默认 0 |
isNewMT | number | 否 | 是否支持移动授课模式,建议传 1 |
recordAvator | string | 否 | 传入老师或助教的 loginName,表示录制对应人的头像 |
recordScreen | string | 否 | 传入 screen 表示录制屏幕 |
d_enableReRecording | number | 否 | 是否允许重新录制:0 不允许,1 老师,2 助教,3 老师和助教;默认允许老师与助教重新录制 |
d_restrictAssistantPerm | number | 否 | 是否限制助教权限,0 否,1 是 |
d_lowLatencyClass=1(并参与签名),见 极速课堂/Electron。const PlasoElectronSdk = window.require('@plasosdk/plaso-electron-sdk');
// 业务后端接口,非 SDK API
const query = await api.createPlasoLiveQuery({ /* 业务参数 */ });
const code = PlasoElectronSdk.createLiveClassWindow({
classOptions: { query },
onClassWindowReadyFn: (winId: number) => {},
onClassFinishedFn: (meetingId: string) => {},
});closeLiveClassWindow()(1.3.19 起)。classOptions(如 supportShowResourceCenter)见 初始化与配置 §5、§6。classOptions| 参数 | 类型 | 必填 | 默认值 | 说明 | 起始版本 |
|---|---|---|---|---|---|
query | string | 是 | - | 服务端生成的签名 query | - |
displayAvatarUrl | string | 否 | - | 当前用户头像(HTTPS 全地址) | - |
classMembers | UserInfo[] | 否 | - | 成员列表;超过 2000 人需另行申请 | - |
enableRTC3A | boolean | 否 | true | 回音消除、降噪、自动增益 | - |
enableENC | boolean | 否 | true | 降噪 | - |
enableLiveNewShare | boolean | 否 | false | 新桌面共享 | - |
enableLiveNewShareInTouch | boolean | 否 | false | 触屏设备新桌面共享 | - |
enableLiveNewShareRegion | boolean | 否 | false | 区域共享 | - |
enableLiveSign | boolean | 否 | false | 签到 | - |
supportSaveBoard | boolean | 否 | false | 保存板书(配合 onSaveBoardFn) | - |
residentCamera | boolean | 否 | false | 学生/游客常驻摄像头 | - |
enableUploadLog | boolean | 否 | true | 进入/退出课堂自动上传日志 | 1.3.15 |
enableBrowser | boolean | 否 | - | 课堂内置浏览器工具 | 1.3.17 |
starShow | 0 | 1 | 否 | 0 | 积分排行榜 | 1.3.17 |
| 操作 | API | 时机 |
|---|---|---|
| 插入资源 | insertObject(fileObject) | onClassWindowReadyFn 之后 |
| 更新违禁词 | updateProhibitedWords(words) | onClassWindowReadyFn 之后;仅对学生(userType=listener)生效 |
| 关闭窗口 | closeLiveClassWindow() | 窗口打开期间(1.3.19 起) |
classOptions.supportShowResourceCenter = true,并实现 onOpenResourceCenterFn;onClassWindowReadyFn 之后调用 insertObject;info 方式插入的普通资源:实现 onGetExtFileNameFn;onGetPreParseFileNameFn。initRemoteMain,渲染进程与宿主共用同一份 @electron/remote。extraResources、asar、macOS 权限验证通过。info 方式插入的私有资料或预解析课件时,已实现对应 URL 回调。