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

APIを埋め込む

このトピックは、Embed APIをいつどのように使用するかを決定するのに役立ちます。 を使用するかどうかを選択する決定 Player 構成APIと埋め込みAPIは重要なものであり、このドキュメントの内容がこれらの決定をガイドします。

埋め込みAPIを使用する理由

埋め込みAPIを使用すると、特定の player。 これを考える良い方法 player/ instance関係は、親子関係です。 シングル player は親であり、 player埋め込みAPIで作成されたsは親の子です player。 親 player あなたが望むプロパティの大部分を持っています player 必要な場合、埋め込みAPIを使用して、さまざまな子のプロパティのサブセットをカスタマイズできます。 players。 たとえば、さまざまなメディアをロードしたり、さまざまなプラグインを使用したり、さまざまな子でスタイルを設定したりできます players.

次の図は、機能を明確にするのに役立ちます。 親の下に左側に表示され、XNUMXつの子 player右側にあります。 次の点に注意してください。

  • ポスターは両方の子供に受け継がれます
  • 再生ボタンの形状は上の子によって継承され、下の子ではオーバーライドされます
  • 一番上の子はプロパティを追加します。この場合、オーバーレイは親が持っていません
子がプロパティを追加する
子がプロパティを追加する

この親子関係のもう1つの強力な機能は、継承が進行中であることです。 次の図は、親に割り当てられた新しいポスターを示していて、両方の子がその構成の変更を継承します。

子どもたちは変化を継承する
子どもたちは変化を継承する

組み込みAPIを使用しない場合

ユースケースで必要な場合に埋め込みAPIを使用することにはいくつかの正当な理由がありますが、通常の規則を守る必要があるいくつかの正当な理由もあります。 players。 ここにいくつかあります:

  • 子 playerを使用して編集することはできません Video Cloud スタジオ。 子のみ編集できます playerを介して Player Management API。 親を編集できます player 子供の player in Video Cloud スタジオ、ただし、親に加えられた変更 player すべての子供に影響を与える players.
  • 親を公開する player 子供が多いと時間がかかる playerその親に関連付けられたs player。 各子 player 別に発行され、30人以上の子供がいる場合 players、あなたはあなたの子供の遅れを期待することができます player 出版。 これは、通常の30を発行する場合とまったく同じです。 player同時に。

上記の理由を考えると、通常の players、そしてあなたが子供の必要性を見つけたときに埋め込みを試します players.

ビデオタグデータ埋め込み

親子で表記の違いがあります players。 標準ページはめ込み player コードは次の形式で表示されます:

    <video-js
      data-account="1507807800001"
      data-player="HiAdwRZ7kK"
      data-embed="default"
      controls=""
      data-application-id=""
      class="vjs-fluid"></video-js>

挽き目 data-embed 属性は、 player 親または子です。 値が defaultplayer 親です。 もし player 子供です、 data-embed 属性には親のIDが含まれます player。 その例を次に示します。

挽き目 data-embed 属性は、 player 親または子です。 値が defaultplayer 親です。 もし player 子供です、 data-embed 属性には親のIDが含まれます player。 その例を次に示します。

    <video-js
      data-account="1507807800001"
      data-player="HiAdwRZ7kK"
      data-embed="NURK56ZSV"
      data-application-id=""
      class="video-js" controls></video-js>

なお、 data-playerそれが player IDは同じですが、 data-embed から変更されました default 子供に playerのID。

子 player URLは

親をどのように区別しますか player と子供 players? URLは異なります。 たとえば、親 playerのURLは次のとおりです。

    //players.brightcove.net/1507807800001/HiAdwRZ7kK_default/index.min.js

埋め込みAPIを使用して子を作成した後 player、 子供 player次に示すように、親のURLに追加されたのID:

    //players.brightcove.net/1507807800001/HiAdwRZ7kK_NURK56ZSV/index.min.js

親/子ユースケース

