提交截图任务。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试授权信息
当前API暂无授权信息透出。
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| Name | string | 否 | 任务名称。 | SampleJob |
| Input | object | 是 | 截图输入。 | |
| Type | string | 是 | 输入类型，取值：
| Media |
| Media | string | 是 | 输入媒体。当Type为OSS时填入OSS地址，Type为Media时填入媒资ID。 OSS地址规则为：
其中bucket为和当前项目处于同一区域的oss bucket名称，object为文件路径。 说明URL中的 OSS bucket 需要先添加到IMS存储管理后再使用。 | oss://bucket/object.mp4 |
| Output | object | 是 | 截图输出。 | |
| Type | string | 是 | 输出类型，取值：
| OSS |
| Media | string | 是 | 输出媒体。当Type为OSS时填入OSS地址，Type为Media时填入媒资ID。 OSS地址规则为：
其中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 | long | 否 | 截图数量。 | 5 |
| Interval | long | 否 | 截图间隔时间。 | 10 |
| Time | long | 否 | 截图开始时间。 | 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"} |
返回参数
示例
正常返回示例
JSON格式
{
"RequestId": "******11-DB8D-4A9A-875B-275798******",
"JobId": "****20b48fb04483915d4f2cd8ac****"
}错误码
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 | ||
|---|---|---|---|---|
| 2022-08-10 | API 内部配置变更，不影响调用 | |||
| ||||
| 2022-07-11 | 新增 OpenAPI |