Thumbnails Set

Similar to thumbnail capture, but using the thumbnailset output allows multiple thumbnail images at distinct times to be captures in a single request.

<?xml version="1.0"?>
<query>
    <userid>[UserID]</userid> <!-- required-->
    <userkey>[UserKey]</userkey> <!-- required-->
    <action>[Action]</action> <!-- required-->
    <source>[SourceFile]</source> <!-- required-->
    <format>
        <output>thumbnailset</output>
        <thumbnail>
            <time>[Time]</time>
            <width>[Width]</width>
            <height>[Height]</height>
            <quality>[Quality]</quality>
            <file_extension>jpg</file_extension>
            <keep_aspect_ratio>[yes|no]</keep_aspect_ratio>
            <destination>[DestinationURL]</destination>
        </thumbnail>
        <!-- Multiple thumbnails may be included -->
        <thumbnail>
           <!-- thumbnail params -->
        </thumbnail>
        <!-- Format params -->
    </format>
</query>

{
    "query": {
        "userid": "[UserID]", // required
        "userkey": "[UserKey]", // required
        "action": "[Action]", // required
        "source": "[SourceFile]", // required
        "format": {
            "output": "thumbnailset", // required
            "thumbnail": [
                {
                    "time": "[Time]",
                    "width": "[Width]",
                    "height": "[Height]",
                    "quality": "[Quality]",
                    "file_extension": "jpg",
                    "keep_aspect_ratio": "[yes|no]",
                    "destination": "DestinationURL]"
                },
                {
                    // thumbnail params
                }
                // Multiple thumbnails params may be included
            ]
            // Format params
        }
    }
}

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: 00:01:43.10 N% – Positive percentage number from 1 to 100%. Will generate thumbnail on N% of video duration. Example: 4% N – Positive number greater than 0.01. Will generate thumbnail on N second. Example: 5.01 N! – Positive integer number greater or equals to 1. Will generate thumbnail on every N second. Example: 5!	5
width	Specify the thumbnail width in pixels.	Positive integer	none
height	Specify the thumbnail height in pixels.	Positive integer	none
quality	Image Quality	Positive integer between 1 and 100	83
file_extension	File Extension	jpg	none
keep_aspect_ratio	Keep image aspect ratio	yes, no	no
destination	Thumbnail destination	Valid URL	none