Help Center/ Video On Demand/ User Guide/ Appendix/ JSON Message Body/ Snapshot Message Body
Updated on 2022-10-24 GMT+08:00
View PDF
Share

Snapshot Message Body

Sample Frame Capture Success Message

{
	"event_type": "thumbnailComplete",
	"thumbnail_info": {
		"asset_id": "14d7b2faba0dddd6b4e8936272d6bc3f",
		"status": "SUCCEED",
		"sample": [{
			"offset": 0,
			"url": "https://179.cdn-vod.huaweicloud.com/asset/14d7b2faba0dddd6b4e8936272d6bc3f/snapshot/sample/0.jpg"
		}, {
			"offset": 5,
			"url": "https://179.cdn-vod.huaweicloud.com/asset/14d7b2faba0dddd6b4e8936272d6bc3f/snapshot/sample/5.jpg"
		}, {
			"offset": 10,
			"url": "https://179.cdn-vod.huaweicloud.com/asset/14d7b2faba0dddd6b4e8936272d6bc3f/snapshot/sample/10.jpg"
		}, {
			"offset": 15,
			"url": "https://179.cdn-vod.huaweicloud.com/asset/14d7b2faba0dddd6b4e8936272d6bc3f/snapshot/sample/15.jpg"
		}, {
			"offset": 20,
			"url": "https://179.cdn-vod.huaweicloud.com/asset/14d7b2faba0dddd6b4e8936272d6bc3f/snapshot/sample/20.jpg"
		}, {
			"offset": 25,
			"url": "https://179.cdn-vod.huaweicloud.com/asset/14d7b2faba0dddd6b4e8936272d6bc3f/snapshot/sample/25.jpg"
		}],
		"dots": []
	}
}

Snapshot Message Body Description

Table 1 ThumbnailInfo structure

Parameter

Description

asset_id

Media ID

status

Event status

  • SUCCEED
  • FAILED

sample

Sampling information. This parameter is used only when status is SUCCEED.

  • offset: time offset of a snapshot in the video, in seconds
  • url: URL for accessing the snapshot

dots

Snapshot information at a specified time point. This parameter is used only when status is SUCCEED.

  • offset: time offset of a snapshot in the video, in seconds
  • url: URL for accessing the snapshot

error_code

Error code. This parameter is used only when status is FAILED.

error_msg

Error description. This parameter is used only when status is FAILED.
Parent topic: JSON Message Body