DocumentazioneLearning Manager

Documentazione API per l’interazione col lettore incorporato

Ultimo aggiornamento: 11 febbraio 2025

Adobe Learning Manager offre una libreria che può essere integrata in un’app. Questa libreria fornisce varie API per ascoltare gli eventi e attivare le azioni nel lettore incorporato.

Utilizzando le API fornite puoi riprodurre, mettere in pausa ed eseguire altre azioni sul lettore.

Caricamento della libreria

La libreria è disponibile qui.

Per caricare la libreria, effettua le seguenti operazioni:

  1. Carica il file js nell’applicazione consumer.
  2. Al caricamento della libreria, window.cpPlayerLib viene popolato.
NOTA
Se non utilizzi prod US, imposta i parametri cpPlayerLib.env e cpPlayerLib.sourceOrigin in base alla tua env.

I valori predefiniti sono:

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

Metodi disponibili

La libreria cpPlayerLib è composta dalle seguenti funzioni:

startPlayer

Nome metodostartPlayer
DescrizioneCarica un lettore nell’app.
Parametri

  • loId: l’ID dell’oggetto di apprendimento.

  • accountId: l’ID account dell’account ALM.

  • userId: l’ID utente.

  • accessToken: il token di accesso.

  • domRefId: l’ID del contenitore div in cui deve essere eseguito il rendering del lettore.

  • onModuleLoaded: questa funzione viene richiamata quando vengono caricati i moduli con i dettagli seguenti.

  • contentType

  • loId

  • moduleId

  • completed

  • currentLanguage

  • availableLanguages

  • isCCAavailable

  • ccEnabled

RestituisceRestituisce una promessa. Alla risoluzione della promessa, verrà passato un playerObj.
EccezioneLa promessa darà luogo a un'eccezione.
Codice di esempio

