调用SubmitSnapshotJob提交视频截图作业,开始异步截图处理。

使用说明

  • 暂时只支持生成JPG格式的图片。
  • 截图完成会产生EventType=SnapshotComplete,SubType=SpecifiedTime的视频截图完成的事件通知。

QPS限制

本接口的单用户QPS限制为30次/秒。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。更多信息,请参见QPS限制

调试

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

请求参数

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

系统规定参数。取值:SubmitSnapshotJob

VideoId String d3e680e618708efbf2cae7cc9312****

视频ID。可通过以下方式获取:

  • 通过控制台上传的视频,可登录点播控制台,选择媒资库 > 音/视频查看视频ID。
  • 通过获取视频上传地址和凭证接口获取上传地址和凭证时,视频ID为返回参数VideoId的值。
  • 视频上传后,可通过搜索媒体信息接口查询视频ID,为请求后返回参数VideoId的值。
SpecifiedOffsetTime Long 0

截图指定时间的起始点。

  • 单位:毫秒。
  • 默认值:0
Width String 1280

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

Height String 720

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

Count Long 1

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

Interval Long 1

截图的间隔时间,必须大于或等于0

  • 单位:秒。
  • 默认值:1
  • Interval为0时,表示按照Count数根据视频时长平均截图。
SpriteSnapshotConfig String {'CellWidth': 120, 'CellHeight': 68, 'Columns': 3,'Lines': 10, 'Padding': 20, 'Margin': 50}

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

SnapshotTemplateId String f5b228fe693bf55bd87b789****

截图模板ID。

  • 推荐先创建截图模板,再传递截图模板ID。截图模板创建详情,请参见添加截图模板
  • 如果传递截图模板ID,会忽略除Action、VideoId之外的请求参数。
UserData String {"MessageCallback":{"CallbackURL":"http://.example.aliyundoc.com"},"Extend":{"localId":"xxx","example":"www"}}

自定义设置。仅支持JSON字符串,支持用户自定义数据透传及指定回调地址设置等。参数结构详情,请参见UserData

说明 此参数中消息回调的使用前提是需要在控制台配置HTTP回调地址和勾选对应的回调事件类型才能使用,否则回调设置不生效。
说明 Count和Interval至少指定一个,若同时指定,截图数目以少者为准。

返回数据

名称 类型 示例值 描述
RequestId String 25818875-5F78-5EB0-4AF6-D7393642****

请求ID。

SnapshotJob Object

截图作业信息。

JobId String ad90a501b1b94b72374ad0050464****

截图作业ID。

示例

请求示例

http(s)://vod.cn-shanghai.aliyuncs.com/?Action=SubmitSnapshotJob
&VideoId=d3e680e618708efbf2cae7cc9312****
&SpecifiedOffsetTime=0
&Width=1280
&Height=720
&Count=1
&Interval=1
&SpriteSnapshotConfig={'CellWidth': 120, 'CellHeight': 68, 'Columns': 3,'Lines': 10, 'Padding': 20, 'Margin': 50}
&UserData={"MessageCallback":{"CallbackURL":"http://.example.aliyundoc.com"},"Extend":{"localId":"xxx","example":"www"}}
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<SubmitSnapshotJobResponse>
    <RequestId>25818875-5F78-5EB0-4AF6-D7393642****</RequestId>
    <SnapshotJob>
        <JobId>ad90a501b1b94b72374ad0050464****</JobId>
    </SnapshotJob>
</SubmitSnapshotJobResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "25818875-5F78-5EB0-4AF6-D7393642****",
  "SnapshotJob" : {
    "JobId" : "ad90a501b1b94b72374ad0050464****"
  }
}

错误码

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

接口错误码

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

错误代码

错误信息

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各语言调用的示例代码,请参见: