Thumbnail Capture

Capture thumbnails from your source video.

To generate thumbnail images, please specify a separate encoding task using thumbnail output format.

<?xml version="1.0"?>
    <userid>[UserID]</userid> <!-- required-->
    <userkey>[UserKey]</userkey> <!-- required-->
    <action>[Action]</action> <!-- required-->
    <source>[SourceFile]</source> <!-- required-->
        <output>thumbnail</output> <!-- required-->
        <!-- Format params -->
    "query": {
        "userid": "[UserID]", // required
        "userkey": "[UserKey]", // required
        "action": "[Action]", // required
        "source": "[SourceFile]", // required
        "format": {
            "output": "thumbnail", // required
            "time": "[Time]",
            "width": "[Width]",
            "height": "[Size]",
            "use_vtt": "[yes|no]",
            "vtt_line_size": "[LineSize]",
            "vtt_max_lines": "[MaxLinesPerTile]",
            "vtt_destination": "[VTTDestination]",
            "public_url": "[PublicURL]",
            "public_vtt_url": "[VTTManifestPublicURL]",
            "quality": "[Quality]",
            "destination": "[DestFile]"
ParameterDescriptionAllowed ValuesDefault Value
timeSpecify the timestamp in seconds, percentage, or interval to capture – once created thumbnail from given timestamp.

N% – Positive percentage number from 1 to 100%.
Will generate thumbnail on N% of video duration.

N – Positive number greater than 0.01.
Will generate thumbnail on N second.

N! – Positive integer number greater or equals to 1.
Will generate thumbnail on every N second.
widthSpecify the thumbnail width in pixels.Positive integernone
heightSpecify the thumbnail height in pixels.Positive integernone
use_vttEnable merging of thumbnails in single video tooltip thumbnail (VTT).yes, nono
vtt_line_sizeSpecify the number of thumbnails used for the VTT image.Positive integer4
vtt_max_linesSpecify the maximum count of lines per tile. In cases where more than one tile is needed than a set of tiles is generated.Positive integernone
vtt_destinationSpecify the VTT manifest file destination.Valid URLnone
public_urlSpecify the public URL to use in VTT manifest to point to tiles.Valid URLnone
public_vtt_urlSpecify the public URL to VTT manifest file.Valid URLnone
qualityImage QualityPositive integer between 1 and 10083



JPEG is the only supported image format for thumbnail images.



If your specified thumbnail width and height are different from your video's aspect ratio, you may get black spaces added to the thumbnail image.

If you specify only width or height, the other will be calculated according to your video size.

If neither width nor height are specified, the thumbnail will result in the same size as your video.