iframe 埋め込みコードで利用可能なオプション

このトピックでは、iframe 埋め込みコードの使用方法と設定について説明します。このプレーヤー実装バージョンは、標準 プレーヤーコードとも呼ばれます。

概要

iframe プレーヤー実装コードは、プレーヤーを 1 つのコンテナとして簡単に扱える利点があります。これは、ソーシャルメディア アプリケーションやシェア用途で求められることが多い形式です。

使用方法

iframe コードを使用するには、以下の手順に従います。

  1. PLAYERS モジュールを使用してプレーヤーを作成します。
  2. MEDIA モジュールで、作成したプレーヤーを使用して動画を公開します。
  3. iframe 埋め込みコードをコピーします。HTML は次のようになります。 
    <iframe src="https://players.brightcove.net/.../index.html?videoId=6116779877001"
        allowfullscreen=""
        allow="encrypted-media"
        width="960" height="540"></iframe>
  4. ブラウザから HTML をコピーし、完全な HTML ページの body 内に貼り付けます。
  5. HTML ページを開き、プレーヤーが動作することを確認します。

クエリ パラメーター

iframe タグには、プレーヤーの動作を指定するために多数のクエリ パラメーターが使用できます。以下の表では、利用可能なパラメーターを説明します。

パラメーター 説明 データ型
adConfigId Dynamic Delivery SSAI の広告設定 ID。 String
applicationId 単一のプレーヤーを再利用しつつ、サイトやアプリごとに分析情報を区別できます。詳細は プレーヤー埋め込みコードへのアプリケーション ID の追加 を参照してください。 String
autoplay プレーヤーが自動再生するかどうかを指定します（プラットフォームが許可している場合）。

Boolean 値の場合はブラウザのネイティブ動作が使用されます。以下の文字列値を使用すると、指定された動作になります：
  • play: 手動で再生を試行します。
  • muted: ミュートにした上で再生を試行します。
  • any: まず通常再生を試行し、失敗した場合はミュートして再生を試行します。
上記がすべて失敗した場合、「大きな再生ボタン」が表示され、自動再生が無効とみなされます。

自動再生は複雑な問題となる場合があります。詳細は 自動再生に関する考慮事項 を参照してください。 		Boolean または String
crossorigin true の場合、<video> 要素に crossorigin="anonymous" が設定されます。これは、プレーヤーが読み込む動画やテキスト トラックが CORS ヘッダーを持つ必要があることを意味します。 Boolean
deliveryConfigId Dynamic Delivery Rules の設定 ID。 String
language プレーヤーの言語を設定します（通常 2 文字の言語コード）。 String
loop 動画が終了するとすぐに再生を最初から繰り返します。 String
muted 動画の音声をミュートします。 Boolean
playlistId プレーヤー内で使用するプレイリストの ID または参照 ID を設定します。 String
playlistVideoId プレイリスト内で最初に再生する動画を設定します。 String
playsinline プラットフォームや OS が許可する場合、動画をフルスクリーンではなくプレーヤー内にインライン表示します（iPhone / iPad でも機能します）。 Boolean
preload 動画タグが読み込まれた際に、どの程度動画データを事前読み込みするかを指定します。値は none、metadata、auto です。詳細は次のセクションを参照してください。 String
referrer document.referrer を含めたトラッキングが可能になります。値は URI エンコードする必要があります（例：referrer=http%3A%2F%2Ffoo.com）。このパラメーターは Brightcove Player 6.25 以降で使用できます。 String
t 再生開始位置を秒数で指定します。詳細は ディープリンク を参照してください。 String
videoId プレーヤーで再生する動画の ID または参照 ID を設定します。 String

preload の詳細

preload パラメーターは、動画タグが読み込まれた際に動画データをどの程度読み込むかをブラウザに伝えます。利用できる値は auto、metadata、none です。HLS の場合、それぞれの意味は以下のとおりです。

  • auto（デフォルト）：ブラウザが許可する場合、動画をすぐに読み込み開始します。ただし iPhone や iPad など、一部のモバイル デバイスでは帯域保護のためプリロードしないことがあります。

  • metadata：動画のメタデータ（長さや寸法など）のみを読み込みます。

  • none：動画データを一切プリロードしません。再生ボタンが押されるまで読み込みを開始しません。ただし iOS ではこの設定でも一部セグメントが読み込まれる場合があります。

            <video-js preload ...>
            または
            { "preload": "auto" }