调用SubmitSnapshotJob提交视频截图作业,开始异步截图处理。支持普通截图和雪碧图截图。

说明
  • 暂时只支持生成 jpg 格式的图片。
  • 截图完成会产生EventType=SnapshotComplete,SubType=SpecifiedTime的 截图回调 消息。

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String SubmitSnapshotJob

系统规定参数。取值:SubmitSnapshotJob

VideoId String d3e680e618708*****efbf2cae7cc931

视频ID。

SpecifiedOffsetTime Long 0

截图指定时间的起始点,单位:毫秒。默认值:0

Width String 1280

截图宽,取值范围:[8,4096],默认原片宽,单位:px。

Height String 720

截图高,取值范围:[8,4096],默认原片高,单位:px。

Count Long 1

截图的最大数量。默认值:1

Interval Long 1

截图的间隔时间,必须大于等于0,单位:秒。其中,Interval为0表示按照Count数根据视频时长平均截图。默认值:1

SpriteSnapshotConfig String {'CellWidth': 120, 'CellHeight': 68, 'Columns': 3,'Lines': 10, 'Padding': 20, 'Margin': 50}

生成雪碧图的配置信息,如果不为空则生成雪碧图。参数结构详情参考 SpriteSnapshotConfig

SnapshotTemplateId String f5b228fe693*****bf55bd87789

截图模板ID,推荐先构建截图模板,再传递截图模板ID。

UserData String {"MessageCallback":{"CallbackURL":"http://test.test.com"},"Extend":{"localId":"xxx","test":"www"}}

仅支持JSON字符串,支持用户自定义数据透传及指定回调地址设置等。

说明
  • Count 和 Interval 至少指定一个,若同时指定,截图数目以少者为准。
  • 如果传递截图模板ID,会忽略除Action、VideoId之外的请求参数。
  • 截图模板创建详细请参考添加截图模板

返回数据

名称 类型 示例值 描述
RequestId String 25818875-5F78-4A*****F6-D7393642CA58

请求ID。

SnapshotJob Struct

截图作业信息。

JobId String ad90a501b1b94b*****72374ad005046

截图作业ID。

说明 下述请求示例中的“公共请求参数”详情,参见公共参数说明文档

示例

请求示例

http(s)://[Endpoint]/?Action=SubmitSnapshotJob
&VideoId=d3e680e618708*****efbf2cae7cc931
&<公共请求参数>

正常返回示例

XML 格式

<SubmitSnapshotJobResponse>
	  <RequestId>25818875-5F78-4A*****F6-D7393642CA58</RequestId>
	  <SnapshotJob>
		    <JobId>ad90a501b1b94b*****72374ad005046</JobId>
	  </SnapshotJob>
</SubmitSnapshotJobResponse>

JSON 格式

{
    "RequestId": "25818875-5F78-4A*****F6-D7393642CA58",
    "SnapshotJob": {
        "JobId": "ad90a501b1b94b*****72374ad005046"
    }
}

错误码

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

接口错误码

下表列举了本接口特有的错误码。

错误代码

错误信息

HTTP 状态码

说明

InvalidVideo.NotFound

The video does not exist.

404

视频不存在。

NoSuchResource

The specified resource %s does not exist.

404

指定资源不存在。

Forbidden.IllegalStatus

Status of the video is illegal.

400

视频状态无效。只有状态为 上传完成正常审核中 以及 屏蔽 的视频才能发起截图。

SDK示例

建议使用 服务端SDK 来调用API,此API各语言调用的示例代码,请参考如下: