API-Dokumentation zur eingebetteten Player-Interaktion

Adobe Learning Manager bietet eine Bibliothek, die in eine App integriert werden kann. Diese Bibliothek bietet verschiedene APIs, um Ereignisse zu überwachen und Aktionen im eingebetteten Player auszulösen.

Mithilfe der bereitgestellten APIs können Sie andere Aktionen für den Player wiedergeben, anhalten und ausführen.

Bibliothek laden

Die Bibliothek ist an diesem Speicherort verfügbar.

Führen Sie die untengenannten Schritte aus, um die Bibliothek zu laden:

  1. Laden Sie die JS-Datei in die Nutzeranwendung. 
  2. Beim Laden der Bibliothek wird window.cpPlayerLib aufgefüllt. 

Hinweis: Wenn Sie nicht „prod US“ verwenden, legen Sie die Parameter cpPlayerLib.env und cpPlayerLib.sourceOrigin gemäß Ihrer Umgebung fest.

Die Standardwerte sind: 

Verfügbare Methoden

Die Bibliothek cpPlayerLib besteht aus den folgenden Funktionen:

startPlayer

Methodenname startPlayer
Beschreibung Lädt einen Player in die App.
Parameter
  • loId: Die Lernobjekt-ID.
  • accountId: Die Konto-ID des ALM-Kontos.
  • userId: Die Benutzer-ID.
  • accessToken: Das Zugriffstoken.
  • domRefId: Die ID des div-Containers, in dem der Player gerendert werden muss.
  • onModuleLoaded: Diese Funktion wird aufgerufen, wenn die Module mit den folgenden Details geladen werden.
    • contentType
    • loID
    • moduleId
    • completed
    • currentLanguage
    • availableLanguages
    • isCCAvailable
    • ccEnabled
Rückgabe Gibt ein Versprechen zurück. Nach Auflösung des Versprechens wird ein playerObj übergeben.
Ausnahme Das Versprechen führt zu einer Ausnahme. 
Beispielcode

cpPlayerLib.startPlayer(loId, accountId, userId, accessToken, domRefId, onModuleLoaded).then((playerObj) => {

//playerObj verfügt über die APIs zur Interaktion mit dem Player

}) >

getAllPlayers

Methodenname getAllPlayers
Beschreibung Gibt alle Player-Objekte auf der aktuellen Seite zurück. 
Parameter Ohne
Beispielcode cpPlayerLib.getAllPlayers()

getPlayer

Methodenname getPlayer
Beschreibung Gibt ein Player-Objekt mit der angegebenen Lernobjekt-ID zurück.
Parameter
  • loId: Die Lernobjekt-ID.
Beispielcode cpPlayerLib.getPlayer(loId)

navigateToModule

Methodenname navigateToModule
Beschreibung Zum nächsten Modul navigieren.
Parameter
  • moduleId: Die Modul-ID.
Beispielcode playerObj.navigateToModule
(moduleID)

next

Methodenname next
Beschreibung Zum nächsten Modul navigieren.
Parameter Ohne
Beispielcode playerObj.next()

previous

Methodenname previous
Beschreibung Zum vorherigen Modul navigieren.
Parameter Ohne
Beispielcode playerObj.previous()

toggleTOC

Methodenname toggleTOC
Beschreibung Das Inhaltsverzeichnisfenster auf dem Player umschalten.
Parameter Ohne
Beispielcode playerObj.toggleTOC()

toggleNotes

Methodenname toggleNotes
Beschreibung Das Bedienfeld „Anmerkungen“ auf dem Player umschalten.
Parameter Ohne
Beispielcode playerObj.toggleNotes()

toggleClosedCaption

Methodenname toggleClosedCaption
Beschreibung Schalten Sie die Anzeige von Untertiteln im Player um.
Parameter Ohne
Beispielcode playerObj.toggleClosedCaption()

changeLanguage

Methodenname changeLanguage
Beschreibung Die Sprache des Inhalts im Player ändern.
Parameter
  • language: Der anzugebende Sprachcode.
Beispielcode playerObj.changeLanguage("es")

closePlayer

