文档

AddTemplate - 创建模板

更新时间:

创建云剪辑模板。模板工厂是对剪辑合成时间线的一个封装,用户可以把常用的剪辑保存为模板,当有同样的需求出现时,只需要传入替换素材即可生产视频。调用AddTemplate接口创建模板,Config为模板描述,普通模板和高级模板Config有较大差异,参考下方使用文档。

接口说明

  • 使用普通模板,请参考:普通模板快速入门
  • 使用高级模板,请参考:高级模板创建及使用
  • 高级模板创建后有个解析的时间,状态为 Processing,此时模板不可用,当模板状态为 Available 方可使用。模板解析时间与模板文件大小有关,一般 10s-5min。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
Namestring

模板名称

模板名称
Typestring

模板类型,目前支持:

  • Timeline
  • VETemplate
Timeline
Configstring

参见 Timeline 模板 Config 文档

参见Timeline模板Config文档
CoverUrlstring

模板封面

http://example-bucket.oss-cn-shanghai.aliyuncs.com/cover.jpg
PreviewMediastring

模板预览视频 MediaId

****01bf24bf41c78b2754cb3187****
Statusstring

模板状态,取值范围:

  • Available
  • Created
  • Uploading
  • Processing
  • UploadFailed
  • ProcessFailed
Available
Sourcestring

模板创建来源,取值范围:

  • OpenAPI
  • AliyunConsole
  • WebSDK
OpenAPI
RelatedMediaidsstring

模板关联素材,普通模板编辑器使用

{"video":["1805a0c6ca544fb395a06ca683619655"]}

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

Id of the request

****2876-6263-4B75-8F2C-CD0F7FCF****
Templateobject

模板信息

TemplateIdstring

模板 Id

****01bf24bf41c78b2754cb3187****
Namestring

模板名称

模板名称
Typestring

模板类型

枚举值:
  • Timeline普通模板
  • VETemplate高级模板
Timeline
Configstring

参见 Timeline 模板 Config 文档

参见Config文档
CoverUrlstring

模板封面

http://example-bucket.oss-cn-shanghai.aliyuncs.com/cover.jpg
PreviewMediastring

预览视频媒资 id

****01bf24bf41c78b2754cb3187****
Statusstring

模板状态

枚举值:
  • UploadFailed上传失败
  • ProcessFailed高级模板分析失败
  • Available正常
  • Uploading上传中
  • Created已创建,还不能使用
  • Processing高级模板分析中
Available
CreateSourcestring

模板创建来源

枚举值:
  • AliyunConsole通过阿里云控制台创建
  • WebSDK通过WebSDK创建
  • OpenAPI通过OpenAPI创建
OpenAPI
ModifiedSourcestring

模板修改来源

枚举值:
  • AliyunConsole通过阿里云控制台创建
  • WebSDK通过WebSDK创建
  • OpenAPI通过OpenAPI创建
OpenAPI

示例

正常返回示例

JSON格式

{
  "RequestId": "****2876-6263-4B75-8F2C-CD0F7FCF****",
  "Template": {
    "TemplateId": "****01bf24bf41c78b2754cb3187****",
    "Name": "模板名称",
    "Type": "Timeline",
    "Config": "参见Config文档",
    "CoverUrl": "http://example-bucket.oss-cn-shanghai.aliyuncs.com/cover.jpg",
    "PreviewMedia": "****01bf24bf41c78b2754cb3187****",
    "Status": "Available",
    "CreateSource": "OpenAPI",
    "ModifiedSource": "OpenAPI"
  }
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2023-11-23API 内部配置变更,不影响调用看变更集
变更项变更内容
API 内部配置变更,不影响调用
  • 本页导读 (1)
文档反馈