文档Learning Manager

嵌入式播放器的交互 API 文档

Last update: Tue Feb 11 2025 00:00:00 GMT+0000 (Coordinated Universal Time)

Adobe Learning Manager 提供一个可集成至应用程序的库。 该库提供多种 API 来收听嵌入式播放器中的事件并触发操作。

通过使用提供的 API，您可以在播放器上执行播放、暂停和其他操作。

加载库

可在此位置获取该库。

要加载该库，请按以下步骤操作：

  1. 加载使用者应用程序中的 js 文件。
  2. 加载该库时，系统会填充 window.cpPlayerLib。
NOTE
如果您没有使用prod US，请根据您的环境设置参数cpPlayerLib.env和cpPlayerLib.sourceOrigin。

默认值为：

可用方法

cpPlayerLib 库包含以下函数：

startPlayer

方法名称
startPlayer
描述
在应用程序中加载播放器。
参数

  • loId：学习对象 ID。

  • accountId：ALM 帐户的帐户 ID。

  • userId：用户 ID。

  • accessToken：访问令牌。

  • domRefId：div 容器 ID，必须在容器中渲染播放器。

  • onModuleLoaded：加载含有以下详细信息的模块时，系统将调用此函数。

  • contentType

  • loId

  • moduleId

  • completed

  • currentLanguage

  • availableLanguages

  • isCCAvailable

  • ccEnabled

返回
返回一个 promise 对象。 如果履行承诺，将通过播放器对象。
异常
这个承诺会导致例外。
示例代码
cpPlayerLib.startPlayer(loId， accountId， userId， accessToken， domRefId， onModuleLoaded)。then((playerObj) => {//playerObj具有与播放器交互的api}) >

getAllPlayers

方法名称
getAllPlayers
描述
返回当前页面上的所有播放器对象。
参数
无
示例代码
cpPlayerLib.getAllPlayers()

getPlayer

方法名称
getPlayer
描述
返回具有指定学习对象ID的播放器对象。
参数
  • loId：学习对象 ID。
示例代码
cpPlayerLib.getPlayer(loId)

navigateToModule

方法名称
navigateToModule
描述
导航至下一个模块。
参数
  • moduleId：模块ID。
示例代码
playerObj.navigateToModule(moduleID)

下一个

方法名称
next
描述
导航至下一个模块。
参数
  • 无
示例代码
playerObj.next()

上一个

方法名称
previous
描述
导航至上一个模块。
参数
  • 无
示例代码
playerObj.previous()

切换目录

方法名称
toggleTOC
描述
切换播放器上的目录面板。
参数
  • 无
示例代码
playerObj.toggleTOC()

toggleNotes

方法名称
toggleNotes
描述
切换播放器上的备注面板。
参数
  • 无
示例代码
playerObj.toggleNotes()

toggleClosedCaption

方法名称
toggleClosedCaption
描述
在播放器上切换隐藏字幕的显示。
参数
  • 无
示例代码
playerObj.toggleClosedCaption()

更改语言

方法名称
changeLanguage
描述
更改播放器上的内容语言。
参数
  • language：要指定的语言代码。
示例代码
playerObj.changeLanguage("es")

closePlayer

方法名称
closePlayer
描述
关闭播放器并从页面中删除播放器。
参数
  • 无
示例代码
playerObj.closePlayer()

togglePlayPause

方法名称
togglePlayPause
描述
在播放器和暂停播放器上的内容之间切换。
参数
  • 无
示例代码
playerObj.togglePlayPause()

setVolume

方法名称
setVolume
描述
设置播放器的音量。 该值必须介于 0 和 1 之间。
参数
  • volume：音量值。 有效范围为0-1。
示例代码
playerObj.setVolume(0.5)

setPlayBackSpeed

方法名称
setPlayBackSpeed
描述
在播放器中设置回放速度。
参数
  • speed：要指定的倍速值。 有效值为。25、.5、.75、1、1.25、1.5、1.75、2。
示例代码
playerObj.setPlayBackSpeed(1.25)

查找

方法名称
seek
描述
跳转至视频的任何时间点。
参数
  • time：要跳转的时间点。 时间点以秒为单位。
示例代码
playerObj.seek(50)

转发

方法名称
forward
描述
将视频快进 10 秒。
参数
  • 无
示例代码
playerObj.forward()

向后

方法名称
backward
描述
将视频后退 10 秒。
参数
  • 无
示例代码
playerObj.backward()

navigateToPage

方法名称
navigateToPage
描述
跳转至 PPT/PDF 的指定页面。
参数
  • pageNumber：要跳转到达的页码。
示例代码
playerObj.navigateToPage (5)

下一页

方法名称
nextPage
描述
跳转至 PPT/PDF 的下一页。
参数
  • 无
示例代码
playerObj.nextPage()

previousPage

方法名称
previousPage
描述
跳转至 PPT/PDF 的上一页。
参数
  • 无
示例代码
playerObj.previousPage()

放大

方法名称
zoomIn
描述
放大 PPT/PDF 中的内容。
参数
  • 无
示例代码
playerObj.zoomIn()

缩小

方法名称
zoomOut
描述
缩小 PPT/PDF 中的内容。
参数
  • 无
示例代码
playerObj.zoomOut()

downloadJobAid

方法名称
downloadjobaid
描述
从课程中下载工作辅助。
参数
  • 无
示例代码
playerObj.downloadJobAid()

toggleJobAidPullout

方法名称
toggleJobAidPullout
描述
是否下载工作辅助。
参数
  • 无
示例代码
playerObj.toggleJobAidPullout()

全屏

方法名称
全屏
描述
将播放器设置为全屏模式。
参数
  • 无
示例代码
playerObj.fullScreen()

事件列表

onPlayerEvents(callBack)

注册回调函数时，系统将在所有播放器事件中调用该函数。 事件名称如下：

  • PLAY（视频/音频/CP）
  • PAUSE（视频/音频/CP）
  • TIMEUPDATE（视频/音频/CP）
  • PAGECHANGE（PPT/PDF）
  • NOTEADDED（所有内容）
  • LAUNCHED（所有内容）
  • STARTED（所有内容）
  • COMPLETED（所有内容）
  • PASSED（所有内容）
  • FAILED（所有内容）

onStreamingEvents(callBack)

注册回调函数后，系统将在为跟踪用户活动而发送的所有播放器语句中调用该函数。

recommendation-more-help
d5e5961a-141b-4c77-820e-8453ddef913d