cpPlayerLib.startPlayer(loId, accountId, userId, accessToken, domRefId, onModuleLoaded).then((playerObj) => {//playerObj ha le api per interagire con il lettore})

getAllPlayers

Nome del metodogetAllPlayers
DescrizioneRestituisce tutti gli oggetti player nella pagina corrente.
ParametriNessuno
Codice di esempiocpPlayerLib.getAllPlayers()

getPlayer

Nome del metodogetPlayer
DescrizioneRestituisce un oggetto player con l’ID dell’oggetto di apprendimento specificato.
Parametri
  • loId: l’ID dell’oggetto di apprendimento.
Codice di esempiocpPlayerLib.getPlayer(loId)

navigateToModule

Nome del metodonavigateToModule
DescrizionePassa al modulo successivo.
Parametri
  • moduleId: l’ID del modulo.
Codice di esempioplayerObj.navigateToModule(moduleID)

avanti

Nome del metodonext
DescrizionePassa al modulo successivo.
Parametri
  • Nessuno
Codice di esempioplayerObj.next()

precedente

Nome del metodoprevious
DescrizionePassa al modulo precedente.
Parametri
  • Nessuno
Codice di esempioplayerObj.previous()

toggleTOC

Nome del metodotoggleTOC
DescrizioneAttiva/disattiva il pannello Sommario sul lettore.
Parametri
  • Nessuno
Codice di esempioplayerObj.toggleTOC()

toggleNotes

Nome del metodotoggleNotes
DescrizioneAttiva/disattiva il pannello Note sul lettore.
Parametri
  • Nessuno
Codice di esempioplayerObj.toggleNotes()

toggleClosedCaption

Nome del metodotoggleClosedCaption
DescrizioneAttiva/disattiva la visualizzazione dei sottotitoli codificati sul lettore.
Parametri
  • Nessuno
Codice di esempioplayerObj.toggleClosedCaption()

changeLanguage

Nome del metodochangeLanguage
DescrizioneCambia la lingua del contenuto sul lettore.
Parametri
  • language: il codice della lingua da specificare.
Codice di esempioplayerObj.changeLanguage("es")

closePlayer

Nome del metodoclosePlayer
DescrizioneChiudere il lettore e rimuoverlo dalla pagina.
Parametri
  • Nessuno
Codice di esempioplayerObj.closePlayer()

togglePlayPause

Nome del metodotogglePlayPause
DescrizioneAlterna la riproduzione e la sospensione del contenuto sul lettore.
Parametri
  • Nessuno
Codice di esempioplayerObj.togglePlayPause()

setVolume

Nome del metodosetVolume
DescrizioneImposta il volume del lettore. Il valore deve essere compreso tra 0 e 1.
Parametri
  • volume: il valore del volume. L'intervallo valido è 0-1.
Codice di esempioplayerObj.setVolume(0.5)

setPlayBackSpeed

Nome del metodosetPlayBackSpeed
DescrizioneImpostare la velocità di riproduzione nel lettore.
Parametri
  • speed: il valore della velocità da specificare. I valori validi sono .25, .5, .75, 1, 1.25, 1.5, 1.75, 2.
Codice di esempioplayerObj.setPlayBackSpeed(1.25)

cerca

Nome del metodoseek
DescrizionePassa a qualsiasi punto del video.
Parametri
  • time: il punto a cui passare. Il punto è espresso in secondi.
Codice di esempioplayerObj.seek(50)

avanti

Nome del metodoforward
DescrizioneVa avanti di 10 secondi nel video.
Parametri
  • Nessuno
Codice di esempioplayerObj.forward()

indietro

Nome del metodobackward
DescrizioneVa indietro di 10 secondi nel video.
Parametri
  • Nessuno
Codice di esempioplayerObj.backward()

navigateToPage

Nome del metodonavigateToPage
DescrizionePassa alla pagina specificata sul PPT/PDF.
Parametri
  • pageNumber: numero della pagina a cui passare.
Codice di esempioplayerObj.navigateToPage (5)

paginaSuccessiva

Nome del metodo
nextPage
Descrizione
Passa alla pagina successiva sul PPT/PDF.
Parametri
  • Nessuno
Codice di esempio
playerObj.nextPage()

paginaPrecedente

Nome del metodo
previousPage
Descrizione
Passa alla pagina precedente sul PPT/PDF.
Parametri
  • Nessuno
Codice di esempio
playerObj.previousPage()

zoomIn

Nome del metodo
zoomIn
Descrizione
Ingrandisce i contenuti su un PPT/PDF.
Parametri
  • Nessuno
Codice di esempio
playerObj.zoomIn()

zoomOut

Nome del metodo
zoomOut
Descrizione
Rimpicciolisce i contenuti su un PPT/PDF.
Parametri
  • Nessuno
Codice di esempio
playerObj.zoomOut()

downloadJobAid

Nome del metodo
downloadJobAid
Descrizione
Scarica una risorsa formativa da un corso.
Parametri
  • Nessuno
Codice di esempio
playerObj.downloadJobAid()

toggleJobAidPullout

Nome del metodo
toggleJobAidPullout
Descrizione
Se desideri o meno scaricare una risorsa formativa.
Parametri
  • Nessuno
Codice di esempio
playerObj.toggleJobAidPullout()

schermo intero

Nome del metodo
fullScreen
Descrizione
Imposta il lettore sulla modalità a schermo intero.
Parametri
  • Nessuno
Codice di esempio
playerObj.fullScreen()

Elenco degli eventi

onPlayerEvents(callBack)

Al momento della registrazione, la funzione di callback viene richiamata in tutti gli eventi del lettore. I nomi degli eventi sono i seguenti:

  • PLAY (video/audio/CP)
  • PAUSE (video/audio/CP)
  • TIMEUPDATE (video/audio/CP)
  • PAGECHANGE (PPT/PDF)
  • NOTEADDED (tutti i contenuti)
  • LAUNCHED (tutti i contenuti)
  • STARTED (tutti i contenuti)
  • COMPLETED (tutti i contenuti)
  • PASSED (tutti i contenuti)
  • FAILED (tutti i contenuti)

onStreamingEvents(callBack)

Al momento della registrazione, la funzione di callback viene richiamata su tutte le istruzioni del lettore inviate per il monitoraggio dell’attività dell’utente.

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