Media API でキュー ポイントを設定する

Video Cloud Media 書き込み API を使用して、動画にキュー ポイントを挿入できます。キュー ポイントは、動画内の特定時点を示すマーカーです。キュー ポイントを使用することにより、ミッドロール広告（動画の途中に挟む広告）をトリガすることや、長時間動画を複数のチャプタやシーンに分割することができます。

Media 書き込み API が利用できるのは、Video Cloud Pro エディションと Enterprise エディションをご利用の方のみです。Video Cloud アカウントのアップグレードについては、ブライトコーブにお問い合わせください。

• キュー ポイントを作成する
• キュー ポイントを更新または削除する

キュー ポイントは、Video Cloud Advertising モジュールでも挿入できます。また、FTP バッチ プロビジョニングで、バッチ プロビジョニング マニフェストの XML 要素である <cuepoint> を使用して挿入することもできます。それぞれのキュー ポイント挿入方法の詳細については、動画にキュー ポイントを追加するを参照してください。

キュー ポイントを作成する

Media API の create_video メソッドを使用して、キュー ポイントを作成します。create_video のシグネチャは以下のとおりです。

create_video(token:String, video:Video, filename:String, 
   maxsize:Long, file:InputStream, file_checksum:String, 
   create_multiple_renditions:Boolean, cuePoints:List):Long

create_video メソッドを使用するには、以下を渡します。

• Media API の書き込みトークン
• キュー ポイントを割り当てたい動画の ID、または 参照 ID
• それぞれ以下のプロパティを含む CuePoint のリスト

キュー ポイントのプロパティ

たとえば ID が 123 の動画に、CODE のキュー ポイントを 1 秒後と 48 秒後に、AD のキュー ポイントを 120 秒後に設定する場合は、以下のような内容を http://api.brightcove.co.jp/services/ にポストします。

{"method": "create_video",
  "params": {
    "token": "riBRb-rHGiBBouSAXs-Q8Nmz04kE.",
    "video": {
      "name": "名前は必須です。",
      "shortDescription": "shortDescription も必須です。",
      "cuePoints": [
        {"name": "cp_code_1", "time": 1000, "type": 1},
        {"name": "cp_code_2", "time": 48000, "type": 1, "metadata": "some data"}, 
        {"name": "cp_ad_1", "time": 120000, "type": 0, "forceStop": "true"}   
      ]
    }
  }
}

キュー ポイントを更新する

Media API の update_video メソッドを使用して、既存のキュー ポイントを更新および削除できます。update_video で任意パラメータの cuePoints を使用すると、対象となる動画の既存キュー ポイントをすべて上書きします。cuePoints パラメータに含めなかったキュー ポイントは、すべて削除されます。

たとえば、前の例のように、ID が 123 の動画にすでにキュー ポイントを設定済みだと仮定し、この動画に追加で CODE のキュー ポイントを 360 秒後に設定し、48 秒後の CODE のキュー ポイントを動画から削除するには、以下のような内容を http://api.brightcove.co.jp/services/ にポストします。

{"method": "update_video",
  "params": {
    "token" : "riBRb-rHGiBBouSAXs-Q8Nmz04kE.",
    "video" : {
      "id": 123,
      "cuePoints":[
        {"name": "cp_code_1", "time": 1000, "type": 1},
        {"name": "cp_code_3", "time": 360000, "type": 1},
        {"name": "cp_ad_1", "time": 120000, "type": 0, "forceStop": "true"}   
      ]
    }
  }
}