AddTemplate - 创建模板

更新时间:
复制 MD 格式

智能生产制作支持基于普通模板和高级模板的视频剪辑功能,用户可调用AddTemplate创建模板。

接口说明

使用说明

使用限制

高级模板创建后有个解析的时间,状态为 Processing,此时模板不可用,当模板状态为 Available 方可使用。模板解析时间与模板文件大小有关,一般 10s-5min。

调试

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

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

ice:AddTemplate

*全部资源

*

请求参数

名称

类型

必填

描述

示例值

Name

string

自定义模板名称。

Template name

Type

string

模板类型,目前支持:

  • Timeline(普通模板):基于视频剪辑工程的 Timeline(时间线内多个素材,多图层形式进行前后拼接)创建的模板,可实现图文转视频、图片相册、片头片尾、默认水印等效果。

  • VETemplate(高级模板):基于 AE(Adobe After Effects)特效创建的模板,可实现复杂动效样式的高级媒体效果。

  • BatchEditing (一键成片模版):支持配置贴纸水印、背景音乐、背景图片、口播字幕样式、标题字幕样式、输出分辨率等参数,提交一键成片任务时自动应用。

枚举值:

  • Timeline :

    普通模板

  • VETemplate :

    高级模板

Timeline

Config

string

参见Timeline模板Config文档

CoverUrl

string

模板封面

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

PreviewMedia

string

模板预览视频 MediaId

****01bf24bf41c78b2754cb3187****

Status

string

模板状态,取值范围:

  • Available:正常

  • Created:已创建还不能使用

  • Uploading:上传中

  • Processing:高级模板分析中

  • UploadFailed:上传失败

  • ProcessFailed:高级模板分析失败

枚举值:

  • UploadFailed :

    上传失败

  • ProcessFailed :

    高级模板分析失败

  • Available :

    正常

  • Uploading :

    上传中

  • Created :

    已创建,还不能使用

  • Processing :

    高级模板分析中

Available

Source

string

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

  • OpenAPI:通过 OpenAPI 创建

  • AliyunConsole:通过阿里云控制台创建

  • WebSDK:通过 WebSDK 创建

枚举值:

  • AliyunConsole :

    通过阿里云控制台创建

  • WebSDK :

    通过 WebSDK 创建

  • OpenAPI :

    通过 OpenAPI 创建

OpenAPI

RelatedMediaids

string

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

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

返回参数

名称

类型

描述

示例值

object

Schema of Response

RequestId

string

Id of the request

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

Template

object

模板信息

TemplateId

string

模板 Id

****01bf24bf41c78b2754cb3187****

Name

string

模板名称

Template name

Type

string

模板类型

枚举值:

  • Timeline :

    普通模板

  • VETemplate :

    高级模板

Timeline

Config

string

参见 Timeline 模板 Config 文档

参见Config文档

CoverUrl

string

模板封面

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

PreviewMedia

string

预览视频媒资 id

****01bf24bf41c78b2754cb3187****

Status

string

模板状态

枚举值:

  • UploadFailed :

    上传失败

  • ProcessFailed :

    高级模板分析失败

  • Available :

    正常

  • Uploading :

    上传中

  • Created :

    已创建,还不能使用

  • Processing :

    高级模板分析中

Available

CreateSource

string

模板创建来源

枚举值:

  • AliyunConsole :

    通过阿里云控制台创建

  • WebSDK :

    通过 WebSDK 创建

  • OpenAPI :

    通过 OpenAPI 创建

OpenAPI

ModifiedSource

string

模板修改来源

枚举值:

  • AliyunConsole :

    通过阿里云控制台创建

  • WebSDK :

    通过 WebSDK 创建

  • OpenAPI :

    通过 OpenAPI 创建

OpenAPI

示例

正常返回示例

JSON格式

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

错误码

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

变更历史

更多信息,参考变更详情