ApsaraVideo for Media ProcessingAPI詳細參數說明 - ApsaraVideo Media Processing

本文介紹ApsaraVideo for Media Processing中轉碼、工作流程、管道等功能API的部分參數詳細說明，包含參數類型、參數用途以及參數取值樣本等內容。

Input詳情

參數	類型	是否必選	描述
Bucket	String	是	輸入檔案所在OSS Bucket。遵守OSS Bucket定義，更多資訊請參見基本概念。
Location	String	是	輸入OSS Bucket所在資料中心（OSS Region）。 OSS Bucket必須與ApsaraVideo for Media Processing服務在同一個地區。遵守OSS Region定義，更多資訊請參見基本概念。
Object	String	是	輸入檔案的OSS路徑（OSS ObjectKey），即包含檔案名稱在內的完整路徑。遵循OSS ObjectKey定義，更多資訊請參見基本概念。在ApsaraVideo for Media ProcessingAPI中，Object必須經過URL Encoding（基於UTF-8編碼）後使用。詳細說明，請參見URL Encoding說明。樣本：如果您的路徑為`阿里雲/mts HD+.mp4`，需要編碼為`%E9%98%BF%E9%87%8C%E4%BA%91/mts%20HD%2B.mp4`。
Referer	String	否	當您在OSS設定了防盜鏈，僅允許某些白名單地址可下載檔案，則必須填寫Referer。如果未設定防盜鏈，則無需填寫。設定防盜鏈詳細操作，請參見防盜鏈。如果使用工作流程轉碼，則必須在控制台設定Referer。詳細操作，請參見設定防盜鏈。如果提交單個轉碼作業，必須在API中填寫Referer。

Output詳情

本參數被SubmitJobs - 提交轉碼作業、AddMediaWorkflow - 新增媒體工作流程、UpdateMediaWorkflow - 更新媒體工作流程的拓撲結構引用。

參數	類型	是否必選	描述
OutputObject	String	是	輸出檔案的OSS路徑（OSS ObjectKey），即包含檔案名稱、副檔名在內的完整路徑。遵循OSS ObjectKey定義，更多資訊請參見基本概念。支援使用預留位置，詳細說明請參見下文預留位置替換規則。副檔名規則使用工作流程：無需指定。MPS根據模板容器格式自動在OutputObject後面添加副檔名。提交單個轉碼作業：必須手動指定副檔名，且副檔名需要與模板的容器格式相符。但如果容器類型為M3U8，則MPS會給Playlist自動添加副檔名`.m3u8`。分區檔案名稱會在Playlist後自動添加一個從00001開始的5為序號為尾碼，並以中劃線（-）相連，副檔名為`.ts`。例如：Playlist檔案名稱為filename.m3u8，則輸出第一個ts分區檔案為filename-00001.ts。在ApsaraVideo for Media ProcessingAPI中，Object必須經過URL Encoding（基於UTF-8）編碼後使用。詳細說明，請參見URL Encoding說明。樣本：入檔案路徑為a/b/example.flv，若想輸出檔案路徑為a/b/c/example+test.mp4，則OutputObject用預留位置可表示為{ObjectPrefix}/c/{FileName}+test.mp4，再經過URL Encoding後，最終設定為%7BObjectPrefix%7D/c/%7BFileName%7D%2Btest.mp4。
TemplateId	String	是	轉碼模板ID。支援自訂轉碼模板與系統預置模板。更多說明請參見自訂轉碼模板、預置模板詳情。樣本：S00000002-200040。
Container	Object	否	容器格式（封裝格式），更多資訊請參見下文Container詳情。如設定則覆蓋指定轉碼模板中的對應參數。
Video	Object	否	視頻轉碼參數。更多資訊請參見下文Video詳情。如設定則覆蓋指定轉碼模板中的對應參數。
Audio	Object	否	音頻轉碼參數。更多資訊請參見下文Audio詳情。如設定則覆蓋指定轉碼模板中的對應參數。
TransConfig	Object	否	轉碼流程參數。更多資訊請參見下文TransConfig詳情。如設定則覆蓋指定轉碼模板中的對應參數。樣本：`{"TransMode":"onepass","AdjDarMethod":"none","IsCheckVideoBitrateFail":"true","IsCheckAudioBitrateFail":"true"}`。
VideoStreamMap	String	否	輸入檔案中需要保留的視頻流標識。取值如下：不設定：代表由MPS選擇預設的1個視頻流。 0:v:{序號}：序號的含義是視頻流列表的下標，序號從0開始。例如0:v:1，代表選擇第2個視頻流參與轉碼。 0:v：代表選擇所有視頻流。
AudioStreamMap	String	否	輸入檔案中需要保留的音頻流標識。取值如下：不設定：代表由MPS選擇預設的1個音頻流。通常優先選擇中文、多聲道、高品質的1個音頻流。 0:a:{序號}：序號的含義是音頻流列表的下標，序號從0開始。例如0:a:1，代表選擇第2個音頻流參與轉碼。 0:a：代表選擇所有音頻流。適合多語言配音情境。
Rotate	String	否	視頻順時針旋轉角度。值範圍：0、90、180、270。預設值：0，代表不旋轉。
WaterMarks	Object[]	否	浮水印列表，將圖片或文字壓制到畫面中。如設定則覆蓋指定浮水印模板中的對應參數。更多資訊請參見轉碼浮水印參數詳情。一次轉碼任務最多添加4個浮水印。單個圖片浮水印樣本：`["WaterMarkTemplateId":"88c6ca184c0e47098a5b665e2a12****"},{"InputFile":{"Bucket":"example-bucket","Location":"oss-cn-hangzhou","Object":"example-logo.png"},{"Timeline":{"Start":"0","Duration":"ToEND"}}]`。單個文字浮水印樣本：`["Type":"Text","TextWaterMark":"{"Content":"5rWL6K+V5paH5a2X5rC05Y2w","FontName":"SimSun","FontSize":"16","Top":2,"Left":10}]`。
DeWatermark	Object	否	模糊處理。更多資訊請參見模糊處理詳情。樣本：`{"0": [{"l":10,"t":10,"w":10,"h":10},{"l":100,"t":0.1,"w":10,"h":10}],"128000": [],"250000": [{"l":0.2,"t":0.1,"w":0.01,"h":0.05}]}`。
SubtitleConfig	Object	否	硬字幕配置，將外部字幕檔案硬壓到畫面中。更多資訊請參見SubtitleConfig詳情。一次轉碼任務最多壓制4個字幕檔案。樣本：`{"ExtSubtitleList":[{"Input":{"Bucket":"example-bucket-****","Location":"oss-cn-hangzhou","Object":"example.srt"},"CharEnc":"UTF-8"}]}`。
Clip	Object	否	片段剪輯。更多資訊請參見下文Clip詳情。樣本：`{"TimeSpan"：{"Seek":"00:01:59.999","End":"18000.30"},"ConfigToClipFirstPart":false}`，代表先拼接再整體剪輯，剪輯從1分59秒999毫秒開始，截取到距離片尾剩餘5分30毫秒為止。
MergeList	Object[]	否	拼接列表，將輸入檔案和片段依次拼接合成為一個視頻。更多資訊請參見下文MergeList拼接參數詳情。 MergeList與MergeConfigUrl只支援二選一，MergeConfigUrl優先順序更高。一次轉碼任務最多添加4個MergeURL，如需拼接更多片段請使用MergeConfigUrl。單個拼接片段樣本：`[{"MergeURL":"http://exampleBucket**.oss-cn-hangzhou.aliyuncs.com/tail_comm_01.mp4"}]` 2個拼接片段樣本：`[{"MergeURL":"http://exampleBucketm.oss-cn-hangzhou.aliyuncs.com/tail_comm_01.mp4","Start":"1","Duration":"20"},{"MergeURL":"http://exampleBucket**.oss-cn-hangzhou.aliyuncs.com/tail_comm_02.mp4","Start":"5.4","Duration":"10.2"}]`。
MergeConfigUrl	String	否	拼接設定檔的OSS儲存地址。 MergeList與MergeConfigUrl只支援二選一，MergeConfigUrl優先順序更高。檔案只支援儲存於OSS上，儲存地址樣本：`http://exampleBucket**.oss-cn-hangzhou.aliyuncs.com/mergeConfigfile`。檔案內容為多個MergeURL，請按拼接順序填寫，最多支援50個片段拼接。格式請參見MergeList拼接參數詳情。檔案內容樣本：`{"MergeList":[{"MergeURL":"http://exampleBucketm.oss-cn-hangzhou.aliyuncs.com/tail_comm_01.mp4","Start":"1","Duration":"20"},{"MergeURL":"http://exampleBucket**.oss-cn-hangzhou.aliyuncs.com/tail_comm_02.mp4","Start":"5.4","Duration":"10.2"}]}`。
OpeningList	Object[]	否	開板列表。開板是一種特殊的拼接效果，將開板視頻嵌入在輸入視頻開頭中，以畫中畫的方式展示。更多資訊請參見OpeningList詳情。一次轉碼任務最多添加2個開板視頻，請按拼接順序填寫。樣本：`[{"OpenUrl":"http://exampleBucket**.oss-cn-hangzhou.aliyuncs.com/opening_01.flv","Start":"1","Width":"1920","Height":"1080"},{"OpenUrl":"http://exampleBucket**.oss-cn-hangzhou.aliyuncs.com/opening_02.flv","Start":"1","Width":"-1","Height":"full"}]`。
TailSlateList	Object[]	否	尾板列表。尾板是一種特殊的拼接效果，將尾板視頻拼接在輸入視頻結尾處，以淡入淡出的效果過渡展示。更多資訊請參見TailSlateList詳情。一次轉碼任務最多添加2個尾板視頻，請按拼接順序填寫。樣本：`[{"TailUrl":"http://exampleBucket****.oss-cn-hangzhou.aliyuncs.com/tail_01.flv","Start":"1","BlendDuration":"2","Width":"1920","Height":"1080","IsMergeAudio":false,"BgColor":"White"}]`。
Amix	Object[]	否	混音配置。適用於同一視頻的多音軌合并、增加背景音樂等。更多資訊請參見Amix混音詳情。一次轉碼任務最多添加4個Amix混音檔案。將輸入檔案的兩路音頻流混音樣本：`[{"AmixURL":"input","MixDurMode":"longest","Start":"1","Duration":"2"}]`。添加外部檔案與輸入檔案混音樣本：`[{"AmixURL":"http://exampleBucket****.oss-cn-hangzhou.aliyuncs.com/tail.flv","Map":"0:a:1","MixDurMode":"longest","Start":"1","Duration":"2"}]`。
MuxConfig	Object	否	打包配置。更多資訊請參見下文MuxConfig詳情。如設定則覆蓋指定轉碼模板中的對應參數。樣本：`{"Segment":{"Duration":"10","ForceSegTime":"1,2,4,6,10,14,18"}`，代表在第1、2、4、6、10、14、18、20、30、40、50...秒處強制分區。
M3U8NonStandardSupport	Object	否	M3U8非標準支援。更多資訊請參見M3U8非標準參數支援詳情。樣本：`{"TS":{"Md5Support":true,"SizeSupport":true}}`，代表支援輸出ts的md5，支援輸出ts的檔案大小。
Encryption	String	否	加密配置，僅當Container為m3u8時生效。更多資訊請參見Encryption參數詳情。樣本：`{"Type":"hls-aes-128","Key":"ZW5jcnlwdGlvbmtleTEyMw","KeyType":"Base64","KeyUri":"aHR0cDovL2FsaXl1bi5jb20vZG9jdW1lbnQvaGxzMTI4LmtleQ=="}`。
UserData	String	否	使用者自訂資料，最大長度1024個位元組。
Priority	String	否	任務在其對應管道內的轉碼優先順序。值範圍：[1,10]，1優先順序最低，10優先順序最高。預設值：6。最佳實務：管道有並發限制，當您提交大量任務可能出現排隊時，建議將時效性、重要內容設定為高優先順序。