複数のビデオを使用するとします players。 多くの場合、 playerはほとんど同じですが、場合によっては、 player 特別な場合。 複数作成できます playerを使用して Player 構成API POSTPATCH メソッドですが、これは重大なメンテナンスの問題につながる可能性があります。 たとえば、すべてのポスターを変更したいとします。 players。 これは PATCH すべての異なる players。 一方、子供を作成した場合 players、あなただけ PATCH 親 player、そしてすべての子供 playersは自動的に新しいポスターを持ちます。

作成プロセス

あなたが ステップバイステップ: Player 管理 curlステートメントを使用してHTTPメソッドを Player Management API。 ここでも同じアプローチを使用します。

作成するには player ほとんどの場合、いくつかのHTTPメソッドを Player 次のような構成API

  • 作ります player 使用して POST 〜へ https://players.api.brightcove.com/v2/accounts/$ACCOUNT_ID/players
  • 更新する player 使用して PATCH 〜へ https://players.api.brightcove.com/v2/accounts/$ACCOUNT_ID/players/$PLAYER_ID/configuration
  • 更新されたを公開 player 使用して POST 〜へ https://players.api.brightcove.com/v2/accounts/$ACCOUNT_ID/players/$PLAYER_ID/publish

同様のアプローチが子供にも使用されます player■埋め込みAPIの使用。 非常に高いレベルで:

  • 子を作成する player 使用して POST 〜へ https://players.api.brightcove.com/v2/accounts/$ACCOUNT_ID/players/$PLAYER_ID/埋め込む。 注:子供 player埋め込みAPIで作成されたsは、作成時に自己公開するため、子で公開する必要はありません。 player 作成、子供のみ player アップデート。
  • 子を更新 player 使用して PATCH 〜へ https://players.api.brightcove.com/v2/accounts/$ACCOUNT_ID/players/$PLAYER_ID/embeds / $ EMBED_ID / configuration
  • 子供を公開する player 使用して POST 〜へ https://players.api.brightcove.com/v2/accounts/$ACCOUNT_ID/players/$PLAYER_ID/embeds / $ EMBED_ID / publish

以下の内容はプロセスを詳細に説明しています。

子を作成 player

子を作成するには player あなたはHTTPを使用します POST メソッドを呼び出します。

    curl /
    --header "Content-Type: application/json" /
    --user $EMAIL /
    --request POST /
    --data '{
    "media": {
    "sources": [
      {
        "src":"http://solutions.brightcove.com/bcls/assets/videos/BirdsOfAFeather.mp4",
        "type":"video/mp4"
      }
    ],
    "poster": {
      "highres":"http://solutions.brightcove.com/bcls/assets/images/BirdsOfAFeather.jpg"
    }
    }
      }' /
    https://players.api.brightcove.com/v2/accounts/$ACCOUNT_ID/players/$PLAYER_ID/embeds

子供への応答の例 player 作成は次のとおりです。

    {
        "id": "be864624-8d85-4dfc-8fe6-4e9dd4c70417",
        "url": "http://players.brightcove.net/1507807800001/668c5107-a80c-4940-8c17-279c01ce101c_be864624-8d85-4dfc-8fe6-4e9dd4c70417/index.html",
        "embed_code": "<iframe src='//players.brightcove.net/1507807800001/668c5107-a80c-4940-8c17-279c01ce101c_be864624-8d85-4dfc-8fe6-4e9dd4c70417/index.html' allowfullscreen webkitallowfullscreen mozallowfullscreen></iframe>",
        "embed_in_page": "http://players.brightcove.net/1507807800001/668c5107-a80c-4940-8c17-279c01ce101c_be864624-8d85-4dfc-8fe6-4e9dd4c70417/in_page.embed",
        "preview_url": "http://preview-players.brightcove.net/1507807800001/668c5107-a80c-4940-8c17-279c01ce101c/be864624-8d85-4dfc-8fe6-4e9dd4c70417/index.html",
        "preview_embed_code": "<iframe src='//preview-players.brightcove.net/1507807800001/668c5107-a80c-4940-8c17-279c01ce101c/be864624-8d85-4dfc-8fe6-4e9dd4c70417/index.html' allowfullscreen webkitallowfullscreen mozallowfullscreen></iframe>"
    }