Methodenname closePlayer
Beschreibung Den Player schließen und ihn von der Seite entfernen. 
Parameter Ohne
Beispielcode playerObj.closePlayer()

togglePlayPause 

Methodenname togglePlayPause
Beschreibung Zwischen Wiedergabe des Inhalts auf dem Player und Pause wechseln. 
Parameter Ohne
Beispielcode playerObj.togglePlayPause()

setVolume

Methodenname setVolume
Beschreibung Die Lautstärke des Players festlegen. Der Wert muss zwischen 0 und 1 liegen.
Parameter
  • volume: Der Wert für die Lautstärke. Der gültige Bereich liegt zwischen 0 und 1. 
Beispielcode playerObj.setVolume(0.5)

setPlayBackSpeed

Methodenname setPlayBackSpeed
Beschreibung Die Geschwindigkeit der Wiedergabe im Player festlegen. 
Parameter
  • speed: Der Wert der anzugebenden Geschwindigkeit. Gültige Werte sind .25, .5, .75, 1, 1.25, 1.5, 1.75, 2.
Beispielcode playerObj.setPlayBackSpeed(1.25)

seek

Methodenname seek
Beschreibung Zu einem beliebigen Zeitpunkt im Video springen.
Parameter
  • time: Der Zeitpunkt, zu dem gesprungen werden soll. Die Zeit wird in Sekunden angegeben.
Beispielcode playerObj.seek(50)

forward

Methodenname forward
Beschreibung Im Video 10 Sekunden vorwärts springen.
Parameter Ohne
Beispielcode playerObj.forward()

backward

Methodenname backward
Beschreibung Im Video 10 Sekunden rückwärts springen.
Parameter Ohne
Beispielcode playerObj.backward()

navigateToPage

Methodenname navigateToPage
Beschreibung Zur angegebenen Seite der PPT-/PDF-Datei wechseln.
Parameter
  • pageNumber: Die Seitennummer, zu der gesprungen werden soll.
Beispielcode playerObj.navigateToPage (5)

nextPage

Methodenname nextPage
Beschreibung Zur nächsten Seite der PPT-/PDF-Datei wechseln.
Parameter Ohne
Beispielcode playerObj.nextPage()

previousPage

Methodenname previousPage
Beschreibung Zur vorherigen Seite der PPT-/PDF-Datei wechseln.
Parameter Ohne
Beispielcode playerObj.previousPage()

zoomIn

Methodenname zoomIn
Beschreibung Den Inhalt einer PPT-/PDF-Datei vergrößern.
Parameter Ohne
Beispielcode playerObj.zoomIn()

zoomOut

Methodenname zoomOut
Beschreibung Den Inhalt einer PPT-/PDF-Datei verkleinern.
Parameter Ohne
Beispielcode playerObj.zoomOut()

downloadJobAid 

Methodenname downloadJobAid
Beschreibung Eine Arbeitshilfe aus einem Kurs herunterladen. 
Parameter Ohne
Beispielcode playerObj.downloadJobAid()

toggleJobAidPullout 

Methodenname toggleJobAidPullout
Beschreibung Gibt an, ob Sie eine Arbeitshilfe herunterladen möchten. 
Parameter Ohne
Beispielcode playerObj.toggleJobAidPullout()

Liste der Ereignisse

onPlayerEvents(callBack)

Bei der Registrierung wird die Rückruffunktion bei allen Player-Ereignissen aufgerufen. Die Ereignisnamen lauten wie folgt:

  • PLAY (Video/Audio/CP)

  • PAUSE (Video/Audio/CP)

  • TIMEUPDATE (Video/Audio/CP)

  • PAGECHANGE (PPT/PDF)

  • NOTEADDED (Alle Inhalte)

  • LAUNCHED (Alle Inhalte)

  • STARTED (Alle Inhalte)

  • COMPLETED (Alle Inhalte)

  • PASSED (Alle Inhalte)

  • FAILED (Alle Inhalte)

onStreamingEvents(callBack)

Bei der Registrierung wird die Rückruffunktion für alle Player-Anweisungen aufgerufen, die zur Verfolgung der Benutzeraktivität gesendet werden.

Schneller und einfacher Hilfe erhalten

Neuer Benutzer?