Video Storyboard

Video Storyboard is a set of image frames extracted from a video at specific intervals. Storyboards can be used to select specific thumbnails for videos, to analyse video content quickly, etc.

You can make use of /process API and /reprocess Batch API to create storyboard images for a video. The size of images and number of images generated are based on the settings profile.

Addon key for process and reprocess API: storyboard

Note:

• storyboard conversion will be added to Asset's data automatically
• Storyboard details can be retrieved using the Get Data API (see Asset Data Storyboard JSON example)
• A storyboard specific key file_count gives the number of storyboard images that have been generated and available
• Storyboard images will be named storyboard_000001.jpg, storyboard_000002.jpg, etc, where the zero-fill numbers 000001, 000002 go upto file_count
• Storyboard images are stored under Video Transcodes storage bucket specified in account settings

HTTP Request

HTTP POST <<API_HOST>>/api/v1/assets/{ASSET_ID}/process (Refer Process API )

Request Parameters

Example Storyboard conversion key data fragment (part of Asset Get Data API response)

{  
    "storyboard": {  
      "key": "/transcodes/1cba32852739447c956b97580977fdf4/storyboard",  
      "bucket": "my-bucket",  
      "width": 480,  
      "height": 360,  
      "public": true,  
      "watermarked": false,  
      "size": 186240,  
      "file_count": 6,  
      "duration": 0  
    }  
}

Request JSON

The request body should be a JSON as below.

{
  "keys": ["storyboard"]
}

HTTP Response

Standard HTTP Status code - 202 or 200

📘

Once a processing completes, callbacks are issued to registered webhooks.

Also, once processing completes, Asset Data JSON will contain process state for the addon as below:

{
"addons_info": {
    "STORYBOARD": {
      "available": true
    }
  }
}