Get Frame Thumbnail(s)

Returns a Base64-encoded representation from the lowest bitrate variant of the asset for each frame within the time range defined by the start and stop parameters.

Request

Request syntax:

GET /api2/asset/getthumbs

Request parameters:

Pass the following parameters through the msg parameter:

A valid request must identify an asset by including either the id or external_id request parameter.

Request ParameterTypeDescription
idIntegerIdentifies an asset by its asset IDThis unique ID identifies an asset. View this ID by navigating to the Content tab, selecting the desired asset, and then viewing the GUID option from the Details tab..
external_idStringIdentifies an asset by its external ID.
start RequiredInteger / StringIdentifies the start of the range. Syntax (Integer): Milliseconds Syntax (String): hh:mm:ss.ms
stopInteger / StringIdentifies the end of the range. If omitted, it will default to start + 1 second. Do not specify a time range greater than 1 second. Syntax (Integer): Milliseconds Syntax (String): hh:mm:ss.ms

Response

A response body parameter is described below.

Response ParameterTypeDescription
imgsStringA list of Base64-encoded representations of the requested frames.

Sample Request/Response

The following sample requests demonstrate the different syntax that may be used to retrieve frames between 91.415 and 92.415 seconds into the video. The Call() function, which is imported from uplynk_api2_auth module, prepares the message body and digital signature.

from uplynk_api2_auth import Call

print(Call('/api2/asset/getthumbs', id='5fa5c4bc8ff34261b7fbafba5b5e6347', start=91415))       # 91.415 seconds
print(Call('/api2/asset/getthumbs', external_id='id1234', start='01:31.415')) # 91.415 seconds

{
    'imgs': ['iVBORw0KGgoAAAANSUhEUgAABQAAAALQCAIAAAB...',
             'iVBORw0KGgoAAAANSUhEUgAABQAAAALQCAIAAAB...',
             ...]
}