Документация по API-интерфейсу для взаимодействия со встроенным проигрывателем

Adobe Learning Manager предоставляет библиотеку, которую можно интегрировать в приложение. Эта библиотека включает различные API-интерфейсы для прослушивания мероприятий и запуска действий на встроенном проигрывателе.

С помощью этих API-интерфейсов можно запускать и приостанавливать воспроизведение, а также выполнять другие действия с проигрывателем.

Загрузить библиотеку

Библиотека представлена здесь.

Для загрузки библиотеки выполните следующие действия:

  1. Загрузите JS-файл в приложении для потребителей. 
  2. При загрузке библиотеки файл window.cpPlayerLib заполняется. 

Примечание. Если вы не пользуетесь prod US, установите параметры cpPlayerLib.env и cpPlayerLib.sourceOrigin, исзодя из файла среды env.

Значения по умолчанию:

Доступные методы

Библиотека cpPlayerLib library предусматривает следующие функции:

startPlayer

Название метода startPlayer
Описание Загружает проигрыватель в приложении
Параметры
  • loId: идентификатор объекта обучения.
  • accountId: идентификатор учетной записи ALM.
  • userId: идентификатор пользователя.
  • accessToken: маркер доступа.
  • domRefId: идентификатор div-контейнера, в котором должен визуализироваться проигрыватель.
  • onModuleLoaded: эта функция запускается при загрузке моделей с нижеперечисленными параметрами.
    • contentType
    • loId
    • moduleId
    • completed
    • currentLanguage
    • availableLanguages
    • isCCAvailable
    • ccEnabled
Возвраты Возвращает Promise-объект (обязательство). При разрешении обязательства будет передан playerObj.
Исключение Обязательство приводит к возникновению исключения. 
Образец кода

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

//playerObj имеет API-интерфейс для взаимодействия с проигрывателем

}) >

getAllPlayers

Название метода getAllPlayers
Описание Возвращает все объекты проигрывателя на текущей странице. 
Параметры Нет
Образец кода cpPlayerLib.getAllPlayers()

getPlayer

Название метода getPlayer
Описание Возвращает объект проигрывателя с идентификатором указанного обхекты обучения.
Параметры
  • loId: идентификатор объекта обучения.
Образец кода cpPlayerLib.getPlayer(loId)

navigateToModule

Название метода navigateToModule
Описание Переход к нужному блоку
Параметры
  • moduleId: идентификатор блока.
Образец кода playerObj.navigateToModule
(moduleID)

next

Название метода next
Описание Переход к следующему блоку.
Параметры Нет
Образец кода playerObj.next()

previous

Название метода previous
Описание Переход к предыдущему блоку.
Параметры Нет
Образец кода playerObj.previous()

toggleTOC

Название метода toggleTOC
Описание Включение и выключение панели оглавления в проигрывателе.
Параметры Нет
Образец кода playerObj.toggleTOC()

toggleNotes

Название метода toggleNotes
Описание Включение и выключение панели заметок в проигрывателе.
Параметры Нет
Образец кода playerObj.toggleNotes()

toggleClosedCaption

Название метода toggleClosedCaption
Описание Включение и выключение отображения скрытых субтитров в проигрывателе.
Параметры Нет
Образец кода playerObj.toggleClosedCaption()

changeLanguage

Название метода changeLanguage
Описание Изменение языка содержимого в проигрывателе.
Параметры
  • language: указывается код языка.
Образец кода playerObj.changeLanguage("es")

closePlayer

Название метода closePlayer
Описание Закрытие и удаление проигрывателя со страницы. 
Параметры Нет
Образец кода playerObj.closePlayer()

togglePlayPause 

Название метода togglePlayPause
Описание Включение и приостановка воспроизведения содержимого в проигрывателе. 
Параметры Нет
Образец кода playerObj.togglePlayPause()

setVolume

Название метода setVolume
Описание Установление громкости проигрывателя. Значение должно быть в диапазоне от 0 до 1.
Параметры
  • volume: уровень громкости. Действительный диапазон 0-1. 
Образец кода playerObj.setVolume(0.5)

setPlayBackSpeed

Название метода setPlayBackSpeed
Описание Установление скорости воспроизведения в проигрывателе. 
Параметры
  • speed: указывается значение скорости. Действительные значения: ,25; ,5; ,75; 1; 1,25; 1,5; 1,75; 2.
Образец кода playerObj.setPlayBackSpeed(1.25)

seek

Название метода seek
Описание Переход в любую временную точку видео.
Параметры
  • time: временная точка для перехода. Временная точка задается в секундах.
Образец кода playerObj.seek(50)

forward

Название метода forward
Описание Прокрутка видео на 10 секунд вперед.
Параметры Нет
Образец кода playerObj.forward()

backward

Название метода backward
Описание Прокрутка видео на 10 секунд назад.
Параметры Нет
Образец кода playerObj.backward()

navigateToPage

Название метода navigateToPage
Описание Переход на указанную страницу файла PPT/PDF.
Параметры
  • pageNumber: номер страницы для перехода.
Образец кода playerObj.navigateToPage (5)

nextPage

Название метода nextPage
Описание Переход на следующую страницу файла PPT/PDF.
Параметры Нет
Образец кода playerObj.nextPage()

previousPage

Название метода previousPage
Описание Переход на предыдущую страницу файла PPT/PDF.
Параметры Нет
Образец кода playerObj.previousPage()

zoomIn

Название метода zoomIn
Описание Увеличение содержимого файла PPT/PDF.
Параметры Нет
Образец кода playerObj.zoomIn()

zoomOut

Название метода zoomOut
Описание Уменьшение содержимого файла PPT/PDF.
Параметры Нет
Образец кода playerObj.zoomOut()

downloadJobAid 

Название метода downloadJobAid
Описание Загрузка вспомогательного материала для курса. 
Параметры Нет
Образец кода playerObj.downloadJobAid()

toggleJobAidPullout 

Название метода toggleJobAidPullout
Описание Нужно ли загружать вспомогательный материал или нет. 
Параметры Нет
Образец кода playerObj.toggleJobAidPullout()

Список мероприятий

onPlayerEvents(callBack)

При регистрации функция обратного вызова запустится для всех мероприятий проигрывателя. Названия мероприятий:

  • PLAY - ВОСПРОИЗВЕСТИ (видео/ аудио/ CP)

  • PAUSE - ПРИОСТАНОВИТЬ (видео/ аудио/ CP)

  • TIMEUPDATE - ОБНОВИТЬ ВРЕМЯ (видео/ аудио/ CP)

  • PAGECHANGE - ИЗМЕНИТЬ СТРАНИЦУ (PPT/ PDF)

  • NOTEADDED - ДОБАВЛЕНА ЗАМЕТКА (все содержимое)

  • LAUNCHED - ЗАПУЩЕНО (все содержимое)

  • STARTED - НАЧАТО (все содержимое)

  • COMPLETED - ЗАВЕРШЕНО (все содержимое)

  • PASSED - ПРОЙДЕНО (все содержимое)

  • FAILED - НЕ ПРОЙДЕНО (все содержимое)

onStreamingEvents(callBack)

При регистрации функция обратного вызова запустится для всех операторов проигрывателя, отправленных для отслеживания активности пользователя.

Получайте помощь быстрее и проще

Новый пользователь?