サポート サポート問い合わせ先 | システムステータス システムステータス

キューポイントを追加する

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

概要

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

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

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

実装の概要

キューポイントを Studio Mediaモジュール。 また、 CMS APIこれは、このサンプルで使用する方法です。

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 文字列 いいえ 任意の名前-これは、特定のキューポイントを特定するのに役立ちます。 Player API コード
type 文字列 はい でなければなりません AD or CODE
time はい ビデオの先頭からの秒単位のキューポイントの時間 【1]
metadata 文字列 いいえ 128のシングルバイト文字までの任意の文字列 - これは、オーバーレイのテキストや表示するイメージの場所など、キューポイントイベントハンドラにとって有用な情報です
force_stop ブール値 いいえ キューポイントに達したときにビデオを一時停止するかどうか( force_stop は無視されます Brightcove Player 現在サポートする計画はありませんが、キューポイントイベントハンドラで手動でビデオを一時停止することができます)

ノート

  • 【1] 技術的には、キューポイントは次のキューポイントに達するまでアクティブです。したがって、キューポイントアレイで Brightcove Player、あなたは startTimeendTime 同様に time キューポイント用。

資格情報を取得する

使用するには CMS API 適切な資格情報が必要になります。

ほとんどの場合、資格情報を取得する最も簡単な方法は、Studio Admin 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リポジトリ.

ペンを見る CMS API サンプル:キューポイントの追加 ブライトコーブラーニングサービス( @rcrooks1969)上 コードペン.

CodePenの使用

上記のCodePenを効果的に使用するためのヒントをいくつか紹介します。

  • をクリックして、アプリの実際の表示を切り替えます。 Result ボタン。
  • HTML / CSS / JSの各ボタンをクリックして、1つのコードタイプを表示します。
  • ナビゲーションヘッダーの CodePenで編集 右上隅にあるこのCodePenを自分のアカウントにフォークします。
  • このサンプルに関連付けられているすべてのコードをこれで見つけます GitHubリポジトリ.

プロキシコード

このページのサンプルアプリで独自のバージョンを構築するには、独自のプロキシを作成してホストする必要があります。 (Brightcoveラーニングサービスで使用されるプロキシは、Brightcoveドメインからの要求のみを受け入れます。)サンプルプロキシは、使用するものと非常に似ていますが、Brightcove以外のドメインからの要求をブロックするチェックがない場合は、次の場所にあります。 このGitHubリポジトリ。 また、そこでの使用のための基本的な手順や、プロキシの周囲にアプリケーションを構築するためのより詳細なガイドが含まれています。 REST APIの使用.


ページの最終更新日:12年2020月XNUMX日