文档首页 > > API参考> 抽帧截图接口> 新建截图任务

新建截图任务

分享
更新时间: 2020/07/09 GMT+08:00

功能介绍

新建截图任务,视频截图将从首帧开始,按设置的时间间隔截图,最后截取末帧。 待截图的视频文件需要存储在与媒体处理服务同区域的OBS桶中,且该OBS桶已授权。

约束: 暂只支持生成JPG格式的图片文件。

调试

您可以在API Explorer中调试该接口。

URI

POST /v1/{project_id}/thumbnails

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID,获取方法请参考获取项目ID

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。

通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

表3 请求Body参数

参数

是否必选

参数类型

描述

input

ObsObjInfo object

源文件地址。

output

ObsObjInfo object

输出地址。

thumbnail_para

ThumbnailPara object

截图参数

tar

Integer

是否压缩抽帧图片生成tar包。

取值如下:

  • 0:压缩。

  • 1:不压缩

sync

Integer

是否同步处理,同步处理是指不下载全部文件,快速定位到截图位置进行截图。

取值如下:

  • 0:排队处理。

  • 1:同步处理,暂只支持按时间点截单张图。

original_dir

Integer

是否使用原始输出目录。

取值如下:

  • 0:不使用原始输出目录,下发的输出目录后面追加随机目录,防止截图文件outputUri相同被覆盖。

  • 1:使用原始输出目录。

表4 ObsObjInfo

参数

是否必选

参数类型

描述

bucket

String

OBS的bucket名称。

location

String

输入OBS Bucket所在数据中心(OBS Location)。

object

String

OBS对象路径,遵守OSS Object定义。

  • 当用于指示input时,需要指定到具体对象。

  • 当用于指示output时, 只需指定到转码结果期望存放的路径。

file_name

String

文件名,仅用于输出。

  • 当指定了此参数时,输出的对象名为object/file_name 。

  • 当不指定此参数时,输出的对象名为object/xxx,其中xxx由MPC指定。

表5 ThumbnailPara

参数

是否必选

参数类型

描述

type

String

采样类型。支持三种采样方式,目前只支持time,dots两种方式。

percent

Integer

根据视频时长百分比间隔采样时的百分比值。

time

Integer

根据时间间隔采样时的时间间隔值。

start_time

Integer

TIME模式的开始时间,和time配合使用。

单位:秒。

duration

Integer

TIME模式的持续时间,和time、start_time配合使用。

单位:秒。

dots

Array of integers

指定时间截图时的时间点数组。

output_filename

String

截图输出文件名。

  • 如果只抽一张图(即:按DOTS方式,指定1个时间点)则按该指定文件名输出图片。

  • 如果抽多张图(即:按DOTS方式指定多个时间点或按TIME间隔截图)则输出图片名在该指定文件名基础上在增加时间点(示例:output_filename_10.jpg)。

  • 如果指定了压缩抽帧图片生成tar包,则tar包按该指定文件名输出。

format

Integer

截图文件格式。

取值如下:

1:表示jpg格式

aspect_ratio

Integer

纵横比。

width

Integer

图片宽度

取值范围:(96,3840]

单位:px

height

Integer

图片高度

取值范围:(96,2160]

单位:px

max_length

Integer

截图最长边的尺寸。宽边尺寸按照该尺寸与原始视频像素等比缩放计算。

取值范围:[240,3840]

单位:px

响应参数

状态码为 202 时:

表6 响应Body参数

参数

参数类型

描述

task_id

String

任务ID。

status

String

任务状态

create_time

String

任务创建时间

output

ObsObjInfo object

输出文件信息

output_file_name

String

截图文件名称

thumbnail_time

String

指定的截图时间点

description

String

截图任务描述,当截图出现异常时,此字段为异常的原因

表7 ObsObjInfo

参数

参数类型

描述

bucket

String

OBS的bucket名称。

location

String

输入OBS Bucket所在数据中心(OBS Location)。

object

String

OBS对象路径,遵守OSS Object定义。

  • 当用于指示input时,需要指定到具体对象。

  • 当用于指示output时, 只需指定到转码结果期望存放的路径。

file_name

String

文件名,仅用于输出。

  • 当指定了此参数时,输出的对象名为object/file_name 。

  • 当不指定此参数时,输出的对象名为object/xxx,其中xxx由MPC指定。

状态码为 400 时:

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

请求示例

```
POST https://mts.cn-north-1.myhuaweicloud.com/v1/{project_id}/thumbnails
 {
    "input": {
               "bucket": "example-bucket",
               "location": "cn-north-1",
               "object": "/VOD/input/sample.MP4"
    },
    "output": {
               "bucket": "example-bucket",
               "location": "cn-north-1",
               "object": "/VOD/output/"
    },

    "tar" : 1,
        "thumbnail_para": {
            "time":2,
            "format":1,
            "aspect_ratio":1,
            "max_length":480
        }
    }

  }
```

响应示例

状态码为 202 时:

{
  "task_id" : "string",
  "status" : "string",
  "create_time" : "string",
  "output" : {
    "bucket" : "string",
    "location" : "string",
    "object" : "string",
    "file_name" : "string"
  },
  "output_file_name" : "string",
  "thumbnail_time" : "string",
  "description" : "string"
}

状态码为 400 时:

{
  "error_code" : "string",
  "error_msg" : "string"
}

状态码

状态码

描述

202

新建截图任务成功。

400

新建截图任务失败。

错误码

请参见错误码

分享:

    相关文档

    相关产品

文档是否有解决您的问题?

提交成功!

非常感谢您的反馈,我们会继续努力做到更好!

反馈提交失败,请稍后再试!

*必选

请至少选择或填写一项反馈信息

字符长度不能超过200

提交反馈 取消

如您有其它疑问,您也可以通过华为云社区问答频道来与我们联系探讨

智能客服提问云社区提问