全部产品
云市场

提交媒体截图作业

更新时间:2019-05-16 11:09:18

描述

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

注意:

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

请求参数

名称类型是否必需描述
ActionString系统规定参数。取值: SubmitSnapshotJob
VideoIdString视频ID
CountLong截图的最大数量。默认值:1
IntervalLong截图的间隔时间,必须大于等于0,单位:秒。其中Interval为0表示按照Count数根据视频时长平均截图。默认值:1
SpecifiedOffsetTimeLong截图指定时间的起始点,单位:毫秒。默认值:0
WidthString截图宽,取值范围:[8,4096],默认原片宽,单位:px
HeightString截图高,取值范围:[8,4096],默认原片高,单位:px
SpriteSnapshotConfigString生成雪碧图的配置信息,如果不为空则生成雪碧图。
UserDataString自定义数据,将在截图完成时进行回调
  • 最大长度为1024
  • 建议采用JSON字符串
SnapshotTemplateIdString截图模板ID,推荐先构建截图模板,再传递截图模板ID。

说明:

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

返回参数

名称类型描述
RequestIdString请求ID
SnapshotJobSnapshotJob截图作业信息

API示例

请求示例

  1. https://vod.cn-shanghai.aliyuncs.com?Action=SubmitSnapshotJob&Video=d3e680e618708fef7cefbf2cae7cc931&TimeOffset=5&Count=1&Interval=0&Type=sprite&Width=640&Height=360&SpriteSnapshotConfig=%7b%22CellHeight%22%3a%2268%22%2c%22CellWidth%22%3a%22120%22%2c%22Columns%22%3a%2210%22%2c%22Lines%22%3a%2210%22%7d

返回示例

  1. {
  2. "RequestId": "25818875-5F78-4A13-BEF6-D7393642CA58",
  3. "SnapshotJob": {
  4. "JobId": "ad90a501b1b94ba6afb72374ad005046"
  5. }
  6. }

错误码

错误代码错误信息HTTP 状态码说明
InvalidVideo.NotFoundThe video does not exist.404视频不存在。
NoSuchResourceThe specified resource %s does not exist.404指定资源不存在。
Forbidden.IllegalStatusStatus of the video is illegal.400视频状态无效。只有状态为 上传完成正常审核中 以及 屏蔽 的视频才能发起截图。

SDK示例

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