サポート サポートへのお問い合わせ | システムステータス システムステータス
ページコンテンツ

    キューポイントの追加

    このサンプルでは、CMS API を使用してプログラムによってビデオにキューポイントを追加する方法を学習します。

    はじめに

    キューポイントは、ビデオタイムライン上の指定された場所です。ビデオが再生されると、キューポイントに到達するたびにイベントが自動的にブロードキャストされます。PlayerAPIを使用すると、これらのイベントをリッスンして、必要なアクションを実行できます。さらに、プレーヤーに保存されているビデオメタデータからすべてのキューポイント情報を読み取ることができますmediainfoオブジェクト、それはあなたがすることを可能にしますビデオタイムラインでキューポイントをマークします必要に応じて何らかの方法で。

    キューポイントには次の2種類があります。

    • 広告キューポイント:これらは、広告リクエストを行う必要がある場所をマークするために使用されます(ビデオとプレーヤーで広告が有効になっている場合)。
    • コードキューポイント:これらは、Player APIを使用して何らかのアクションを実行するために使用されます-いくつかの典型的な使用法は、ある種の行動を促すフレーズ(CTA)を表示したり、ビデオコンテンツに関連する画像やテキストをビデオオーバーレイとして表示したり、プレーヤーの周りのページ。

    実装の概要

    キューポイントを追加できますスタジオメディアモジュール。このサンプルで使用する方法であるCMSAPIを使用してそれらを追加することもできます。

    HTTPメソッド

    キューポイントは、次のいずれかの場合に追加できます。ビデオを作成するまたは後で更新リクエスト。このサンプルでは、既存のビデオにそれらを追加します。ビデオアップデートリクエスト、つまり、PATCH方法。

    終点

    ビデオ更新リクエストのエンドポイントは次のとおりです。

              https://cms.api.brightcove.com/v1/accounts/account_id / videos /  video_id

    リクエスト本文

    リクエストの本文は、ビデオメタデータの多くのアイテムを含むことができるJSONオブジェクトです。ここでは、cue_points次のサンプルのように、キューポイントオブジェクトの配列に設定されているフィールド。

              {
              "cue_points": [
                  {
                    "name": "Ad Cue Point",
                    "type": "AD",
                    "time": 2.0,
                    "metadata": null,
                    "force_stop": false
                  },
                  {
                    "name": "Code Cue Point",
                    "type": "CODE",
                    "time": 4.0,
                    "metadata": "The metadata might be text or the url for an image to display",
                    "force_stop": true
                  }
                ]
              }

    キューポイントオブジェクトフィールド

    以下は、キューポイントオブジェクトのフィールドの説明です。

    キューポイントオブジェクトフィールド
    フィールド タイプ 必須 説明
    name 文字列 いいえ 任意の名前-これは、PlayerAPIコードの特定のキューポイントを識別するのに役立つ場合があります
    type 文字列 はい でなければなりませんADまたはCODE
    time 番号 はい ビデオの開始から秒単位のキューポイントの時間[1]
    metadata 文字列 いいえ 最大128文字のシングルバイト文字列-これは、オーバーレイのテキストや表示する画像の場所など、キューポイントイベントハンドラーに役立つ情報になる可能性があります
    force_stop ブール値 いいえ キューポイントに達したときにビデオを一時停止するかどうか(force_stop Brightcove Playerによって無視され、現在サポートする予定はありませんが、キューポイントイベントハンドラーで手動でビデオを一時停止できます)

    • [1]技術的には、キューポイントは次のキューポイントに到達するまでアクティブです。したがって、Brightcove Playerから取得できるキューポイント配列には、startTimeそしてendTime同様にtimeキューポイント用。

    認証資格情報の取得

    CMS APIを使用するには、適切な資格情報が必要です。

    ほとんどの場合、資格情報を取得する最も簡単な方法は、Studioの管理API認証セクションを使用することです(アカウントに対する管理者権限が必要です)。詳細については、「 API 認証資格情報の管理」を参照してください。ほとんどの場合、CMS APIおそらくすべての操作のパーミッションを取得したいだけです。

    CMS API のアクセス許可
    CMS API のアクセス許可

    必要な権限が Studio で使用できない場合、または OAuth API から直接取得する場合は、以下に示す [ クライアント認証情報の取得 ] ドキュメントを選択します。どちらのオプションを選択しても、正しい操作権限を要求する必要があります。以下を cURL または Postman で使用して、CMS API のすべての権限を取得できます。

              "operations": [
                "video-cloud/video/all",
                "video-cloud/playlist/all",
                "video-cloud/sharing-relationships/all",
                "video-cloud/notifications/all"
              ]

    サンプルアプリ

    このサンプルに関連付けられているすべてのコードを、この GitHub リポジトリで検索します

    Pen CMS API のサンプルを参照してください。キューポイントを追加 Brightcove Learning Services( @ rcrooks1969) オンCodePen

    CodePen を使用する

    • [ 結果 ] ボタンをクリックして、アプリの実際の表示を切り替えます。
    • HTML/CSS/JS ボタンをクリックして、コードタイプの 1 つを表示します。
    • 右上隅にある CodePen の編集をクリックして、この CodePen を自分のアカウントにフォークします。
    • このサンプルに関連付けられているすべてのコードを、この GitHub リポジトリで検索します

    プロキシコード

    このページのサンプルアプリを独自のバージョンで作成するには、独自のプロキシを作成してホストする必要があります。(ブライトコーブラーニングサービスで使用されるプロキシは、ブライトコーブのドメインからのリクエストのみを受け付けます)。サンプルプロキシは、私たちが使用しているものと非常に似ていますが、BrightCove 以外のドメインからのリクエストをブロックするチェックがないサンプルプロキシは、この GitHub リポジトリにあります。また、そこで使用するための基本的な手順と、 REST API の使用で説明されているプロキシの周りにアプリを構築するためのより精巧なガイドがあります。