接口3：发起模板合成任务--创意互动Vlog-火山引擎

文档中心

立即注册

导航

接口3：发起模板合成任务

最近更新时间：2024.08.23 10:23:54首次发布时间：2024.06.21 12:46:12

描述

该接口将触发模板合成任务，任务为异步处理，处理结果需通过 ListFilms 接口获取。

Action

SubmitTemplateTaskAsync

入参

字段	类型	是否必填	描述
ScenicSpotId	string	是	景区ID。
MaterialInfos	[]MaterialInput	是	素材集合
OpenId	string	否	游客在客户端的唯一标识，不填，默认为 Default。
TemplateId	string	否	指定成片使用的模板 ID，字段通过 ListTemplates 获取。
Group	string	否	可指定在分组内随机选择模板成片，若同时指定了 TemplateId，优先按 TemplateId 成片。
FaceMaterial	string	否	AIGC合成人脸素材链接，填 GenerateUploadUrl 接口返回的 UploadUrl，不需要带URL Query部分；也可填其他资源的 http 链接。图片限制: 1.图片格式：建议使用jpg/jpeg、png格式，其余格式可能会报错，后续逐步开放。 2. 图片像素尺寸：最小 128 x 128 像素，最大 4096 x 4096 像素 3. 不支持黑白图片 4. 图片文件大小：目标图片需小于 5 MB 5. 人脸像素尺寸：为了保证融合效果，推荐图片中人脸框（正方形）边长的最小值不低于200像素。 6. 人脸质量：人脸质量越高，则融合效果越好。 7. 影响人脸质量的因素包括：对人脸五官的遮挡、不当的光照（强光、暗光、逆光）、过大的人脸角度（推荐 yaw ≤ ±20°, pitch ≤ ±20°）等。

注：若 TemplateId 和 Group 均未提供，系统将从景区候选模板随机选择一个进行成片。
MaterialInput 素材输入信息

字段	类型	是否必填	描述
Url	string	是	素材链接，填 GenerateUploadUrl 接口返回的 UploadUrl，不需要带URL Query部分；也可填其他资源的 http 链接。
HighlightTimestamp	float64	否	高光时刻，相对视频开始的偏移量，单位s，精确到毫秒。注：系统将根据高光点，截取满足槽位时长的片段，填充槽位。若未填写，则默认从素材开始截取。

注：成片将按照提交的素材顺序进行填充。

出参

字段	类型	是否允许为空	描述
TaskId	string	否	任务ID。

示例

请求成功

{
    "ResponseMetadata": {
        "RequestId": "5bfc9ca7-*************-6ebd922a8564",
        "Action": "SubmitTemplateTaskAsync",
        "Version": "2022-11-08",
        "Service": "vlog",
        "Region": "cn-north-1"
    },
    "Result": {
        "TaskId": "5bfc9ca7-******-5bfc9ca7"
    }
}

系统内部错误

{
    "ResponseMetadata": {
        "RequestId": "5bfc9ca7-4d01-43e0-801e-6ebd922a8564",
        "Action": "SubmitTemplateTaskAsync",
        "Version": "2022-11-08",
        "Service": "vlog",
        "Region": "cn-north-1",
        "Error": {
            "Code": "InternalError",
            "Message": "系统内部错误"
        }
    }
}