Container詳情

本參數被Output.Container引用。

參數

類型

是否必選

描述

Format

String

否

容器格式（封裝格式）。

格式支援：更多格式和與Codec的相容要求，請參見格式支援。
- 視頻：3gp、avi、flv、f4v、fmp4、mkv、mov、mp4、ts、mxf、webm、m3u8、hls-fmp4、mpd、cmaf-hls、cmaf-dash。
- 音頻：aac、m4a、mp2、mp3、mp4、ogg、flac、m3u8、hls-fmp4、mpd、cmaf-hls、cmaf-dash。
- 動圖：gif、webp。
預設值：mp4。

TransConfig詳情

本參數被Output.TransConfig引用。

參數	類型	是否必選	描述
TransMode	String	否	視頻轉碼模式。僅Codec為H.264、H.265、AV1時生效，且不同模式必須搭配Video的Bitrate、Crf正確設定。詳細說明請參見下文視頻碼率控制模式。取值如下： CBR：固定碼率模式。 onepass：一般用於ABR。編碼速度較twopass更快。 twopass：一般用於VBR。編碼速度較onepass更慢。 fixCRF：Crf品質控制模式。預設值：有Bitrate為onepass。沒有Bitrate為fixCRF，Crf使用預設值。
AdjDarMethod	String	否	解析度改寫方式。當Width或Height都填寫時才生效，可以和LongShortMode搭配使用。可選值：rescale、crop、pad、none。預設值：none。樣本：請參見如何設定解析度。
IsCheckReso	String	否	是否檢查視頻解析度。IsCheckReso和IsCheckResoFail只支援二選一，IsCheckResoFail優先順序更高。 true：檢查。當輸入視頻解析度（寬或高）小於輸出設定時，按輸入視頻解析度轉碼。 false：不檢查。預設值：false。
IsCheckResoFail	String	否	是否檢查視頻解析度。IsCheckReso和IsCheckResoFail只支援二選一，本參數優先順序更高。 true：檢查。當輸入視頻解析度（寬或高）小於輸出設定時，返迴轉碼失敗。 false：不檢查。預設值：false。
IsCheckVideoBitrate	String	否	是否檢查視頻碼率。IsCheckVideoBitrate和IsCheckVideoBitrateFail只支援二選一，IsCheckVideoBitrateFail優先順序更高。 true：檢查。當輸入視頻碼率小於輸出設定時，按輸入視頻碼率轉碼。 false：不檢查。預設值：false。
IsCheckVideoBitrateFail	String	否	是否檢查視頻碼率。IsCheckVideoBitrate和IsCheckVideoBitrateFail只支援二選一，本參數優先順序更高。 true：檢查。當輸入視頻碼率小於輸出設定時，返迴轉碼失敗。 false：不檢查。預設值：false。
IsCheckAudioBitrate	String	否	是否檢查音頻碼率。IsCheckAudioBitrate和IsCheckAudioBitrateFail只支援二選一，IsCheckAudioBitrateFail優先順序更高。 true：檢查。當輸入音頻碼率小於輸出設定時，按輸入音頻碼率轉碼。 false：不檢查。預設值：參數為空白，並且codec和輸入源不一樣：false。參數為空白，並且codec和輸入源一樣：true。
IsCheckAudioBitrateFail	String	否	是否檢查音頻碼率。IsCheckAudioBitrate和IsCheckAudioBitrateFail只支援二選一，本參數優先順序更高。 true：檢查。當輸入音頻碼率小於輸出設定時，返迴轉碼失敗。 false：不檢查。預設值：false。

視頻碼率控制模式

請根據視頻碼率控制模式，設定對應的TransMode、Bitrate、vbv（Maxrate、Bufsize）、Crf參數。

視頻率控制模式	TransMode設定	碼率相關參數設定
CBR固定碼率模式	CBR	Bitrate=Maxrate=Bufsize。
ABR平均碼率模式	onepass或不指定	需指定Bitrate。可選指定Maxrate和Bufsize控制峰值碼率波動範圍。
VBR動態碼率模式	twopass	需指定Bitrate、Maxrate和Bufsize參數。
Crf品質控制模式	fixCRF	需指定Crf，若不指定則按對應codec的預設Crf值生效。可選指定Maxrate和Bufsize控制峰值碼率波動範圍。
Crf品質控制模式	不指定	不能指定Bitrate，將按對應codec的預設Crf值生效。

Video詳情

本參數被Output.Video引用。

