控制台指南

最佳实践

开发者指南

API 文档

SDK 文档

诚邀爱技术、爱分享的你,成为文档内容共建者> HOT

简介

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

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

SDK API 参考

SDK 所有接口的具体参数与方法说明,请参考 SDK API

查询截图

功能说明

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

注意:

COS iOS SDK 版本需要大于等于 v5.9.6。

请求示例

Objective-C

QCloudGetGenerateSnapshotRequest * request = [[QCloudGetGenerateSnapshotRequest alloc]init];

// 对象键,是对象在 COS 上的完整路径,如果带目录的话,格式为 "dir1/object1"
request.object = @"exampleobject";
// 存储桶名称,格式为 BucketName-APPID
request.bucket = @"examplebucket-1250000000";
// 截图配置信息
request.generateSnapshotConfiguration = [QCloudGenerateSnapshotConfiguration new];
// 截取哪个时间点的内容,单位为秒 必传
request.generateSnapshotConfiguration.time = 10;
// 截图的宽。默认为0
request.generateSnapshotConfiguration.width = 100;
// 截图的宽。默认为0
request.generateSnapshotConfiguration.height = 100;

// 截帧方式:枚举值
//  GenerateSnapshotModeExactframe:截取指定时间点的帧
//  GenerateSnapshotModeKeyframe:截取指定时间点之前的最近的
//  默认值为 exactframe
request.generateSnapshotConfiguration.mode = QCloudGenerateSnapshotModeExactframe;

// 图片旋转方式:枚举值
// GenerateSnapshotRotateTypeAuto:按视频旋转信息进行自动旋转
// GenerateSnapshotRotateTypeOff:不旋转
// 默认值为 auto
request.generateSnapshotConfiguration.rotate = QCloudGenerateSnapshotRotateTypeAuto;

// 截图的格式:枚举值
// GenerateSnapshotFormatJPG:jpg
// GenerateSnapshotFormatPNG:png
// 默认 jpg
request.generateSnapshotConfiguration.format = QCloudGenerateSnapshotFormatJPG;

request.finishBlock = ^(QCloudGenerateSnapshotResult * outputObject, NSError *error) {
    // outputObject 截图信息,详细字段请查看api文档或者SDK源码
    // QCloudGenerateSnapshotResult  类;
};
[[QCloudCOSXMLService defaultCOSXML] GetGenerateSnapshot:request];

说明:

更多完整示例,请前往 GitHub 查看。

Swift

let request : QCloudGetGenerateSnapshotRequest = QCloudGetGenerateSnapshotRequest();
// 对象键,是对象在 COS 上的完整路径,如果带目录的话,格式为 "dir1/object1"
request.object = "test.mp4";
// 存储桶名称,以“,”分隔,支持多个存储桶,精确搜索
request.bucket = "CURRENT_BUCKET";
// 截图配置信息
request.generateSnapshotConfiguration = QCloudGenerateSnapshotConfiguration();
// 截取哪个时间点的内容,单位为秒 必传
request.generateSnapshotConfiguration.time = 10;
// 截图的宽。默认为0
request.generateSnapshotConfiguration.width = 100;
// 截图的宽。默认为0
request.generateSnapshotConfiguration.height = 100;

// 截帧方式:枚举值
//  GenerateSnapshotModeExactframe:截取指定时间点的帧
//  GenerateSnapshotModeKeyframe:截取指定时间点之前的最近的
//  默认值为 exactframe
request.generateSnapshotConfiguration.mode = QCloudGenerateSnapshotMode.exactframe;

// 图片旋转方式:枚举值
// GenerateSnapshotRotateTypeAuto:按视频旋转信息进行自动旋转
// GenerateSnapshotRotateTypeOff:不旋转
// 默认值为 auto
request.generateSnapshotConfiguration.rotate = QCloudGenerateSnapshotRotateType.auto;

// 截图的格式:枚举值
// GenerateSnapshotFormatJPG:jpg
// GenerateSnapshotFormatPNG:png
// 默认 jpg
request.generateSnapshotConfiguration.format = QCloudGenerateSnapshotFormat.JPG;

request.finishBlock = { (result, error) in
    // result 截图信息,详细字段请查看api文档或者SDK源码
    // QCloudGenerateSnapshotResult  类;
}
QCloudCOSXMLService.defaultCOSXML().getGenerateSnapshot(request);

说明:

更多完整示例,请前往 GitHub 查看。

目录