すべてのプロダクト
Search

このプロダクト

    ApsaraVideo VOD:SnapshotComplete

    ドキュメントセンター

    ApsaraVideo VOD:SnapshotComplete

    最終更新日:Jun 20, 2022

    このトピックでは、SnapshotCompleteイベントとその通知内容とサンプルコールバックについて説明します。

    イベントタイプ

    SnapshotComplete

    イベントの説明

    SnapshotCompleteイベントは、ビデオのスナップショットが取得された後に生成されます。

    • Snapshottingとトランスコードは同時に実行されます。

    • スナップショットがサムネイルスナップショットで、CoverUrlパラメーターが指定されていない場合、サムネイルスナップショットの1つがビデオサムネイルとして選択されます。 For more information about thumbnail snapshots, see Video snapshots.

    • GetVideoInfo操作を呼び出して、CoverSnapshotタイプのビデオサムネイルとスナップショットのURLを取得できます。

    • ListSnapshots操作を呼び出して、特定のビデオで取得された最新のスナップショットのURLを取得できます。

    説明

    URL署名を有効にしている場合は、スナップショットのURLにアクセスするために独自のauth_keyを生成する必要があります。 それ以外の場合、リクエストに対してHTTP 403エラーコードが返されます。 URL署名の詳細については、「URL署名」をご参照ください。

    イベント通知コンテンツ

    パラメーター

    データ型

    必須／任意

    説明

    EventTime

    String

    必須

    イベントが生成された時刻。 時刻はyyyy-MM-ddTHH:mm:ssZ形式でUTCで表示されます。

    EventType

    String

    必須

    イベントタイプ。 値はSnapshotCompleteです。

    VideoId

    String

    必須

    The ID of the video.

    ステータス

    String

    必須

    ビデオのスナップショットを取得するかどうかを示します。 設定可能な値は以下のとおりです。

    • success: ビデオのスナップショットが取得されます。

    • fail: ビデオのスナップショットの撮影に失敗しました。

    サブタイプ

    String

    任意

    The subtype of the snapshot. The value is SpecifiedTime.

    説明

    The value of SpecifiedTime indicates that the snapshot is taken through calls to the SubmitSnapshotJob operation.

    ErrorCode

    String

    任意

    エラーコードを示します。 This parameter is available when snapshots fail to be taken for the video.

    ErrorMessage

    String

    任意

    エラーメッセージを示します。 このパラメーターは、ビデオのスナップショットの撮影に失敗した場合に使用できます。

    CoverUrl

    String

    任意

    サムネイルのURL。 スナップショットの取得に失敗した場合、このパラメーターは使用できません。

    SnapshotInfos

    SnapshotInfo[]

    任意

    Details about the snapshots. スナップショットの取得に失敗した場合、このパラメーターは使用できません。 For more information, see the following table SnapshotInfos.

    Extend

    String

    任意

    コールバックのパススルーモードで返されるユーザー定義パラメーター。 詳細については、「リクエストパラメーター」の「UserData」セクションをご参照ください。

    SnapshotInfos

    フィールド

    データ型

    必須／任意

    説明

    ステータス

    String

    必須

    ビデオのスナップショットを取得するかどうかを示します。 設定可能な値は以下のとおりです。

    • success: ビデオのスナップショットが取得されます。

    • fail: ビデオのスナップショットの撮影に失敗しました。

    SnapshotType

    String

    必須

    スナップショットのタイプ。 設定可能な値は以下のとおりです。

    • CoverSnapshot: サムネイルスナップショット

    • NormalSnapshot: 通常のスナップショット

    • SpriteSnapshot: スプライトスナップショット

    詳細については、「ビデオスナップショット」をご参照ください。

    SnapshotCount

    Long

    必須

    スナップショットの総数。

    SnapshotFormat

    String

    必須

    スナップショット名の形式。 このパラメーターは、OSSストレージURLまたはCDNドメイン名と一緒に使用して、スナップショットURLを生成できます。

    説明

    ドメイン名が頻繁に変更される場合は、このパラメーターに基づいてスナップショットURLを生成できます。

    SnapshotRegular

    String

    必須

    スナップショットURLの生成に使用されるルール。 スナップショットURLは、ルールに基づいて生成することができる。 SnapshotRegular値に基づいてスナップショットURLを生成することを推奨します。 スナップショットURLを生成する方法の詳細については、次のセクションを参照してください。

    説明

    ドメイン名がある場合、CDN URLを生成するルールが返されます。 ドメイン名がない場合、OSSストレージURLの生成に使用されるルールが返されます。 このパラメーターは、HTTPS URLを生成するルールを返しません。

    JobId

    String

    必須

    スナップショット作成ジョブのID。

    説明

    新しくアップロードされたビデオとそのスナップショットには、同じOSSストレージURLがあります。 詳細については、「VODリソースの管理」をご参照ください。

    スナップショットURLの生成

    スナップショットURLは、次のいずれかの方法で生成できます。

    • SnapshotFormat値に基づいてスナップショットURLを生成する

      • ルール: http(s)://{CDNドメイン名またはOSSストレージURL}/SnapshotFormat

      • 説明: {SnapshotCount} 値は、各スナップショットのシリアル番号です。 値が5桁で構成されるように、先行ゼロを追加します。

      • 例：

        • 最初のスナップショットのシリアル番号が00001の場合、スナップショットのURLは次のとおりです。

          http://example.com/2327a6ec24b44844b3a5e2c1b691 ****/covers/990f3820db2948b5b4a13d65d9a4 **** -00001.jp g

        • 2番目のスナップショットのシリアル番号が00002の場合、スナップショットのURLは次のとおりです。

          http://example.com/2327a6ec24b44844b3a5e2c1b691 ****/covers/990f3820db2948b5b4a13d65d9a4 **** -00002.jp g

          他のスナップショットのURLも同様に生成することができる。

    • SnapshotRegular値に基づいてスナップショットURLを生成する

      • ルール: SnapshotRegular値は、スナップショットURLを生成するための完全なルールを示します。

      • 説明: SnapshotFormat値に基づくのと同じ方法で、SnapshotRegular値に基づいてSnapshot URLを生成できます。

    サンプルコールバック

    説明

    • HTTPコールバックの場合、次の例はHTTP POSTリクエストのボディです。

    • MNSコールバックの場合、次の例はメッセージ本文です。

    {
  "EventType": "SnapshotComplete" 、
  "EventTime": "2018-07-31T10:07:31Z" 、
  "CoverUrl": "http:// sample/covers/990f3820db2948b5b4a13d65d9a4 **** -00002.jp g" 、
  "Extend":"テストデータ" 、
  "SnapshotInfos": [
    {
      "ステータス": "成功" 、
      "SnapshotType": "CoverSnapshot" 、
      "SnapshotCount": 2、
      "SnapshotFormat": "2327a6ec24b44844b3a5e2c1b691 ****/covers/990f3820db2948b5b4a13d65d9a4 ****-{SnapshotCount }.jpg" 、
      "SnapshotRegular": "http:// sample/covers/990f3820db2948b5b4a13d65d9a4 ****-{SnapshotCount}.jpg" 、
      "JobId": "ee16d4bbf3f7 ***** e094bcb8cf8ddde"
    },
    {
      "ステータス": "成功" 、
      "SnapshotType": "SpriteSnapshot" 、
      "SnapshotCount": 1、
      "SnapshotFormat": "2327a6ec24b44844b3a5e2c1b691 ****/covers/sprite/990f3820db2948b5b4a13d65d9a4 ****-{SnapshotCount}.jpg" 、
      "SnapshotRegular": "http:// sample/covers/sprite/990f3820db2948b5b4a13d65d9a4 ****-{SnapshotCount}.jpg" 、
      "JobId": "b3187205eed ***** b72adf4eb3840713"
    }
  ]
}