參數	類型	是否必選	描述
Remove	String	否	是否刪除視頻流。 true：刪除。則本節所有Video相關參數失效。 false：保留。預設值：false。
Codec	String	否	視頻編碼格式。可選值：H.264、H.265、AV1、GIF、WEBP。更多格式和與Container的相容要求，請參見格式支援。預設值：H.264。
Width	String	否	寬度（或長邊）。當LongShortMode為false或未設定時，代表寬度。當LongShortMode為true時，代表視頻的長邊。單位：px。值範圍：[128,4096]，必須為偶數。預設值當Width和Height都未設定：使用輸入視頻的原始寬度（或長邊）。當僅設定Height：按照輸入視頻的原始比例來計算。
Height	String	否	高度（或短邊）。當LongShortMode為false或未設定時，代表視頻的高度。當LongShortMode為true時，代表視頻的短邊。單位：px。值範圍：[128,4096]，必須為偶數。預設值當Width和Height都未設定：使用輸入視頻的原始高度（或短邊）。當僅設定Width：按照輸入視頻的原始比例計算。
LongShortMode	String	否	是否開啟橫豎屏自適應（又稱，長短邊自適應）。當Width或Height至少填寫一項時生效。 true：開啟。 false：關閉。預設值：false。最佳實務：如果您的輸入視頻既有橫屏視頻也有豎屏視頻，為了避免視頻展開變形，請開啟橫豎屏自適應開關，並結合解析度參數設定等比縮放。樣本請參見設定橫豎屏自適應。
Fps	String	否	幀率。單位：fps，幀每秒。值範圍：(0,60]。預設值：輸入檔案的視頻原始幀率，超過60時取60。常見值：24、25、30。
MaxFps	String	否	最大幀率。
Gop	String	否	設定相鄰兩個I幀之間的時間或者幀數間隔。說明 Gop值越大，壓縮率越高，但編碼速度越低、且流媒體單個分區時間長度越長、播放器seek回應時間越長。更多資訊請參見基本概念。主要畫面格間最大時間間隔：{時間}s，時間範圍[1,100000]。主要畫面格間最大幀數間隔：{幀數}，幀數範圍[1,100000]。預設值：10s，代表每10s一個主要畫面格。最佳實務：流媒體播放情境下，為了提高播放器開播速度和seek響應時間長度，建議設定為[2,7]s。
Bitrate	String	否	輸出檔案的視頻平均碼率。使用CBR、ABR、VBR碼控必須設定Bitrate，且TransMode需正確配對設定。詳細說明請參見視頻碼率控制模式。單位：Kbps。值範圍：-1、[10,50000]。-1代表使用輸入視頻的原始碼率。最佳實務： CBR固定碼率模式：需設定TransMode為CBR，且Bitrate=Maxrate=Bufsize。 ABR平均碼率模式：需設定TransMode為onepass，且指定Bitrate。還可指定Maxrate和Bufsize控制碼率波動範圍。 VBR動態碼率模式：需設定TransMode為twopass，且指定Maxrate（或BitrateBnd）和Bufsize參數。
BitrateBnd	String	否	輸出檔案的視頻平均碼率範圍。僅Codec為H.264時生效。樣本：`{"Max":"5000","Min":"1000"}`。
Maxrate	String	否	輸出檔案的視頻碼率峰值。詳細說明請參見視頻碼率控制模式。單位：Kbps。值範圍：[10,50000]。
Bufsize	String	否	碼率控制緩衝區大小。用於控制碼率波動。詳細說明請參見視頻碼率控制模式。說明 Bufsize值越大，碼率的波動越大，視頻品質越高。單位：Kb。值範圍：[1000,128000]。預設值：6000。
Crf	String	否	品質控制因子。使用Crf碼控必須設定Crf，且TransMode需設定為fixCRF，詳細說明請參見視頻碼率控制模式。說明 Crf值越大，視頻品質越低，壓縮率越高。值範圍：[20,51]。預設值：Codec為H.264時，預設值為23；Codec為H.265時，預設值為26；Codec為AV1時，預設值為32。最佳實務： 0為無損，51為最差。建議取值[23,29]。您可根據畫面複雜度進行調節。每增加或減少6，碼率會減少一半或增加一倍，通常同等清晰度下動畫片可以比實拍設定得更高。 Crf以品質為目標，輸出視頻碼率不可預知，可結合Maxrate、Bufsize來控制碼率波動範圍。
Qscale	String	否	視頻品質控制值（VBR模式可用）。說明 Qscale值越大，視頻品質越低，壓縮率越高。僅Codec為H.264時生效。值範圍：[0,51]。
Profile	String	否	編碼層級。更多資訊請參見基本概念。僅Codec為H.264時生效。可選值：baseline、main、high。預設值：high。最佳實務：一個視頻輸出多清晰度時，建議最低清晰度設定baseline，以保證最低端裝置可播放。其他清晰度設定為main或high。
Preset	String	否	H.264編碼器預置模式。說明編碼器選擇越快的速度模式，視頻品質越低。僅Codec為H.264時生效。可選值：veryfast、fast、medium、slow、slower。預設值：medium。
ScanMode	String	否	掃描模式。取值如下：不設定：按輸入檔案的原始模式。 auto：自動去隔行。 progressive：順序掃描（漸進式掃描）。 interlaced：交叉掃描（隔行掃描）。預設值：空，即不設定。最佳實務：交叉掃描雖然比順序掃描更節省資料量，但畫質不佳，所以現在主流視頻製作都採用順序掃描。如果您設定了順序掃描或交叉掃描，但與原視頻模式不符，會導致轉碼失敗。建議您設定原視頻模式或自動去隔行，以提高相容性。
PixFmt	String	否	視頻顏色格式。使用原始顏色格式：PixFmt=""。指定格式可選值：yuv420p、yuvj420p、yuv422p、yuvj422p、yuv444p、yuvj444p、yuv444p161e、pc、bt470bg、 smpte170m等。當Codec為GIF時，支援bgr8。
Crop	String	否	視頻畫面剪裁。支援自動去黑邊或自訂剪裁。請在輸入視頻解析度大於輸出視頻解析度時使用。不要設定解析度改寫參數AdjDarMethod。自動去黑邊：border。自訂剪裁：參數格式為{width}:{height}:{left}:{top}。 width：剪裁後，輸出視頻的寬度。 height：剪裁後，輸出視頻的高度。 left：輸出畫面距離原畫面的左邊距。 top：輸出畫面距離原畫面的上邊距。自訂剪裁樣本：1920:800:0:140。
Pad	String	否	視頻貼黑邊。請在輸入視頻解析度小於輸出視頻解析度時使用。不要設定解析度檢查參數IsCheckReso和IsCheckResoFail、不要設定解析度改寫參數AdjDarMethod。參數格式：{width}:{height}:{left}:{top}。 width：貼黑邊後，輸出視頻的寬度。 height：貼黑邊後，輸出視頻的高度。 left：原畫面距離輸出畫面的左邊距。 top：原畫面距離輸出畫面的上邊距。樣本：1920:1080:0:140。

Audio詳情

本參數被Output.Audio引用。

參數	類型	是否必選	描述
Remove	String	否	是否刪除音頻流。 true：刪除。則本節所有Audio相關參數失效。 false：保留。預設值：false。
Codec	String	否	音頻編解碼格式。可選值：AAC、AC3、EAC3、MP2、MP3、FLAC、OPUS、VORBIS、WMA-V1、WMA-V2、pcm_s16le。更多格式和與Container的相容要求，請參見格式支援。預設值：AAC。
Profile	String	否	音頻編碼層級。僅Codec為AAC時生效。可選值：aac_low、aac_he、aac_he_v2、aac_ld、aac_eld。更多資訊請參見基本概念。預設值：aac_low。
Bitrate	String	否	輸出檔案的音頻碼率。單位：Kbps。值範圍：[8,1000]。預設值：128。常見值：64、128、256。
Samplerate	String	否	採樣率。單位：Hz。可選值：22050、32000、44100、48000、96000。說明不同封裝和編碼格式支援的採樣率不同，完整資訊請參見採樣率支援。例如：音頻Codec為MP3時，所有封裝格式的採樣率不支援96000，且封裝格式為FLV時，採樣率僅支援22050、44100。預設值：44100
Channels	String	否	聲道數。可選值：0、1、2、4、5、6、8。音頻Codec為MP3、OPUS時，支援0、1、2。音頻Codec為AAC、FLAC時，支援0、1、2、4、5、6、8。音頻Codec為VORBIS時，支援2。 Format為mpd時，不支援8。預設值：2。若要保留原聲道數，請設定為0。
Volume	String	否	音量控制，詳細資料請參見下文Volume音量控制詳情。僅支援輸出一路音頻流時設定，多音頻流不支援。

