请登录后查看
- 自定义转码模板接口
- 新建转码模板CreateTransTemplate
- 删除转码模板DeleteTemplate
- 查询转码模板ListTemplate
- 更新转码模板UpdateTransTemplate
- 自定义转码模板组接口
- 新建转码模板组CreateTemplateGroup
- 删除转码模板组DeleteTemplateGroup
- 查询转码模板组ListTemplateGroup
- 更新转码模板组UpdateTemplateGroup
- 水印模板接口
- 新建水印模板CreateWatermarkTemplate
- 删除水印模板DeleteWatermarkTemplate
- 查询水印模板ListWatermarkTemplate
- 更新水印模板UpdateWatermarkTemplate
- 媒资转码接口
- 新建转码任务CreateTranscodingTask
- 取消转码任务DeleteTranscodingTask
- 删除转码任务记录DeleteTranscodingTaskByConsole
- 查询点播概览信息ListStatSummary
- 查询转码任务ListTranscodingTask
- 转封装接口
- 取消转封装任务CancelRemuxTask
- 新建转封装任务CreateRemuxTask
- 重试转封装任务CreateRetryRemuxTask
- 删除转封装任务记录DeleteRemuxTask
- 查询转封装任务ListRemuxTask
- 转动图接口
- 新建转动图任务CreateAnimatedGraphicsTask
- 取消转动图任务DeleteAnimatedGraphicsTask
- 查询转动图任务ListAnimatedGraphicsTask
- 视频解析接口
- 新建视频解析任务CreateExtractTask
- 取消视频解析任务DeleteExtractTask
- 查询视频解析任务ListExtractTask
- 抽帧截图接口
- 新建截图任务CreateThumbnailsTask
- 取消截图任务DeleteThumbnailsTask
- 查询截图任务ListThumbnailsTask
- 独立加密接口
- 新建独立加密任务CreateEncryptTask
- 取消独立加密任务DeleteEncryptTask
- 查询独立加密任务ListEncryptTask
- 授权与配置接口
- 请求委托任务CreateAgenciesTask
- 查询桶列表ListAllBuckets
- 查询桶里的objectListAllObsObjList
- 查询转码服务端所有事件ListNotifyEvent
- 查询转码服务端事件通知ListNotifySmnTopicConfig
- 配置转码服务端事件通知NotifySmnTopicConfig
- 查询创建委托任务状态ShowAgenciesTask
- 桶授权或取消授权UpdateBucketAuthorized
- 租户开通
- 租户查询服务开通状态信息ShowTenantAccessInfo
- 租户开通媒体转码服务UpdateTenantAccessInfo
CreateThumbnailsTask
新建截图任务
- 亚太-新加坡
- 华东-上海一
- 华东-上海二
- 华北-北京一
- 华北-北京四
- 华南-广州
- TIME
- DOTS
- DOTS_MS
本文档信息来源于官网帮助中心
功能介绍
新建截图任务，视频截图将从首帧开始，按设置的时间间隔截图，最后截取末帧。
待截图的视频文件需要存储在与媒体处理服务同区域的OBS桶中，且该OBS桶已授权。
约束：
暂只支持生成JPG格式的图片文件。
调用方法
请参见如何调用API。
URI
POST /v1/{project_id}/thumbnails
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
项目ID。获取方法请参考获取项目ID。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
否 |
String |
用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 |
|
Authorization |
否 |
String |
使用AK/SK方式认证时必选，携带的鉴权信息。 |
|
X-Project_Id |
否 |
String |
使用AK/SK方式认证时必选，携带项目ID信息, 与路径参数中的项目ID相同。 |
|
X-Sdk-Date |
否 |
String |
使用AK/SK方式认证时必选，请求的发生时间。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
input |
是 |
ObsObjInfo object |
源文件地址。 |
|
output |
是 |
ObsObjInfo object |
输出地址。 |
|
user_data |
否 |
String |
用户自定义数据。 |
|
thumbnail_para |
是 |
ThumbnailPara object |
截图参数 |
|
tar |
否 |
Integer |
是否压缩抽帧图片生成tar包。 取值如下：
|
|
sync |
否 |
Integer |
是否同步处理，同步处理是指不下载全部文件，快速定位到截图位置进行截图。 取值如下：
默认值：0 |
|
original_dir |
否 |
Integer |
是否使用原始输出目录。 取值如下：
|
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
bucket |
是 |
String |
OBS的bucket名称。 |
|
location |
是 |
String |
OBS桶所在的区域，且必须与使用的MPC区域保持一致。 |
|
object |
是 |
String |
OBS对象路径，遵守OSS Object定义。
在字幕场景下，字幕文件名称中禁止携带特殊符号，否则会导致转码任务失败，如：[
|
|
file_name |
否 |
String |
文件名，文件名长度不能超过180个字符。
在作为输出文件名时：
|
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
type |
否 |
String |
采样类型。 取值如下：
|
|
time |
否 |
Integer |
采样截图的时间间隔值。 默认值：12。 单位：秒 |
|
start_time |
否 |
Integer |
采样类型为“TIME”模式的开始时间，和“time”配合使用。 默认值：0。 单位：秒。
说明：
start_time超过片源时长,不进行抽帧 |
|
duration |
否 |
Integer |
采样类型为“TIME”模式的持续时间，和“time”、“start_time”配合使用，表示从视频文件的第“start_time”开始，持续时间为“duration”，每间隔“time”生成一张截图。 取值范围：[数字，ToEND]。“ToEND”表示持续到视频结束。 默认值： ToEND。 单位：秒。
说明：
“duration”必须大于等0，若设置为0，则截图持续时间从“start_time”到视频结束。 |
|
dots |
否 |
Array of integers |
指定时间截图的时间点数组 例如输入[1,3,5]，分别截取视频第1秒、第3秒、第5秒位置的图像帧
|
|
dots_ms |
否 |
Array of integers |
同步截图下，指定时间截图的时间点数组，单位毫秒 例如输入[1000]，截取视频第1000毫秒位置的图像帧，仅支持一个时间点 |
|
output_filename |
否 |
String |
截图输出文件名。
|
|
format |
否 |
Integer |
截图文件格式。 取值如下： 1：表示jpg格式 2：表示png格式 仅同步截图支持png格式 |
|
width |
否 |
Integer |
图片宽度 取值范围：
单位：px |
|
height |
否 |
Integer |
图片高度 取值范围：
单位：px |
|
max_length |
否 |
Integer |
截图最长边的尺寸。宽边尺寸按照该尺寸与原始视频像素等比缩放计算。 参考取值范围：[240,3840] 单位：像素
说明：
该参数和width/height选择使用，以width/height优先，若width/height都不等于0，则图片尺寸按width/height得出；反之，则图片尺寸按max_length 得出;若该参数和width/height都未选择，则按源片源宽高输出截图 |
响应参数
状态码：202
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
task_id |
String |
任务ID。 |
|
status |
String |
任务状态 |
|
create_time |
String |
任务创建时间 |
|
output |
ObsObjInfo object |
输出文件信息 |
|
output_file_name |
String |
截图文件名称 |
|
thumbnail_time |
String |
指定的截图时间点 |
|
description |
String |
截图任务描述，当截图出现异常时，此字段为异常的原因 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
bucket |
String |
OBS的bucket名称。 |
|
location |
String |
OBS桶所在的区域，且必须与使用的MPC区域保持一致。 |
|
object |
String |
OBS对象路径，遵守OSS Object定义。
在字幕场景下，字幕文件名称中禁止携带特殊符号，否则会导致转码任务失败，如：[
|
|
file_name |
String |
文件名，文件名长度不能超过180个字符。
在作为输出文件名时：
|
状态码：400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码。 |
|
error_msg |
String |
错误描述。 |
请求示例
-
新建异步截图任务，视频截图将从首帧开始，按设置的时间间隔截图，最后截取末帧。
POST https://{endpoint}/v1/{project_id}/thumbnails { "input" : { "bucket" : "example-bucket", "location" : "region01", "object" : "example-path/input.mp4" }, "output" : { "bucket" : "example-bucket", "location" : "region01", "object" : "example-path/output" }, "tar" : 1, "thumbnail_para" : { "time" : 2, "format" : 1, "max_length" : 480 }, "sync" : 0 } -
新建同步截图任务（将sync设置为1），视频截图将从首帧开始，按设置的时间间隔截图，最后截取末帧。
POST https://{endpoint}/v1/{project_id}/thumbnails { "input" : { "bucket" : "example-bucket", "location" : "region01", "object" : "example-path/input.mp4" }, "output" : { "bucket" : "example-bucket", "location" : "region01", "object" : "example-path/output" }, "tar" : 1, "thumbnail_para" : { "time" : 2, "format" : 1, "max_length" : 480 }, "sync" : 1 }
响应示例
状态码：202
新建截图任务成功。
-
新建异步截图任务成功。
{ "task_id" : "100211" } -
新建同步截图任务成功。
{ "task_id" : "100212", "status" : "FINISHED", "create_time" : "20231201020412", "output" : { "bucket" : "bucket-demo", "location" : "cn-north-4", "object" : "output/demo_object", "file_name" : "" }, "output_file_name" : "H_270.png", "thumbnail_time" : "30", "description" : "任务处理成功。" }
状态码：400
新建截图任务失败。
{
"error_code" : "MPC.10202",
"error_msg" : "Invalid request parameter"
}
状态码
|
状态码 |
描述 |
|---|---|
|
202 |
新建截图任务成功。 |
|
400 |
新建截图任务失败。 |
错误码
请参见错误码。