本文向您介紹常用的剪輯合成參數。
OutputMediaConfig
輸出成品的目標配置,JSON格式??梢栽O置輸出成品在OSS上的URL,或者VOD Bucket 中的存儲位置。輸出到OSS時,輸出目標的 MediaURL 必填;輸出到VOD 時,StorageLocation 和 FileName 兩個參數必填。
參數說明
字段名稱 | 類型 | 必填項 | 描述 |
MediaURL | String | 成片輸出到OSS時必填 | 指定輸出到OSS的媒資文件URL。 如:http://-bucket.oss-cn-shanghai.aliyuncs.com/outputOss.mp4 注:
|
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??梢圆惶睿J值是多個素材的最高碼率。 |
MaxDuration | Float | 否 | 輸出成品的最大時長,單位為秒。相關用法介紹請參見設置 MaxDuration |
ProduceTemplateId | String | 否 | 定制參數,合成模板Id,與MPS轉碼模板ID一致,用于設置輸出成品的合成轉碼參數。用于特殊場景下定制視頻處理,模板 ID 為 MPS 系統中的轉碼模板ID,可以在 MPS 產品中創建。 |
VodTemplateGroupId | String | 否 | 成片輸出至VOD時,請指定VOD轉碼模板組,并使用從視頻點播控制臺獲取的轉碼模板組ID。如不需要VOD轉碼,請填寫 "VOD_NO_TRANSCODE"。更多詳情請參見轉碼模板。 |
Endpoint | String | 否 |
|
Bucket | String | 否 |
|
ObjectKey | String | 否 |
|
AccessKeyId | String | 否 |
|
AccessKeySecret | String | 否 |
|
Video 詳情
OutputMediaConfig 中的參數,用于指定輸出成品與視頻流相關的配置,配置示例見下文。
參數 | 類型 | 必填項 | 含義 | 描述 |
Fps | Integer | 否 | 輸出視頻流幀率 |
|
Orientation | String | 否 | 輸出成片橫豎屏 |
|
Codec | String | 否 | 編碼格式 |
|
Profile | String | 否 | 編碼級別 |
|
Crf | Integer | 否 | 碼率-質量控制因子 |
|
Preset | String | 否 | 視頻算法器預制 |
|
參數示例
輸出到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 參數示例。
{
"OutputMediaConfig": {
"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可獲取封面地址)
|
InputMediaRegisterConfig | JSON | 否 | 如果剪輯時間線中包含url,會自動注冊成媒資,此字段為輸入素材自動注冊媒資的配置。
|
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 | 否 | 媒資標題。
|
Description | String | 否 | 媒資描述。
|
Tags | String | 否 | 媒資標簽。
|
CateId | Long | 否 | 媒資分類ID。 |
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打頭。 |