制約事項
プレーヤーの例
次の使用例は、再生が一時停止または終了したときに、関連するビデオのサムネイルを対話的にオーバーレイ表示します。下のビデオの再生を開始します。オーバーレイでサムネイルを選択して、関連するビデオをプレーヤーにロードし、再生を開始します。
ここで使用されているプレーヤーのサイズとサムネイルを使用して最大9つのビデオを表示できますが、これらの設定は必要に応じて変更できます。
ペンを見る再生リストからの関連動画 Brightcove Learning Services( @ bcls1969) オンCodePen。
ソースコード
CodePen を使用する
上記のCodePenを効果的に使用するためのヒントは次のとおりです。
- [ 結果]ボタンをクリックして、プレーヤーの実際の表示を切り替えます。
- HTML/CSS/JSボタンをクリックして、いずれかのコードタイプを表示します。
- このドキュメントの後半では、アプリケーションで使用されるロジック、フロー、およびスタイル設定については、 Player/HTML設定、アプリケーションフロー、およびアプリケーションのスタイル設定で説明されます。セクション。これらのセクションの情報に沿って従う最も良い方法は、次のとおりです。
- CodePen の [ EDIT ON CODEPEN]ボタンをクリックし、1 つのブラウザ/ブラウザタブでコードを使用できるようにします。
- CodePen で、表示するコードを調整します。CodePen 内の異なるコードセクションの幅を変更できます。
- を見るプレーヤー/ HTML構成、アプリケーションフローおよび/またはアプリケーションのスタイリング別のブラウザ/ブラウザタブのセクション。これで、コードの説明に従い、同時にコードを表示できるようになります。
開発シーケンス
推奨される開発順序は次のとおりです。
- インページ埋め込みプレーヤーの実装を使用して、プレーヤー、プラグイン、CSS の機能をテストします (CSS が必要な場合)
- ローカルテストのためにプラグインのJavaScriptとCSSを別々のファイルに置く
- エラーを解決したら、プラグインコードとCSSをサーバーにデプロイします
- Studio を使用してプラグインと CSS をプレイヤーに追加する
- iframe の実装が適切であると判断した場合は、インページ埋め込みプレーヤーの実装を置き換えます (次のセクションで詳しく説明します)。
これらの手順の詳細については、「ステップバイステップ」を参照してください。プラグイン開発ガイド。
iframe またはページ内埋め込み
Brightcove Player の拡張機能を開発する際には、コードが iframe 実装またはページ内埋め込み実装に最も適しているかどうかを判断する必要があります。ベストプラクティスの推奨事項は、iframe 実装で使用するプラグインを構築することです。iframe プレーヤーを使用する利点は次のとおりです。
- 既存のJavaScriptおよび/またはCSSとの衝突はありません
- 自動応答性
- iframe は、ソーシャルメディアアプリ(または動画が他のアプリに「移動」する必要があるとき)での使用を容易にします。
インページ埋め込みプレーヤーの統合はより複雑になりますが、その実装に関するコードを計画する場合もあります。一般化するために、このアプローチは、包含ページがプレイヤーと通信する必要がある場合に最適です。具体的には、いくつかの例を挙げます。
- 含まれているページのコードは、プレイヤーイベントをリッスンして行動する必要があります
- プレーヤーは包含ページのスタイルを使用します
- iframe は、含まれているページからのリダイレクトのように、アプリロジックが失敗します。
最終実装で iframe コードを使用しない場合でも、JavaScript 用のプラグインと CSS 用の別のファイルを使用して、ページ内埋め込みコードを使用できます。これにより、ロジックがカプセル化され、複数のプレーヤーで簡単に使用できます。
API/プラグインリソースを使用
API メソッド | API イベント | プラグイン |
---|---|---|
catalog.getPlaylist () | 遊ぶ | ビデオオーバーレイ |
catalog.load () | 一時停止 | |
遊ぶ () |
プレーヤー/HTML構成
Overlayプラグインは、この例の JavaScript コードで定義され、初期化されています。ここで行われる理由は、オーバーレイを初期化する前に、関連する動画のメタデータを取得する必要があるためです。
プレーヤー設定にオーバーレイプラグインを含める場合は、Video Cloud Studio のプレーヤーモジュールにオーバーレイ JavaScript および CSS ファイルを追加できます。の中にプラグインセクション、 出て名前プロパティが空白であるため、コード内でプラグインを初期化できます。
その他のHTML
追加することを忘れないでくださいid
に属性video
プレーヤーの埋め込みコードにタグを付けます。
<video-js id="myPlayerID"
...
アプリケーションフロー
このアプリケーションの背後にある基本的なロジックは次のとおりです。
- カタログを使用してプレイリストを取得します。
- オーバーレイコンテンツをフォーマットして、関連する各動画のサムネイルを表示します。
- ユーザーが関連する動画のサムネールを選択したら、それをプレーヤーにロードして再生を開始します。
プレイリストを入手する
ラベルが付いたコードを見つけます。
// +++ Get the playlist +++
指定されたプレイリスト ID に関連付けられたプレイリストを取得するには、catalog.getPlaylist () メソッドを使用します。オーバーレイに使用する再生リストの最初の9つの動画を保存します。
オーバーレイの内容を書式設定する
ラベルが付いたコードを見つけます。
// +++ Format the overlay content +++
オーバーレイコンテンツをフォーマットするには、次の操作を実行します。
- 関連する各ビデオオブジェクトを配列に保存します。
- 関連するビデオ配列をループし、オーバーレイコンテンツになるビデオリストを作成します。
生のオーバーレイ HTML
オーバーレイを初期化する
ラベルが付いたコードを見つけます。
// +++ Initialize the overlay +++
関連するビデオサムネイルを使用して Overlay プラグインを呼び出し、一時停止またはビデオ端に表示するオーバーレイを設定します。
関連ビデオの読み込みと再生
ラベルが付いたコードを見つけます。
// +++ Load and play related video +++
ユーザーが選択した関連ビデオのロードと再生を開始する関数を作成します。
アプリケーションのスタイリング
CSS は、オーバーレイの関連するビデオのサムネイルグリッドにスタイルを設定します。
プラグインコード
通常、JavaScript を Brightcove Player プラグインに変換する場合は、公称の変更が必要です。必要な変更の 1 つは、ready()
メソッドの標準使用をプラグインを定義するコードに置き換えることです。
ここでは、プレーヤーで動作するJavaScriptコードへの非常に一般的に使用されるスタートです:
videojs.getPlayer('myPlayerID').ready(function() {
var myPlayer = this;
...
});
最初の行を変更して、標準の構文を使用して Brightcove Player プラグインを起動します。
videojs.registerPlugin('pluginName', function(options) {
var myPlayer = this;
...
});
前述のように、このドキュメントの対応する GitHub レポ: related-videos-playlist.js には、プラグインの JavaScript コードが表示されます。
プレーヤーでプラグインを使用する
プラグインの CSS ファイルと JavaScript ファイルをインターネットでアクセス可能な場所に保存したら、プレーヤーでプラグインを使用できます。Studio の PLAYERSモジュールでは、プレーヤーを選択し、[ プラグイン ] セクションで CSS ファイルと JavaScript ファイルに URL を追加し、名前を追加することもできます。オプションが必要な場合は、[Options] と [Options]