Documentation sur les API d’interaction avec le lecteur intégré

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

Adobe Learning Manager fournit une bibliothèque pouvant être intégrée dans une application. Cette bibliothèque fournit diverses API permettant d’écouter des événements et de déclencher des actions dans le lecteur intégré.

Avec les API fournies, vous pouvez lire et mettre en pause la lecture, ainsi qu’effectuer des actions supplémentaires sur le lecteur.

Chargement de la bibliothèque

La bibliothèque est disponible à cet emplacement.

Pour charger la bibliothèque, procédez comme suit :

Chargez le fichier js dans l’application client.
Lors du chargement de la bibliothèque, window.cpPlayerLib sera renseigné.

NOTE

Si vous n'utilisez pas prod US, définissez les paramètres cpPlayerLib.env et cpPlayerLib.sourceOrigin en fonction de votre env.

Les valeurs par défaut sont :

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

Méthodes disponibles

La bibliothèque cpPlayerLib comporte les fonctions suivantes :

startPlayer

Nom de la méthode

startPlayer

Description

Charge un lecteur dans l’application.

Paramètres

loId : ID de l’objet d’apprentissage.
accountId : ID de compte du compte ALM.
userId : ID utilisateur.
accessToken : jeton d’accès.
domRefId : ID du conteneur div dans lequel afficher le lecteur.
onModuleLoaded : cette fonction est appelée lorsque les modules avec les détails ci-dessous sont chargés.
contentType
loId
moduleId
completed
currentLanguage
availableLanguages
isCCAvailable
ccEnabled

Retours

Renvoie une promesse. Une fois la promesse résolue, un playerObj sera passé.

Exception

La promesse entraînera une exception.

Exemple de code

