Documentazione API per l’interazione col lettore incorporato

Cerca

Ultimo aggiornamento il 13 apr 2023

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:

Carica il file js nell’applicazione consumer.
Al caricamento della libreria, window.cpPlayerLib viene popolato.

Nota: se non utilizzi prod US, imposta params cpPlayerLib.env e cpPlayerLib.sourceOrigin in base al tuo 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 del metodo	startPlayer
Descrizione	Carica 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
Restituisce	Restituisce una promessa. Una volta risoluta la promessa, viene passato un playerObj.
Eccezione	La promessa genera un’eccezione.
Codice di esempio	cpPlayerLib.startPlayer(loId, accountId, userId, accessToken, domRefId, onModuleLoaded).then((playerObj) => { //playerObj has the apis to interact with the player }) >

getAllPlayers

Nome del metodo	getAllPlayers
Descrizione	Restituisce tutti gli oggetti lettore presenti nella pagina corrente.
Parametri	Nessuno
Codice di esempio	cpPlayerLib.getAllPlayers()

getPlayer

Nome del metodo	getPlayer
Descrizione	Restituisce un oggetto lettore con l’id dell’oggetto di apprendimento specificato.
Parametri	loId: l’ID dell’oggetto di apprendimento.
Codice di esempio	cpPlayerLib.getPlayer(loId)

navigateToModule

Nome del metodo	navigateToModule
Descrizione	Passa al modulo successivo.
Parametri	moduleId: l’ID del modulo.
Codice di esempio	playerObj.navigateToModule (moduleID)

next

Nome del metodo	next
Descrizione	Passa al modulo successivo.
Parametri	Nessuno
Codice di esempio	playerObj.next()

previous

Nome del metodo	previous
Descrizione	Passa al modulo precedente.
Parametri	Nessuno
Codice di esempio	playerObj.previous()

toggleTOC

Nome del metodo	toggleTOC
Descrizione	Attiva/disattiva il pannello Sommario sul lettore.
Parametri	Nessuno
Codice di esempio	playerObj.toggleTOC()

toggleNotes

Nome del metodo	toggleNotes
Descrizione	Attiva/disattiva il pannello Note sul lettore.
Parametri	Nessuno
Codice di esempio	playerObj.toggleNotes()

toggleClosedCaption

Nome del metodo	toggleClosedCaption
Descrizione	Attiva/disattiva la visualizzazione dei sottotitoli codificati sul lettore.
Parametri	Nessuno
Codice di esempio	playerObj.toggleClosedCaption()

changeLanguage

Nome del metodo	changeLanguage
Descrizione	Cambia la lingua dei contenuti nel lettore.
Parametri	language: il codice della lingua da specificare.
Codice di esempio	playerObj.changeLanguage("es")

closePlayer

Nome del metodo	closePlayer
Descrizione	Chiude il lettore e lo rimuove dalla pagina.
Parametri	Nessuno
Codice di esempio	playerObj.closePlayer()

togglePlayPause

Nome del metodo	togglePlayPause
Descrizione	Passa dalla riproduzione alla messa in pausa del contenuto sul lettore.
Parametri	Nessuno
Codice di esempio	playerObj.togglePlayPause()

setVolume

Nome del metodo	setVolume
Descrizione	Imposta 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 esempio	playerObj.setVolume(0.5)

setPlayBackSpeed

Nome del metodo	setPlayBackSpeed
Descrizione	Imposta la velocità di riproduzione nel lettore.
Parametri	speed: il valore della velocità da specificare. I valori validi sono 0,25, 0,5, 0,75, 1, 1,25, 1,5, 1,75, 2.
Codice di esempio	playerObj.setPlayBackSpeed(1.25)

seek

Nome del metodo	seek
Descrizione	Passa a qualsiasi punto del video.
Parametri	time: il punto a cui passare. Il punto è espresso in secondi.
Codice di esempio	playerObj.seek(50)

forward

Nome del metodo	forward
Descrizione	Va avanti di 10 secondi nel video.
Parametri	Nessuno
Codice di esempio	playerObj.forward()

backward

Nome del metodo	backward
Descrizione	Va indietro di 10 secondi nel video.
Parametri	Nessuno
Codice di esempio	playerObj.backward()

navigateToPage

Nome del metodo	navigateToPage
Descrizione	Passa alla pagina specificata sul PPT/PDF.
Parametri	pageNumber: il numero di pagina a cui passare.
Codice di esempio	playerObj.navigateToPage (5)

nextPage

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

previousPage

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 scaricare o meno una risorsa formativa.
Parametri	Nessuno
Codice di esempio	playerObj.toggleJobAidPullout()

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.