使用SubmitSnapshotJob提交截图任务-智能媒体服务-阿里云-智能媒体服务(IMS)-阿里云帮助中心

本接口用于提交截图任务。通过该接口，用户可以指定媒体文件的ID或URL，以及截图的时间点和格式，系统将根据这些参数生成截图并保存到指定的位置。

接口说明

该接口为异步接口，提交任务后返回任务 ID（此时任务尚未完成，任务将进入后台排队异步执行），最终结果将通过回调通知，也可通过查询截图任务详细信息主动查询任务状态。

调试

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

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

ice:SubmitSnapshotJob

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
Name	string	否	任务名称。	SampleJob
Input	object	是	截图输入。
Type	string	是	输入类型，取值： OSS：OSS 文件地址。 Media：媒资 ID。	Media
Media	string	是	输入媒体。当 Type 为 OSS 时填入 OSS 地址。 Type 为 Media 时填入媒资 ID。 OSS 地址规则为： oss://bucket/object http(s)://bucket.oss-[RegionId].aliyuncs.com/object 其中 bucket 为和当前项目处于同一区域的 oss bucket 名称，object 为文件路径。说明 URL 中的 OSS bucket 需要先添加到 IMS存储管理后再使用。	oss://bucket/object.mp4
Output	object	是	截图输出。
Type	string	是	输入类型，取值： OSS：OSS 文件地址。 Media：媒资 ID。	OSS
Media	string	是	输出媒体。当 Type 为 OSS 时填入 OSS 地址。 Type 为 Media 时填入媒资 ID。 OSS 地址规则为： oss://bucket/object http(s)://bucket.oss-[RegionId].aliyuncs.com/object 其中 bucket 为和当前项目处于同一区域的 oss bucket 名称，object 为文件路径。截取多张静态截图时，object 必须要带有”{Count}“占位符；截取雪碧图时，object 必须要带有“{TileCount}”占位符。 WebVTT 截图 object 的后缀必须是“.vtt”。说明 URL 中的 OSS bucket 需要先添加到 IMS存储管理后再使用。	oss://test-bucket/output-{Count}.jpg
TemplateConfig	object	是	截图模板配置。
TemplateId	string	是	模板 ID。	**96e8864746a0b6f3**
OverwriteParams	object	否	覆盖参数。
Type	string	否	截图类型。	Sprite
FrameType	string	否	帧类型。	intra
Count	integer	否	截图数量。	5
Interval	integer	否	截图间隔时间。	10
Time	integer	否	截图开始时间。	1000
Width	integer	否	输出图片宽度。	720
Height	integer	否	输出图片高度。	480
BlackLevel	integer	否	多帧截图针对首帧过滤黑屏图片判定阈值。	30
PixelBlackThreshold	integer	否	判断像素点是否为黑色点的阈值。	70
SpriteSnapshotConfig	object	否	雪碧图配置。
CellWidth	integer	否	单图片宽度。默认截图输出分辨率宽度。	720
CellHeight	integer	否	单图片高度。默认截图输出分辨率高度。	480
Padding	integer	否	图片间距，默认 0，单位 px	20
Margin	integer	否	外框宽度，默认 0，单位 px	20
Columns	integer	否	图片拼合列数。	20
Lines	integer	否	图片拼合行数。	20
Color	string	否	背景颜色。	#000000
IsSptFrag	boolean	否	Webvtt 截图配置：是否拼合输出	true
ScheduleConfig	object	否	调度配置
PipelineId	string	否	管道 ID。	**96e8864746a0b6f3**
UserData	string	否	用户自定义数据。	{"test parameter": "test value"}

返回参数

名称	类型	描述	示例值
	object	PlainResponse
RequestId	string	请求 ID	****11-DB8D-4A9A-875B-275798****
JobId	string	任务 ID	**20b48fb04483915d4f2cd8ac**

示例

正常返回示例

JSON格式

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

错误码

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

变更历史

更多信息，参考变更详情。