剪輯合成參數說明 -

本文向您介紹常用的剪輯合成參數。

OutputMediaConfig

輸出成品的目標配置，JSON格式。可以設定輸出成品在OSS上的URL，或者VOD Bucket 中的儲存位置。輸出到OSS時，輸出目標的 MediaURL 必填；輸出到VOD 時，StorageLocation 和 FileName 兩個參數必填。

參數說明

欄位名稱	類型	必填項	描述
MediaURL	String	成片輸出到OSS時必填	指定輸出到OSS的媒資檔案URL。如：http://-bucket.oss-cn-shanghai.aliyuncs.com/outputOss.mp4 註： OSS bucket需與調用服務所在地區相同。不支援OSS加速網域名稱或CDN網域名稱。輸出格式支援可參見支援剪輯的媒資格式
StorageLocation	String	成片輸出到VOD時必填	指定輸出到VOD的媒資檔案儲存體地址，不包含http:// 的首碼。如：outin-xxxxxx.oss-cn-shanghai.aliyuncs.com
FileName	String	成片輸出到vod時必填	指定輸出到VOD的媒資檔案名稱，包含檔案尾碼，不包含路徑。如：outputVod.mp4
Video	String	否	指定輸出成品與視頻流相關的配置，更多資訊請參見下文 Video 詳情
Width	Integer	否	輸出成品的寬。可以不填，預設值是多個素材的最大寬。
Height	Integer	否	輸出成品的高。可以不填，預設值是多個素材的最大高。
Bitrate	Integer	否	輸出成品的碼率，單位為Kbps。可以不填，預設值是多個素材的最高碼率。
MaxDuration	Float	否	輸出成品的最大時間長度，單位為秒。相關用法介紹請參見設定 MaxDuration
ProduceTemplateId	String	否	定製參數，合成模板Id，與MPS轉碼模板ID一致，用於設定輸出成品的合成轉碼參數。用於特殊情境下定製視頻處理，模板 ID 為 MPS 系統中的轉碼模板ID，可以在 MPS 產品中建立。
VodTemplateGroupId	String	否	成片輸出至VOD時，請指定VOD轉碼模板組，並使用從ApsaraVideo for VOD控制台擷取的轉碼模板組ID。如不需要VOD轉碼，請填寫 "VOD_NO_TRANSCODE"。更多詳情請參見轉碼模板。
Endpoint	String	否	雲廠商的 Endpoint 輸出為 S3 協議時所需
Bucket	String	否	輸出雲廠商的儲存 Bucket 輸出為 S3 協議時所需
ObjectKey	String	否	輸出對象名輸出為 S3 協議時所需
AccessKeyId	String	否	從對應雲廠商中拿到的臨時 AccessKeyId 輸出為 S3 協議時所需
AccessKeySecret	String	否	從對應雲廠商中拿到的臨時 AccessKeySecret 輸出為 S3 協議時所需

Video 詳情

OutputMediaConfig 中的參數，用於指定輸出成品與視頻流相關的配置，配置樣本見下文。

參數	類型	必填項	含義	描述
Fps	Integer	否	輸出視頻流幀率	取值範圍：[1, 60] 預設值：25
Orientation	String	否	輸出成片橫豎屏	取值範圍：{Horizontal, Vertical} Horizontal：橫屏 Vertical：豎屏指定橫屏，則會以「寬最大的橫屏視頻素材」的寬高作為輸出成片的最大寬高指定豎屏：則會以「高最大的豎屏視頻素材」的寬高作為輸出成片的最大寬高如果指定了 Width 與 Height，本參數將失效
Codec	String	否	編碼格式	取值集合：{H.264, H.265} 預設值：H.264
Profile	String	否	編碼層級	取值集合：{baseline, main, high} 預設值：high 注意：僅 H.264 支援此參數
Crf	Integer	否	碼率-品質控制因子	取值範圍：[0, 51] 預設值：編碼格式為 H.264 時，預設值為 23 編碼格式為 H.265 時，預設值為 26 注意：如果同時設定 Crf 和 Bitrate，Bitrate 會失效
Preset	String	否	視頻演算法器預製	取值集合：{veryfast, fast, medium, slow, slower} 預設值：medium 注意：僅 H.264 支援此參數