Volume音量控制詳情

本參數被Output.Audio.Volume引用。

參數	類型	是否必選	描述
Method	String	否	音量調整方式。 auto：自動調整。 dynamic：動態調整。 linear：線性調整。預設值：dynamic。
Level	String	否	相對輸入音訊音量提升的幅度。當指定Method為linear時生效。單位：db。值範圍：不超過20db。預設值：-20db。
IntegratedLoudnessTarget	String	否	目標音量。當指定Method為dynamic時生效。單位：db。值範圍：[-70,-5]。預設值：-6。
TruePeak	String	否	最大峰值。當指定Method為dynamic時生效。單位：db。值範圍：[-9,0]。預設值：-1。
LoudnessRangeTarget	String	否	相對目標音量的波動範圍。當指定Method為dynamic時生效。單位：db。值範圍：[1,20]。預設值：8。

轉碼浮水印參數詳情

本參數被Output.WaterMarks引用。

參數	類型	是否必選	描述
Type	String	否	浮水印類型。 Text：文字浮水印。此時必須設定TextWaterMark。 Image：圖片浮水印。此時必須設定圖片浮水印相關參數。預設值：Image。
TextWaterMark	Object	否	文字浮水印配置。更多資訊請參見文字浮水印參數詳情。若Type為Text文字浮水印，此參數必填。樣本：`{"Content":"5rWL6K+V5paH5a2X5rC05Y2w","FontName":"SimSun","FontSize":"16","Top":2,"Left":10}`。
InputFile	Object	否	圖片浮水印檔案，使用OSS的Bucket、Location、Object描述檔案位置。格式及副檔名要求：PNG靜態圖片（副檔名.png）、PNG動圖（副檔名.apng）、MOV檔案（副檔名.mov）、GIF檔案（副檔名.gif）。檔案只支援儲存於OSS上，參數規範請參見Input詳情。在ApsaraVideo for Media ProcessingAPI中，Object必須經過URL Encoding（基於UTF-8編碼）後使用。樣本：`{"Bucket":"example-bucket","Location":"oss-cn-hangzhou","Object":"example-logo.png"}`。說明給HDR視頻添加非HDR圖片浮水印可能會導致偏色。
WaterMarkTemplateId	String	否	圖片浮水印模板ID。若不設定，則圖片浮水印相關參數使用以下預設配置：圖片浮水印位置：TopRight。圖片浮水印水平位移量Dx、垂直位移量Dy：0。圖片浮水印寬度：為輸出解析度寬的0.12倍。圖片浮水印高度：為相對浮水印寬的等比縮放。圖片浮水印顯示時間：從頭到尾。
ReferPos	String	否	圖片浮水印的位置。可選值：TopRight、TopLeft、BottomRight、BottomLeft。
Dx	String	否	圖片浮水印相對輸出視頻的水平位移量。如設定則覆蓋指定浮水印模板中的對應參數。有兩種設定方式：整數型，代表位移像素。單位：px。值範圍：[8,4096]。小數型，代表水平位移量與輸出解析度寬的比率。值範圍：(0,1)。支援4位小數，如0.9999，超出部分自動丟棄。
Dy	String	否	圖片浮水印相對輸出視頻的垂直位移量。有兩種設定方式：整數型，代表位移像素。單位：px。值範圍：[8,4096]。小數型，代表垂直位移量與輸出解析度高的比率。值範圍：(0,1)。支援4位小數，如0.9999，超出部分自動丟棄。
Width	String	否	圖片浮水印寬度。有兩種設定方式：整數型，代表浮水印圖片寬的像素值。範圍：[8,4096]。單位：px。小數型，代表相對輸出視頻解析度寬的百分比。範圍：(0,1)。支援4位小數，如0.9999，超出部分系統自動丟棄。
Height	String	否	圖片浮水印高度。有兩種設定方式：整數型，代表浮水印圖片高的像素值。範圍：[8,4096]。單位：px。小數型，代表相對輸出視頻解析度高的比率。範圍：(0,1)。支援4位小數，如0.9999，超出部分系統自動丟棄。
Timeline	String	否	圖片浮水印的顯示時間。更多資訊請參見Timeline參數詳情。

文字浮水印參數詳情

本參數被Output.WaterMarks.TextWaterMark引用。

參數	類型	是否必選	描述
Content	String	是	文字浮水印內容，內容需做Base64編碼。樣本：添加文字浮水印“測試文字浮水印”，那麼Content的值為“5rWL6K+V5paH5a2X5rC05Y2w”。說明傳入特殊字元（比如emoji、單引號）會導致浮水印輸出截斷或失敗。請先對特殊字元進行轉義後再傳入。
FontName	String	否	字型。可選值：請參見字型支援。預設值：SimSun。
FontSize	Int	否	字型大小。值範圍：(4,120)。預設值：16。
FontColor	String	否	字型顏色。可選值：請參見FontColor的name。預設值：black。
FontAlpha	Float	否	字型透明度。值範圍：(0,1]。預設值：1.0。
BorderWidth	Int	否	描邊寬度。單位：px。值範圍：[0,4096]。預設值：0。
BorderColor	String	否	描邊顏色。可選值：請參見BorderColor的name。預設值：Black。
Top	Int	否	文本上邊距。單位：px。值範圍：[0,4096]。預設值：0。
Left	Int	否	文本左邊距。單位：px。值範圍：[0,4096]。預設值：0。

Timeline參數詳情

本參數被Output.WaterMarks.Timeline引用。

參數

類型

是否必選

描述

Start

String

否

圖片浮水印開始出現時間。

格式：sssss[.SSS]。
值範圍： [0.000,86399.999]。如果開始時間超過片長則轉碼失敗。
預設值：0。
樣本：18000.30。

Duration

String

否

圖片浮水印期間。

ToEND：代表浮水印持續顯示直到片尾。
{持續時間長度}：格式sssss[.SSS]，單位秒。
預設值：ToEND。

浮水印模板配置詳情

本參數被AddWaterMarkTemplate - 新增浮水印模板、UpdateWaterMarkTemplate - 更新浮水印模板介面引用。

參數	類型	是否必選	描述
Type	String	否	浮水印類型。 Image：圖片浮水印。預設值：Image。
ReferPos	String	否	圖片浮水印的位置。可選值：TopRight、TopLeft、BottomRight、BottomLeft。樣本：使用ReferPos、Dx、Dy描述位置請見下圖。
Dx	String	否	圖片浮水印相對輸出視頻的水平位移量。有兩種設定方式：整數型，代表位移像素。單位：px。值範圍：[8，4096]。小數型，代表水平位移量與輸出解析度寬的比率。值範圍：(0，1)。支援4位小數，如0.9999，超出部分自動丟棄。
Dy	String	否	圖片浮水印相對輸出視頻的垂直位移量。有兩種設定方式：整數型，代表位移像素。單位：px。值範圍：[8，4096]。小數型，代表垂直位移量與輸出解析度高的比率。值範圍：(0，1)。支援4位小數，如0.9999，超出部分自動丟棄。
Width	String	否	圖片浮水印寬度。有兩種設定方式：整數型：代表浮水印圖片寬的像素值。單位：px。範圍：[8,4096]。小數型：代表相對輸出視頻解析度寬的比率。值範圍：(0，1)。支援4位小數，如0.9999，超出部分系統自動丟棄。
Height	String	否	圖片浮水印高度。有兩種設定方式：整數型：代表浮水印圖片高的像素值。單位：px。範圍：[8,4096]。小數型：代表相對輸出視頻解析度高的比率。值範圍：(0，1)。支援4位小數，如0.9999，超出部分系統自動丟棄。
Timeline	String	否	動態浮水印。更多資訊請參見Timeline參數詳情。

使用ReferPos、Dx、Dy描述浮水印位置說明：

使用Width、Height描述浮水印寬、高說明：

寬、高都不設定時，浮水印寬取輸出視頻解析度寬的0.12倍，浮水印高按浮水印原圖寬高比例等比縮放。
寬或高設定一邊，另一邊不設定時，則另一邊按浮水印原圖寬高比等比縮放。
寬、高兩邊都設時，按實際設定值設定浮水印圖片。

