本文旨在介绍智能一键成片-模板配置相关的参数。
注意:在此接口中,所有媒资的OSS URL中的区域(region)必须与调用OpenAPI服务地址中的区域(region)保持一致。
支持的区域:华东2(上海)、华北2(北京)、华东1(杭州)、华南1(深圳)、美国(西部)、新加坡。
实际使用过程中,请将文档所有参数示例中的 [your-bucket]、[your-region-id]、[your-file-name]、[your-file-path]、媒资ID(例如:“****9d46c8b4548681030f6e****”)等参数替换为您的实际值。
使用说明
通过AddTemplate - 创建模板创建一键成片自定义模板,API参数详见下方AddTemplate 参数说明。
获取单个一键成片模板:GetTemplate - 获取模板信息
获取一键成片模板列表:ListTemplates - 列出符合条件的模板
AddTemplate 参数说明
参数 | 类型 | 说明 | 示例值 | 是否必填 |
Name | String | 模板名称 | batch-editing-template-1 | 否 |
Type | String | 模板类型,一键成片固定传BatchEditing | BatchEditing | 是 |
JSON | 模板配置参数 | 详见参数示例中的Config | 是 |
Config 参数说明
参数 | 类型 | 说明 | 示例值 | 是否必填 |
JSON | 用于配置贴纸水印、背景音乐、背景图片等参数。 | 详见参数示例中的InputTemplateConfig | 否 | |
JSON | 用于配置标题、口播、背景音乐、背景图片等剪辑参数。 | 详见参数示例中的EditingTemplateConfig | 否 | |
JSON | 用于配置分辨率、输出视频流等相关的合成参数。 | 详见参数示例中的OutputTemplateConfig | 是 |
InputTemplateConfig 参数说明
参数 | 类型 | 说明 | 示例值 | 是否必填 |
StickerArray | List<Sticker> | 贴纸水印logo | [{"MediaId":"****9d46c8b4548681030f6e****","X":10,"Y":100,"Width":300,"Height":300,"Opacity":0.6}] | 否 |
BackgroundMusicArray | List<String> | 背景音乐,支持媒资ID或OSS URL | ["****b4549d46c88681030f6e****","****549d46c88b4681030f6e****"] | 否 |
BackgroundImageArray | List<String> | 背景图,支持媒资ID 或 OSS URL。 | ["****b4549d46c88681030f6e****","****549d46c88b4681030f6e****"] | 否 |
EditingTemplateConfig 参数说明
参数 | 类型 | 说明 | 示例值 | 是否必填 |
JSON | 标题相关配置。支持配置字幕参数。 | 否 | ||
SubHeadingConfig | JSON | 多级副标题相关配置。支持设置字幕参数。 JSON字段说明: | {"1":{"Y":0.3,"FontSize":40},"3":{"Y":0.5,"FontSize":30}} | 否 |
JSON | 口播文案相关配置。 模板不支持配置参数SpecialWordsConfig | 否 | ||
JSON | 背景音乐相关配置。 | 否 | ||
JSON | 背景图相关配置。如果InputTemplateConfig中已配置背景图,则此字段不生效。 | 否 | ||
JSON | 用于前端页面预览时的画布配置。 | {"Width": 1080,"Height": 1920} | 否 |
FECanvas 参数说明
如果您希望把控制台-普通模板中的普通模板的样式迁移到一键成片模板,为了保证预览的字幕大小和实际合成大小一致,需要把普通模板中的参数FECanvas,以及标题和字幕的样式配置,复制并赋值给一键成片模板中的TitleConfig 、SpeechConfig.AsrConfig、FECanvas。
参数 | 类型 | 说明 | 示例值 | 是否必填 |
Width | Integer | 画布宽度,单位:像素 | 450 | 是 |
Height | Integer | 画布高度,单位:像素 | 800 | 是 |
OutputTemplateConfig 参数说明
参数 | 类型 | 说明 | 示例值 | 是否必填 |
Width | Integer | 成片宽,px | 1920 | 是 |
Height | Integer | 成片高,px | 1080 | 是 |
JSONObject | 输出视频流相关配置,Crf、Codec等 | {"Crf": 27} | 否 |
参数示例
{
"Name": "batch-editing-template-1",
"Type": "BatchEditing",
"Config": {
"InputTemplateConfig": {
"BackgroundImageArray": [
"https://[your-bucket].oss-[your-region-id].aliyuncs.com/[your-file-path]/[your-file-name].png"
],
"BackgroundMusicArray": [
"icepublic-0c4475c3936f3a8743850f2da942ceee"
],
"StickerArray": [
{
"MediaURL": "https://[your-bucket].oss-[your-region-id].aliyuncs.com/[your-file-path]/[your-file-name].jpeg",
"X": 0.1,
"Y": 0.1,
"Width": 0.1,
"Height": 0.1
}
]
},
"EditingTemplateConfig": {
"TitleConfig": {
"Y": 0.7
},
"SpeechConfig": {
"Voice": "zhifei",
"AsrConfig": {
"Y": 0.9
}
}
},
"OutputTemplateConfig": {
"Width": 1080,
"Height": 1920
}
}
}
- 本页导读 (1)
- 使用说明
- AddTemplate 参数说明
- Config 参数说明
- InputTemplateConfig 参数说明
- EditingTemplateConfig 参数说明
- OutputTemplateConfig 参数说明
- 参数示例