Returns a Base64-encoded representation of the specified frame from the highest bitrate variant of the specified asset.
Request
Request syntax:
GET /api2/asset/getframe
Request parameters:
Pass the following parameters through the msg parameter:
| Request Parameter | Type | Description | |
|---|---|---|---|
| id Required | Integer | Identifies 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.. | |
| ts Required | Integer | String | Identifies a frame by its timestamp. Syntax (Integer): Milliseconds Syntax (String): hh:mm:ss.ms |
Response
A response body parameter is described below.
| Response Parameter | Type | Description |
|---|---|---|
| img | String | The Base64-encoded representation of the requested frame. |
Sample Request/Response
The following sample requests demonstrate the different syntax that may be used to retrieve the frame that can be found 91.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/getframe', id='5fa5c4bc8ff34261b7fbafba5b5e6347', ts=91415)) # 91.415 seconds
print(Call('/api2/asset/getframe', id='5fa5c4bc8ff34261b7fbafba5b5e6347', ts='00:01:31.415')) # 91.415 seconds
{
'img': 'iVBORw0KGgoAAAANSUhEUgAABQAAAALQCAIAAAB...'
}