參數樣本

輸出到OSS

當輸出到 OSS ，即成片儲存至使用者自有oss bucket時，MediaURL 必填，其他參數可以選填。其中 Bitrate 用來設定輸出成品的碼率，通常碼率越高越清晰，最大可以設定到 5000。 Width, Height 用來設定成品的解析度。

{
 "MediaURL":"https://your-bucket.oss-cn-shanghai.aliyuncs.com/outputOss.mp4",
 "Bitrate": 2000,  
 "Width": 800,  
 "Height": 680
}

OSS URL 的路徑格式： https://${bucket}.${oss-region-name}.aliyuncs.com/${fileKey}

bucket 是 OSS Bucket 的名稱，fileKey 是OSS 檔案名稱（包含路徑和檔案尾碼）。

oss-region-name.aliyuncs.com 是 OSS 檔案的外網 Endpoint，比如上海，北京，杭州的分別是：

oss-cn-shanghai.aliyuncs.com
oss-cn-hangzhou.aliyuncs.com 
oss-cn-beijing.aliyuncs.com

輸出到VOD

當輸出到 VOD 時， StorageLocation 和 FileName 兩個參數必填。請到vod控制台查看可用的VOD儲存地址。

{ 
  "StorageLocation": "outin-*xxxxxx7d2a3811eb83da00163exxxxxx.oss-cn-shanghai.aliyuncs.com",  
  "FileName": "outputVod.mp4",  
  "Bitrate": 2000,  
  "Width": 800,  
  "Height": 680,
  "VodTemplateGroupId": "VOD_NO_TRANSCODE"
}

配置 Video 參數樣本

在 OutputMediaConfig 中設定 Video 參數樣本。

{
  "MediaURL": "https://your-bucket.oss-cn-shanghai.aliyuncs.com/outputOss.mp4",
  "Width": 800,
  "Height": 680,
  "Video": {
    "Codec": "H.264",
    "Fps": 50,
    "Profile": "main",
    "Crf": 15
  }
}

ProjectMetadata

剪輯工程的中繼資料資訊，JSON格式。

參數說明

欄位名稱

類型

必填項

描述

Description

String

否

剪輯工程的描述

Title

String

否

剪輯工程的標題

參數樣本

{
   "Description":"描述",
   "Title":"標題"
}

EditingProduceConfig

普通剪輯合成參數，JSON格式。

參數說明

