カテゴリコールバックの使用

Prev Next

Classic/VPC環境で利用できます。

VOD Stationは、エンコードリクエスト状態確認のためにコールバック(Callback)機能を使用します。コールバックを使用すると、VOD Stationでエンコード中に状態変更イベントが発生するたびに設定された notificationUrlにコールバックメッセージが自動的に送信されます。次の APIでリクエストする際は、notificationにコールバック URLを入力してコールバックを設定してください。

参考

コールバックメッセージはencodingOptionIdごとに個別送信されます。例えば、カテゴリに3つのエンコードオプションが設定されていて、入力ファイルに対してエンコードの状態が変更された場合、エンコードオプションごとに状態変更に関するコールバックを送信します。

コールバックメッセージ

コールバックメッセージの説明は次の通りです。

フィールド タイプ 必須の有無 説明
categoryId Integer - カテゴリ ID
categoryName String - カテゴリ名
fileId Integer - 入力ファイル ID
filePath String - ファイル名を含む入力ファイルのバケットの詳細パス
  • statusがWAITING(待機)の場合、空の文字列を送信
encodingOptionId Integer - エンコードオプション ID
outputType String - 出力タイプ
link String - ファイル名を含む出力ファイルの HTTP URLパス
  • statusがCOMPLETE(完了)の場合、表示
status String - ファイルエンコード状態
  • COMPLETE | WAITING | RUNNING | FAILURE
    • COMPLETE: 完了
    • WAITING: 待機
    • RUNNING: 処理中
    • FAILURE: 失敗

コールバックメッセージの例

コールバックメッセージのサンプルコードは次の通りです。

// ジョブ待ち (WAITING)
{
  "categoryId": 13814,
  "categoryName": "VOD-Callback",
  "fileId": 1163694,
  "filePath": "",
  "encodingOptionId": 2,
  "outputType": "AVC_SD_1Pass_30fps_1",
  "status": "WAITING"
}
{
  "categoryId": 13814,
  "categoryName": "VOD-Callback",
  "fileId": 1163694,
  "filePath": "",
  "encodingOptionId": 1,
  "outputType": "AVC_SD_1Pass_30fps",
  "status": "WAITING"
}
{
  "categoryId": 13814,
  "categoryName": "VOD-Callback",
  "fileId": 1163694,
  "filePath": "",
  "encodingOptionId": 3,
  "outputType": "AVC_HD_1Pass_30fps",
  "status": "WAITING"
}

// ジョブ処理中 (RUNNING)
{
  "categoryId": 13814,
  "categoryName": "VOD-Callback",
  "fileId": 1163694,
  "filePath": "/VOD-Callback/VODStation_AVC_HD_1Pass_30fps.mp4",
  "encodingOptionId": 3,
  "outputType": "AVC_HD_1Pass_30fps",
  "status": "RUNNING"
}
{
  "categoryId": 13814,
  "categoryName": "VOD-Callback",
  "fileId": 1163694,
  "filePath": "/VOD-Callback/VODStation_AVC_SD_1Pass_30fps.mp4",
  "encodingOptionId": 1,
  "outputType": "AVC_SD_1Pass_30fps",
  "status": "RUNNING"
}
{
  "categoryId": 13814,
  "categoryName": "VOD-Callback",
  "fileId": 1163694,
  "filePath": "/VOD-Callback/VODStation_AVC_SD_1Pass_30fps_1.mp4",
  "encodingOptionId": 2,
  "outputType": "AVC_SD_1Pass_30fps_1",
  "status": "RUNNING"
}

// ジョブ完了 (COMPLETE)
{
  "categoryId": 13814,
  "categoryName": "VOD-Callback",
  "fileId": 1163694,
  "filePath": "/VOD-Callback/VODStation_AVC_SD_1Pass_30fps.mp4",
  "encodingOptionId": 1,
  "outputType": "AVC_SD_1Pass_30fps",
  "link": "https://kr.object.ncloudstorage.com/station-000/VOD-Callback/VODStation_AVC_SD_1Pass_30fps.mp4",
  "status": "COMPLETE"
}
{
  "categoryId": 13814,
  "categoryName": "VOD-Callback",
  "fileId": 1163694,
  "filePath": "/VOD-Callback/VODStation_AVC_SD_1Pass_30fps_1.mp4",
  "encodingOptionId": 2,
  "outputType": "AVC_SD_1Pass_30fps_1",
  "link": "https://kr.object.ncloudstorage.com/station-000/VOD-Callback/VODStation_AVC_SD_1Pass_30fps_1.mp4",
  "status": "COMPLETE"
}
{
  "categoryId": 13814,
  "categoryName": "VOD-Callback",
  "fileId": 1163694,
  "filePath": "/VOD-Callback/VODStation_AVC_HD_1Pass_30fps.mp4",
  "encodingOptionId": 3,
  "outputType": "AVC_HD_1Pass_30fps",
  "link": "https://kr.object.ncloudstorage.com/station-000/VOD-Callback/VODStation_AVC_HD_1Pass_30fps.mp4",       
  "status": "COMPLETE"
}