DocumentatieLearning Manager

API-documentatie voor interactie ingesloten speler

Laatst bijgewerkt: 11 februari 2025

Adobe Learning Manager beschikt over een bibliotheek die kan worden geïntegreerd in een app. Deze bibliotheek biedt verschillende API's om gebeurtenissen te tracken en acties in de ingesloten speler te activeren.

Met de beschikbare API's kunt u afspelen, pauzeren en andere acties uitvoeren in de speler.

De bibliotheek laden

U vindt de bibliotheek op deze locatie.

Volg de onderstaande stappen om de bibliotheek te laden:

  1. Laad het JS-bestand in de toepassing voor consumenten.
  2. Bij het laden van de bibliotheek wordt window.cpPlayerLib ingevuld.
OPMERKING
Als u geen prod US gebruikt, stelt u de params cpPlayerLib.env en cpPlayerLib.sourceOrigin in op basis van uw env.

De standaardwaarden zijn:

  • window.cpPlayerLib.env = https://learningmanager.adobe.com/app/player;
  • window.cpPlayerLib.sourceOrigin = "https://cpcontents.adobe.com";

Beschikbare methoden

De cpPlayerLib-bibliotheek bestaat uit de volgende functies:

startPlayer

Naam methode
startPlayer
Beschrijving
Laadt een speler in de app.
Parameters

  • loId: de ID van het leerobject.

  • accountId: de account-ID van het ALM-account.

  • userId: de gebruikers-ID.

  • accessToken: het toegangstoken.

  • domRefId: de ID van de div-container waarin de speler moet worden weergegeven.

  • onModuleLoaded: deze functie wordt aangeroepen wanneer de modules met de onderstaande details worden geladen.

  • contentType

  • loID

  • moduleId

  • completed

  • currentLanguage

  • availableLanguages

  • isCCAvailable

  • ccEnabled

