产品文档

媒体处理服务

createThumbnailTask

描述

创建截图任务,创建成功时返回任务ID。本接口用于截取指定时间点的画面。

请求方式

POST

请求地址

https://mps.jdcloud-api.com/v1/regions/{regionId}/thumbnail

名称 类型 是否必需 默认值 描述
regionId String True region id

请求参数

名称 类型 是否必需 默认值 描述
taskID String False 任务ID (readonly)
status String False 状态 (SUCCESS, ERROR, PENDDING, RUNNING) (readonly)
errorCode Integer False 错误码 (readonly)
createdTime String False 任务创建时间 时间格式(GMT): yyyy-MM-dd’T’HH:mm:ss.SSS’Z’ (readonly)
lastUpdatedTime String False 任务创建时间 时间格式(GMT): yyyy-MM-dd’T’HH:mm:ss.SSS’Z’ (readonly)
source ThumbnailTaskSource True
target ThumbnailTaskTarget True
rule ThumbnailTaskRule False

ThumbnailTaskRule

名称 类型 是否必需 默认值 描述
mode String False single 截图模式 单张: single 多张: multi 平均: average default: single
keyFrame Boolean False True 是否开启关键帧截图 default: true
startTimeInSecond Integer False 生成截图的开始时间, mode=average 时不可选. default:0
endTimeInSecond Integer False -1 生成截图的结束时间, mode=single/average时不可选, 且不得小于startTimeInSecond. default:-1(代表视频时长)
count Integer False 1 截图数量, mode=single时不可选. default:1

ThumbnailTaskTarget

名称 类型 是否必需 默认值 描述
destBucket String True 输入存放目标文件的 bucket
destKeyPrefix String False sourceKey 目标截图的Key的前缀, '前缀-taskID-%04d(num).(format)', 默认: sourceKey
format String False jpg 目标截图的格式 default: jpg
widthInPixel Integer False 目标截图的宽, 如果视频实际分辨率低于目标分辨率则按照实际分辨率输出 default: 0 代表源视频高 其他[8, 4096]
heightInPixel Integer False 目标截图的高, 如果视频实际分辨率低于目标分辨率则按照实际分辨率输出 default: 0 代表源视频高 其他[8, 4096]
keys String[ ] False 目标截图的Key的集合 (readonly)

ThumbnailTaskSource

名称 类型 是否必需 默认值 描述
bucket String True 输入视频信息的 bucket
key String True 输入视频信息的 Key

返回参数

名称 类型 描述
result Result
requestId String

Result

名称 类型 描述
thumbnailTaskID ThumbnailTaskID

ThumbnailTaskID

名称 类型 描述
taskID String

返回码

返回码 描述
200 成功
更新时间:2020-05-09 10:43:01