功能描述
GetSnapshot 接口用于获取媒体文件某个时间的截图。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
使用说明
此接口为同步模式，异步模式请参考 任务接口-截图任务。
请求示例
1. 通过GET请求方式
GET /for-test.mp4?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. 通过URL地址添加参数方式
https://<BucketName-APPID>.cos.<Region>.myqcloud.com/for-test.mp4?ci-process=snapshot&time=1&format=jpg&<Auth String>说明：
请求头
此接口仅使用公共请求头部，详情请参见 公共请求头部 文档。
请求参数
参数说明如下：
| 参数名称 | 描述 | 类型 | 是否必选 |
|---|---|---|---|
| ci-process | 操作类型，固定使用 snapshot | String | 是 |
| time | 截图的时间点，单位为秒 | float | 是 |
| width | 截图的宽。默认为0 | Int | 否 |
| height | 截图的高。默认为0 当 width 和 height 都为0时，表示使用视频的宽高。如果单个为0，则以另外一个值按视频宽高比例自动适应 |
Int | 否 |
| format | 截图的格式，支持 jpg 和 png，默认 jpg | String | 否 |
| rotate | 图片旋转方式 |
String | 否 |
| mode | 截帧方式 |
String | 否 |
请求体
该请求无请求体。
响应
响应头
该响应包含公共响应头，详情请参见 公共响应头部 文档。
响应体
该响应体为截图文件内容。
错误码
该请求操作无特殊错误信息，常见的错误信息请参见 错误码 文档。
实际案例
请求1 通过GET请求方式
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=AKIDWtTCBYjM5OwLB9CAwA1Qb2ThTSUjfG****-sign-time=1484213027;32557109027&q-key-time=1484213027;32557109027&q-header-list=host&q-url-param-list=acl&q-signature=dcc1eb2022b79cb2a780bf062d3a40e120b40652
Content-Length: 0请求2 通过URL地址添加参数方式
https://examplebucket-1250000000.cos.ap-beijing.myqcloud.com/for-test.mp4?ci-process=snapshot&time=1.5&q-sign-algorithm=sha1&q-ak=AKID********************************&q-sign-time=1650425932;1650433132&q-key-time=1650425932;1650433132&q-header-list=&q-url-param-list=&q-signature=********404b08ea7f7b8f803961bedd5
响应
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-cos
x-cos-request-id: NTg3NzRiMjVfYmRjMzVfMTViMl82ZGZmNw==
<图片内容>