Resultaten
Geeft een belofte als resultaat. Bij het oplossen van de belofte wordt een playerObj doorgegeven.
Uitzondering
De belofte resulteert in een uitzondering.
Voorbeeldcode
cpPlayerLib.startPlayer(loId, accountId, userId, accessToken, domRefId, onModuleLoaded).then((playerObj) => {//playerObj heeft de API voor interactie met de speler}) >

getAllPlayers

Naam van methode
getAllPlayers
Beschrijving
Retourneert alle spelerobjecten op de huidige pagina.
Parameters
Geen
Voorbeeldcode
cpPlayerLib.getAllPlayers()

getPlayer

Naam van methode
getPlayer
Beschrijving
Retourneert een Player-object met de opgegeven leerobject-id.
Parameters
  • loId: de ID van het leerobject.
Voorbeeldcode
cpPlayerLib.getPlayer(loId)

navigateToModule

Naam van methode
navigateToModule
Beschrijving
Navigeer naar de volgende module.
Parameters
  • moduleId: De module-id.
Voorbeeldcode
playerObj.navigateToModule(moduleID)

volgende

Naam van methode
next
Beschrijving
Navigeer naar de volgende module.
Parameters
  • Geen
Voorbeeldcode
playerObj.next()

vorige

Naam van methode
previous
Beschrijving
Navigeer naar de vorige module.
Parameters
  • Geen
Voorbeeldcode
playerObj.previous()

toggleTOC

Naam van methode
toggleTOC
Beschrijving
Schakel het deelvenster met inhoudsopgave van de speler in.
Parameters
  • Geen
Voorbeeldcode
playerObj.toggleTOC()

toggleNotes

Naam van methode
toggleNotes
Beschrijving
Schakel het deelvenster Notities van de speler in.
Parameters
  • Geen
Voorbeeldcode
playerObj.toggleNotes()

toggleClosedCaption

Naam van methode
toggleClosedCaption
Beschrijving
Weergave van ondertiteling in- en uitschakelen op de speler.
Parameters
  • Geen
Voorbeeldcode
playerObj.toggleClosedCaption()

changeLanguage

Naam van methode
changeLanguage
Beschrijving
Wijzig de taal van de inhoud op de speler.
Parameters
  • language: de taalcode die moet worden opgegeven.
Voorbeeldcode
playerObj.changeLanguage("es")

closePlayer

Naam van methode
closePlayer
Beschrijving
Sluit de speler en verwijder de speler van de pagina.
Parameters
  • Geen
Voorbeeldcode
playerObj.closePlayer()

togglePlayPause

Naam van methode
togglePlayPause
Beschrijving
Schakel tussen het afspelen en pauzeren van de inhoud op de speler.
Parameters
  • Geen
Voorbeeldcode
playerObj.togglePlayPause()

setVolume

Naam van methode
setVolume
Beschrijving
Stel het volume van de speler in. De waarde moet tussen 0 en 1 liggen.
Parameters
  • volume: de waarde van het volume. Het geldige bereik is 0-1.
Voorbeeldcode
playerObj.setVolume(0.5)

setPlayBackSpeed

Naam van methode
setPlayBackSpeed
Beschrijving
Stel de afspeelsnelheid in de speler in.
Parameters
  • speed: de waarde van de snelheid die moet worden opgegeven. Geldige waarden zijn 0,25, 0,5, 0,75, 1, 1,25, 1,5, 1,75, 2.
Voorbeeldcode
playerObj.setPlayBackSpeed(1.25)

zoek

Naam van methode
seek
Beschrijving
Ga naar een willekeurig moment in de video.
Parameters
  • time: de tijd om naartoe te springen. De tijd wordt in seconden weergegeven.
Voorbeeldcode
playerObj.seek(50)

voorwaarts

Naam van methode
forward
Beschrijving
Spring 10 seconden vooruit in de video.
Parameters
  • Geen
Voorbeeldcode
playerObj.forward()

achteruit

Naam van methode
backward
Beschrijving
Spring 10 seconden terug in de video.
Parameters
  • Geen
Voorbeeldcode
playerObj.backward()

navigateToPage

Naam van methode
navigateToPage
Beschrijving
Ga naar de opgegeven pagina op de PPT/PDF.
Parameters
  • pageNumber: Het paginanummer waar naartoe moet worden gegaan.
Voorbeeldcode
playerObj.navigateToPage (5)

nextPage

Naam van methode
nextPage
Beschrijving
Ga naar de volgende pagina in de PPT/PDF.
Parameters
  • Geen
Voorbeeldcode
playerObj.nextPage()

previousPage

Naam van methode
previousPage
Beschrijving
Ga naar de vorige pagina in de PPT/PDF.
Parameters
  • Geen
Voorbeeldcode
playerObj.previousPage()

zoomIn

Naam van methode
zoomIn
Beschrijving
Zoom in op de inhoud van een PPT/PDF.
Parameters
  • Geen
Voorbeeldcode
playerObj.zoomIn()

zoomOut

Naam van methode
zoomOut
Beschrijving
Zoom uit op de inhoud van een PPT/PDF.
Parameters
  • Geen
Voorbeeldcode
playerObj.zoomOut()

downloadJobAid

Naam van methode
downloadJobAid
Beschrijving
Download een taakhulp van een cursus.
Parameters
  • Geen
Voorbeeldcode
playerObj.downloadJobAid()

toggleJobAidPullout

Naam van methode
toggleJobAidPullout
Beschrijving
Of u een taakhulp wilt downloaden of niet.
Parameters
  • Geen
Voorbeeldcode
playerObj.toggleJobAidPullout()

fullScreen

Naam van methode
fullScreen
Beschrijving
Stel de speler in op de modus Volledig scherm.
Parameters
  • Geen
Voorbeeldcode
playerObj.fullScreen()

Lijst met gebeurtenissen

onPlayerEvents (callBack)

Bij de registratie wordt de callback-functie aangeroepen voor alle spelergebeurtenissen. De namen van de gebeurtenissen zijn als volgt:

  • PLAY (video/audio/CP)
  • PAUSE (video/audio/CP)
  • TIMEUPDATE (video/audio/CP)
  • PAGECHANGE (PPT/PDF)
  • NOTEADDED (alle inhoud)
  • LAUNCHED (alle inhoud)
  • STARTED (alle inhoud)
  • COMPLETED (alle inhoud)
  • PASSED (alle inhoud)
  • FAILED (alle inhoud)

onStreamingEvents (callBack)

Bij de registratie wordt de callback-functie aangeroepen voor alle instructies van de speler die worden verzonden om de gebruikersactiviteit te volgen.

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