Cover Image

A cover image serves as the initial scene that viewers will see when the player is initiated while the AOD doesn't autoplay.

To embed a cover image for a AOD, make a PUT request to the following API with specific AOD id provided:

PUT /bv/cms/v1/aods/:id

Configure the cover_image request body with the following options:

Query Parameters	Required	Description
type	Required	Specify the type of cover image to utilize: COVER_IMAGE_TYPE_AUTO: The first frame of your AOD autometically generated by BlendVision One. COVER_IMAGE_TYPE_CUSTOMIZE: Customized image uploaded from your ends.
customize	Optional	Required if the type is set to COVER_IMAGE_TYPE_CUSTOMIZE. Specify the image to use as the cover image with library_id. You can upload and obtain the ID for a image file using this API: POST /bv/cms/v1/library/files:upload Supported Formats: png, jpg, jpeg, gif File Size Limitation: 5 MB

Here is an example of a request body that embed a customized cover image for a AOD:

{
  "cover_image":{
    "type":"COVER_IMAGE_TYPE_CUSTOMIZE",
    "customize":{
      "library_id":"your-library-id-here"
    }
  }
}