建立智能一鍵成片模板的配置參數說明-智能媒體服務-阿里雲

本文旨在介紹智能一鍵成片-模板配置相關的參數。

重要

注意：在此介面中，所有媒資的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	是
Config	JSON	模板配置參數	詳見參數樣本中的Config	是

Config 參數說明

參數	類型	說明	樣本值	是否必填
InputTemplateConfig	JSON	用於配置貼紙浮水印、背景音樂、背景圖片等參數。	詳見參數樣本中的InputTemplateConfig	否
EditingTemplateConfig	JSON	用於配置標題、口播、背景音樂、背景圖片等剪輯參數。	詳見參數樣本中的EditingTemplateConfig	否
OutputTemplateConfig	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 參數說明

參數	類型	說明	樣本值	是否必填
TitleConfig	JSON	標題相關配置。支援配置字幕參數。	詳見TitleConfig樣本值	否
SubHeadingConfig	JSON	多級副標題相關配置。支援設定字幕參數。 JSON欄位說明： key：Level value：橫幅文字	{"1":{"Y":0.3,"FontSize":40},"3":{"Y":0.5,"FontSize":30}}	否
SpeechConfig	JSON	口播文案相關配置。重要模板不支援配置參數SpecialWordsConfig	詳見SpeechConfig樣本值	否
BackgroundMusicConfig	JSON	背景音樂相關配置。	詳見BackgroundMusicConfig樣本值	否
BackgroundImageConfig	JSON	背景圖相關配置。如果InputTemplateConfig中已配置背景圖，則此欄位不生效。	詳見BackgroundImageConfig樣本值	否
FECanvas	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	是
Video	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
    }
  }
}