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"?>
<query>
    <userid><<id>></userid> <!-- required-->
    <userkey><<key>></userkey> <!-- required-->
    <action>[Action]</action> <!-- required-->
    <source>[SourceFile]</source> <!-- required-->
    <format>
        <output>thumbnail</output> <!-- required-->
        <time>[Time]</time>
        <width>[Width]</width>
        <height>[Size]</height>
        <use_vtt>[yes|no]</use_vtt>
        <vtt_line_size>[LineSize]</vtt_line_size>
        <vtt_max_lines>[MaxLinesPerTile]</vtt_max_lines>
        <vtt_destination>[VTTDestination]</vtt_destination>
        <public_url>[PublicURL]</public_url>
        <public_vtt_url>[VTTManifestPublicURL]</public_vtt_url>
        <quality>[Quality]</quality>
        <destination>[DestFile]</destination>
        <!-- Format params -->
    </format>
</query>
{
    "query": {
        "userid": "<<id>>", // required
        "userkey": "<<key>>", // 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]"
        }
    }
}

Parameter

Description

Allowed Values

Default Value

time

Specify the timestamp in seconds, percentage, or interval to capture thumbnails.

hh:mm:ss.ms – once created thumbnail from given timestamp.
Example:

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

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

N! – Positive integer number greater or equals to 1.
Will generate thumbnail on every N second.
Example:

5

width

Specify the thumbnail width in pixels.

Positive integer

none

height

Specify the thumbnail height in pixels.

Positive integer

none

use_vtt

Enable merging of thumbnails in single video tooltip thumbnail (VTT).

yes, no

no

vtt_line_size

Specify the number of thumbnails used for the VTT image.

Positive integer

4

vtt_max_lines

Specify the maximum count of lines per tile. In cases where more than one tile is needed than a set of tiles is generated.

Positive integer

none

vtt_destination

Specify the VTT manifest file destination.

Valid URL

none

public_url

Specify the public URL to use in VTT manifest to point to tiles.

Valid URL

none

public_vtt_url

Specify the public URL to VTT manifest file.

Valid URL

none

quality

Image Quality

Positive integer between 1 and 100

83

📘

Note

JPEG is the only supported image format for thumbnail images.

🚧

Note

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.