tencent cloud

Overview

This document provides an overview of APIs and SDK code samples for media screenshot.

Note：

The COS Mini Program SDK version must be at least v1.1.1.

Querying Screenshot

Feature description

This API is used to query the screenshot of a media file at some time point.

Note：

Before using this API, make sure that the media processing feature has been enabled in the data processing section in the console; otherwise, the error media bucket unbinded, bucket's host is unavailable will be reported.

Sample code

var config = {
 // Replace with your own bucket information
 Bucket: 'examplebucket-1250000000', /* Bucket (required) */
 Region: 'COS_REGION', /* Bucket region (required) */
};
cos.request({
   Bucket: config.Bucket,
   Region: config.Region,
   Method: 'GET',
   Key: 'test.mp4',  /* Media file in bucket (required) */
   Query: {
       'ci-process': 'snapshot', /** Fixed value (required) */
       time: 1, /** Screenshot time point in seconds (required) */
       // width: 0, /** Screenshot width (optional) */
       // height: 0, /** Screenshot height (optional) */
       // format: 'jpg', /** Screenshot format (optional). Valid values: jpg; png. Default value: jpg */
       // rotate: 'auto', /** Image rotation method (optional). Default value: auto */
       // mode: 'exactframe', /** Frame capturing method (optional). Default value: exactframe */
   },
   RawBody: true,
},
function(err, data){
   console.log(err || data);
});

Parameter description

Callback function description

function(err, data) { ... }