DokumentationLearning Manager

API-dokumentation för inbäddad Player-interaktion

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

Adobe Learning Manager tillhandahåller ett bibliotek som kan integreras i ett program. Det här biblioteket innehåller olika API:er för att lyssna på händelser och utlösa åtgärder i den inbäddade spelaren.

Med de tillhandahållna API:erna kan du spela upp, pausa och utföra andra åtgärder på spelaren.

Läs in biblioteket

Biblioteket är tillgängligt på den här platsen.

Läs in biblioteket genom att följa stegen nedan:

  1. Läs in js-filen i konsumentprogrammet.
  2. När biblioteket laddas fylls window.cpPlayerLib i.
NOTE
Om du inte använder prod US anger du parametrarna cpPlayerLib.env och cpPlayerLib.sourceOrigin baserat på din env.

Standardvärdena är:

Tillgängliga metoder

Biblioteket cpPlayerLib består av följande funktioner:

startPlayer

Metodnamn
startPlayer
Beskrivning
Läser in en spelare i appen.
Parametrar

  • LoID : Utbildningsobjekts-ID.

  • konto-ID : konto-ID för ALM-kontot.

  • userId : Användar-id.

  • accessToken : Åtkomsttoken.

  • domRefId: ID:t för div-behållaren där spelaren måste renderas.

  • onModuleLoaded: Den här funktionen anropas när modulerna med nedanstående information läses in.

  • contentType

  • loId

  • moduleId

  • Genomgång av

  • currentLanguage

  • availableLanguages

  • isCCAvailable

  • ccEnabled

