控制台指南

最佳实践

开发者指南

API 文档

SDK 文档

有奖征文|投稿上云技术实践,赢取价值5000元大奖> HOT

简介

本文档提供关于媒体截图接口的 API 概览和 SDK 示例代码。

注意:

COS 小程序 SDK 版本需要大于等于 v1.1.1。

API 操作名 操作描述
GetSnapshot 查询截图 用于查询媒体文件在某个时间的截图

查询截图

功能说明

用于查询媒体文件在某个时间的截图。

注意:

使用此接口前,请确保已打开官网控制台中数据处理下的媒体处理开关,否则会报错media bucket unbinded, bucket's host is unavailable

使用示例

var config = {
  // 需要替换成您自己的存储桶信息
  Bucket: 'examplebucket-1250000000', /* 存储桶,必须 */
  Region: 'COS_REGION', /* 存储桶所在地域,必须字段 */
};
cos.request({
    Bucket: config.Bucket,
    Region: config.Region,
    Method: 'GET',
    Key: 'test.mp4',  /* 存储桶内的媒体文件,必须字段 */
    Query: {
        'ci-process': 'snapshot', /** 固定值,必须 */
        time: 1, /** 截图的时间点,单位为秒,必须 */
        // width: 0, /** 截图的宽,非必须 */
        // height: 0, /** 截图的高,非必须 */
        // format: 'jpg', /** 截图的格式,支持 jpg 和 png,默认 jpg,非必须 */
        // rotate: 'auto', /** 图片旋转方式,默认为'auto',非必须 */
        // mode: 'exactframe', /** 截帧方式,默认为'exactframe',非必须 */
    },
    RawBody: true,
},
function(err, data){
    console.log(err || data);
});

参数说明

参数名称 参数描述 类型 是否必填
Bucket 存储桶的名称,命名格式为 BucketName-APPID,此处填写的存储桶名称必须为此格式 String
Region 存储桶所在地域,枚举值请参见 地域和访问域名 String
Key 对象键(Object 的名称),对象在存储桶中的唯一标识,详情请参见 对象概述 String
ci-process 操作类型,固定使用 snapshot String
time 截图的时间点,单位为秒 Number
width 截图的宽。默认为0 Number
height 截图的高。默认为0。当 width 和 height 都为0时,表示使用视频的宽高;如果单个为0,则以另外一个值按视频宽高比例自动适应 Number
format 截图的格式,支持 jpg 和 png,默认 jpg String
rotate 图片旋转方式 auto:按视频旋转信息进行自动旋转 off:不旋转,默认值为 auto String
mode 截帧方式 keyframe:截取指定时间点之前的最近的一个关键帧 exactframe:截取指定时间点的帧,默认值为 exactframe String

回调函数说明

function(err, data) { ... }

参数名 参数描述 类型
err 请求发生错误时返回的对象,包括网络错误和业务错误。如果请求成功则为空,更多详情请参见 错误码 Object
- statusCode 请求返回的 HTTP 状态码,例如200、403、404等 Number
- headers 请求返回的头部信息 Object
data 请求成功时返回的对象,如果请求发生错误,则为空 Object
- statusCode 请求返回的 HTTP 状态码,例如200、403、404等 Number
- headers 请求返回的头部信息 Object
- RequestId 请求的唯一 ID String
- Body 返回的文件内容,默认为 String 形式 String
目录