模糊處理詳情

本參數被Output.DeWatermark引用。

{
//0ms開始，對距離視頻畫面左上方10×10像素處，大小為10×10像素的Logo，以及距離左邊距100像素，上邊距0.1×（src_height）的位置10×10的Logo進行模糊處理。
       "0": [
              {
                "l": 10,
                "t": 10,
                "w": 10,
                "h": 10
              },
              {
                "l": 100,
                "t": 0.1,
                "w": 10,
                "h": 10
              }
            ],
  //128000ms開始，停止對Logo進行模糊處理，即，[0~128000]ms為對Logo進行模糊處理的時間段。
     "128000": [],
  //250000ms開始，在左邊距0.2×（src_width）、上邊距0.1×（src_height）處，對大小為寬0.01×（src_width），高0.05×（src_height）的Logo進行模糊處理。
  "250000": [
              {
                "l": 0.2,
                "t": 0.1,
                "w": 0.01,
                "h": 0.05
              }
            ]
 }

欄位說明

pts：字元，指對象幀的時間戳記。單位：毫秒（ms）。
l：指模糊處理地區的左邊距。
t：指模糊處理地區的上邊距。
w：指模糊處理地區的寬度。
h：指模糊處理地區的高度。

當l、t、w、h的值大於 1 時，表示絕對像素值。否則，表示相對片源解析度的比例值。無論是比例值還是絕對值，都會在最終處理時進行截整處理。

SubtitleConfig詳情

本參數被Output.SubtitleConfig引用。

參數

類型

是否必選

描述

ExtSubtitleList

Object[]

否

外部字幕列表。更多資訊請參見ExtSubtitle詳情。

