tencent cloud

Overview

This document provides an overview of APIs and SDK code samples related to media file screencapturing in CI.

Basic operations

Getting a screenshot of a media file at some time point

Feature description

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

Method prototype

public SnapshotResponse generateSnapshot(SnapshotRequest request);

Parameter description

Input has the following sub-nodes:

Output has the following sub-nodes:

Response description

• Success: The screenshot entity information is returned.
• Failure: An error (such as the bucket does not exist) occurs, throwing the CosClientException or CosServiceException exception. For more information, see Troubleshooting.

Sample request

//1. Create a screenshot request object
SnapshotRequest request = new SnapshotRequest();
//2. Add request parameters as detailed in the API documentation
request.setBucketName("examplebucket-1250000000");
request.getInput().setObject("1.mp4");
request.getOutput().setBucket("examplebucket-1250000000");
request.getOutput().setRegion("ap-chongqing");
request.getOutput().setObject("test/1.jpg");
request.setTime("15");
//3. Call the API to get the screenshot response object
SnapshotResponse response = client.generateSnapshot(request);