@plasosdk/client-sdk(当前文档按 3.1.0 整理)。@plasosdk/plaso-electron-sdk,签名 query 进课)不同:本包以用户访问 Token 打开云学堂业务页,不直接拼课堂 query。| 要求 | 值 |
|---|---|
| 运行环境 | 现代浏览器(Web),或 Electron(需 @electron/remote) |
| npm 包 | @plasosdk/client-sdk(建议 3.1.0 及以上) |
| 入口 | 渲染进程:PlasoClient;Electron 主进程:@plasosdk/client-sdk/electron 的 init |
| 鉴权 | OpenAPI getToken 签发的访问 Token |
@plasosdk/plaso-electron-sdk 与 electron-store 已作为本包依赖随安装带上,宿主不必再单独安装。init() 时显式传入(开发与打包一律如此):@plasosdk/plaso-electron-sdk 原生二进制。NHOMEWORK)、课堂(LIVECLASS)、资源(RESOURCES)。appId、signKey(即 SDK 文档中的 appKey,同一把密钥),在机构后台准备 loginName。POST https://{host}/dataentry/user/getToken 签发 Token(客户端勿内置 signKey / appKey)。userType 与角色一致:student / teacher / assistant。obj.token 交给 PlasoClient。PlasoClient 实例重复创建模块时,会先销毁上一个再创建新的。| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
token | string | 是 | 开放平台用户访问 Token |
container | HTMLElement | 是 | 渲染容器;Web / Electron 均必填(Electron 下页面不嵌入该容器,见第 5 节) |
platform | string | 否 | 'plaso'(默认)或 'ai';非法值不会抛错,但会拼出无效域名导致静默失败 |
env | Environment | 否 | 默认 PROD,可不传 |
onError | (error: Error) => void | 否 | 错误回调 |
onLoading | (isLoading: boolean) => void | 否 | 加载状态回调 |
devTools | boolean | 否 | 是否打开开发者工具,默认 false |
| 枚举 | 值 | 说明 |
|---|---|---|
PlasoContentType.NHOMEWORK | nhomework | 作业 |
PlasoContentType.LIVECLASS | liveclass | 课堂(列表 / 进课) |
PlasoContentType.RESOURCES | resources | 资料中心 |
destroy() 会用同属性空节点替换构造时传入的 container,原节点已脱离 DOM。若还要再建实例,必须使用返回值:destroy() 还会请求关闭已打开的模块独立窗口(课堂进行中时,课堂列表窗口关闭会被拦截,见第 5 节)。init,且创建宿主 BrowserWindow 时开启 SDK 硬性要求的三项偏好:init(remoteMain, ffmpegModule?, ffmpegPath?) 返回 EventEmitter。后两个参数在类型上可选,但若要用音频转换,开发与打包都应显式传入;不要依赖 SDK 内部 require 兜底(打包后路径常失效)。成功加载时可在主进程日志中看到 FFmpeg loaded successfully from external modules。| 事件 | 参数 | 时机 |
|---|---|---|
relaunch | args: string[](process.argv) | 页面侧请求重启宿主(如 Token 过期) |
new PlasoClient + createModule)。createModule() 不把页面嵌进传入的 container,而是按模块类型打开独立窗口(同类型单例:重复创建会聚焦已有窗口;不同类型可同时开)。container。| 项 | PC 模块化 SDK(本文) | Electron 课堂引擎 SDK |
|---|---|---|
| 包名 | @plasosdk/client-sdk | @plasosdk/plaso-electron-sdk(亦可被本包间接依赖) |
| 典型目标 | 嵌入云学堂作业 / 课堂列表 / 资料中心业务页 | 用签名 query 直接拉起单次实时课堂 / 微课等 |
| 鉴权 | getToken → PlasoClient({ token }) | 服务端签发课堂 query |
| 文档 | 本文 | 接入基础(Electron & Web)/Electron/ |
@plasosdk/client-sdk;Electron 另装 @electron/remote,音频转换按需装 fluent-ffmpeg / ffmpeg-static。getToken 验签通过,Token 未过期。createModule / 快捷方法可打开作业、课堂、资源。init;BrowserWindow 开启 webviewTag、nodeIntegration、contextIsolation: false;已 remoteMain.enable。destroy() 复用容器时使用了返回值。signKey;platform 与业务域名一致。