ダウンロード ボタン プラグイン

はじめに

mp4 ダウンロードの例

トランスクリプトのダウンロードの例

ベーシック

ダウンロード プラグインはプレーヤーの mediainfo オブジェクトに依存します。このオブジェクトが動作するには、いくつかのサブプロパティが必要です。

• tags: tags 属性には、プレーヤーのメディア情報に関する情報が含まれます。ダウンロード ボタン プラグインを初期化するには、この配列に文字列 “downloadable“ を含める必要があります。

  tags: ["downloadable"]

• sources: sources 配列には、プレーヤーによって取り込まれるさまざまなソースに関する情報が含まれます。その他の要素は無視されます。container プロパティはソースが mp4 ファイルであることを判別し、size プロパティは mp4 の品質を選択します。

  
    sources: [{
        avg_bitrate: 2121000,
        codec: "H264",
        container: "MP4",
        duration: 734167,
        height: 720,
        size: 195024286,
        src: "https://examplesource.mp4",
        type: "video/mp4",
        width: 1728
      }]
  

• transcripts: transcripts 配列には、プレーヤーに関連付けられたすべてのトランスクリプトがリストされます。ダウンロード ボタン プラグインは、プレーヤーの言語と一致する言語のトランスクリプトを探します。該当するものがない場合は、リストの最初のトランスクリプトが選択されます。src_lang プロパティは、トランスクリプトの言語を決定します。

  
    transcripts: [{
      default: false,
      id: "95423543d7-8363-49dd-9b1c-ff32365433fc0cda",
      label: "English",
      src: "https://examplesource.txt",
      src_lang: "en-US",
      status: null
      }]
  

ブラウザの互換性

このプラグインは、以下の主要ブラウザの最新バージョンと互換性があります:

• Chrome デスクトップ
• Chrome モバイル (on Android 6+)
• Firefox デスクトップ
• Edge
• Safari デスクトップ *
• Safari モバイル (iOS 11.2+) *

Playersモジュールを使用した実装

この機能を有効にするには、プレーヤーを手動で設定します:

1. プレーヤー モジュールを開き、新しいプレーヤーを作成するか、プラグインを追加したいプレーヤーを探します。
2. プレーヤーのリンクをクリックして、プレーヤーのプロパティを開きます。

3. 左のナビゲーションメニューのJSON エディターをクリックします。

   

4. JSON エディター オブジェクトに、プロパティ download_button を追加します。

   利用可能な最高品質のMP4ファイルをダウンロードするようにプレーヤを設定するには、このプロパティを定義する時にmp4 値を使用します。コードは以下のようになります:

   

   プレーヤーで使用されている言語に一致するトランスクリプトのテキストファイル（一致するものがない場合は最初のトランスクリプト）をダウンロードするようにプレーヤを設定するには、download_button プロパティを定義する時に transcript 値を使用します。コードは次のようになります:

   

5. 保存をクリックします。

この機能が有効であっても、mp4やトランスクリプトが利用できない場合、ボタンは表示されますが、無効になります。

ランタイム プロパティ

ダウンロード ボタンには、player.downloadButton でアクセスできます。このオブジェクトには、便利なアクセス可能なプロパティがいくつかあります。

player.downloadButton.state

タイプ: String

このプロパティは、ダウンロード ボタンの現在の状態を表します。有効なオプションは次のとおりです。:

• ready: ダウンロードボタンはダウンロードを開始する準備ができています。
• hidden: ダウンロードボタンが隠れている状態。この状態は、downloadable タグがない場合に発生します。
• off: ダウンロードボタンがDOM内にない。この状態は、ソースが無効または見つからない場合に発生します。

player.downloadButton.source

タイプ: String

このプロパティには、ダウンロードするソースへの URL が含まれます。ダウンロード方法によって、これはmp4ファイルへのリンクまたはトランスクリプト テキストファイルになります。

イベント

ダウンロード ボタン プラグインは、分析目的でいくつかのイベントをトリガーします。

• download-ready: プラグインが正常に初期化されると発生されます。

• download-hidden: プラグインが初期化され、ボタンが非表示になった時に発生します。mediainfo の tags 配列に ”downloadable” タグがない場合に発生します。

• download-disabled: プラグインが初期化され、ボタンが無効になったときに発生します。これは、mediainfo オブジェクトが見つからないか、予想されるダウンロード方法によっては無効な sources や transcripts を持っている場合に発生します。

• download-started: ダウンロードボタンがクリックされ、ダウンロードが開始されたときに発生します。

• download-finished: ダウンロードが正常に終了したときに発生します。このイベントはファイル名もリスナーに送信します。

• download-failed: ダウンロードが失敗したときに発生します。このイベントは、リスナーにエラーに関する情報を送信します。