创建预览图任务

更新时间: 2025/01/22 15:03:40

调用本接口可为指定视频生成进度条预览快照图(雪碧图,Sprite Images),方便用户在播放视频的同时拖动进度条预览其他时间区间的视频截图。

请求信息

请求频率

请参考 接口概述 频率说明章节。

请求 URL

POST  http://vcloud.163.com/app/vod/previewSnapshot/submitJob

请求头参数

请参考 接口概述 公共参数章节。

请求体参数

参数 类型 是否必需 默认值 说明
vid Long - 视频点播的视频 ID。
- previewSnapshotPreset Object - 预览图快照设置。
type Integer 1 预览大图格式:
  • 1:.jpg 格式
  • 2:.png 格式
cellWidth Integer 120 预览小图宽,取值范围为 [-1, 4096],单位为 px。
  • -1:保持高宽比 px
  • 0:原视频宽
cellHeight Integer -1 预览小图高,取值范围为 [-1, 4096],单位为 px。
  • -1:保持高宽比 px
  • 0:原视频高
startTime Long 0 开始时间。
endTime Long 视频结束时间 结束时间。
interval Integer 1 截图间隔,单位为秒。
rows Integer 6 行数,取值范围为 [1, 10]。
columns Integer 10 列数,取值范围为 [1, 10]。
padding Integer 0 预览小图间距,单位为 px,取值范围为 [0, ∞)。
margin Integer 0 预览小图与大图间距,单位为 px,取值范围为 [0, ∞)。
onlyKeyFrame Integer 0 是否只截取关键帧:
  • 0:否
  • 1:是
callbackUrl String - 结果抄送地址。
userDefInfo String - 用户自定义内容。

请求体示例

JSON{
    "vid": 8461***,
    "previewSnapshotPreset": {
        "type": 1,
        "cellWidth": -1,
        "cellHeight": -1,
        "rows": 3,
        "columns": 3,
        "padding": 100,
        "interval": 1,
        "margin": 50,
    },
    "userDefInfo": "sprite test"
}

响应信息

响应体参数

参数 类型 说明
- ret Object 返回的具体业务数据。
taskId Long 任务 ID。
code Int 返回的 HTTP 状态码,请参考 状态码
requestId String 请求 ID。

响应体示例

JSON{
    "ret": {
        "taskId": 1781902
    },
    "code": 200,
    "requestId": "vodb7188651ae324e0cb605069f0fea8914"
}
此文档是否对你有帮助?
有帮助
去反馈
  • 请求信息
  • 请求频率
  • 请求 URL
  • 请求头参数
  • 请求体参数
  • 请求体示例
  • 响应信息
  • 响应体参数
  • 响应体示例