Dokumentacja interfejsu API interakcji z odtwarzaczem osadzonym

Usługa Adobe Learning Manager zawiera bibliotekę, którą można zintegrować z aplikacją. Są w niej dostępne interfejsy API nasłuchiwania zdarzeń i wyzwalania operacji odtwarzacza osadzonego.

Korzystając z tych interfejsów, można wykonywać różnorodne operacje odtwarzacza, takie jak odtwarzanie i wstrzymywanie.

Wczytywanie biblioteki

Biblioteka jest dostępna tutaj.

Aby wczytać bibliotekę, wykonaj poniższe kroki:

  1. Wczytaj plik JS w aplikacji konsumenckiej. 
  2. Po wczytaniu biblioteki zostanie wypełniony parametr window.cpPlayerLib. 

Uwaga: Jeśli nie używasz środowiska produkcyjnego, ustaw parametry cpPlayerLib.env i cpPlayerLib.sourceOrigin zgodnie ze środowiskiem.

Wartości domyślne: 

Dostępne metody

Biblioteka cpPlayerLib zawiera następujące funkcje:

startPlayer

Nazwa metody startPlayer
Opis Wczytuje aplikację odtwarzacza.
Parametry
  • loId: Identyfikator elementu edukacyjnego.
  • accountId: Identyfikator konta ALM.
  • userId: Identyfikator użytkownika.
  • accessToken: Token dostępu.
  • domRefId: Identyfikator kontenera DIV, w którym ma być renderowany odtwarzacz.
  • onModuleLoaded: Ta funkcja jest wywoływana, gdy są wczytywane moduły o poniższych właściwościach.
    • contentType
    • loId
    • moduleId
    • completed
    • currentLanguage
    • availableLanguages
    • isCCAvailable
    • ccEnabled
Zwraca Zwraca obietnicę. Po rozwiązaniu obietnicy jest przekazywany obiekt playerObj.
Wyjątek Obietnica generuje wyjątek.
Kod przykładowy

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

// Klasa playerObj zawiera interfejsy API interakcji z odtwarzaczem.

}) >

getAllPlayers

Nazwa metody getAllPlayers
Opis Zwraca wszystkie obiekty odtwarzacza na bieżącej stronie.
Parametry Brak
Kod przykładowy cpPlayerLib.getAllPlayers()

getPlayer

Nazwa metody getPlayer
Opis Zwraca obiekt odtwarzacza o określonym identyfikatorze elementu edukacyjnego.
Parametry
  • loId: Identyfikator elementu edukacyjnego.
Kod przykładowy cpPlayerLib.getPlayer(loId)

navigateToModule

Nazwa metody navigateToModule
Opis Przechodzi do następnego modułu.
Parametry
  • moduleId: Identyfikator modułu.
Kod przykładowy playerObj.navigateToModule
(moduleID)

next

Nazwa metody next
Opis Przechodzi do następnego modułu.
Parametry Brak
Kod przykładowy playerObj.next()

previous

Nazwa metody previous
Opis Przechodzi do poprzedniego modułu.
Parametry Brak
Kod przykładowy playerObj.previous()

toggleTOC

Nazwa metody toggleTOC
Opis Przełącza panel spisu treści w odtwarzaczu.
Parametry Brak
Kod przykładowy playerObj.toggleTOC()

toggleNotes

Nazwa metody toggleNotes
Opis Przełącza panel notatek w odtwarzaczu.
Parametry Brak
Kod przykładowy playerObj.toggleNotes()

toggleClosedCaption

Nazwa metody toggleClosedCaption
Opis Przełącza wyświetlanie napisów w odtwarzaczu.
Parametry Brak
Kod przykładowy playerObj.toggleClosedCaption()

changeLanguage

Nazwa metody changeLanguage
Opis Zmienia język zawartości w odtwarzaczu.
Parametry
  • language: Należy podać kod języka.
Kod przykładowy playerObj.changeLanguage("es")

closePlayer