cpPlayerLib.startPlayer(loId, accountId, userId, accessToken, domRefId, onModuleLoaded).then((playerObj) => {//playerObj dispose des api pour interagir avec le lecteur}) >

getAllPlayers

Nom de la méthode

getAllPlayers

Description

Renvoie tous les objets Player de la page active.

Paramètres

Aucune

Exemple de code

cpPlayerLib.getAllPlayers()

getPlayer

Nom de la méthode

getPlayer

Description

Renvoie un objet Player avec l'ID d'objet d'apprentissage spécifié.

Paramètres

loId : ID de l’objet d’apprentissage.

Exemple de code

cpPlayerLib.getPlayer(loId)

navigateToModule

Nom de la méthode

navigateToModule

Description

Accéder au module suivant.

Paramètres

moduleId : ID du module.

Exemple de code

playerObj.navigateToModule(moduleID)

suivant

Nom de la méthode

Description

Accéder au module suivant.

Paramètres

Aucune

Exemple de code

playerObj.next()

précédent

Nom de la méthode

Description

Accéder au module précédent.

Paramètres

Aucune

Exemple de code

playerObj.previous()

toggleTOC

Nom de la méthode

toggleTOC

Description

Activer/désactiver le panneau Table des matières sur le lecteur.

Paramètres

Aucune

Exemple de code

playerObj.toggleTOC()

toggleNotes

Nom de la méthode

toggleNotes

Description

Activer/désactiver le panneau Notes sur le lecteur.

Paramètres

Aucune

Exemple de code

playerObj.toggleNotes()

toggleClosedCaption

Nom de la méthode

toggleClosedCaption

Description

Activez/désactivez l’affichage des sous-titres sur le lecteur.

Paramètres

Aucune

Exemple de code

playerObj.toggleClosedCaption()

changeLanguage

Nom de la méthode

changeLanguage

Description

Modifiez la langue du contenu sur le lecteur.

Paramètres

language : code de langue à spécifier.

Exemple de code

playerObj.changeLanguage("es")

closePlayer

Nom de la méthode

closePlayer

Description

Fermez le lecteur et supprimez-le de la page.

Paramètres

Aucune

Exemple de code

playerObj.closePlayer()

togglePlayPause

Nom de la méthode

togglePlayPause

Description

Basculez entre la lecture et la suspension du contenu sur le lecteur.

Paramètres

Aucune

Exemple de code

playerObj.togglePlayPause()

setVolume

Nom de la méthode

setVolume

Description

Régler le volume du lecteur. La valeur doit être comprise entre 0 et 1.

Paramètres

volume : valeur du volume. La plage valide est 0-1.

Exemple de code

playerObj.setVolume(0.5)

setPlayBackSpeed

Nom de la méthode

setPlayBackSpeed

Description

Définissez la vitesse de lecture dans le lecteur.

Paramètres

speed : valeur de la vitesse à spécifier. Les valeurs valides sont .25, .5, .75, 1, 1.25, 1.5, 1.75, 2.

Exemple de code

playerObj.setPlayBackSpeed(1.25)

recherche

Nom de la méthode

rechercher

Description

Accès à n’importe quel moment de la vidéo.

Paramètres

time : heure de sauter. L’heure est spécifiée en secondes.

Exemple de code

playerObj.seek(50)

en avant

Nom de la méthode

avance

Description

Avance de 10 secondes dans la vidéo.

Paramètres

Aucune

Exemple de code

playerObj.forward()

en arrière

Nom de la méthode

backward

Description

Retour de 10 secondes dans la vidéo.

Paramètres

Aucune

Exemple de code

playerObj.backward()

navigateToPage

Nom de la méthode

navigateToPage

Description

Accès à la page spécifiée sur le PPT/PDF.

Paramètres

pageNumber : numéro de la page cible.

Exemple de code

playerObj.navigateToPage (5)

nextPage

Nom de la méthode

Description

Accès à la page suivante sur le PPT/PDF.

Paramètres

Aucune

Exemple de code

playerObj.nextPage()

previousPage

Nom de la méthode

Description

Retour à la page précédente sur le PPT/PDF.

Paramètres

Aucune

Exemple de code

playerObj.previousPage()

zoomIn

Nom de la méthode

zoomIn

Description

Effectuer un zoom avant du contenu d’un PPT/PDF.

Paramètres

Aucune

Exemple de code

playerObj.zoomIn()

zoom arrière

Nom de la méthode

zoomOut

Description

Effectuer un zoom arrière du contenu d’un PPT/PDF.

Paramètres

Aucune

Exemple de code

playerObj.zoomOut()

downloadJobAid

Nom de la méthode

downloadJobAid

Description

Téléchargement d’une assistance à la tâche à partir d’un cours

Paramètres

Aucune

Exemple de code

playerObj.downloadJobAid()

toggleJobAidPullout

Nom de la méthode

toggleJobAidPullout

Description

Si vous souhaitez télécharger une assistance à la tâche.

Paramètres

Aucune

Exemple de code

playerObj.toggleJobAidPullout()

plein écran

Nom de la méthode

fullScreen

Description

Définissez le lecteur en mode plein écran.

Paramètres

Aucune

Exemple de code

playerObj.fullScreen()

Liste des événements

onPlayerEvents(callBack)

Lors de l’enregistrement, la fonction de rappel est appelée sur tous les événements du lecteur. Voici les noms des événements :

PLAY (vidéo / audio / CP)
PAUSE (vidéo / audio / CP)
TIMEUPDATE (vidéo / audio / CP)
PAGECHANGE (PPT / PDF)
NOTEADDED (tout le contenu)
LAUNCHED (tout le contenu)
STARTED (tout le contenu)
COMPLETED (tout le contenu)
PASSED (tout le contenu)
FAILED (tout le contenu)

onStreamingEvents(callBack)

Lors de l’enregistrement, la fonction de rappel est appelée sur toutes les instructions du lecteur envoyées pour effectuer le suivi de l’activité de l’utilisateur.

recommendation-more-help

d5e5961a-141b-4c77-820e-8453ddef913d