プレーヤーの例
この例では、ModalDialog を使用して、最初にプレーヤーをカバーします。ユーザーがモーダルウィンドウをクリックして年齢を確認すると、コントロールが表示され、ビデオが再生されます。モーダルウィンドウの任意の場所をクリックして、機能をテストします。
ペンを見る18193-brightcove-player-sample-age-gate-modaldialog 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 用の別のファイルを使用して、ページ内埋め込みコードを使用できます。これにより、ロジックがカプセル化され、複数のプレーヤーで簡単に使用できます。
モーダルの利点
ModalDialogコンポーネントを使用する利点には、次のようなものがあります。
- デフォルトでプレイヤー全体をカバーします
- それは簡単にモーダルウィンドウを開いたり閉じたりするメソッドを持っています
API/プラグインリソースを使用
API メソッド | API イベント | ModalDialog API メソッド |
---|---|---|
addChild () | 準備ができて | 開く () |
オン () | ||
閉じる () |
プレーヤー/HTML構成
このサンプル用に作成した Brightcove Player には、特別な設定は必要ありません。
アプリケーションフロー
このアプリケーションの背後にある基本的なロジックは次のとおりです。
- クリック可能な ModalDialog をテキストで表示します。
- ユーザーがModalDialogテキストをクリックすると、ModalDialogを閉じ、ビデオの再生を開始します。
ModalDialog テキストを表示
ModalDialogは、ビデオがロードされるとすぐに表示されます。年齢ゲートの文字は、ModalDialog のオプションとして定義されます。
ModalDialogを設定する
ラベルが付いたコードを見つけます。
// +++ Configure the ModalDialog +++
オプションオブジェクトを作成し、 ModalDialog クラスのプロパティを設定します。このオブジェクトの詳細については、「ModalDialog の実装」を参照してください。ここでは、次のことを行います。
- 年齢ゲートのテキストを定義する
- ダイアログを閉じることができるように、ダイアログを一時的なものに設定します
- ダイアログの [閉じる] ボタンを非表示にする
ModalDialog をインスタンス化して開きます
ラベルが付いたコードを見つけます。
// +++ Instantiate and open the ModalDialog +++
年齢ゲートのテキストでダイアログをインスタンス化し、プレーヤーに追加してダイアログを開きます。
ModalDialogでクリックイベントをリッスンする
ラベルが付いたコードを見つけます。
// +++ Listen for the click event on the ModalDialog +++
ModalDialog に、イベントのイベントリスナーを追加します。click
ユーザーが年齢ゲートのテキストを選択したら、ダイアログを閉じてビデオの再生を開始します。
アプリケーションのスタイリング
CSSは、ModalDialog内の年齢ゲートのテキストをスタイルと位置決めします。
プラグインコード
通常、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 レポ: age-gate-modal.js には、プラグインの JavaScript コードが表示されます。
プレーヤーでプラグインを使用する
プラグインの CSS ファイルと JavaScript ファイルをインターネットでアクセス可能な場所に保存したら、プレーヤーでプラグインを使用できます。Studio の PLAYERSモジュールでは、プレーヤーを選択し、[ プラグイン ] セクションで CSS ファイルと JavaScript ファイルに URL を追加し、名前を追加することもできます。オプションが必要な場合は、[Options] と [Options]