埋め込みプレーヤーインタラクション API に関するドキュメント

Adobe Learning Manager には、アプリケーションに統合できるライブラリが用意されています。 このライブラリには、埋め込みプレーヤーでイベントをリッスンし、アクションをトリガーするための各種 API が用意されています。

用意されている API をプレーヤーで使用して、再生や一時停止などのアクションを実行できます。

ライブラリの読み込み

ライブラリはこちらから入手できます。

ライブラリを読み込むには、次の手順を実行します。

  1. js ファイルをコンシューマーアプリケーションに読み込みます。 
  2. ライブラリを読み込むと、window.cpPlayerLib が取り込まれます。 

注意:prod US を使用していない場合は、実際の環境に基づいてパラメーター cpPlayerLib.env と cpPlayerLib.sourceOrigin を設定します。

デフォルト値は次のとおりです。 

利用可能なメソッド

cpPlayerLib ライブラリは、次の関数で構成されています。

startPlayer

メソッド名 startPlayer
説明 アプリにプレーヤーを読み込みます。
パラメーター
  • loId:学習オブジェクト ID。
  • accountId:ALM アカウントのアカウント ID。
  • userId:ユーザー ID。
  • accessToken:アクセストークン。
  • domRefId:プレーヤーをレンダリングする必要がある div コンテナーの ID。
  • onModuleLoaded:以下の詳細が含まれているモジュールが読み込まれると、この関数が呼び出されます。
    • contentType
    • loId
    • moduleId
    • completed
    • currentLanguage
    • availableLanguages
    • isCCAvailable
    • ccEnabled
戻り値 promise を返します。 promise の解決時に playerObj が渡されます。
例外 promise は例外となります。
サンプルコード

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

//playerObj には、プレーヤーと情報を共有するための API が含まれています

}) >

getAllPlayers

メソッド名 getAllPlayers
説明 現在のページで、プレーヤーオブジェクトをすべて返します。
パラメーター なし
サンプルコード cpPlayerLib.getAllPlayers()

getPlayer

メソッド名 getPlayer
説明 指定された学習オブジェクト ID が含まれるプレーヤーオブジェクトを返します。
パラメーター
  • loId:学習オブジェクト ID。
サンプルコード cpPlayerLib.getPlayer(loId)

navigateToModule

メソッド名 navigateToModule
説明 次のモジュールに移動します。
パラメーター
  • moduleId:モジュール ID。
サンプルコード 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)

登録すると、ユーザーのアクティビティを追跡するために送信されるプレーヤーステートメントすべてで、コールバック関数が呼び出されます。

ヘルプをすばやく簡単に入手

新規ユーザーの場合