注:子供 player 自己作成時に公開するため、子を公開する必要はありません player 作成後。 子供を公開する必要があります player で変更された場合 PATCH 方法。 この時点では、公開された子を使用できるため、プレビュー情報は役に立ちません。 player 作成直後。

これで、 url 子供からの財産 player 結果を確認します。 子の下の例では player 親に追加されました player ステップバイステップで作成: Player 管理。 新しいポスターとビデオが表示されますが、親からのオーバーレイプラグイン player まだ存在しています。

子 Player 親のオーバーレイあり
子 Player 親のオーバーレイあり

子を更新 player

子を更新するには player あなたはHTTPを使用します PATCH 方法。 次のcurlステートメントは、 poster プロパティ。 あなたが $EMBED_ID 環境変数を適切に:

    curl
    --header "Content-Type: application/json"
    --user $EMAIL
    --request PATCH
    --data '{
    "media": {
    "poster": {
      "highres":"http://solutions.brightcove.com/bcls/assets/images/Water-Splashing.jpg"
    }
    }
      }'
    https://players.api.brightcove.com/v2/accounts/$ACCOUNT_ID/players/$PLAYER_ID/embeds/$EMBED_ID/configuration
    

レスポンスは、 preview_urlpreview_embed_code コー​​ド:

    {
        "preview_url": "http://preview-players.brightcove.net/1507807800001/668c5107-a80c-4940-8c17-279c01ce101c/be864624-8d85-4dfc-8fe6-4e9dd4c70417/index.html",
        "preview_embed_code": "<iframe src='//preview-players.brightcove.net/1507807800001/668c5107-a80c-4940-8c17-279c01ce101c/be864624-8d85-4dfc-8fe6-4e9dd4c70417/index.html' allowfullscreen webkitallowfullscreen mozallowfullscreen></iframe>"
    }

子を公開 player

子供がいれば player 変更された場合は、公開する必要があります。 必ず $EMBED_ID 環境変数が設定され、新しく変更された子を公開できます player:

    curl
    --header "Content-Type: application/json"
    --user $EMAIL
    --request POST
    https://players.api.brightcove.com/v2/accounts/$ACCOUNT_ID/players/$PLAYER_ID/embeds/$EMBED_ID/publish

応答は、子供を使用するために必要な重要な情報を提供します player、出版に非常に似ています player する:

    {
        "id": "be864624-8d85-4dfc-8fe6-4e9dd4c70417",
        "url": "http://players.brightcove.net/1507807800001/668c5107-a80c-4940-8c17-279c01ce101c_be864624-8d85-4dfc-8fe6-4e9dd4c70417/index.html",
        "embed_code": "<iframe src='//players.brightcove.net/1507807800001/668c5107-a80c-4940-8c17-279c01ce101c_be864624-8d85-4dfc-8fe6-4e9dd4c70417/index.html' allowfullscreen webkitallowfullscreen mozallowfullscreen></iframe>",
        "embed_in_page": "http://players.brightcove.net/1507807800001/668c5107-a80c-4940-8c17-279c01ce101c_be864624-8d85-4dfc-8fe6-4e9dd4c70417/in_page.embed"
    }

子情報を表示する

HTTPを使用することができます GET 子に関する情報を取得するメソッド player。 curlステートメントの例は次のとおりです。

    curl
      --header "Content-Type: application/json"
      --user $EMAIL
      --request GET
      https://players.api.brightcove.com/v2/accounts/$ACCOUNT_ID/players/$PLAYER_ID/embeds

非常に大量のJSONデータが返されます。

子を削除 players

子を削除することもできます player 使用して、 DELETE 方法。 子を削除するcurlステートメントの例を次に示します player:

    curl
    --header "Content-Type: application/json"
    --user $EMAIL
    --request DELETE
    https://players.api.brightcove.com/v2/accounts/$ACCOUNT_ID/players/$PLAYER_ID/embeds/$EMBED_ID

もちろん、これは子供だけに影響します player 親ではなく player.


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