API Method: /api/photo/frame
Extract a single frame of a video clip as a JPEG image.
Please note that this API method is subject to rate limiting and might be disabled entirely for a site or for a specific consumer key.
Parameters
| Parameter | Description |
|---|---|
| photo_id | The ID of the video to fetch a frame for. If this parameter is given, token is required. |
| token | The corresponding token for the photo_id. If this parameter is given, photo_id is required. |
| upload_token | An upload token for a file uploaded through the token upload method. You might want to include a filename along with this parameter. |
| time (required) | The timestamp in seconds of the frame to extract (i.e. 40.2) |
| size | The size of the frame (i.e. 160x90). If this parameter is omitted, a suitable size is chosen. |
Parameters for Resumable.js
This API methods support an extra set of parameters designed to work with Resumable.js, an open sourced JavaScript library for providing multiple simultaneous, stable, fault-tolerant and resumable uploads via the HTML5 File API released by TwentyThree.
You can retrieve a frame for one of multiple files being uploaded through Resumable.js by including the specific file's resumableIdentifier in the request along with the parameters listed above.
Permission level
The minimum required permission level is:
none
For non-public sites, the minimum level is:
anonymous
Response
If the request is successful, an image is returned with the content type image/jpeg.