调用方式--视频技术-火山引擎

文档中心

立即注册

导航

调用方式

最近更新时间：2023.11.24 16:46:53首次发布时间：2022.07.21 16:22:01

说明

该服务为异步调用，分为任务提交和任务查询两步骤。

调用方式-任务提交

接口简介

视频尺寸转化的任务提交。

限制条件

名称	内容
视频要求	1.视频格式：不做硬性限制，建议使用MP4格式。 2.视频时长：不做硬性限制。分辨率过高或者时长过长的视频可能会处理超时或失败。 3.视频大小不超过380MB

请求说明

名称	内容
接口地址	https://visual.volcengineapi.com
请求方式	POST
Content-Type	`application/x-www-form-urlencoded`

请求参数

（1）header请求参数

公共请求参数

以下请求参数列表仅列出了接口请求参数和必要公共参数，完整公共参数列表见公共参数

名称	类型	是否必填	描述
X-Date	String	是	使用UTC时间，精确到秒。请使用格式：`YYYYMMDD'T'HHMMSS'Z'` ，例如：`20201103T104027Z`
Authorization	String	是	HMAC-SHA256：签名方法 -Credential为签名凭证，其中: -AccessKeyId为访问密钥ID，可在访问密钥（Access Key）获取； -ShortDate为请求的短时间，使用UTC时间，精确到日。请使用格式：`YYYYMMDD`，例如：`20180201`； -Region为请求地区，国内一般为为`cn-north-1`； -Service为请求的服务，一般为`cv`； -SignedHeaders为参与签名计算的头部信息，`content-type` 和 `host` 为必选头部； -Signature为签名，可在签名方法获取。注：我们提供了SDK及签名示例供您实现服务快速接入，具体可参考快速接入例如：`HMAC-SHA256 Credential={AccessKeyId}/{ShortDate}/{Region}/{Service}/request, SignedHeaders={SignedHeaders}, Signature={Signature}`
X-Security-Token	String	否	指安全令牌服务（Security Token Service，STS）颁发的临时安全凭证中的SessionToken，使用长期密钥时无需填写该参数。

（2）Query参数

业务请求参数

参数	可选/必选	类型	说明
Action	必选	String	接口名，取值：VideoRetargetingSubmitTask
Version	必选	String	版本号，取值：2020-08-26

（3）Body参数

业务请求参数

参数	可选/必选	类型	说明
`video_url`	必选	`String`	视频链接，受网络因素影响可能会导致任务失败
`strategy`	必选	`String`	视频裁剪策略，可选值：`FIXED_PADDING`，`STATIC_CROPPING`，注意大小写敏感
`aspect_ratio`	必选	`Float`	处理后的视频长宽比，数值为长:宽
`crop_size`	必选	`Float`	裁剪长宽比，数值为长:宽

注：服务会根据crop_size对原视频图像进行裁剪，之后padding到指定长宽比（即aspect_ratio）。

策略说明

策略名	说明
`FIXED_PADDING`	默认标准裁剪，每一帧的裁剪框会动态计算位置
`STATIC_CROPPING`	静态裁剪，全视频的裁剪位置只有一个，相比于前一策略，处理速度更快

输出说明

（1）通用输出参数
请参考通用返回字段及错误码
（2）业务输出参数
data字段

字段	类型	说明
`task_id`	`String`	任务编号，用于查询任务运行状态和结果

（3）输出示例

{
    "status": 10000,
    "code": 10000,
    "time_elapsed": "570.835792ms",
    "request_id": "69048264100455403521607655177",
    "message": "Success",
    "data": {
        "task_id": {任务id}
    }
}

错误码

（1）通用错误码
请参考通用返回字段及错误码

（2）业务错误码

http code	错误码	错误信息	说明
200	10000	Success	成功
400	50201	Missing Input Parameters: {param}	缺少输入参数param，param可能为video，strategy，aspect_ratio，crop_size
400	50200	Invalid Input Parameters: {param}	输入参数param不合规，param可能为video，strategy，aspect_ratio，crop_size
400	50211	Video Size Exceeds Maximum Limit: please compress the video	输入视频过大，超过限制
500	50500	Internal Error	服务内部错误

调用方式-任务查询

接口简介

视频尺寸转化的任务查询。

请求说明

名称	内容
接口地址	https://visual.volcengineapi.com
请求方式	GET
Content-Type	`application/x-www-form-urlencoded`

请求参数
（1）header请求参数
公共请求参数

名称	类型	是否必填	示例值	描述
X-Date	String	是	20201103T104027Z	使用UTC标准时间，日期精确到秒，格式：YYYYMMDD'T'HHMMSS'Z'。
Authorization	String	是	HMAC-SHA256 Credential={AccessKeyId}/{ShortDate}/{Region}/{Service}/request, SignedHeaders={SignedHeaders}, Signature={Signature}	HMAC-SHA256：签名方法 Credential：签名凭证，其中， -AccessKeyId是访问密钥ID，可在访问密钥（Access Key）获取； -ShortDate是请求的短时间，使用UTC时间，精确到日。请使用格式：YYYYMMDD，例如：20180201 -Region默认为cn-north-1 -Service默认为cv SignedHeaders是参与签名计算的头部信息，content-type 和 host 为必选头部 Signature是签名，可在签名方法获取。注：我们提供了SDK及签名示例供您实现服务快速接入，具体可参考快速接入
X-Security-Token	String	否	无	指安全令牌服务（Security Token Service，STS）颁发的临时安全凭证中的SessionToken： 1.用户 / Service 访问自己的资源则可以使用 AK/SK 直接访问（长期 Token），无需填写该参数。 2.用户 / Service 通过扮演角色去调用接口时需要使用 STS。具体流程：先调用 AssumeRole 获得短期 token, 然后将该 Token 放入该参数去请求目标接口。
Content-Type	String	是	application/x-www-form-urlencoded	编码格式

（2）Query参数

参数	可选/必选	类型	说明
Action	必选	String	接口名，取值：VideoRetargetingQueryTask
Version	必选	String	版本号，取值：2020-08-26
`task_id`	必选	`String`	任务ID

输出说明

（1）通用输出参数
请参考通用返回字段及错误码
（2）业务输出参数
data字段

字段	类型	说明
`status`	`String`	任务运行状态，可能为：Pending、Running、Success、Failed
`video_url`	`String`	处理后的视频链接，链接有效时长为1h，超过请重新请求该接口获取，仅当status为Success时该值有效，当status为Failed时请查看错误码

注：部分视频编码无法在浏览器正常播放，可尝试下载后使用视频播放器播放。
（3）输出示例

{
    "status": 10000,
    "code": 10000,
    "time_elapsed": "570.835792ms",
    "request_id": "69048264100455403521607655177",
    "message": "Success",
    "data": {
        "status": "Success"
        "video_url": {视频链接}
    }
}

错误码

（1）通用错误码
请参考通用返回字段及错误码

（2）业务错误码

http code	错误码	错误信息	说明
200	10000	Success	成功
400	50201	Missing Input Parameters: task_id	缺少输入参数task_id
400	50200	Invalid Input Parameters: task_id	输入参数task_id无效
500	50500	Internal Error	服务内部错误
500	50502	Processing time is too long, exceeding the limit	服务处理超时