SubmitSnapshotJob - 提交截图任务

提交截图任务。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
Namestring

任务名称。

SampleJob
Inputobject

截图输入。

Typestring

输入类型,取值:

  1. OSS:oss文件地址
  2. Media:媒资ID
Media
Mediastring

输入媒体。当Type为OSS时填入OSS地址,Type为Media时填入媒资ID。 OSS地址规则为: 1.OSS://bucket/object 2. http(s)://bucket.oss-[RegionId].aliyuncs.com/object 其中bucket为和当前项目处于同一区域的oss bucket名称,object为文件路径。

oss://bucket/object.mp4
Outputobject

截图输出。

Typestring

输出类型,取值:

  1. OSS:oss文件地址
  2. Media:媒资ID
OSS
Mediastring

输出媒体。当Type为OSS时填入OSS地址,Type为Media时填入媒资ID。 OSS地址规则为:

  1. oss://bucket/object
  2. http(s)://bucket.oss-[RegionId].aliyuncs.com/object

其中bucket为和当前项目处于同一区域的oss bucket名称,object为文件路径。 截取多张静态截图时,object必须要带有”{Count}“占位符;截取雪碧图时,object必须要带有“{TileCount}”占位符。WebVTT截图object的后缀必须是“.vtt”。

oss://test-bucket/output-{Count}.jpg
TemplateConfigobject

截图模板配置。

TemplateIdstring

模板ID。

****96e8864746a0b6f3****
OverwriteParamsobject

覆盖参数。

Typestring

截图类型。

Sprite
FrameTypestring

帧类型。

intra
CountLong

截图数量。

5
IntervalLong

截图间隔时间。

10
TimeLong

截图开始时间。

1000
Widthinteger

输出图片宽度。

720
Heightinteger

输出图片高度。

480
BlackLevelinteger

多帧截图针对首帧过滤黑屏图片判定阈值。

30
PixelBlackThresholdinteger

判断像素点是否为黑色点的阈值。

70
SpriteSnapshotConfigobject

雪碧图配置。

CellWidthinteger

单图片宽度。默认截图输出分辨率宽度。

720
CellHeightinteger

单图片高度。默认截图输出分辨率高度。

480
Paddinginteger

图片间距,默认0,单位px

20
Margininteger

外框宽度,默认0,单位px

20
Columnsinteger

图片拼合列数。

20
Linesinteger

图片拼合行数。

20
Colorstring

背景颜色。

#000000
IsSptFragboolean

Webvtt截图配置:是否拼合输出

true
ScheduleConfigobject

调度配置

PipelineIdstring

管道ID。

****96e8864746a0b6f3****
UserDatastring

用户自定义数据。

{"test parameter": "test value"}

返回参数

名称类型描述示例值
object

PlainResponse

RequestIdstring

请求ID

******11-DB8D-4A9A-875B-275798******
JobIdstring

任务ID

****20b48fb04483915d4f2cd8ac****

示例

正常返回示例

JSON格式

{
  "RequestId": "******11-DB8D-4A9A-875B-275798******",
  "JobId": "****20b48fb04483915d4f2cd8ac****"
}

错误码

访问错误中心查看更多错误码。

阿里云首页 智能媒体生产 相关技术圈