| 项 | 说明 |
|---|---|
| SDK 版本 | 1.68.110(预解析资源回调 ≥ 1.60.116) |
| 依赖 | plaso_style_upime-1.68.110.js(jssdk) |
| 接入性质 | 可选能力(仅当课堂含以 info 方式插入的资源时需要) |
| 入口 | PlasoStyleUpime.createLiveClient、getExtFileName、getPreParseFileName |
info 签发短时 URL 的接口;info 方式插入的私有资源或预解析资源时,引入 jssdk 并实现资源回调。url 方式插入的资源也可正常显示,此时不必引入 jssdk。不接 jssdk 时,以 info 方式插入的资源将无法显示。info 方式插入的资源时,用 jssdk 嵌入监课并实现资源回调:const client = PlasoStyleUpime.createLiveClient(
document.getElementById('plaso-container'),
{ query: signedMonitorQuery }, // 与 URL 接入相同的已签名监课 query
{
getExtFileName: async (info) => api.fetchSignedFileUrl(info),
getPreParseFileName: async (info, { suffix }) => api.fetchParsedFileUrl(info, suffix),
onExit: () => { /* SDK 已自动 destroy,这里做页面跳转 */ },
},
);api.* 均为业务后端接口,非 SDK API。client.destroy() 会移除 iframe 并解除消息监听,可重复调用;课堂内点击退出触发 onExit 时,SDK 已自动 destroy()。appKey、OSS 私钥或永久下载地址放入前端;info 为上课端插入时传入的原值,只作为业务文件标识,服务端负责鉴权,并校验监课人员对该课堂资源的访问权限。| 上课端插入方式 | Web 监课如何查看 |
|---|---|
url | URL 接入即可正常显示,无需 jssdk |
info(私有资源) | 必须使用 jssdk,并实现 getExtFileName |
url 方式插入资源(公开可访问或已由业务方预签名、有效期足够的短时 URL)时,Web 监课使用 URL 接入即可显示。SDK 不会调用 getExtFileName。info 方式插入私有资源时,不要期望 URL 接入能够显示这些文件。需改用 jssdk;SDK 需要加载文件时,会将上课端传入的原始 info 回调给 getExtFileName,由页面向业务服务端换取短时 URL。getExtFileName: async (info) => api.fetchSignedFileUrl(info),info 为上课端插入时传入的原值;协议见《服务端接口与协议/04-资料中心与文件URL》;getPreParseFileName 请求每个解析产物的短时 URL。Web 监课不能插入预解析文件,只能在上课端已以 info 方式插入后查看。info 方式插入课堂。getPreParseFileName。getPreParseFileName(info, { suffix }) 请求页面或资源。suffix 提交业务服务端,服务端鉴权后返回该产物的短时 URL。info(而不是可直接访问的 url),Web 监课才能通过回调换取产物 URL。info 为上课端插入时传入的原值,回调中原样回传。getPreParseFileName: async (info, { suffix }) => api.fetchParsedFileUrl(info, suffix),| 参数 | 使用方式 |
|---|---|
info | 上课端插入时传入的原始对象,可从中取出解析文件 ID。 |
suffix | SDK 请求的解析产物相对路径,例如 /index.html、/info.json、/1.jpg。原样提交业务服务端。每个 suffix 调用一次,同一文件会多次调用。 |
| 返回值 | 成功时返回完整的短时 URL;任何失败场景 reject。不要让 Promise 永久挂起。 |
fileId + suffix 请求业务服务端;服务端负责鉴权、校验 suffix、定位解析产物和签发 URL。url 方式插入的资源用 URL 接入即可查看;以 info 方式插入的私有资源或预解析资源需改用 jssdk,并实现 getExtFileName / getPreParseFileName,见 实时课堂/Web;info 方式插入的资源需要播放器 SDK jssdk 重新实现资源回调;以 url 方式插入的资源无需回调,见 历史课堂回放/播放器。url 方式插入的资源在 URL 接入下能直接显示。info 方式插入的私有资源时,已改用 jssdk,getExtFileName 能返回短时 URL。getPreParseFileName,能按 suffix 返回短时 URL;异常时 reject。info 为上课端插入时的原值;失败时 Promise 会 reject,不会永久挂起。onExit 触发,SDK 已自动 destroy();也可再次调用 client.destroy()。