Gömülü Oynatıcı etkileşimi API belgeleri

Adobe Learning Manager, uygulamalara entegre edilebilen bir kitaplık sunar. Bu kitaplık, gömülü oynatıcıda etkinlikleri dinlemek ve eylemleri tetiklemek için çeşitli API'ler sağlar.

Sağlanan API'leri kullanarak oynatıcıda oynatma, duraklatma eylemlerini ve diğer eylemleri gerçekleştirebilirsiniz.

Kitaplığı yükleme

Kitaplık, bu konumda bulunur.

Kitaplığı yüklemek için aşağıdaki adımları takip edin:

  1. Tüketici uygulamasına js dosyasını yükleyin. 
  2. Kitaplık yüklendikten sonra, window.cpPlayerLib doldurulur. 

Not: prod US kullanmıyorsanız parametreleri env'nize göre cpPlayerLib.env ve cpPlayerLib.sourceOrigin olarak ayarlayın.

Varsayılan değerler şu şekildedir: 

Kullanılabilir yöntemler

cpPlayerLib kitaplığı şu işlevlerden oluşur:

startPlayer

Yöntem adı startPlayer
Açıklama Uygulamaya bir oynatıcı yükler.
Parametreler
  • loId : Öğrenme Hedefi kimliği.
  • accountId : ALM hesabının Hesap kimliği.
  • userId : Kullanıcı kimliği.
  • accessToken : Erişim belirteci.
  • domRefId: Oynatıcının oluşturulması gereken div kapsayıcısının kimliği.
  • onModuleLoaded: Aşağıdaki ayrıntılara sahip modüller yüklendiğinde bu işlev çağrılacaktır.
    • contentType
    • loId
    • moduleId
    • completed
    • currentLanguage
    • availableLanguages
    • isCCAvailable
    • ccEnabled
İadeler Bir promise'i döndürür. Promise çözümlendikten sonra bir playerObj geçirilir.
İstisna Promise, bir özel durumla sonuçlanır. 
Örnek kod

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

//playerObj, oynatıcıyla etkileşime geçmeye yönelik API'lere sahiptir

}) >

getAllPlayers

Yöntem adı getAllPlayers
Açıklama Tüm oynatıcı nesnelerini geçerli sayfaya döndürür. 
Parametreler Yok
Örnek Kod cpPlayerLib.getAllPlayers()

getPlayer

Yöntem adı getPlayer
Açıklama Belirli bir Öğrenme Hedefi kimliğiyle, oynatıcı nesnesini döndürür.
Parametreler
  • loId : Öğrenme Hedefi kimliği.
Örnek Kod cpPlayerLib.getPlayer(loId)

navigateToModule

Yöntem adı navigateToModule
Açıklama Sıradaki modüle gidin.
Parametreler
  • moduleId: Modül kimliği.
Örnek Kod playerObj.navigateToModule
(moduleID)

next

Yöntem adı next
Açıklama Sıradaki modüle gidin.
Parametreler Yok
Örnek Kod playerObj.next()

previous

Yöntem adı previous
Açıklama Önceki modüle gidin.
Parametreler Yok
Örnek Kod playerObj.previous()

toggleTOC

Yöntem adı toggleTOC
Açıklama Oynatıcıdaki içindekiler tablosu panelini değiştirin.
Parametreler Yok
Örnek Kod playerObj.toggleTOC()

toggleNotes

Yöntem adı toggleNotes
Açıklama Oynatıcıdaki notlar panelini değiştirin.
Parametreler Yok
Örnek Kod playerObj.toggleNotes()

toggleClosedCaption

Yöntem adı toggleClosedCaption
Açıklama Oynatıcıdaki kapalı alt yazıların gösterilmesini değiştirin.
Parametreler Yok
Örnek Kod playerObj.toggleClosedCaption()

changeLanguage

Yöntem adı changeLanguage
Açıklama Oynatıcıdaki içerik dilini değiştirin.
Parametreler
  • language: Dil kodu belirtilmelidir.
Örnek Kod playerObj.changeLanguage("es")

closePlayer

