Help Center/ Video On Demand/ User Guide/ Appendix/ JSON Message Body/ Thumbnail Generation Message Body
Updated on 2022-10-24 GMT+08:00

Thumbnail Generation Message Body

The condition for triggering thumbnail generation is to take first frame of video.

Sample Thumbnail Generation Success Message

{
	"event_type": "coverComplete",
	"cover_info": {
		"status": "FAILED",
		"title": "XC1",
		"asset_id": "13d570ca574035a3efd7014689c34507",
		"error_code": "VOD.10013",
		"error_msg": "null",
		"cover_type": "HEAD_FRAME_COVER"
	}
}

Message Body Description

Table 1 Cover_Info structure

Parameter

Description

status

Event status

  • SUCCEED
  • FAILED

title

Media name

asset_id

Media ID

cover_type

Media generation type.

  • HEAD_FRAME_COVER: thumbnail of the first frame

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.