欄位名稱	類型	必填項	描述
AudioChannelCopy	String	否	聲道複製，支援設定為left或者right。如果設定為left，則輸出視頻的左右聲道均會被複製為輸入素材的左聲道。如果設定為right，則輸出視頻的左右聲道均會被複製為輸入素材的右聲道。
AutoRegisterInputVodMedia	Boolean	否	是否需要將您時間軸中的VOD媒資自動註冊至IMS，預設為true。
AutoRegisterOutputImsMedia	Boolean	否	是否將剪輯合成的視頻，自動註冊到IMS媒資庫中，預設為true。
OutputWebmTransparentChannel	Boolean	否	是否需要輸出視頻帶透明通道，預設為false。如果您需要您的輸出webm視頻帶有alpha透明通道，您需要您的輸出視頻MediaURL或者FileName以webm結尾，否則預設產生mp4不帶透明通道，且您的時間軸中有且僅有Scale類型的Effect。
CoverConfig	JSON	否	封面圖參數，使用者可以設定成片第幾秒作為媒資封面（注意，此參數不是修改視頻的第一幀，媒資封面是一張單獨的圖片，儲存在客戶OSS中，調用GetMediaInfo可擷取封面地址） StartTime: 封面圖位於成片的第幾秒，支援四位小數。
InputMediaRegisterConfig	JSON	否	如果剪輯時間軸中包含url，會自動註冊成媒資，此欄位為輸入素材自動註冊媒資的配置。 NeedSnapshot：是否截取截圖，類型為Boolean，預設為true； NeedSprite：是否截取雪碧圖，類型為Boolean，預設為true。 SearchLibName：自訂搜尋庫，類型為String，預設為空白。如果您希望註冊的素材媒資匯入自訂搜尋庫需配置此欄位。參考基於OpenAPI自建搜尋庫的使用流程。
SearchLibName	String	否	剪輯合成後，自動註冊的成片媒資如需匯入自訂搜尋庫，需配置此欄位。參考基於OpenAPI自建搜尋庫的使用流程。
NeedSnapshot	Boolean	否	剪輯合成後自動註冊的媒資，是否截取截圖。預設為true。
NeedSprite	Boolean	否	剪輯合成後自動註冊的媒資，是否截取雪碧圖。預設為true。
PipelineId	String	否	使用者自訂管道ID，一般用於多個業務線使用同一個主帳號提交任務，需要將不同業務線之間的任務做資源隔離。如有需求，請提工單申請。
MaxBitrate	Integer	否	使用者自訂輸出視頻的最大碼率。當指定了該欄位，且輸入素材的碼率大於MaxBitrate，輸出視頻的碼率會按照MaxBitrate進行配置。不指定時，輸出視頻預設最大碼率為5000。
KeepOriginMaxBitrate	Boolean	否	輸出視頻的碼率是否隨源，預設為false。當KeepOriginMaxBitrate為true 時，根據素材最高碼率設定成片碼率，上限為50000。
KeepOriginVideoMaxFps	Boolean	否	輸出視頻的幀率是否隨源，預設為false。當KeepOriginVideoMaxFps為true時，根據素材最高幀率設定成片幀率。

參數樣本

{
	"AutoRegisterInputVodMedia": true,
	"OutputWebmTransparentChannel": true,
	"CoverConfig": {
		"StartTime": 3.3
	},
	"AudioChannelCopy": "left",
	"PipelineId": "xxxd54a97cff4108b555b01166d4bxxx",
	"MaxBitrate": 5000,
	"KeepOriginMaxBitrate": false,
	"KeepOriginVideoMaxFps": false
}

MediaMetadata

剪輯輸出媒資的meta資訊，JSON 格式。

參數說明

欄位名稱	類型	必填項	描述
Title	String	否	媒資標題。長度不超過128位元組。 UTF8編碼。
Description	String	否	媒資描述。長度不超過1024位元組 UTF8編碼。
Tags	String	否	媒資標籤。最多不超過16個標籤。多個用逗號分隔。單個標籤不超過32位元組。 UTF8編碼。
CateId	Long	否	媒資分類ID。
CustomMetadata	String	否	自訂中繼資料，JSON 格式字串。樣本： {"key1": "value1", "dict1": {"key2": "value2", "key3": "value3"}} 輸出成片的 metadata 中，就會包含上述資訊

UserData

使用者自訂資料，JSON格式。使用者在提交合成任務時，可以將自訂資料放在userData中。若配置了合成回調，合成完成後，回調中會包含UserData欄位，上限1024位元組。

為方便使用者使用，userData支援直接傳入回調配置，詳情請參考最佳實務：配置事件通知地址擷取合成完成的回調。

UserData保留欄位說明如下：

保留欄位

欄位名稱

類型

必填項

描述

NotifyAddress

String

否

回調地址，支援HTTP回調（http URL）或者MNS回調（mns 隊列名）。

HTTP回調樣本：http://yourdomain.com/callback

MNS回調樣本："ice-callback-test"，隊列名必須以ice-callback打頭。