Yöntem adı closePlayer
Açıklama Oynatıcıyı kapatın ve sayfadan kaldırın. 
Parametreler Yok
Örnek Kod playerObj.closePlayer()

togglePlayPause 

Yöntem adı togglePlayPause
Açıklama Oynatıcıdaki içeriği oynatma ve duraklatma eylemleri arasında geçiş yapın. 
Parametreler Yok
Örnek Kod playerObj.togglePlayPause()

setVolume

Yöntem adı setVolume
Açıklama Oynatıcının ses seviyesini ayarlayın. Değer, 0 ile 1 arasında olmalıdır.
Parametreler
  • volume: Ses seviyesi değeri. Geçerli aralık 0 ila 1 aralığındadır. 
Örnek Kod playerObj.setVolume(0.5)

setPlayBackSpeed

Yöntem adı setPlayBackSpeed
Açıklama Oynatıcıdaki oynatma hızını ayarlayın. 
Parametreler
  • speed: Hız değeri belirtilmelidir. Geçerli değerler: .25, .5, .75, 1, 1.25, 1.5, 1.75, 2.
Örnek Kod playerObj.setPlayBackSpeed(1.25)

seek

Yöntem adı seek
Açıklama Videodaki herhangi bir zamana atlayın.
Parametreler
  • time: Atlanacak zaman. Zaman, saniye birimindedir.
Örnek Kod playerObj.seek(50)

forward

Yöntem adı forward
Açıklama Videoda 10 saniye ileriye atlayın.
Parametreler Yok
Örnek Kod playerObj.forward()

backward

Yöntem adı backward
Açıklama Videoda 10 saniye geriye atlayın.
Parametreler Yok
Örnek Kod playerObj.backward()

navigateToPage

Yöntem adı navigateToPage
Açıklama PPT/PDF'de belirtilen sayfaya atlayın.
Parametreler
  • pageNumber: Atlanacak sayfanın numarası.
Örnek Kod playerObj.navigateToPage (5)

nextPage

Yöntem adı nextPage
Açıklama PPT/PDF'deki bir sonraki sayfaya atlayın.
Parametreler Yok
Örnek Kod playerObj.nextPage()

previousPage

Yöntem adı previousPage
Açıklama PPT/PDF'deki bir önceki sayfaya atlayın.
Parametreler Yok
Örnek Kod playerObj.previousPage()

zoomIn

Yöntem adı zoomIn
Açıklama PPT/PDF'deki içeriği yakınlaştırın.
Parametreler Yok
Örnek Kod playerObj.zoomIn()

zoomOut

Yöntem adı zoomOut
Açıklama PPT/PDF'deki içeriği uzaklaştırın.
Parametreler Yok
Örnek Kod playerObj.zoomOut()

downloadJobAid 

Yöntem adı downloadJobAid
Açıklama Bir dersten Yardımcı Materyal indirin. 
Parametreler Yok
Örnek Kod playerObj.downloadJobAid()

toggleJobAidPullout 

Yöntem adı toggleJobAidPullout
Açıklama Bir yardımcı materyali indirmek isteyip istemediğiniz. 
Parametreler Yok
Örnek Kod playerObj.toggleJobAidPullout()

Etkinlikler listesi

onPlayerEvents(callBack)

Kaydedildikten sonra, geri arama işlevi tüm oynatıcı etkinliklerine çağrılacaktır. Etkinlik adları aşağıdaki gibidir:

  • PLAY (Video/Ses/CP)

  • PAUSE (Video/Ses/CP)

  • TIMEUPDATE (Video/Ses/CP)

  • PAGECHANGE (PPT/PDF)

  • NOTEADDED (Tüm içerikler)

  • LAUNCHED (Tüm içerikler)

  • STARTED (Tüm içerikler)

  • COMPLETED (Tüm içerikler)

  • PASSED (Tüm içerikler)

  • FAILED (Tüm içerikler)

onStreamingEvents(callBack)

Kaydedildikten sonra; geri arama işlevi, kullanıcı etkinliğini takip etmek için gönderilen tüm oynatıcı ifadelerine çağrılacaktır.

Daha hızlı ve daha kolay yardım alın

Yeni kullanıcı mısınız?