GetTemplate - 获取模板信息

根据模板ID获取模板信息。高级模板有解析过长,当类型为高级模板时,Status为Available时即可使用。

接口说明

模板工厂是对剪辑合成时间线的一个封装,用户可以把常用的时间线定义成模板,当有同样的需求出现时,只需要传入关键参数及素材即可生产视频。

调试

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

调试

授权信息

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

请求参数

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

模板Id

****20b48fb04483915d4f2cd8ac****
RelatedMediaidFlagstring

相关媒体ID标记,默认值0,当值为1时返回模板关联素材,仅普通模板有效。

0

返回参数

名称类型描述示例值
object

返回数据

RequestIdstring

请求Id

******11-DB8D-4A9A-875B-275798******
Templateobject

模板信息

TemplateIdstring

模板ID

****20b48fb04483915d4f2cd8ac****
Namestring

模板名称

视频添加水印模板
Typestring

模板类型,目前支持:

  • Timeline
  • VETemplate
Timeline
Configstring

模板配置

参考Timeline模板配置详解
PreviewMediastring

预览素材

****20b48fb04483915d4f2cd8ac****
Statusstring

模板状态,取值范围

  • Available
  • Created
  • Uploading
  • Processing
  • UploadFailed
  • ProcessFailed
Available
CreateSourcestring

创建来源,取值范围:

  • AliyunConsole
  • OpenAPI
  • WebSDK
OpenAPI
ModifiedSourcestring

修改来源,取值范围:

  • AliyunConsole
  • OpenAPI
  • WebSDK
OpenAPI
PreviewMediaStatusstring

预览素材状态

  • Init(初始状态:源文件未就绪)
  • Preparing(源文件准备中:比如上传中或者剪辑合成中)
  • PrepareFail(源文件准备失败:比如获取源文件信息失败)
  • Normal(正常:源文件已就绪)
Normal
CreationTimestring

创建时间

2020-12-26T04:11:10Z
ModifiedTimestring

修改时间

2020-12-26T04:11:10Z
CoverURLstring

封面URL

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

提交合成任务的ClipsParam参数模板,可把mediaId和text换成真实的参数来提交合成任务。使用方式参考:

{"Media1":"mediaId","Text1":"text"}
RelatedMediaidsstring

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

{"video":["******c04f1d4a06996144cc1a******"],"audio":["******c04f1d4a06996144cc1a******"],"image":["******c04f1d4a06996144cc1a******"]}

示例

正常返回示例

JSON格式

{
  "RequestId": "******11-DB8D-4A9A-875B-275798******",
  "Template": {
    "TemplateId": "****20b48fb04483915d4f2cd8ac****",
    "Name": "视频添加水印模板",
    "Type": "Timeline",
    "Config": "参考Timeline模板配置详解",
    "PreviewMedia": "****20b48fb04483915d4f2cd8ac****",
    "Status": "Available",
    "CreateSource": "OpenAPI",
    "ModifiedSource": "OpenAPI",
    "PreviewMediaStatus": "Normal",
    "CreationTime": "2020-12-26T04:11:10Z",
    "ModifiedTime": "2020-12-26T04:11:10Z",
    "CoverURL": "http://example-bucket.oss-cn-shanghai.aliyuncs.com/cover.jpg",
    "ClipsParam": "{\"Media1\":\"mediaId\",\"Text1\":\"text\"}",
    "RelatedMediaids": "{\"video\":[\"******c04f1d4a06996144cc1a******\"],\"audio\":[\"******c04f1d4a06996144cc1a******\"],\"image\":[\"******c04f1d4a06996144cc1a******\"]}"
  }
}

错误码

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

阿里云首页 智能媒体生产 相关技术圈