Adobe Learning Manager 提供一个可集成至应用程序的库。 该库提供多种 API 来收听嵌入式播放器中的事件并触发操作。
通过使用提供的 API,您可以在播放器上执行播放、暂停和其他操作。
加载库
可在此位置获取该库。
要加载该库,请按以下步骤操作:
- 加载使用者应用程序中的 js 文件。
- 加载该库时,系统会填充 window.cpPlayerLib。
注意:如果您不使用 prod US,请根据您的 env 命令设置 params cpPlayerLib.env 和 cpPlayerLib.sourceOrigin。
默认值为:
- window.cpPlayerLib.env = https://learningmanager.adobe.com/app/player;
- window.cpPlayerLib.sourceOrigin = "https://cpcontents.adobe.com";
可用方法
cpPlayerLib 库包含以下函数:
startPlayer
方法名称 | startPlayer |
描述 | 在应用程序中加载播放器。 |
参数 |
|
返回 | 返回一个 promise 对象。 获取 promise 对象后,系统将传递 playerObj。 |
异常 | 该 promise 对象会导致异常。 |
示例代码 | cpPlayerLib.startPlayer(loId, accountId, userId, accessToken, domRefId, onModuleLoaded).then((playerObj) => { //playerObj 拥有可与播放器交互的 API }) > |
getAllPlayers
方法名称 | getAllPlayers |
描述 | 返回当前页面上的所有播放器对象。 |
参数 | 无 |
示例代码 | cpPlayerLib.getAllPlayers() |
getPlayer
方法名称 | getPlayer |
描述 | 返回拥有指定学习对象 ID 的播放器对象。 |
参数 |
|
示例代码 | cpPlayerLib.getPlayer(loId) |
navigateToModule
方法名称 | navigateToModule |
描述 | 导航至下一个模块。 |
参数 |
|
示例代码 | playerObj.navigateToModule (moduleID) |
next
方法名称 | next |
描述 | 导航至下一个模块。 |
参数 | 无 |
示例代码 | playerObj.next() |
previous
方法名称 | previous |
描述 | 导航至上一个模块。 |
参数 | 无 |
示例代码 | playerObj.previous() |
toggleTOC
方法名称 | toggleTOC |
描述 | 切换播放器上的目录面板。 |
参数 | 无 |
示例代码 | playerObj.toggleTOC() |
toggleNotes
方法名称 | toggleNotes |
描述 | 切换播放器上的备注面板。 |
参数 | 无 |
示例代码 | playerObj.toggleNotes() |
toggleClosedCaption
方法名称 | toggleClosedCaption |
描述 | 切换播放器上的隐藏字幕显示。 |
参数 | 无 |
示例代码 | playerObj.toggleClosedCaption() |
changeLanguage
方法名称 | changeLanguage |
描述 | 更改播放器上的内容语言。 |
参数 |
|
示例代码 | playerObj.changeLanguage("es") |
closePlayer
方法名称 | closePlayer |
描述 | 关闭播放器并将其从页面中删除。 |
参数 | 无 |
示例代码 | playerObj.closePlayer() |
togglePlayPause
方法名称 | togglePlayPause |
描述 | 在播放和暂停播放器的内容之间切换。 |
参数 | 无 |
示例代码 | playerObj.togglePlayPause() |
setVolume
方法名称 | setVolume |
描述 | 设置播放器的音量。 该值必须介于 0 和 1 之间。 |
参数 |
|
示例代码 | playerObj.setVolume(0.5) |
setPlayBackSpeed
方法名称 | setPlayBackSpeed |
描述 | 设置播放器的播放速度。 |
参数 |
|
示例代码 | playerObj.setPlayBackSpeed(1.25) |
seek
方法名称 | seek |
描述 | 跳转至视频的任何时间点。 |
参数 |
|
示例代码 | playerObj.seek(50) |
forward
方法名称 | forward |
描述 | 将视频快进 10 秒。 |
参数 | 无 |
示例代码 | playerObj.forward() |
backward
方法名称 | backward |
描述 | 将视频后退 10 秒。 |
参数 | 无 |
示例代码 | playerObj.backward() |
navigateToPage
方法名称 | navigateToPage |
描述 | 跳转至 PPT/PDF 的指定页面。 |
参数 |
|
示例代码 | playerObj.navigateToPage (5) |
nextPage
方法名称 | nextPage |
描述 | 跳转至 PPT/PDF 的下一页。 |
参数 | 无 |
示例代码 | playerObj.nextPage() |
previousPage
方法名称 | previousPage |
描述 | 跳转至 PPT/PDF 的上一页。 |
参数 | 无 |
示例代码 | playerObj.previousPage() |
zoomIn
方法名称 | zoomIn |
描述 | 放大 PPT/PDF 中的内容。 |
参数 | 无 |
示例代码 | playerObj.zoomIn() |
zoomOut
方法名称 | zoomOut |
描述 | 缩小 PPT/PDF 中的内容。 |
参数 | 无 |
示例代码 | playerObj.zoomOut() |
downloadJobAid
方法名称 | downloadJobAid |
描述 | 下载课程中的工作辅助。 |
参数 | 无 |
示例代码 | playerObj.downloadJobAid() |
toggleJobAidPullout
方法名称 | toggleJobAidPullout |
描述 | 是否要下载工作辅助。 |
参数 | 无 |
示例代码 | playerObj.toggleJobAidPullout() |
事件列表
onPlayerEvents(callBack)
注册回调函数时,系统将在所有播放器事件中调用该函数。 事件名称如下:
PLAY(视频/音频/CP)
PAUSE(视频/音频/CP)
TIMEUPDATE(视频/音频/CP)
PAGECHANGE(PPT/PDF)
NOTEADDED(所有内容)
LAUNCHED(所有内容)
STARTED(所有内容)
COMPLETED(所有内容)
PASSED(所有内容)
FAILED(所有内容)
onStreamingEvents(callBack)
注册回调函数后,系统将在为跟踪用户活动而发送的所有播放器语句中调用该函数。