文件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，請根據您的環境設定params cpPlayerLib.env和cpPlayerLib.sourceOrigin。

預設值為：

可用方法

cpPlayerLib程式庫包含下列函式：

startPlayer

方法名稱
startPlayer
說明
在應用程式中載入播放器。
引數

  • loId ：學習物件ID。

  • accountId ：ALM帳戶的帳戶ID。

  • userId ：使用者ID。

  • accessToken ：存取權杖。

  • domRefId：必須轉譯播放器的div容器ID。

  • onModuleLoaded：載入具有下列詳細資訊的模組時，將會叫用此函式。

  • contenttype

  • loId

  • moduleId

  • 已完成

  • currentlanguage

  • availablelanguages

  • isCCAvailable

  • 已啟用

傳回
傳回Promise。 在Promise解析時，將會傳遞playerObj。
例外
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：模組識別碼。
程式碼範例
playerObj.navigateToModule(moduleID)

下一個

方法名稱
下一個
說明
導覽至下一個模組。
引數
  • 無
程式碼範例
playerObj.next()

上一個

方法名稱
上一個
說明
導覽至上一個模組。
引數
  • 無
程式碼範例
playerObj.previous()

toggleTOC

方法名稱
toggleToc
說明
切換播放器上的目錄面板。
引數
  • 無
程式碼範例
playerObj.toggleTOC()

toggleNotes

方法名稱
toggleNotes
說明
切換播放器上的附註面板。
引數
  • 無
程式碼範例
playerObj.toggleNotes()

toggleClosedCaption

方法名稱
toggleClosedCaption
說明
切換隱藏式字幕在播放器上的顯示。
引數
  • 無
程式碼範例
playerObj.toggleClosedCaption()

changeLanguage

方法名稱
changeLanguage
說明
變更播放器上的內容語言。
引數
  • language：要指定的語言代碼。
程式碼範例
playerObj.changeLanguage("es")

closePlayer

方法名稱
closePlay
說明
關閉播放器，並從頁面中移除播放器。
引數
  • 無
程式碼範例
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)

搜尋

方法名稱
搜尋
說明
跳至視訊上的任何時間。
引數
  • 時間：跳至的時間。 時間以秒為單位。
程式碼範例
playerObj.seek(50)

轉寄

方法名稱
轉寄
說明
在視訊中往前跳10秒。
引數
  • 無
程式碼範例
playerObj.forward()

向後

方法名稱
後退
說明
在視訊中向後跳轉10秒。
引數
  • 無
程式碼範例
playerObj.backward()

navigateToPage

方法名稱
navigateToPage
說明
跳至PPT/PDF上的指定頁面。
引數
  • pageNumber：要跳轉到的頁碼。
程式碼範例
playerObj.navigateToPage (5)

下一頁

方法名稱
下一頁
說明
跳至PPT/PDF上的下一頁。
引數
  • 無
程式碼範例
playerObj.nextPage()

previousPage

方法名稱
上一頁
說明
跳至PPT/PDF的上一頁。
引數
  • 無
程式碼範例
playerObj.previousPage()

zoomIn

方法名稱
zoomIn
說明
放大PPT/PDF上的內容。
引數
  • 無
程式碼範例
playerObj.zoomIn()

縮小

方法名稱
縮小
說明
縮小PPT/PDF上的內容。
引數
  • 無
程式碼範例
playerObj.zoomOut()

下載工作輔助

方法名稱
downloadJobAid
說明
從課程下載工作輔助。
引數
  • 無
程式碼範例
playerObj.downloadJobAid()

toggleJobAidPullout

方法名稱
toggleJobAidPullout
說明
您是否要下載工作輔助。
引數
  • 無
程式碼範例
playerObj.toggleJobAidPullout()

全熒幕

方法名稱
全熒幕
說明
將播放器設為全熒幕模式。
引數
  • 無
程式碼範例
playerObj.fullScreen()

事件清單

onPlayerEvents(callBack)

註冊時，將會在所有播放器事件上叫用回呼函式。 事件名稱如下：

  • 播放（視訊/音訊/CP）
  • 暫停（視訊/音訊/CP）
  • TIMEUPDATE （視訊/音訊/CP）
  • 頁面變更(PPT/PDF)
  • NOTEADDED （所有內容）
  • 已啟動（所有內容）
  • 已開始（所有內容）
  • 已完成（所有內容）
  • 通過（所有內容）
  • 失敗（所有內容）

onStreamingEvents(callBack)

註冊時，將會在為了追蹤使用者活動而傳送的所有播放器陳述式上叫用回呼函式。

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