tencent cloud


Media Screenshot APIs

Last updated: 2022-05-24 16:41:42


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

    API Operation Description
    GetSnapshot Querying screenshot Query the screenshot of media file at some time point

    SDK API References

    For the parameters and method description of all the APIs in the SDK, see the API documentation.

    Querying Screenshot

    Feature description

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


    • The GetSnapshot API is supported since v5.4.24. To download the new version of SDK, go to Releases or see Getting Started.
    • For the SDK version changelog, see Changelog.

    Sample code

    using COSXML.Model.CI;
    using COSXML.Auth;
    using System;
    using COSXML;
    namespace COSSnippet
      public class GetSnapshotModel {
         private CosXml cosXml;
         GetSnapshotModel() {
          CosXmlConfig config = new CosXmlConfig.Builder()
            .SetRegion("COS_REGION") // Set the default region. For abbreviations of COS regions, visit https://www.tencentcloud.com/document/product/436/6224.
          string secretId = "SECRET_ID";   // TencentCloud API `SecretId`. For more information on how to get it, visit https://console.tencentcloud.com/cam/capi.
          string secretKey = "SECRET_KEY"; // TencentCloud API `SecretKey`. For more information on how to get it, visit https://console.tencentcloud.com/cam/capi.
          long durationSecond = 600;          // Validity period of the request signature in seconds
          QCloudCredentialProvider qCloudCredentialProvider = new DefaultQCloudCredentialProvider(secretId, 
            secretKey, durationSecond);
          this.cosXml = new CosXmlServer(config, qCloudCredentialProvider);
         /// Capture video frames
        public void GetSnapshot()
          // Bucket name in the format of `BucketName-APPID`. You can get the `APPID` by referring to https://console.tencentcloud.com/developer.
          string bucket = "examplebucket-1250000000";
          string key = "video.mp4"; // Object key of the media file, which should be replaced with the actual object key of the media file existing in the bucket
          float time = 1.5F; // Screenshot time point expressed as a floating point number
          string destPath = @"temp-source-file"; // The path to save the screenshot file, which needs to be replaced with a local specific path, such as "/usr/local/"
          GetSnapshotRequest request = new GetSnapshotRequest(bucket, key, time, destPath);
          // Execute the request
          GetSnapshotResult result = cosXml.GetSnapshot(request);
         static void Main(string[] args)
          GetSnapshotModel m = new GetSnapshotModel();
          /// Capture video frames

    For more complete samples, visit GitHub.

    Contact Us

    Contact our sales team or business advisors to help your business.

    Technical Support

    Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

    7x24 Phone Support