Returer
Returnerar ett löfte. Vid lösning av löftet, en playerObj kommer att passeras.
Undantag
Löftet kommer att resultera i ett undantag.
Exempelkod
cpPlayerLib.startPlayer(loId, accountId, userId, accessToken, domRefId, onModuleLoaded).then((playerObj) => {//playerObj har API:er för att interagera med spelaren}) >

getAllPlayers

Metodnamn
getAllPlayers
Beskrivning
Returnerar alla spelarobjekt på den aktuella sidan.
Parametrar
Inget
Exempelkod
cpPlayerLib.getAllPlayers()

getPlayer

Metodnamn
getPlayer
Beskrivning
Returnerar ett spelarobjekt med angivet ID för utbildningsobjekt.
Parametrar
  • LoID : Utbildningsobjekts-ID.
Exempelkod
cpPlayerLib.getPlayer(loId)

navigateToModule

Metodnamn
navigateToModule
Beskrivning
Gå till nästa modul.
Parametrar
  • moduleId: modul-id.
Exempelkod
playerObj.navigateToModule(moduleID)

nästa

Metodnamn
nästa
Beskrivning
Gå till nästa modul.
Parametrar
  • Inget
Exempelkod
playerObj.next()

tidigare

Metodnamn
föregående
Beskrivning
Gå till föregående modul.
Parametrar
  • Inget
Exempelkod
playerObj.previous()

toggleTOC

Metodnamn
toggleTOC
Beskrivning
Växla panelen för innehållsförteckning i spelaren.
Parametrar
  • Inget
Exempelkod
playerObj.toggleTOC()

växlingsanteckningar

Metodnamn
toggleNotes
Beskrivning
Växla anteckningspanelen i spelaren.
Parametrar
  • Inget
Exempelkod
playerObj.toggleNotes()

toggleClosedCaption

Metodnamn
toggleClosedCaption
Beskrivning
Aktivera/avaktivera visning av undertexter i spelaren.
Parametrar
  • Inget
Exempelkod
playerObj.toggleClosedCaption()

changeLanguage

Metodnamn
changeLanguage
Beskrivning
Ändra språk för innehållet i spelaren.
Parametrar
  • språk: Språkkoden som ska anges.
Exempelkod
playerObj.changeLanguage("es")

closePlayer

Metodnamn
closePlayer
Beskrivning
Stäng spelaren och ta bort den från sidan.
Parametrar
  • Inget
Exempelkod
playerObj.closePlayer()

togglePlayPause

Metodnamn
togglePlayPause
Beskrivning
Växla mellan att spela upp och pausa innehållet i spelaren.
Parametrar
  • Inget
Exempelkod
playerObj.togglePlayPause()

setVolume

Metodnamn
setVolume
Beskrivning
Ställ in volymen för spelaren. Värdet måste vara mellan 0 och 1.
Parametrar
  • volym: Volymens värde. Giltigt intervall är 0-1.
Exempelkod
playerObj.setVolume(0.5)

setPlayBackSpeed

Metodnamn
setPlayBackSpeed
Beskrivning
Ställ in uppspelningshastigheten i spelaren.
Parametrar
  • hastighet: värdet på den hastighet som ska anges. Giltiga värden är .25, .5, .75, 1, 1.25, 1.5, 1.75, 2.
Exempelkod
playerObj.setPlayBackSpeed(1.25)

sök

Metodnamn
söka
Beskrivning
Hoppa till när som helst på videon.
Parametrar
  • tid: Dags att hoppa till. Tiden är i sekunder.
Exempelkod
playerObj.seek(50)

framåt

Metodnamn
vidarebefordra
Beskrivning
Hoppa framåt i videon med 10 sekunder.
Parametrar
  • Inget
Exempelkod
playerObj.forward()

bakåt

Metodnamn
efterbliven
Beskrivning
Hoppa bakåt i videon med 10 sekunder.
Parametrar
  • Inget
Exempelkod
playerObj.backward()

navigateToPage

Metodnamn
navigateToPage
Beskrivning
Hoppa till angiven sida på PPT/PDF.
Parametrar
  • pageNumber: Sidnumret som du vill gå till.
Exempelkod
playerObj.navigateToPage (5)

nextPage

Metodnamn
nextPage
Beskrivning
Hoppa till nästa sida på PPT/PDF.
Parametrar
  • Inget
Exempelkod
playerObj.nextPage()

previousPage

Metodnamn
previousPage
Beskrivning
Hoppa till föregående sida på PPT/PDF.
Parametrar
  • Inget
Exempelkod
playerObj.previousPage()

zoomaIn

Metodnamn
zoomIn
Beskrivning
Zooma in på innehåll på en PPT/PDF.
Parametrar
  • Inget
Exempelkod
playerObj.zoomIn()

zooma ut

Metodnamn
zoomOut
Beskrivning
Zooma ut på innehåll på en PPT/PDF.
Parametrar
  • Inget
Exempelkod
playerObj.zoomOut()

downloadJobAid

Metodnamn
downloadJobAid
Beskrivning
Ladda ned arbetsstöd från en kurs.
Parametrar
  • Inget
Exempelkod
playerObj.downloadJobAid()

toggleJobAidPullout

Metodnamn
toggleJobAidPullout
Beskrivning
Om du vill ladda ned ett arbetsstöd eller inte.
Parametrar
  • Inget
Exempelkod
playerObj.toggleJobAidPullout()

helskärm

Metodnamn
fullScreen
Beskrivning
Ställ in spelaren på helskärmsläge.
Parametrar
  • Inget
Exempelkod
playerObj.fullScreen()

Lista över händelser

onPlayerEvents(callBack)

När du registrerar återanropsfunktionen anropas alla spelarhändelser. Händelsenamnen är följande:

  • SPELA UPP (video/ljud/CP)
  • PAUSA (Video/Ljud/CP)
  • TIMEUPDATE (video/ljud/CP)
  • PAGECHANGE (PPT/PDF)
  • ANTECKNAT (allt innehåll)
  • STARTAD (allt innehåll)
  • INLEDDES (allt innehåll)
  • SLUTFÖRT (allt innehåll)
  • GODKÄNT (allt innehåll)
  • MISSLYCKADES (allt innehåll)

onStreamingEvents(callBack)

När du registrerar återanropsfunktionen anropas alla Player-satser som skickas för att spåra användaraktivitet.

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