Documentação da API de interação do reprodutor incorporado

O Adobe Learning Manager fornece uma biblioteca que pode ser integrada a um aplicativo. Esta biblioteca fornece várias APIs para ouvir eventos e acionar ações no reprodutor incorporado.

Usando as APIs fornecidas, você pode reproduzir, pausar e executar outras ações no reprodutor.

Carregar a biblioteca

A biblioteca está disponível neste local.

Para carregar a biblioteca, siga as etapas abaixo:

  1. Carregue o arquivo js no aplicativo do cliente. 
  2. Ao carregar a biblioteca, window.cpPlayerLib será preenchido. 

Observação: se você não estiver usando prod US, defina os parâmetros cpPlayerLib.env e cpPlayerLib.sourceOrigin com base em seu env.

Os valores padrão são: 

Métodos disponíveis

A biblioteca cpPlayerLib consiste nas seguintes funções:

startPlayer

Nome do método startPlayer
Descrição Carrega um reprodutor no aplicativo.
Parâmetros
  • loId: a ID do objeto de aprendizado.
  • accountId: a ID da conta da conta do ALM.
  • userId: a ID do usuário.
  • accessToken: o token de acesso.
  • domRefId: a ID do contêiner div no qual o reprodutor deve ser renderizado.
  • onModuleLoaded: esta função será invocada quando os módulos com os detalhes abaixo forem carregados.
    • contentType
    • loID
    • moduleId
    • concluído
    • currentLanguage
    • availableLanguages
    • isCCAvailable
    • ccEnabled
Devoluções Retorna uma promessa. Na resolução da promessa, um playerObj será passado.
Exceção A promessa resultará em uma exceção. 
Código de exemplo

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

//playerObj tem as apis para interagir com o reprodutor

}) >

getAllPlayers

Nome do método getAllPlayers
Descrição Retorna todos os objetos do reprodutor na página atual. 
Parâmetros Nenhum
Código de exemplo cpPlayerLib.getAllPlayers()

getPlayer

Nome do método getPlayer
Descrição Retorna um objeto do reprodutor com a ID do objeto de aprendizado especificada.
Parâmetros
  • loId: a ID do objeto de aprendizado.
Código de exemplo cpPlayerLib.getPlayer(loId)

navigateToModule

Nome do método navigateToModule
Descrição Navegar para o próximo módulo.
Parâmetros
  • moduleId: a ID do módulo.
Código de exemplo playerObj.navigateToModule
(moduleID)

próximo

Nome do método próximo
Descrição Navegar para o próximo módulo.
Parâmetros Nenhum
Código de exemplo playerObj.next()

anterior

Nome do método anterior
Descrição Navegue para o módulo anterior.
Parâmetros Nenhum
Código de exemplo playerObj.previous()

toggleTOC

Nome do método toggleTOC
Descrição Alterne o painel de sumário no reprodutor.
Parâmetros Nenhum
Código de exemplo playerObj.toggleTOC()

toggleNotes

Nome do método toggleNotes
Descrição Alterna o painel de notas no reprodutor.
Parâmetros Nenhum
Código de exemplo playerObj.toggleNotes()

toggleClosedCaption

Nome do método toggleClosedCaption
Descrição Alterne a exibição das legendas ocultas no reprodutor.
Parâmetros Nenhum
Código de exemplo playerObj.toggleClosedCaption()

changeLanguage

Nome do método changeLanguage
Descrição Alterne o idioma do conteúdo no reprodutor.
Parâmetros
  • idioma: o código do idioma a ser especificado.
Código de exemplo playerObj.changeLanguage("es")

closePlayer

Nome do método closePlayer
Descrição Feche o reprodutor e remova-o da página. 
Parâmetros Nenhum
Código de exemplo playerObj.closePlayer()

togglePlayPause 

Nome do método togglePlayPause
Descrição Alterne entre reproduzir e pausar o conteúdo no reprodutor. 
Parâmetros Nenhum
Código de exemplo playerObj.togglePlayPause()

setVolume

Nome do método setVolume
Descrição Defina o volume do reprodutor. O valor deve estar entre 0 e 1.
Parâmetros
  • volume: o valor do volume. O intervalo válido é de 0 a 1. 
Código de exemplo playerObj.setVolume(0.5)

setPlayBackSpeed

Nome do método setPlayBackSpeed
Descrição Defina a velocidade de reprodução no reprodutor. 
Parâmetros
  • velocidade: o valor da velocidade a ser especificado. Os valores válidos são .25, .5, .75, 1, 1.25, 1.5, 1.75, 2.
Código de exemplo playerObj.setPlayBackSpeed(1.25)

buscar

Nome do método buscar
Descrição Pule para qualquer tempo no vídeo.
Parâmetros
  • tempo: o tempo para o qual pular. O tempo é em segundos.
Código de exemplo playerObj.seek(50)

avançar

Nome do método avançar
Descrição Avance o vídeo em 10 segundos.
Parâmetros Nenhum
Código de exemplo playerObj.forward()

retroceder

Nome do método retroceder
Descrição Retroceda 10 segundos no vídeo.
Parâmetros Nenhum
Código de exemplo playerObj.backward()

navigateToPage

Nome do método navigateToPage
Descrição Pule para a página especificada no PPT/PDF.
Parâmetros
  • pageNumber: o número da página para a qual pular.
Código de exemplo playerObj.navigateToPage (5)

nextPage

Nome do método nextPage
Descrição Vá para a próxima página no PPT/PDF.
Parâmetros Nenhum
Código de exemplo playerObj.nextPage()

previousPage

Nome do método previousPage
Descrição Pule para a página anterior no PPT/PDF.
Parâmetros Nenhum
Código de exemplo playerObj.previousPage()

zoomIn

Nome do método zoomIn
Descrição Amplie o conteúdo em um PPT/PDF.
Parâmetros Nenhum
Código de exemplo playerObj.zoomIn()

zoomOut

Nome do método zoomOut
Descrição Diminua o zoom no conteúdo em um PPT/PDF.
Parâmetros Nenhum
Código de exemplo playerObj.zoomOut()

downloadJobAid 

Nome do método downloadJobAid
Descrição Baixe uma ajuda de tarefa de um curso. 
Parâmetros Nenhum
Código de exemplo playerObj.downloadJobAid()

toggleJobAidPullout 

Nome do método toggleJobAidPullout
Descrição Se você deseja ou não baixar uma ajuda de tarefa. 
Parâmetros Nenhum
Código de exemplo playerObj.toggleJobAidPullout()

Lista de eventos

onPlayerEvents(callBack)

Ao registrar, a função de retorno de chamada será invocada em todos os eventos do reprodutor. Os nomes dos eventos são os seguintes:

  • PLAY (Vídeo/ Áudio/ PC)

  • PAUSE (Vídeo/ Áudio/ PC)

  • TIMEUPDATE (Vídeo/ Áudio/ CP)

  • PAGECHANGE (PPT/ PDF)

  • NOTEADDED (Todos os conteúdos)

  • LAUNCHED (Todos os conteúdos)

  • STARTED (Todos os conteúdos)

  • COMPLETED (Todos os conteúdos)

  • PASSED (Todos os conteúdos)

  • FAILED (todos os conteúdos)

onStreamingEvents(callBack)

Ao registrar, a função de retorno de chamada será invocada em todas as instruções do reprodutor enviadas para acompanhar a atividade do usuário.

Receba ajuda com mais rapidez e facilidade

Novo usuário?