Documentación de la API de interacción de Embedded Player

Buscar

Última actualización el 13 abr. 2023

Adobe Learning Manager proporciona una biblioteca que se puede integrar en una aplicación. Esta biblioteca proporciona varias API para escuchar eventos y activar acciones en el reproductor incrustado.

Con las API proporcionadas, puede reproducir, pausar y realizar otras acciones en el reproductor.

Cargar la biblioteca

La biblioteca está disponible en esta ubicación.

Para cargar la biblioteca, siga los pasos que se indican a continuación:

Cargue el archivo js en la aplicación de consumidor.
Al cargar la biblioteca, se rellenará window.cpPlayerLib.

Nota: Si no utiliza prod US, configure los parámetros cpPlayerLib.env y cpPlayerLib.sourceOrigin según su env.

Los valores predeterminados son:

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

Métodos disponibles

La biblioteca cpPlayerLib consta de las siguientes funciones:

startPlayer

Nombre del método	startPlayer
Descripción	Carga un reproductor en la aplicación.
Parámetros	loId: El ID del objeto de aprendizaje. accountId: El ID de cuenta de la cuenta de ALM. userId: El seudónimo. tokenDeAcceso: El token de acceso. domRefId: El ID del contenedor div en el que se debe procesar el reproductor. onModuleLoaded: Esta función se invocará cuando se carguen los módulos con los siguientes detalles. contentType loId moduleId completado currentLanguage availableLanguages isCCAavailable ccEnabled
Devoluciones	Devuelve una promesa. En la resolución de la promesa, se pasará un playerObj.
Excepción	La promesa resultará en una excepción.
Código de ejemplo	cpPlayerLib.startPlayer(loId, accountId, userId, accessToken, domRefId, onModuleLoaded).then(playerObj) => { //playerObj tiene las api para interactuar con el reproductor }) >

getAllPlayers

Nombre del método	getAllPlayers
Descripción	Devuelve todos los objetos de reproductor de la página actual.
Parámetros	Ninguno
Código de ejemplo	cpPlayerLib.getAllPlayers()

getPlayer

Nombre del método	getPlayer
Descripción	Devuelve un objeto de reproductor con el ID de objeto de aprendizaje especificado.
Parámetros	loId: El ID del objeto de aprendizaje.
Código de ejemplo	cpPlayerLib.getPlayer(loId)

navigateToModule

Nombre del método	navigateToModule
Descripción	Vaya al siguiente módulo.
Parámetros	moduleId: El ID del módulo.
Código de ejemplo	playerObj.navigateToModule (ID de módulo)

siguiente

Nombre del método	siguiente
Descripción	Vaya al siguiente módulo.
Parámetros	Ninguno
Código de ejemplo	playerObj.next()

anterior

Nombre del método	anterior
Descripción	Vaya al módulo anterior.
Parámetros	Ninguno
Código de ejemplo	playerObj.previous()

toggleTOC

Nombre del método	toggleTOC
Descripción	Active el panel del índice en el reproductor.
Parámetros	Ninguno
Código de ejemplo	playerObj.toggleTOC()

toggleNotes

Nombre del método	toggleNotes
Descripción	Active el panel de notas en el reproductor.
Parámetros	Ninguno
Código de ejemplo	playerObj.toggleNotes()

toggleClosedCaption

Nombre del método	toggleClosedCaption
Descripción	Active o desactive la visualización de subtítulos opcionales en el reproductor.
Parámetros	Ninguno
Código de ejemplo	playerObj.toggleClosedCaption()

changeLanguage

Nombre del método	changeLanguage
Descripción	Cambie el idioma del contenido en el reproductor.
Parámetros	idioma: El código de idioma que se va a especificar.
Código de ejemplo	playerObj.changeLanguage("es")

closePlayer

Nombre del método	closePlayer
Descripción	Cierre el reproductor y quítelo de la página.
Parámetros	Ninguno
Código de ejemplo	playerObj.closePlayer()

togglePlayPause

Nombre del método	togglePlayPause
Descripción	Alterne entre reproducir y pausar el contenido en el reproductor.
Parámetros	Ninguno
Código de ejemplo	playerObj.togglePlayPause()

setVolume

Nombre del método	setVolume
Descripción	Ajuste el volumen del reproductor. El valor debe estar entre 0 y 1.
Parámetros	volumen: El valor del volumen. El intervalo válido es 0-1.
Código de ejemplo	playerObj.setVolume(0,5)

setPlayBackSpeed

Nombre del método	setPlayBackSpeed
Descripción	Establezca la velocidad de reproducción en el reproductor.
Parámetros	velocidad: Valor de la velocidad que se va a especificar. Los valores válidos son 0,25, 0,5, 0,75, 1, 1,25, 1,5, 1,75, 2.
Código de ejemplo	playerObj.setPlayBackSpeed(1,25)

buscar

Nombre del método	buscar
Descripción	Ve a cualquier momento del vídeo.
Parámetros	hora: El momento para saltar. El tiempo es en segundos.
Código de ejemplo	playerObj.seek(50)

adelante

Nombre del método	adelante
Descripción	Avanza 10 segundos en el vídeo.
Parámetros	Ninguno
Código de ejemplo	playerObj.forward()

atrasado

Nombre del método	atrasado
Descripción	Retroceder 10 segundos en el vídeo.
Parámetros	Ninguno
Código de ejemplo	playerObj.backward()

navigateToPage

Nombre del método	navigateToPage
Descripción	Ir a la página especificada en PPT/PDF.
Parámetros	pageNumber: Número de página al que se va a saltar.
Código de ejemplo	playerObj.navigateToPage (5)

nextPage

Nombre del método	nextPage
Descripción	Ir a la página siguiente en el PPT/PDF.
Parámetros	Ninguno
Código de ejemplo	playerObj.nextPage()

previousPage

Nombre del método	previousPage
Descripción	Ir a la página anterior en el PPT/PDF.
Parámetros	Ninguno
Código de ejemplo	playerObj.previousPage()

acercar

Nombre del método	acercar
Descripción	Aumente el contenido en un PPT/PDF.
Parámetros	Ninguno
Código de ejemplo	playerObj.zoomIn()

alejarZoom

Nombre del método	alejarZoom
Descripción	Reducir el contenido en un PPT/PDF.
Parámetros	Ninguno
Código de ejemplo	playerObj.zoomOut()

downloadJobAid

Nombre del método	downloadJobAid
Descripción	Descargar una ayuda de trabajo de un curso.
Parámetros	Ninguno
Código de ejemplo	playerObj.downloadJobAid()

toggleJobAidPullout

Nombre del método	toggleJobAidPullout
Descripción	Si desea o no descargar una ayuda de trabajo.
Parámetros	Ninguno
Código de ejemplo	playerObj.toggleJobAidPullout()

Lista de eventos

onPlayerEvents(callBack)

Al registrar la función de devolución de llamada se invoca en todos los eventos del reproductor. Los nombres de los eventos son los siguientes:

REPRODUCCIÓN (Vídeo/Audio/CP)
PAUSA (Vídeo/Audio/CP)
ACTUALIZACIÓN DE TIEMPO (Vídeo/Audio/CP)
CAMBIO DE PÁGINA (PPT/ PDF)
NOTA AÑADIDA (Todo el contenido)
LANZADO (Todo el contenido)
INICIADO (Todo el contenido)
COMPLETADO (Todo el contenido)
PASADO (Todo el contenido)
FALLIDO (Todo el contenido)

onStreamingEvents(callBack)

Al registrar la función de devolución de llamada se invoca en todas las declaraciones de reproductor que se envían para realizar un seguimiento de la actividad del usuario.