標準(iframe)埋め込みコードで使用可能なオプション
はじめに
iframe プレーヤー実装コードは、プレーヤーを単一の包含ユニットとして使いやすさを提供します。これは、ソーシャルメディアのアプリケーションや共有にしばしば必要です。
使用法
iframeコードを使用するには、次の手順に従います。
- プレーヤーを作成するには、PLAYERS モジュールを使用します。
- MEDIA モジュールに移動し、新しく作成したプレーヤーを使用してビデオを公開します。
- iFrame(標準)埋め込みコードをコピーします。HTML は、次のようになります。
<iframe src="https://players.brightcove.net/921483702001/default_default/index.html?videoId=4570583963001" allowfullscreen webkitallowfullscreen mozallowfullscreen></iframe>
- ブラウザから HTML をコピーし、完全な HTML ページの
body
に貼り付けます。 - HTML ページを参照して、プレーヤーが機能しているかどうかを確認します。
クエリパラメータ
iframe タグには多数のクエリパラメータがあり、プレーヤーの動作に関する追加情報を提供します。以下の表に、使用可能なパラメーターの詳細を示します。
パラメーター | 説明 | データタイプ |
---|---|---|
adConfigId | Dynamic Delivery SSAI 広告設定ID。 | String |
applicationID | 単一のプレーヤーの再利用が可能ですが、サイトごとまたはアプリケーションごとに分析を区別します。詳細については、 「Player 埋め込みコードへのアプリケーション IDの追加」ドキュメントを参照してください。 | String |
autoplay | 自動再生が許可されているプラットフォームで、プレーヤーがすぐに再生を開始することを示します。autoplay をBoolean値に設定すると、ブラウザのネイティブな自動再生動作が使用されます。以下の 3 つの有効なString値のいずれかに設定されている場合は、以下のようになります:
ビデオを自動再生するには、複雑な状況になる可能性があります。詳細については、「自動再生に関する考慮事項」を参照してください。 |
BooleanまたはString |
crossorigin |
trueの場合、基礎となる<video>要素はcrossorigin="anonymous"となります。つまり、プレーヤーに取り込まれるビデオやテキストトラックには CORS ヘッダーを持つが必要があります。 | Boolean |
language |
プレーヤーの言語 (有効な言語コードを使用、通常は2文字) を設定します。 | String |
loop |
動画が終了すると再度、最初からスタートします。 | String |
muted |
映像の音声をミュートします。 | Boolean |
playlistId |
プレーヤー内のプレイリストの ID または参照 ID を設定します。 | String |
playlistVideoId |
プレイリストで再生される最初の動画を設定します。このビデオは、指定されたプレイリストにある必要があります。 | String |
playsinline |
プラットフォームとOSで許可されている場合、動画コンテンツはプレーヤーの再生領域内に表示されます。つまり、フルスクリーンやサイズ変更可能な独立したウィンドウで表示されることはありません。iPhoneとiPadでは動作します。 | Boolean |
preload | Videoタグが読み込まれた時点で、ビデオデータのダウンロードを開始するか否かを指定します。指定可能な値はnone 、metadata 、auto のいずれかです。詳細については、次章を参照してください。 |
String |
referrer | document.referrer を他のパラメータと一緒に iframe に渡すことができ、動画の参照元URL を正確に追跡することができます。値を URI エンコードする必要があることに注意してください (例: referrer=http%3A%2F%2Ffoo.com )。また、このパラメータは6.25バージョンのプレーヤー以降で使用できることに注意して下さい。 |
String |
t |
ビデオの再生を開始する時間オフセットを設定します。詳細については、ディープリンクのドキュメントを参照してください。 | String |
videoId |
プレーヤー内の動画ID または参照 ID を設定します。 | String |
プリロードの詳細
preload パラメータは、Videoタグが読み込まれた時点で、ビデオデータのダウンロードを開始するかどうかをブラウザに通知するものです。オプションはauto、metadata、noneです。HLS 再生技術では、この設定は若干意味が異なるので、以下に記します。
-
auto (デフォルト):(ブラウザが同意した場合)すぐに動画の読み込みを開始します。iPhoneやiPadなどの一部のモバイル機器では、ユーザーの帯域幅を保護するために、動画のプリロードを行いません。そのため、この値はtrueのような最終的なものでなく、autoと呼ばれています。
-
metadata:ビデオのメタデータのみをロードします。これには、ビデオの長さやサイズなどの情報が含まれています。
-
none :動画データを一切プリロードしません。ユーザーが [再生] をクリックするまで、ダウンロードが開始されるのを待ちます。iOS では、この設定でもセグメントのダウンロードが発生する可能性があることに注意してください。詳細については、Brightcove Playerと iOSのドキュメントを参照してください。
<video-js preload ...>
or
{ "preload": "auto" }