有奖捉虫:云通信与企业服务文档专题,速来> HOT

功能描述

GetSnapshot 接口用于获取媒体文件某个时间的截图。

授权说明

通过子账号使用时,需要授予 ci:GenerateSnapshot 权限,详情请参见 数据万象 action

服务开通

使用该功能需提前开通数据万象,并绑定存储桶。详情请参见 绑定存储桶

使用限制

使用该接口时,请先确认相关限制条件。详情请参见 使用限制

费用说明

该接口为付费服务,产生的费用将由数据万象收取,详细计费说明可参见 媒体处理费用


请求示例

1. 通过 GET 请求方式

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. 通过 URL 地址添加参数方式

https://<BucketName-APPID>.cos.<Region>.myqcloud.com/for-test.mp4?ci-process=snapshot&time=1&format=jpg&<Auth String>
说明
Authorization: Auth String,详情请参见 请求签名 文档。
ObjectKey 为存储桶对象。
此接口为同步模式,异步模式请参考 截图任务

请求头

此接口仅使用公共请求头部,详情请参见 公共请求头部 文档。

请求参数

参数说明如下:
参数名称
描述
类型
是否必选
ci-process
操作类型,固定使用 snapshot
String
time
截图的时间点,单位为秒
float
width
截图的宽。默认为0
Int
height
截图的高。默认为0
Int
format
截图的格式,支持 jpg 和 png,默认 jpg
String
rotate
图片旋转方式
auto:按视频旋转信息进行自动旋转
off:不旋转
默认值为 auto
String
mode
截帧方式
keyframe:截取指定时间点之前的最近的一个关键帧
exactframe:截取指定时间点的帧
默认值为 exactframe
String
说明:
当 width 和 height 都为0时,表示使用视频的宽高。如果单个为0,则以另外一个值按视频宽高比例自动适应。

请求体

该请求无请求体。

响应

响应头

该响应包含公共响应头,详情请参见 公共响应头部 文档。

响应体

该响应体为截图文件内容。

错误码

该请求操作无特殊错误信息,常见的错误信息请参见 错误码 文档。

实际案例

请求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-ci
x-cos-request-id: NTg3NzRiMjVfYmRjMzVfMTViMl82ZGZmNw==


<图片内容>