API-dokumentasjon for interaksjon med den integrerte spilleren

Adobe Learning Manager inneholder et bibliotek, som kan integreres i en app. Dette biblioteket tilbyr ulike API-er for å lytte etter hendelser og utløse handlinger i den integrerte spilleren.

Ved hjelp av de medfølgende API-ene kan du spille av, midlertidig stanse og utføre andre handlinger i spilleren.

Last inn biblioteket

Biblioteket er nå tilgjengelig på denne plasseringen.

Følg trinnene nedenfor for å laste inn biblioteket:

  1. Last inn js-filen i forbrukerprogrammet. 
  2. window.cpPlayerLib er fylt ut ved innlasting av biblioteket. 

Merk: Hvis du ikke bruker prod US, må du angi parameterne cpPlayerLib.env og cpPlayerLib.sourceOrigin basert på ditt miljø.

Standardverdiene er: 

Tilgjengelige metoder

cpPlayerLib-biblioteket består av følgende funksjoner:

startPlayer

Metodenavn startPlayer
Beskrivelse Laster en spiller i appen.
Parametere
  • loId : ID-en til læringsobjektet.
  • accountId : Konto-ID-en til ALM-kontoen.
  • userId : Bruker-ID-en.
  • accessToken: tilgangstokenet.
  • domRefId: ID-en til div-beholderen der spilleren skal gjengis.
  • onModuleLoaded: Denne funksjonen aktiveres når modulene med detaljene nedenfor lastes inn.
    • contentType
    • loId
    • moduleId
    • completed
    • currentLanguage
    • availableLanguages
    • isCCAvailable
    • ccEnabled
Returer Returnerer et løfte. Ved løsning av løftet sendes et playerObj.
Unntak Løftet vil resultere i et unntak. 
Eksempelkode

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

//playerObj har API-ene for å samhandle med spilleren

}) >

getAllPlayers

Metodenavn getAllPlayers
Beskrivelse Returnerer alle spillerobjekter på den gjeldende siden. 
Parametere Ingen
Eksempelkode cpPlayerLib.getAllPlayers()

getPlayer

Metodenavn getPlayer
Beskrivelse Returnerer et spillerobjekt med den angitte ID-en til et læringsobjekt.
Parametere
  • loId : ID-en til læringsobjektet.
Eksempelkode cpPlayerLib.getPlayer(loId)

navigateToModule

Metodenavn navigateToModule
Beskrivelse Naviger til neste modul.
Parametere
  • moduleId: Modul-IDen.
Eksempelkode playerObj.navigateToModule
(modul-ID)

next

Metodenavn next
Beskrivelse Naviger til neste modul.
Parametere Ingen
Eksempelkode playerObj.next()

previous

Metodenavn previous
Beskrivelse Gå til forrige modul.
Parametere Ingen
Eksempelkode playerObj.previous()

toggleTOC

Metodenavn toggleTOC
Beskrivelse Slå panelet for innholdsfortegnelsen i spilleren på eller av.
Parametere Ingen
Eksempelkode playerObj.toggleTOC()

toggleNotes

Metodenavn toggleNotes
Beskrivelse Slå notatpanelet i spilleren på eller av.
Parametere Ingen
Eksempelkode playerObj.toggleNotes()

toggleClosedCaption

Metodenavn toggleClosedCaption
Beskrivelse Veksle mellom å vise og skjule undertekst i spilleren.
Parametere Ingen
Eksempelkode playerObj.toggleClosedCaption()

changeLanguage

Metodenavn changeLanguage
Beskrivelse Endre innholdsspråket i spilleren.
Parametere
  • språk: Språkkoden som skal angis.
Eksempelkode playerObj.changeLanguage("es")

closePlayer

Metodenavn closePlayer
Beskrivelse Lukk spilleren og fjern spilleren fra siden. 
Parametere Ingen
Eksempelkode playerObj.closePlayer()

togglePlayPause 

Metodenavn togglePlayPause
Beskrivelse Veksle mellom å spille av og midlertidig stanse innholdet i spilleren. 
Parametere Ingen
Eksempelkode playerObj.togglePlayPause()

setVolume

Metodenavn setVolume
Beskrivelse Still inn volumet på spilleren. Verdien må være mellom 0 og 1.
Parametere
  • volum: Verdien for volumet. Gyldig område er 0-1. 
Eksempelkode playerObj.setVolume(0.5)

setPlayBackSpeed

Metodenavn setPlayBackSpeed
Beskrivelse Angi hastigheten på avspillingen i spilleren. 
Parametere
  • hastighet: Hastighetsverdien som skal angis. Gyldige verdier er .25, .5, .75, 1, 1.25, 1.5, 1.75, 2.
Eksempelkode playerObj.setPlayBackSpeed(1.25)

seek

Metodenavn seek
Beskrivelse Hopp til når som helst i videoen.
Parametere
  • Tid: Tiden det skal hoppes til. Tiden er i sekunder.
Eksempelkode playerObj.seek(50)

forward

Metodenavn forward
Beskrivelse Hopp fram 10 sekunder i videoen.
Parametere Ingen
Eksempelkode playerObj.forward()

backward

Metodenavn backward
Beskrivelse Hopp 10 sekunder bakover i videoen.
Parametere Ingen
Eksempelkode playerObj.backward()

navigateToPage

Metodenavn navigateToPage
Beskrivelse Hopp til den angitte siden i PPT/PDF-filen.
Parametere
  • pageNumber: Sidetallet det skal hoppes til.
Eksempelkode playerObj.navigateToPage (5)

nextPage

Metodenavn nextPage
Beskrivelse Hopp til neste side i PPT/PDF-filen.
Parametere Ingen
Eksempelkode playerObj.nextPage()

previousPage

Metodenavn previousPage
Beskrivelse Hopp til forrige side i PPT/PDF-filen.
Parametere Ingen
Eksempelkode playerObj.previousPage()

zoomIn

Metodenavn zoomIn
Beskrivelse Zoom inn på innholdet i en PPT/PDF-fil.
Parametere Ingen
Eksempelkode playerObj.zoomIn()

zoomOut

Metodenavn zoomOut
Beskrivelse Zoom ut på innholdet i en PPT/PDF-fil.
Parametere Ingen
Eksempelkode playerObj.zoomOut()

downloadJobAid 

Metodenavn downloadJobAid
Beskrivelse Last ned jobbhjelp fra et kurs. 
Parametere Ingen
Eksempelkode playerObj.downloadJobAid()

toggleJobAidPullout 

Metodenavn toggleJobAidPullout
Beskrivelse Om du vil laste ned en jobbhjelp eller ikke. 
Parametere Ingen
Eksempelkode playerObj.toggleJobAidPullout()

Liste over hendelser

onPlayerEvents(callBack)

Ved registrering vil tilbakekallfunksjonen bli påkalt på alle spillerhendelser. Hendelsesnavnene er som følger:

  • PLAY (Video/ Lyd/ CP)

  • PAUSE (video/ lyd/ CP)

  • TIMEUPDATE (video/ lyd/ CP)

  • PAGECHANGE (PPT/ PDF)

  • NOTEADDED (Alt innhold)

  • LAUNCHED (alt innhold)

  • STARTED (alt innhold)

  • COMPLETED (alt innhold)

  • PASSED (alt innhold)

  • FAILED (alt innhold)

onStreamingEvents(callBack)

Ved registrering vil tilbakekallfunksjonen bli påkalt på alle spilleruttalelser som sendes for å spore brukeraktivitet.

Adobe, Inc.

Få hjelp raskere og enklere

Ny bruker?