Nazwa metody closePlayer
Opis Zamyka odtwarzacz i usuwa go ze strony.
Parametry Brak
Kod przykładowy playerObj.closePlayer()

togglePlayPause 

Nazwa metody togglePlayPause
Opis Przełącza odtwarzanie i wstrzymanie zawartości w odtwarzaczu.
Parametry Brak
Kod przykładowy playerObj.togglePlayPause()

setVolume

Nazwa metody setVolume
Opis Ustawia głośność w odtwarzaczu. Wartość musi należeć do przedziału od 0 do 1.
Parametry
  • volume: Wartość głośności. Prawidłowy zakres wartości: 0–1.
Kod przykładowy playerObj.setVolume(0.5)

setPlayBackSpeed

Nazwa metody setPlayBackSpeed
Opis Ustawia szybkość odtwarzania w odtwarzaczu.
Parametry
  • speed: Należy określić szybkość. Prawidłowe wartości: .25, .5, .75, 1, 1.25, 1.5, 1.75, 2.
Kod przykładowy playerObj.setPlayBackSpeed(1.25)

seek

Nazwa metody seek
Opis Przeskakuje do wskazanego czasu wideo.
Parametry
  • time: Należy podać czas docelowy skoku. Czas jest określany w sekundach.
Kod przykładowy playerObj.seek(50)

forward

Nazwa metody forward
Opis Przewija wideo do przodu o 10 sekund.
Parametry Brak
Kod przykładowy playerObj.forward()

backward

Nazwa metody backward
Opis Przewija wideo do tyłu o 10 sekund.
Parametry Brak
Kod przykładowy playerObj.backward()

navigateToPage

Nazwa metody navigateToPage
Opis Przechodzi do określonej strony pliku PPT/PDF.
Parametry
  • pageNumber: Należy podać numer strony docelowej.
Kod przykładowy playerObj.navigateToPage (5)

nextPage

Nazwa metody nextPage
Opis Przechodzi do następnej strony pliku PPT/PDF.
Parametry Brak
Kod przykładowy playerObj.nextPage()

previousPage

Nazwa metody previousPage
Opis Przechodzi do poprzedniej strony pliku PPT/PDF.
Parametry Brak
Kod przykładowy playerObj.previousPage()

zoomIn

Nazwa metody zoomIn
Opis Powiększa zawartość pliku PPT/PDF.
Parametry Brak
Kod przykładowy playerObj.zoomIn()

zoomOut

Nazwa metody zoomOut
Opis Zmniejsza zawartość pliku PPT/PDF.
Parametry Brak
Kod przykładowy playerObj.zoomOut()

downloadJobAid 

Nazwa metody downloadJobAid
Opis Pobiera materiały pomocnicze kursu.
Parametry Brak
Kod przykładowy playerObj.downloadJobAid()

toggleJobAidPullout 

Nazwa metody toggleJobAidPullout
Opis Pozwala określić, czy mają być pobierane materiały pomocnicze.
Parametry Brak
Kod przykładowy playerObj.toggleJobAidPullout()

Lista zdarzeń

onPlayerEvents(callBack)

Po zarejestrowaniu dla wszystkich zdarzeń odtwarzacza jest wywoływana funkcja wywołania zwrotnego. Nazwy zdarzeń:

  • PLAY (wideo/audio/CP)

  • PAUSE (wideo/audio/CP)

  • TIMEUPDATE (wideo/audio/CP)

  • PAGECHANGE (PPT/PDF)

  • NOTEADDED (dowolna zawartość)

  • LAUNCHED (dowolna zawartość)

  • STARTED (dowolna zawartość)

  • COMPLETED (dowolna zawartość)

  • PASSED (dowolna zawartość)

  • FAILED (dowolna zawartość)

onStreamingEvents(callBack)

Po zarejestrowaniu dla wszystkich zdarzeń odtwarzacza, które zostały wysłane w celu śledzenia aktywności użytkowników, jest wywoływana funkcja wywołania zwrotnego.

Pomoc dostępna szybciej i łatwiej

Nowy użytkownik?