tencent cloud

Cloud Infinite

Release Notes and Announcements
Release Notes
Announcements
Product Introduction
Product Overview
Product Strengths
Use Cases
Feature Overview
Regions and Domains
Specifications and Limits
Billing
Billing Overview
Billing Mode
Billable Items
Free Tier
Payment Overdue
Viewing Bill Details
FAQs
Getting Started
Registering and Logging In
Bind Bucket
Uploading and Processing File
Downloading and Deleting Images
Unbinding Buckets
Using CI via COS
Features
Image Processing
Media Processing
Content Moderation
AI Content Recognition
File Processing
Smart Voice
File processing
User Guide
Overview
Bucket Management
Smart Toolbox
Job and Workflow
Data Monitoring
Usage statistics
Use Cases
Copyright Protection Solutions
Image Processing Practices
Working with API Authorization Policies
Workflow Practices
API Documentation
API Overview
Structure
Common Request Headers
Common Response Headers
Activate Vast Service
Image Processing
AI-Based Content Recognition
Smart Audio
Media Processing
Content Moderation
Document Processing
File Processing
Job and Workflow
Cloud Virus Detection
Error Codes
Request Signature
SDK Documentation
SDK Overview
Android SDK
iOS SDK
COS Android SDK
C SDK
C++ SDK
.NET(C#) SDK
Go SDK
COS iOS SDK
Java SDK
JavaScript SDK
Node.js SDK
PHP SDK
Python SDK
Mini Program SDK
Personal Information Protection Policy for SDK
Security and Compliance
Permission ‍Management
FAQs
Basic Settings
Document Processing
Media Processing
Content Recognition
Smart Audio
Agreements
Service Level Agreement
Contact Us
Glossary
DocumentaçãoCloud InfiniteAPI DocumentationMedia ProcessingVideo Frame CaptureVideo Frame Capture Synchronization Request

Video Frame Capture Synchronization Request

PDF
Modo Foco
Tamanho da Fonte
Última atualização: 2025-09-09 15:50:49

Feature Description

The GetSnapshot API is used to obtain a screenshot of a media file at a certain time.

Authorization Description

When using with a sub-account, the ci:GenerateSnapshot permission is required. For details, see Cloud Infinite actions.

Service Activation

Using this feature requires enabling Cloud Infinite in advance and binding a bucket. For details, see Bind Bucket.
Use this feature requires enabling Media Processing Service in advance via console or API. For details, see Enable Media Processing Service.

Use Limits

When using this API, please first confirm the relevant restrictions. For details, see Usage Limits.

Fee Description

This API is a paid service. Incurred fees will be collected by Cloud Infinite. For detailed billing instructions, see Media Processing Fees.


Request sample:

1.Using the GET Request Method

GET /<ObjectKey>?ci-process=snapshot&time=1&format=jpg HTTP/1.1
Host: <BucketName-APPID>.cos.<Region>.myqcloud.com
Date: <GMT Date>
Authorization: <Auth String>
Content-Length: <length>

2. Adding Parameters Via URL Address Method

https://<BucketName-APPID>.cos.<Region>.myqcloud.com/for-test.mp4?ci-process=snapshot&time=1&format=jpg&<Auth String>
Note:
Authorization: Auth String. For details, see the Request Signature document.
ObjectKey is the bucket object.
This API uses synchronous mode. For asynchronous mode, refer to Screenshot Job.

Request header.

This API only uses common request headers. For details, see Common Request Headers documentation.

Request parameters.

The parameters are described as follows:
Parameter Name
Description
Type
Required or Not
ci-process
Operation type, fixed usage snapshot
String
Yes
time
Screenshot time point, in seconds
float
Yes
width
Width of the screenshot. Defaults to 0.
Int
No
height
Height of the screenshot. Defaults to 0.
Int
No
format
Format of the screenshot. Supports jpg and png. Default is jpg.
String
No
rotate
Rotation method of the image
auto: Perform automatic rotation based on video rotation information
off: No rotation
default value is auto
String
No
mode
Frame capturing method
keyframe: Capture the latest key frame before the specified time point
exactframe: Capture the frame at the specified time point
default value is exactframe
String
No
Note:
When both width and height are 0, it indicates using the video's aspect ratio. If one is 0, the other value will be used to automatically adapt according to the video aspect ratio.

Request body.

This request has no request body.

Response

Response Headers

This response includes common response headers. For details, see Common Response Headers document.

Response Body

The response body contains screenshot file content.

Error Codes

This request returns common error responses and error codes. For more information, see Error Codes.

Examples

Request 1 Using the GET Request Method

GET /for-test.mp4?ci-process=snapshot&time=1.5 HTTP/1.1
Host: examplebucket-1250000000.cos.ap-beijing.myqcloud.com
Date: Fri, 10 Mar 2016 09:45:46 GMT
Authorization: q-sign-algorithm=sha1&q-ak=**********************************-sign-time=1484213027;32557109027&q-key-time=1484213027;32557109027&q-header-list=host&q-url-param-list=acl&q-signature=**************************************
Content-Length: 0

Request 2. Adding Parameters through URL Address

https://examplebucket-1250000000.cos.ap-beijing.myqcloud.com/for-test.mp4?ci-process=snapshot&time=1.5&q-sign-algorithm=sha1&q-ak=**********************************&q-sign-time=1650425932;1650433132&q-key-time=1650425932;1650433132&q-header-list=&q-url-param-list=&q-signature=**************************************

Response

HTTP/1.1 200 OK
Content-Type: image/jpeg
Content-Length: 266005
Connection: keep-alive
Date: Fri, 10 Mar 2016 09:45:46 GMT
Server: tencent-ci
x-cos-request-id: NTg3NzRiMjVfYmRjMzVfMTViMl82ZGZmNw==


Image Content

Anterior: Updating a TemplatePróximo: Submitting Tasks

Ajuda e Suporte

Esta página foi útil?

comentários