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

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 :

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

Remarque : si vous n’utilisez pas prod US, définissez les paramètres cpPlayerLib.env et cpPlayerLib.sourceOrigin en fonction de votre environnement.

Voici les valeurs par défaut : 

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. À la résolution de la promesse, un playerObj est transmis.
Exception La promesse entraîne une exception. 
Exemple de code

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

//playerObj has the apis to interact with the player

}) >

getAllPlayers

Nom de la méthode getAllPlayers
Description Renvoie tous les objets de lecteur de la page actuelle. 
Paramètres Aucune
Exemple de code cpPlayerLib.getAllPlayers()

getPlayer

Nom de la méthode getPlayer
Description Renvoie un objet de lecteur 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 suivant
Description Accéder au module suivant.
Paramètres Aucune
Exemple de code playerObj.next()

previous

Nom de la méthode previous
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 Activer/désactiver l’affichage des sous-titres sur le lecteur.
Paramètres Aucune
Exemple de code playerObj.toggleClosedCaption()

changeLanguage

Nom de la méthode changeLanguage
Description Modifier 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 Fermer le lecteur et le supprimer sur la page. 
Paramètres Aucune
Exemple de code playerObj.closePlayer()

togglePlayPause 

Nom de la méthode togglePlayPause
Description Basculer entre la lecture et la mise en pause 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 comprise entre 0 et 1. 
Exemple de code playerObj.setVolume(0.5)

setPlayBackSpeed

Nom de la méthode setPlayBackSpeed
Description Définir 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)

rechercher

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)

avance

Nom de la méthode avance
Description Avance de 10 secondes dans la vidéo.
Paramètres Aucune
Exemple de code playerObj.forward()

backward

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 à laquelle accéder.
Exemple de code playerObj.navigateToPage (5)

nextPage

Nom de la méthode nextPage
Description Accès à la page suivante sur le PPT/PDF.
Paramètres Aucune
Exemple de code playerObj.nextPage()

previousPage

Nom de la méthode previousPage
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()

zoomOut

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écharger 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 Indique si vous souhaitez télécharger ou non une assistance à la tâche. 
Paramètres Aucune
Exemple de code playerObj.toggleJobAidPullout()

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.

Recevez de l’aide plus rapidement et plus facilement

Nouvel utilisateur ?