参照ID の使用

このトピックでは、Brightcove プレーヤーに動画やプレイリストを公開する際に参照ID を使用する方法について説明します。

参照IDを 使用する理由

可能であれば、動画ID やプレイリストID の代わりに参照ID を使用するのが望ましい運用です。主な利点は以下の通りです：

  • 動画やプレイリストを誤って削除しても、公開用の埋め込みコードをすべて更新する必要がありません。代わりに、別の動画をアップロードしたり、プレイリストを再作成して、削除されたアイテムと同じ参照ID を割り当てるだけで済みます。
  • コンテンツ管理システム（CMS）で動画やウェブページを管理する際に、参照ID とコンテンツID を簡単に対応させることができます。

概要

デフォルトでは、プレーヤーとともに動画を公開する際に、動画IDが使用されます。参照ID を使用するには、参照識別子の前に ref: を付けるだけです。

つまり、以下のように動画IDを使用する代わりに：

    <video-js data-video-id="4746402489001"

このように参照ID を使用することができます：

    <video-js data-video-id="ref:skivideo"

プレイリストID についても同様です。詳細は以下の例をご参照ください。

参照ID の一意性を保証するために、参照ID に関連する操作ではIDが最大 30 秒間ロックされます。つまり、動画から参照ID を削除したり、その動画を削除した後、すぐに別の動画で同じ参照ID を使用しようとすると、操作は 409 エラーで失敗します。このエラーが発生した場合は、少なくとも 30 秒待ってから再試行してください。

また、参照ID を使って動画の作成を試みた際に（参照ID とは無関係な理由で）処理が失敗すると、その参照ID は 30 秒間ロックされ、再試行してもロックが解除されるまでは失敗します。

参照ID名 でエスケープが必要な文字は、ダブルクオーテーションとアンパサンドのみで、これはHTML 仕様に準拠しています。

参照ID の追加

まず、動画に参照ID を追加します：

  1. Studio で Media モジュールを開き、対象の動画タイトルをクリックして動画のプロパティを開きます。
  2. 動画情報 セクションを見つけて、編集 をクリックします。
  3. 参照ID のプロパティに、任意の参照IDの値を入力します。
  4. 変更を保存します。
Studioでの参照ID追加

動画ID の置き換え

動画ID は参照ID に置き換えることができます。

iframe

iframe 実装を使用するには、以下の手順を実行します：

  1. Media モジュールで、動画をプレーヤーと一緒に公開します。
  2. iframe 埋め込みコードをコピーして、HTM Lページのコードに貼り付けます。
  3. videoId の値を、先頭に ref: を付けた適切な参照ID に変更します。
<!doctype html>
<html>

<head>
    <meta charset="UTF-8">
    <title>Video Reference ID</title>
</head>

<body>

  <iframe src="https://players.brightcove.net/1752604059001/default_default/index.html?videoId=ref:skivideo&muted"
      allowfullscreen
      webkitallowfullscreen
      mozallowfullscreen
      width="640"
      height="360"></iframe>

</body>
</html>

In-page 埋め込み

In-Page 埋め込みを使用するには、以下の手順を実行します：

  1. Media モジュールで、動画をプレーヤーと一緒に公開します。
  2. Videoタグ 埋め込みコードをコピーして、HTMLページのコードに貼り付けます。
  3. data-video-id の値を、先頭に ref: を付けた適切な参照IDに変更します。
<!doctype html>
<html>

<head>
    <meta charset="UTF-8">
    <title>Video Reference ID</title>
</head>

<body>

  <video-js data-video-id="ref:skivideo"
      data-account="1752604059001"
      data-player="default"
      data-embed="default"
      data-application-id
      class="video-js"
      controls muted
      width="640"
      height="360"></video-js>
  <script src="https://players.brightcove.net/1752604059001/default_default/index.min.js"></script>

</body>
</html>

プレイリストID の置き換え

プレイリストID は参照ID に置き換えることができます。

iframe

iframe 実装を使用するには、以下の手順を実行します：

  1. Media モジュールで、動画をプレーヤーと一緒に公開します。
  2. iframe 埋め込みコードをコピーして、HTML ページのコードに貼り付けます。
  3. playlistId の値を、先頭に ref: を付けた適切な参照IDに変更します。
<!doctype html>
<html>

<head>
    <meta charset="UTF-8">
    <title>Video Reference ID</title>
</head>

<body>

  <iframe src="https://players.brightcove.net/1752604059001/H1EyAYN3_default/index.html?playlistId=ref:allTimePlaylist"
      allowfullscreen
      webkitallowfullscreen
      mozallowfullscreen
      width="640"
      height="360"></iframe>

</body>
</html>

Videoタグ 埋め込み

Videoタグ 埋め込みを使用するには、以下の手順を実行します：

  1. Media モジュールで、動画をプレーヤーと一緒に公開します。
  2. Videoタグ 埋め込みコードをコピーして、HTMLページのコードに貼り付けます。
  3. data-playlist-id の値を、先頭に ref: を付けた適切な参照ID に変更します。
<!doctype html>
<html>

<head>
  <meta charset="UTF-8">
  <title>Video Reference ID</title>
  <style type="text/css">
    .video-js {
      float: left;
    }
    .vjs-playlist {
      width: 280px;
      height: 360px;
      overflow-x: hidden;
    }
  </style>
</head>

<body>

  <video-js data-playlist-id="ref:allTimePlaylist"
      data-account="1752604059001"
      data-player="H1EyAYN3"
      data-embed="default"
      data-application-id
      class="video-js"
      controls
      width="640"
      height="360"></video>
  <script src="https://players.brightcove.net/1752604059001/H1EyAYN3_default/index.min.js"></script><div class="vjs-playlist"></div>

</body>
</html>