概要
このプラグインは、Brightcove Player を Kollective eCDN と統合するために使用されます。
Brightcove の Integrations サイトには、Kollective eCDN に関連するドキュメントがいくつか用意されています。以下が該当します。
Players モジュールを使用した実装
Studio の Players モジュールでプラグインを実装するには、次の手順を実行します。
- Studio で Players モジュールを選択します。
- Kollective eCDN プラグインを追加したいプレーヤーをクリックします。
- 左側のナビゲーションで プラグイン をクリックします。
- プラグインの追加 > Brightcove プラグイン をクリックします。
- ドロップダウンから Kollective eCDN を選択します。
- 必要に応じて、設定 オプション を JSON 形式で入力します。例が表示されています。
- 保存してから、プレーヤーを公開します。
また、プレーヤーの JSON を直接編集してプラグインを実装することもできます。以下の手順では、その方法を説明します。
- Studio で Players モジュールを選択します。
- Kollective eCDN プラグインを追加したいプレーヤーをクリックします。
- 左側のナビゲーションで JSON エディタ をクリックします。
- プラグイン セクションに、ハイライトされている部分を追加します。
- 保存してから、プレーヤーを公開します。
JSON エディタを使用した実装
7.28.0 以降のプレーヤーでは、JSON エディタを使用してプラグインを追加するために、以下の手順を実行することもできます。
Players モジュールで、設定したいプレーヤーに移動し、JSON エディタへのリンクをクリックします。
"plugins" 配列を編集して、Kollective eCDN プラグインを追加します。
"plugins": [
{
"name": "kollective",
"is_packaged": true,
"options": {
...
}
}
]
オプション
以下に示す項目は、Kollective eCDN プラグインを設定する際に使用されるプラグインオプションです。
- ksdkUrl: 特定バージョンの Kollective SDK（KSDK）への URL を指定するために使用します。未設定の場合は、Kollective の最新バージョンが使用されます。KSDK がプレーヤーより前にページ内で読み込まれている場合、このオプションは省略できます。
- persistUserToken: true に設定すると、通常はランダムに生成されるユーザートークンを localStorage に保存／取得します。
メソッド
Kollective eCDN プラグインで使用できるメソッドは 1 つあります。
- loadVideo(videoId): ID または参照 ID を指定して、単一の動画を読み込みます。
- データ型は
stringです。 - Brightcove Playback API からのレスポンスが返された時点で解決される Promise を返します。
myPlayer.kollective().loadVideo('1234567890').then(data => { // Playback API リクエストは完了していますが、KSDK.load はまだ完了していない可能性があります。 });
- データ型は