Thumbnail Query API (Deprecated)

For every video uploaded into your Backlot account, the Ooyala Transcoding system produces a thumbnail image roughly every 15-30 seconds.

Note: This software is deprecated. Use the latest version.

The encoding widths in your processing profile dictate the sizes of the images produced. Specifically, for every encoding width X in your processing profile, thumbnail images are produced at size X and size X/3. Any query to the Thumbnail API for a particular size of an image will as a result search against these sizes. If an exact match is not possible, the next closest sized thumbnail image will be returned. It is important to note that the thumbnail images produced maintain the aspect ratio of the original file uploaded into Backlot.

Note: Custom promo images uploaded through Backlot or the API will be returned by a thumbnail query and will not be processed and have multiple sizes made available. The thumbnail image is different from the promo image; the original promo image can be accessed through the Query API interface.

As in the Query API example, Thumbnail queries are generated using a signed REST-style GET request to http://api.ooyala.com/partner/thumbnails.

Required Parameters:

Example of a request

http://api.ooyala.com/partner/thumbnails?pcode=<pcode>&embedCode=<embedCode>
 &range=0-25&resolution=600x400&expires=<expiration>&signature=<signature>
 

Thumbnail Query Result

The result of a query is an XML document served as a response body. The root tag is <thumbnails> with all matching thumbnails included as <thumbnail> tags in that list.

The root <thumbnails> tag has 2 attributes:

Each <thumbnail> tag contains:

Example of Thumbnail Query Result

<?xml version="1.0" encoding="UTF-8"?>
<thumbnails aspectRatio="4/3" estimatedWidth="240" embedCode="kxYm06gFKXEleIHdyXNKeefx-QAu2yVp" requestedWidth="340">
  <thumbnail timestamp="0" index="0">http://ak.c.ooyala.com/kxYm06gFKXEleIHdyXNKeefx-QAu2yVp/Ut_HKthATH4eww8X5hMDoxOmc3O2T4mP</thumbnail>
  <thumbnail timestamp="9933" index="1">http://ak.c.ooyala.com/kxYm06gFKXEleIHdyXNKeefx-QAu2yVp/67AQECG82s3QgdEn5hMToxOmc3OwZ8Ex</thumbnail>
  <promoThumbnail>http://ak.c.ooyala.com/kxYm06gFKXEleIHdyXNKeefx-QAu2yVp/Ut_HKthATH4eww8X5hMDoxOmc3O2T4mP</promoThumbnail>
</thumbnails>