一次轉碼任務最多壓制4個字幕檔案。
樣本：[{"Input":{"Bucket":”example-bucket","Location":"oss-cn-hangzhou","Object":"example.srt"},"CharEnc":"UTF-8"}]。

ExtSubtitle詳情

本參數被Output.SubtitleConfig.ExtSubtitle引用。

參數	類型	是否必選	描述
Input	String	是	外部字幕檔案，使用OSS的Bucket、Location、Object描述檔案位置。支援使用srt、ass格式。會讀取檔案內的顏色資訊。檔案只支援儲存於OSS上，參數規範請參見Input詳情。支援使用預留位置，詳細說明請參見預留位置替換規則。在ApsaraVideo for Media ProcessingAPI中，Object必須經過URL Encoding說明基於UTF-8編碼）後使用。樣本：轉碼輸入檔案路徑為a/b/example.flv，若字幕檔案路徑為a/b/example-cn.mp4，則字幕檔案的Object用預留位置可表示為{ObjectPrefix}{FileName}-cn.srt。再經過URL Encoding後，最終可設定為`{"Bucket":"example-bucket","Location":"oss-cn-hangzhou","Object":"%7bObjectPrefix%7d%7bFileName%7d-cn.srt"}`。說明如果字幕檔案的時間長度超過了視頻時間長度，以視頻時間長度為準。如果字幕的文字過多，無法在一行內展示完整，超出部分字幕會被截斷。
CharEnc	String	否	外部字幕字元編碼。可選值：UTF-8、GBK、BIG5、auto。預設：auto。說明外部字幕字元編碼設定為auto時，存在誤檢情況，建議您指定具體的字元編碼。
FontName	String	否	字幕字型。可選值：請參見字型支援。預設值：SimSun。
FontSize	Int	否	字幕字型大小。值範圍：(4,120)。預設值：16。

Clip詳情

本參數被Output.Clip引用。

參數

類型

是否必選

描述

TimeSpan

String

否

剪輯時間區間。更多資訊請參見下文TimeSpan詳情。

設定持續時間長度樣本：{"Seek":"00:01:59.999","Duration":"18000.30"}，代表從1分59秒999毫秒開始，截取到第5分30毫秒為止。
設定截尾時間長度樣本：{"Seek":"00:01:59.999","End":"18000.30"}，代表從1分59秒999毫秒開始，截取到距離片尾剩餘5分30毫秒為止。

ConfigToClipFirstPart

Boolean

否

是否對第一個剪輯片段進行剪輯。

true：先剪輯第一個片段，再拼接（轉碼）。
false：先拼接（轉碼），再剪輯。
預設值：false。

TimeSpan詳情

本參數被Output.Clip.TimeSpan引用。

參數	類型	是否必選	描述
Seek	String	否	開始時間點。可以設定剪輯的開始時間點。預設從開頭截取。格式：hh:mm:ss[.SSS]或sssss[.SSS]。值範圍：[00:00:00.000,23:59:59.999]或[0.000,86399.999]。樣本：00:01:59.999或18000.30。
Duration	String	否	持續時間長度。可以設定相對於開始時間點（Seek）的剪輯時間長度。預設從開始時間點（Seek）到結尾的全部內容。Duration和End參數只支援二選一，設定End則Duration失效。格式：hh:mm:ss[.SSS]或sssss[.SSS]。值範圍：[00:00:00.000,23:59:59.999]或[0.000,86399.999]。樣本：00:01:59.99 或18000.30。
End	String	否	截尾時間長度，表示切掉尾部的若干時間長度。Duration和End參數只支援二選一，設定End則Duration失效。格式：hh:mm:ss[.SSS]或sssss[.SSS]。值範圍：[00:00:00.000,23:59:59.999]或[0.000,86399.999]。樣本：00:01:59.999或18000.30。

MergeList拼接參數詳情

本參數被Output.MergeList引用。

參數	類型	是否必選	描述
MergeURL	String	是	拼接片段OSS地址。在ApsaraVideo for Media ProcessingAPI中，Object必須經過URL Encoding說明（基於UTF-8編碼）後使用。樣本：`http://exampleBucket****m.oss-cn-hangzhou.aliyuncs.com/tail_comm_01.mp4`。
Start	String	否	起始時間點。拼接視頻時，如果您期望只截取部分內容輸出到最終視頻，可以設定截取的開始時間點。預設從開頭截取。格式：hh:mm:ss[.SSS]或sssss[.SSS]。值範圍：[00:00:00.000,23:59:59.999]或[0.000,86399.999]。樣本：01:59:59.999或32000.23。
Duration	String	否	期間。拼接視頻時，如果您期望只截取部分內容輸出到最終視頻，可以設定相對於開始時間點（Start）的截取時間長度。預設從開始時間點（Start）到結尾的全部內容。格式：hh:mm:ss[.SSS]或sssss[.SSS]。值範圍：[00:00:00.000,23:59:59.999]或[0.000,86399.999]。樣本：01:59:59.999或者32000.23。

OpeningList詳情

本參數被Output.OpeningList引用

參數	類型	是否必選	描述
OpenUrl	String	是	開板視頻的OSS地址。在ApsaraVideo for Media ProcessingAPI中，Object必須經過URL Encoding說明（基於UTF-8編碼）後使用。樣本：`http://exampleBucket****.oss-cn-hangzhou.aliyuncs.com/opening_01.flv`。
Start	String	否	相對正片視頻的開始時間。從0開始延遲多長時間後顯示開板視頻。單位：秒。預設值：0。
Width	String	否	輸出開板視頻的寬。有3種設定方式：指定寬：單位px，值範圍[0,4096]。 -1：代表等於輸入開板視頻的寬。 full：代表填滿正片視頻畫面。預設值：-1。說明輸出的開板視頻會以正片視頻中心點為基準，置中對齊。開板視頻不要超過正片視頻寬，否則效果未知。
Height	String	否	輸出開板視頻的高。有3種設定方式：指定寬：單位px，值範圍[0,4096]。 -1：代表等於輸入開板視頻的高。 full：代表填滿正片視頻畫面。預設值：-1。說明輸出的開板視頻會以正片視頻中心點為基準，置中對齊。開板視頻不要超過正片視頻高，否則效果未知。

TailSlateList詳情

本參數被Output.TailSlateList引用。

參數	類型	是否必選	描述
TailUrl	String	是	尾板視頻的OSS URL地址。在ApsaraVideo for Media ProcessingAPI中，Object必須經過URL Encoding說明（基於UTF-8編碼）後使用。樣本：`http://exampleBucket****.oss-cn-hangzhou.aliyuncs.com/tail_01.flv`。
BlendDuration	String	否	正片視頻和尾板視訊轉換的時間長度。過渡的效果是淡入淡出：正片顯示最後一幀，同時播放尾板視頻，正片最後一幀逐步變暗，尾板視頻逐步變亮。單位：秒。預設值：0。
Width	String	否	輸出尾板視頻的寬。有3種設定方式：指定寬：單位px，值範圍[0,4096]。 -1：代表等於輸入尾板視頻的寬。 full：代表填滿正片視頻畫面。預設值：-1。說明輸出的尾板視頻會以正片視頻中心點為基準，置中對齊。尾板視頻不要超過正片視頻寬，否則效果未知。
Height	String	否	輸出尾板視頻的高。有3種設定方式：指定寬：單位px，值範圍[0,4096]。 -1：代表等於輸入尾板視頻的高。 full：代表填滿正片視頻畫面。預設值：-1。說明輸出的尾板視頻會以正片視頻中心點為基準，置中對齊。尾板視頻不要超過正片視頻高，否則效果未知。
IsMergeAudio	Boolean	否	是否要拼接尾板視頻的音頻內容。 true：拼接。 false：不拼接。預設值：true。
BgColor	String	否	當尾板視頻的寬、高小於正片時，空白處填充的背景色。可選值：請參見bgcolor的name。預設值：White。

Amix混音詳情

本參數被Output.Amix引用。

參數	類型	是否必選	描述
AmixURL	String	是	需要被混音的音頻流。支援2種模式： input：適用於同一視頻的多音軌合并。代表將輸入檔案中的兩路音頻流合并。 OSS地址：適用於添加外部背景音樂。代表將輸入檔案的一路音頻流與OSS地址中的目標音頻流合并。樣本：`http://exampleBucket****.oss-cn-hangzhou.aliyuncs.com/tail.flv`。
Map	String	否	在AmixURL中選取目標音頻流，需搭配AudioStreamMap參數指定Input檔案中要混音的另一路音頻流序號。格式：0:a:{序號}，序號的含義是音頻流列表的下標，序號從0開始。樣本：0:a:1，代表選擇第2個音頻流參與混音。
MixDurMode	String	否	混音後輸出檔案的時間長度模式。 first：代表以輸入檔案的時間長度為準。 longest：代表以輸入檔案和AmixURL中時間長度最長的為準。預設值：longest。
Start	String	否	起始時間點。混音時，如果您期望只截取部分內容輸出到最終音頻，可以設定截取的開始時間點。預設從開頭截取。格式：hh:mm:ss[.SSS]或sssss[.SSS]。值範圍：[00:00:00.000,23:59:59.999]或[0.000,86399.999]。樣本：00:01:59.999或18000.30。
Duration	String	否	期間。混音時，如果您期望只截取部分內容輸出到最終音頻，可以設定相對於開始時間點（Start）的截取時間長度。預設從開始時間點（Start）到結尾的全部內容。格式：hh:mm:ss[.SSS]或sssss[.SSS]。值範圍：[00:00:00.000,23:59:59.999]或[0.000,86399.999]。樣本：00:01:59.999或18000.30。

MuxConfig詳情

本參數被Output.MuxConfig引用。

參數

類型

是否必選

描述

Segment

String

否

分區配置欄位。更多資訊請參見Segment詳情。

僅當Container為m3u8、hls-fmp4、mpd、cmaf時生效。
樣本：{"Duration":"10","ForceSegTime":"1,2,4,6,10,14,18"}。代表在第1、2、4、6、10、14、18、20、30、40、50...秒處強制分區。

Segment詳情

本參數被Output.MuxConfig.Segment引用。

參數

類型

是否必選

描述

Duration

Int

否

分區時間長度。

單位：秒。
值範圍：[1,60]。
預設值：10。代表在第10、20、30、40秒處強制分區。

ForceSegTime

String

否

指定分區時間點列表。時間點之間逗號分隔，最多指定10個。

格式：{時間點},{時間點},{時間點}。
時間點格式：小數型，最多3位小數。
時間點單位：秒。
樣本：1,2,4,6,10,14,18，代表在第1、2、4、6、10、14、18秒處強制分區。

M3U8非標準參數支援詳情

本參數被Output.M3U8NonStandardSupport引用。

參數	類型	是否必選	描述
TS	Object	否	TS檔案相關非標準支援。更多資訊請參見TS參數支援詳情。

TS參數支援詳情

本參數被Output.M3U8NonStandardSupport.TS引用。

參數	類型	是否必選	描述
Md5Support	Boolean	否	是否支援在M3U8檔案中輸出ts的md5值。
SizeSupport	Boolean	否	是否支援在M3U8檔案中輸出ts檔案的大小。

Encryption參數詳情

本參數被Output.Encryption引用。

參數	類型	是否必選	描述
Type	String	是	視頻的加密方式。取值如下： hls-aes-128：標準加密。
KeyType	String	是	密鑰的加密方式。 Base64：基礎加密方式。 KMS：Key Management Service方式。使用KMS服務產生清除金鑰、密文密鑰。
Key	String	是	加密視頻的密文密鑰。請根據密鑰的加密方式填寫。 Base64：請填寫清除金鑰經過Base64加密後產生的密文密鑰。清除金鑰內容自訂，長度最多16位。樣本：清除金鑰"encryptionkey128"對應的密文密鑰"ZW5jcnlwdGlvbmtleTEyOA=="。 KMS：調用KMS的GenerateKMSDataKey，傳入主要金鑰，KeySpec選擇AES_128，擷取密文密鑰CiphertextBlob。說明我們提供主要金鑰，請您聯絡我們。
KeyUri	String	是	解密服務地址。解密服務需由您自己搭建。 KeyUri不能明文傳輸給MPS，需經過Base64加密。樣本：如訪問URL為http://aliyun.com/document/hls128.key，則經過Base64加密後傳入“aHR0cDovL2FsaXl1bi5jb20vZG9jdW1lbnQvaGxzMTI4LmtleQ==”。
SkipCnt	String	否	開頭不加密分區數量，可以便於視頻快速起播。樣本：3。

預留位置替換規則

檔案路徑支援使用以下預留位置。

樣本：輸入檔案路徑為a/b/example.flv，若想輸出檔案路徑為a/b/c/example+test.mp4，則OutputObject需要使用{ObjectPrefix}、{FileName}預留位置，再經過URL Encoding後，最終設定為%7BObjectPrefix%7D/c/%7BFileName%7D%2Btest.mp4。

預留位置說明		轉碼Output		字幕Input	截圖OutputFile
預留位置	說明	使用工作流程轉碼	提交轉碼作業	字幕	使用工作流程截圖	提交截圖作業
{ObjectPrefix}	輸入檔案首碼	支援	支援	支援	支援	支援
{FileName}	輸入檔案名稱	支援	支援	支援	支援	支援
{ExtName}	輸入副檔名	支援	支援	支援	支援	支援
{DestMd5}	輸出檔案的Md5值	支援	支援	不支援	不支援	不支援
{DestAvgBitrate}	輸出檔案的平均碼率	支援	支援	不支援	不支援	不支援
{SnapshotTime}	截圖時間點	不支援	不支援	不支援	支援	支援
{Count}	批量截圖的圖片序號	不支援	不支援	不支援	支援	支援
{RunId}	工作流程執行執行個體ID	支援	不支援	不支援	不支	不支援
{MediaId}	工作流程媒體ID	支援	不支援	不支援	不支	不支援

SnapshotConfig參數詳情

本參數被SubmitSnapshotJob - 提交截圖作業引用。

重要

截圖作業分為同步和非同步模式。非同步模式不保證時效性，在提交截圖作業後，任務會添加到管道中排隊，被調度執行。所以在介面返回時，不保證截圖已經產生。執行完成後需要調用QuerySnapshotJobList - 查詢截圖作業結果介面輪詢執行結果，或通過為管道綁定MNS訊息接收執行結果，詳細說明請參見接收訊息通知。只要設定了Interval和Num中的任何一個參數，就表示使用非同步模式。

參數	類型	是否必選	描述
Num	String	否	截圖數量。只要指定了Interval和Num中的任何一個參數，則表示使用非同步模式。且Num必須大於0。同步單張截圖：Num和Interval不設定。代表在指定Time時間點截取1張。非同步單張截圖：Num=1。代表在指定Time時間點截取1張。非同步多張截圖：Num>1。代表從指定Time時間點開始，按指定Interval（或預設值10秒）的間隔截取指定Num張數。當Time＋Interval＊Num的截取點超過視頻時間長度時，後續截圖自動失效，截圖完成時返回實際截取的張數。非同步平均截圖：Num>1，且Interval=0。代表從指定Time時間點開始，均勻截取Num張圖片。
Time	String	否	截圖開始時間。單位：毫秒若Time超過視頻時間長度會返回截圖失敗。在指定時間點截圖情境中，此參數無需設定。其他截圖情境此參數必填。說明在指定時間點截圖情境中，MPS會取的TimeArrayTimeArray參數中最小的一個時間點，轉換為毫秒，即為該情境下的Time值，如果使用者輸出路徑中設定預留位置`{SnapshotTime}`，則取Time時間進行替換。
Interval	String	否	截圖間隔時間。若指定則表示使用非同步模式截圖。非同步多張截圖：Interval>0 。單位：秒。非同步平均截圖：Interval=0。預設值：10。當指定Num且此參數未設定時按預設值提交。
TimeArray	Array	否	指定時間點數組，指定時間點截圖時必填。單位毫秒，整數，不可重複。時間點不能超過片源長度，否則會導致截圖失敗。可有序或無序提交。推薦您提交有序時間點，無序提交時，將由MPS進行排序。重要指定該參數時，Num、Time、Interval均不指定。如指定則提示參數指定錯誤InvalidParameter.Ambiguity。指定時間點截圖支援ApsaraVideo for Media ProcessingSDK3.3.60及以上版本。版本查詢入口請單擊查詢。
FrameType	String	否	截圖類型。預設值：intra。 normal：普通幀。畫質稍差，執行速度較慢。優點是可以根據設定的時間點精確截取映像。 intra：主要畫面格。因為視頻編碼的特點，主要畫面格映像的優點是畫質好，執行速度快。但由於視頻中主要畫面格是間隔一段時間才會出現，所以截圖時間點不精確，會在設定的時間點附近尋找相應的主要畫面格。且若GOP值大於截圖間隔時間，會因為找不到足夠多的主要畫面格，而導致截圖數量低於設定值。說明指定時間點截圖情境僅支援normal（普通幀）截圖。
Width	String	否	截圖輸出圖片寬度。單位：px。值範圍：[8,4096]。建議為偶數。預設值：當寬和高都未設定：按輸入檔案的視頻原始寬度。當僅設定高：按照輸入檔案等比例計算。
Height	String	否	截圖輸出圖片高度。單位：px。值範圍：[8,4096]。建議為偶數。預設值：當寬和高都未設定：按輸入檔案的視頻原始高度。當僅設定寬：按照輸入檔案等比例計算。
BlackLevel	String	否	首幀黑屏檢測參數，畫面中黑色像素佔據畫面的比例，超過該比例值則認為是黑屏。黑色像素定義見PixelBlackThreshold參數。生效條件： Time=0，參數生效，過濾黑屏。Time>0，放棄過濾黑屏。當Time=0且Num=1或不指定，檢測開始5秒資料，如果有非黑屏圖片，則截取非黑屏圖片；否則返回截圖失敗。當Time=0且Num>1，參數只對第一張截圖生效，檢測開始5秒資料，如果有非黑屏圖片，則截取非黑屏圖片；如果全是黑屏圖片，則截取第一幀黑屏圖片。參數說明：值範圍：[30,100]。預設值：100。最佳實務：純黑請設定成100。樣本：Time=0且Num=10，代表要對首圖做黑屏過濾。
PixelBlackThreshold	String	否	首幀黑屏檢測參數，像素的顏色值，小於該閾值則認為是黑色像素。值範圍：[0,255]。0為純黑色，255為純白色。最佳實務：如果過濾效果不明顯，可以提高值來擴大黑色像素的判定範圍。建議從30開始嘗試。樣本：100，即像素的顏色值小於100的都認為是黑色像素。
Format	String	否	輸出格式。 vtt：代表輸出webvtt，請同時設定SubOut參數控制是否產生webvtt檔案。預設值：空，代表jpg。
SubOut	Object	否	Webvtt配置。更多資訊請參見SubOut Webvtt配置詳情。 Format為vtt時必填。
TileOut	Object	否	拼圖配置。更多資訊請參見TileOut拼圖配置詳情。配置後會產生拼圖大圖，並儲存到TileOutputFile。不配置則不產生拼圖。
OutputFile	Object	是	輸出的單張小圖檔案，使用OSS的Bucket、Location、Object描述檔案位置。更多資訊請參見OutputFile截圖詳情。截圖檔案格式為jpg。樣本：{"Bucket":"example-bucket","Location":"oss-cn-hangzhou","Object":"example.jpg"}。
TileOutputFile	Object	否	輸出的拼圖大圖檔案，使用OSS的Bucket、Location、Object描述檔案位置。結構同OutputFile。當配置了TileOut，即產生拼圖時必填。拼圖檔案格式為jpg。樣本：{"Bucket":"example-bucket","Location":"oss-cn-hangzhou","Object":"example.jpg"}。說明當Num>1時，Object必須包含預留位置{TileCount}，經過URL Encoding後為%7BTileCount%7D，用於區分多張截圖的輸出地址。如要截取3張圖片，Object為%7BTileCount%7D.jpg，則輸出圖片Object依次為00001.jpg，00002.jpg，00003.jpg。當既要在OutputFile保留單張小圖，又在TileOutputFile保留拼圖大圖時，請設定不同的Object，以免被覆蓋。

SubOut Webvtt配置詳情

本參數被SnapshotConfig.SubOut引用。

參數

類型

是否必選

描述

IsSptFrag

String

否

是否產生webvtt索引檔案。

true：產生webvtt索引檔案。並跟隨截圖檔案儲存體到同一路徑。
false：不產生webvtt索引檔案，只輸出截圖。
預設：false。

TileOut拼圖配置詳情

本參數被SnapshotConfig.TileOut引用。

參數	類型	是否必選	描述
Lines	Int	否	圖片拼合行數。值範圍：(0,10000]。預設：10。
Columns	Int	否	圖片拼合列數。值範圍：(0,10000]。預設：10。
CellWidth	String	否	單圖片寬度。單位：px。預設值：截圖輸出解析度寬度。
CellHeight	String	否	單圖片高度。單位：px。預設值：截圖輸出解析度高度。
Padding	String	否	單圖圖片間距。單位：px。預設值：0。
Margin	String	否	外框寬度。預設：0。單位：px。
Color	String	否	背景顏色。間距、外框和未填充圖片的地區會顯示該顏色。值範圍：顏色關鍵字，random。其中顏色關鍵字支援三種格式，比如黑色，支援Black，black，#000000。預設：black。
IsKeepCellPic	String	否	是否保留單張小圖。 true：保留，並且單圖會儲存到OutputFile中。 false：不保留。預設：false，不保留。

OutputFile截圖詳情

參數	類型	是否必選	描述
Bucket	String	是	單張小圖輸出檔案所在的OSS Bucket。遵守OSS Bucket定義，更多資訊請參見基本概念。
Location	String	是	單張小圖輸出檔案所在的OSS Bucket的地區（OSS Region）。 OSS Bucket必須與ApsaraVideo for Media Processing服務在同一個地區。遵守OSS Region定義，更多資訊請參見基本概念。
Object	String	是	單張小圖輸出檔案的OSS路徑（OSS ObjectKey）。即包含檔案名稱、副檔名在內的完整路徑。遵循OSS ObjectKey定義，更多資訊請參見基本概念。支援使用預留位置，詳細說明請參見預留位置替換規則。副檔名：僅支援jpg。在ApsaraVideo for Media ProcessingAPI中，Object必須經過URL Encoding說明（基於UTF-8編碼）後使用。說明當Num>1時，Object必須包含預留位置{Count}，經過URL Encoding後為%7BCount%7D，用於區分多張截圖的輸出地址。如要截取3張圖片，Object為%7BCount%7D.jpg，則輸出圖片Object依次為00001.jpg，00002.jpg，00003.jpg。當既要在OutputFile保留單張小圖，又在TileOutputFile保留拼圖大圖時，請設定不同的Object，以免被覆蓋。

NotifyConfig詳情

本參數被AddPipeline - 添加管道、UpdatePipeline - 更新管道：名稱、狀態及通知設定介面引用。

參數

類型

是否必選

描述

QueueName

String

否

綁定的MNS隊列。綁定後，當該管道上的作業執行結束時，會將執行結果發送到該隊列。訊息設定請參見接收訊息通知。

QueueName與Topic二選一。
可選值：您已經建立的MNS主題，若無可用主題請先前往輕量訊息佇列（原MNS）中建立。

Topic

String

否

綁定的MNS主題。綁定後，當該管道上的作業執行結束時，會將執行結果發送到該主題。主題會以訊息形式推送到多個隊列或訂閱的地址上，訊息設定請參見接收訊息通知。

QueueName與Topic二選一。
可選值：您已經建立的MNS主題，若無可用主題請先前往輕量訊息佇列（原MNS）中建立。

轉碼作業輸入詳情

參數	類型	是否必選	描述
Bucket	String	是	輸入檔案所在OSS Bucket。需在控制台中資源控制頻道裡的Bucket授權頁面授予此Bucket讀許可權給ApsaraVideo for Media Processing服務。遵守OSS Bucket定義，更多資訊請參見術語表。
Location	String	是	輸入OSS Bucket所在資料中心（OSS Location）。遵守OSS Location定義，更多資訊請參見術語表。
Object	String	是	輸入檔案（OSS Object）。遵循RFC 2396（UTF-8編碼，並進行URLEncode，更多資訊，請參見URL Encoding說明）。遵守OSS Object定義，更多資訊請參見術語表。
Audio	String	否	源媒體檔案的音頻配置，JSON對象。說明當輸入檔案為ADPCM、PCM格式時，此參數為必填項。更多資訊請參見InputAudio詳情。樣本：`{"Channels":"2","Samplerate":"44100"}`。
Container	String	否	源媒體檔案容器配置，JSON對象。說明當輸入檔案為ADPCM、PCM格式時此參數為必填項。更多資訊請參見InputContainer詳情。樣本：`{"Format":"u8"}`。

InputContainer詳情

參數

類型

是否必選

描述

Format

String

是

源媒體音頻格式。

取值：alaw、f32be、f32le、f64be、f64le、mulaw、 s16be, s16le, s24be、s24le、s32be、s32le、s8、u16be、u16le、 u24be、u24le、u32be、u32le、u8

InputAudio詳情

參數

類型

是否必選

描述

Channels

String

是

源媒體音頻聲道數。範圍：[1，8]。

Samplerate

String

是

源媒體音頻採樣率。

範圍：(0，320000]
單位：Hz

AnalysisConfig詳情

參數	類型	是否必選	描述
QualityControl	String	否	輸出品質控制，JSON對象。更多資訊請參見AnalysisConfig詳情。
PropertiesControl	String	否	屬性控制，JSON對象。更多資訊請參見PropertiesControl詳情。

QualityControl詳情

參數

類型

是否必選

描述

RateQuality

String

否

輸出品質等級。

值範圍：(0，51）
值為整數
預設值：25

MethodStreaming

String

否

播放方式，network或local。

預設值：network

PropertiesControl詳情

參數

類型

是否必選

描述

Deinterlace

String

否

強制掃描模式判定。

Auto：自動。
Force：強製做deinterlace。
None：強制不做。

Crop

String

否

視頻裁切配置。

預設：自動。
如此值不是空JSON{}，則它的屬性Mode必填。
更多資訊請參見Crop詳情。

Crop詳情

參數	類型	是否必選	描述
Mode	String	否	如Crop不是空JSON{}，則此值必填。取值： Auto：自動 Force：強制 None：強制不做
Width	Integer	否	裁切後寬。範圍：[8，4096] 如MODE為Auto、None，此值失效
Height	Integer	否	裁切後高。範圍：[8，4096] 如MODE為Auto、None，此值失效
Top	Integer	否	裁切上邊距。範圍：[8，4096] 如MODE為Auto、None，此值失效
Left	Integer	否	裁切左邊距。範圍：[8，4096] 如MODE為Auto、None，此值失效

TransFeatures詳情

參數

類型

是否必選

描述

MergeList

String

否

視頻拼接配置欄位。

JSON數組，最多支援4個MergeURL。更多資訊請參見MergeList拼接參數詳情。
樣本：[{"MergeURL":"http://example-bucket-****.oss-cn-hangzhou.aliyuncs.com/k/mp4.mp4"},{"MergeURL":"http://example-bucket-****.oss-cn-hangzhou.aliyuncs.com/c/ts.ts","Start":"1:14","Duration":"29"}]。

作業輸出檔案詳情

參數	類型	是否必選	描述
URL	String	否	輸入檔案的OSS URL。樣本：`http://example-bucket-****.oss-cn-hangzhou.aliyuncs.com/example.flv`。若不指定URL，則Bucket、Location、Object必填。
Bucket	String	否	若不指定URL，則此值必填。否則，此值失效，輸出檔案所在OSS Bucket，需在控制台中資源控制頻道裡的Bucket授權頁面授予此Bucket寫入權限給ApsaraVideo for Media Processing服務。遵守OSS Bucket定義，更多資訊請參見術語表。
Location	String	否	若不指定URL，則此值必填。否則，此值失效，輸出OSS Bucket所在資料中心（OSS Location）。遵守OSS Location定義，更多資訊請參見術語表。
Object	String	否	若不指定URL，則此值必填。若此值失效，輸出檔案（OSS Object）遵循RFC 2396（UTF-8編碼，並進行URLEncode，更多資訊，請參見URL Encoding說明）。遵守OSS Object定義，更多資訊請參見術語表。

MultiBitrateVideoStream詳情

參數	類型	是否必選	描述
URI	String	否	視頻流輸出名稱，必須以.m3u8結尾，樣本：a/b/test.m3u8，格式：^[a-z]{1}[a-z0-9./-]+$。
RefActivityName	String	是	關聯的活動名稱。
ExtXStreamInfo	Json	是	碼流屬性。樣本：`{"BandWidth": "111110","Audio": "auds","Subtitles": "subs"}`。

ExtXMedia詳情

參數	類型	是否必選	描述
Name	String	是	必填項，描述，對應於HLS V5協議的NAME,最多64位元組，UTF-8。
Language	String	否	可選項，語言類型，RFC5646，對應於HLS V5協議LANGUAGE。
URI	String	是	必填，資源路徑。樣本：a/b/c/d/audio-1.m3u8，格式：^[a-z]{1}[a-z0-9./-]+$。

MasterPlayList詳情

參數	類型	是否必選	描述
MultiBitrateVideoStreams	JsonArray	是	多碼流數組。樣本：`[{"RefActivityName": "video-1","ExtXStreamInfo": {"BandWidth": “111110”,"Audio":"auds","Subtitles": "subs"}}]`。

ExtXStreamInfo詳情

參數	類型	是否必選	描述
BandWidth	String	是	頻寬。總碼率上限，必填項，對應於HLS V5協議的BANDWIDTH。
Audio	String	否	音頻流分組ID。可選，對應於HLS V5協議的AUDIO。
Subtitles	String	否	字幕流分組ID。可選，對應於HLS V5協議的SUBTITLES。

AdaptationSet詳情

參數

類型

是否必選

描述

Group

String

是

必填，組名，樣本如下：

<AdaptationSet group="videostreams" mimeType="video/mp4" par="4096:1744"
              minBandwidth="258157" maxBandwidth="10285391" minWidth="426" maxWidth="4096"
              minHeight="180" maxHeight="1744" segmentAlignment="true"
              startWithSAP="1">

Lang

String

否

語言。音頻和字幕活動時，可填。

Representation詳情

參數

類型

是否必選

描述

String

是

必填，流ID，樣本如下：

<Representation id="240p250kbps" frameRate="24" bandwidth="258157"
              codecs="avc1.4d400d" width="426" height="180">

URI

String

是

必填，資源路徑。樣本：a/b/c/d/video-1.mpd，格式：^[a-z]{1}[a-z0-9./-]+$。

InputConfig詳情

參數	類型	是否必選	描述
Format	String	是	必填，字幕檔案的輸入格式。支援 stl、ttml、vtt。
InputFile	String	是	`{"Bucket":"example-bucket-**","Location":"oss-cn-hangzhou","Object":"example-logo.png"} 或 {"URL":"http://exampleBucket.oss-cn-hangzhou.aliyuncs.com/subtitle/test**.chs.vtt"}`