411
windows
參數詳情__附錄_API使用手冊_媒體轉碼-阿裏雲
1 Input詳情
名稱 |
類型 |
必填項 |
描述 |
---|
Bucket |
String |
是 |
輸入文件所在OSS Bucket,需在控製台中資源控製頻道裏的Bucket授權頁麵授予此Bucket讀權限給媒體轉碼服務,遵守OSS Bucket定義,見術語表Bucket |
Location |
String |
是 |
輸入OSS Bucket所在數據中心(OSS Location),遵守OSS Location定義,見術語表Location |
Object |
String |
是 |
輸入文件 (OSS Object),須進行UrlEncode,使用UTF-8編碼,遵守OSS Object定義,見術語表Object |
2 Output詳情
名稱 |
類型 |
必填項 |
描述 |
---|
OutputObject |
String |
是 |
輸出的文件名(OSS Object),須進行Url Encode,使用UTF-8編碼。如果容器類型為m3u8,則媒體轉碼服務會給Playlist自動添加擴展名 .m3u8 ,分片文件名會在Playlist後自動加一個從00001開始的5位序列號為後綴並以 - 號相連,文件擴展名為 .ts。 例如:Playlist文件名為filename.m3u8,則輸出第一個ts分片文件為filename-00001.ts。 |
TemplateId |
String |
是 |
轉碼模板ID,支持自定義轉碼模板與係統預置模板。 |
WaterMarks |
WaterMark[] |
否 |
JSON數組,水印列表,請參照5 轉碼水印參數詳情,水印數組大小上限為4,既同一路輸出最多支持4個水印,示例:
[{
"InputFile":{
"Bucket":"example-bucket",
"Location":"oss-cn-hangzhou",
"Object":"example-logo.png"
},
"WaterMarkTemplateId":"88c6ca184c0e47098a5b665e2a126797"
}] |
Clip |
String |
否 |
JSON對象,剪輯片段,請參照3 Clip詳情,示例:
{
"TimeSpan":{
"Seek":"123.45",
"Duration":"3.45"
}
} |
Rotate |
String |
否 |
視頻旋轉角度,範圍[0,360),順時針。 |
Container |
String |
否 |
如設置則覆蓋指定轉碼模版中的對應參數,參考7 Container詳情。 |
Video |
String |
否 |
如設置則覆蓋指定轉碼模版中的對應參數,參考8 Video詳情。 |
Audio |
String |
否 |
如設置則覆蓋指定轉碼模版中的對應參數,參考10 Audio詳情。 |
TransConfig |
String |
否 |
轉碼流程配置,如設置則覆蓋指定轉碼模版中的對應參數,參考16 TransConfig詳情。 |
MergeList |
String |
否 |
拚接設置,最多支持4個MergeURL,示例:
{
"MergeList":[{"MergeURL":"https://jvm.oss-cn-hangzhou.aliyuncs.com/tail_comm.mp4"}]
} |
MuxConfig |
String |
否 |
如設置則覆蓋指定轉碼模版中的對應參數,參考17 MuxConfig詳情。 |
Priority |
String |
否 |
任務在其對應管道內的轉碼優先級,範圍[1-10],默認6,最高優先級為10。 |
UserData |
String |
否 |
用戶自定義數據,最大長度1024個字節。 |
3 Clip詳情
名稱 |
類型 |
必填項 |
描述 |
---|
TimeSpan |
String |
否 |
剪輯時間區間,請參照4 TimeSpan詳情 |
4 TimeSpan詳情
名稱 |
類型 |
必填項 |
描述 |
---|
Seek |
String |
否 |
開始時間點,格式:hh:mm:ss[.SSS],取值範圍 [00:00:00.000,23:59:59.999] ,或者sssss[.SSS],取值範圍[0.000,86399.999];示例:01:59:59.999或者32000.23 |
Duration |
String |
否 |
持續時長,格式:hh:mm:ss[.SSS],取值範圍 [00:00:00.000,23:59:59.999] ,或者sssss[.SSS],取值範圍[0.000,86399.999];示例:01:00:59.999或者32000.23 |
5 轉碼水印參數詳情
名稱 |
類型 |
必填項 |
描述 |
---|
WaterMarkTemplateId |
String |
否 |
水印模板ID,若不設置,則使用水印模板的默認配置:水印位置TopRight,偏移量Dx、Dy取0,水印寬為輸出分辨率寬的0.12倍,水印高為相對水印寬的等比縮放。 |
InputFile |
String |
是 |
水印輸入文件,見InputFile詳情,目前支持png圖片。 |
Width |
String |
否 |
若設置,則此值覆蓋水印模板對應水印圖片寬,值有兩種形式:整數型代水印圖片寬的像素值,範圍[8,4096],單位px;小數型代表相對輸出視頻分辨率寬的比率,範圍(0,1),支持4位小數,如0.9999,超出部分係統自動丟棄。 |
Height |
String |
否 |
若設置,則此值覆蓋水印模板對應水印圖片高,值有兩種形式:整數型代表水印圖片高的像素值,範圍[8,4096],單位px;小數型代表相對輸出視頻分辨率高的比率,範圍(0,1),支持4位小數,如0.9999,超出部分係統自動丟棄。 |
Dx |
String |
否 |
若設置,則此值覆蓋水印模板對應參數,水印圖片相對輸出視頻的水平偏移量,默認值是0;值有兩種形式:整數型代表偏移像素,範圍[-4096,4096],單位px;小數型代表水平偏移量與輸出分辨率寬的比率,範圍(-1,1),支持4位小數,如0.9999,超出部分係統自動丟棄。 |
Dy |
String |
否 |
若設置,則此值覆蓋水印模板對應參數,水印圖片相對輸出視頻的垂直偏移量,默認值是0;值有兩種形式:整數型代表偏移像素,範圍[-4096,4096],單位px;小數型代表垂直偏移量與輸出分辨率高的比率,範圍(-1,1),支持4位小數,如0.9999,超出部分係統自動丟棄。 |
ReferPos |
String |
否 |
若設置,則此值覆蓋水印模板對應參數,水印的位置,值範圍TopRight、TopLeft、BottomRight、BottomLeft。 |
Type |
String |
否 |
若設置,則此值覆蓋水印模板對應參數,水印類型,Image、Text,目前僅支持Image。 |
6 水印模板配置詳情
名稱 |
類型 |
必填項 |
描述 |
---|
Width |
String |
否 |
輸出視頻上水印圖片寬,值有兩種形式:整數型代水印圖片寬的像素值,範圍[8,4096],單位px;小數型代表相對輸出視頻分辨率寬的比率,範圍(0,1),支持4位小數,如0.9999,超出部分係統自動丟棄。 |
Height |
String |
否 |
輸出視頻上水印圖片高,值有兩種形式:整數型代水印圖片寬的像素值,範圍[8,4096],單位px;小數型代表相對輸出視頻分辨率高的比率,範圍(0,1),支持4位小數,如0.9999,超出部分係統自動丟棄。 |
Dx |
String |
否 |
水印圖片相對輸出視頻的水平偏移量,默認值是0;值有兩種形式:整數型代表偏移像素,範圍[-4096,4096],單位px;小數型代表水平偏移量與輸出分辨率寬的比率,範圍(-1,1),支持4位小數,如0.9999,超出部分係統自動丟棄。 |
Dy |
String |
否 |
水印圖片相對輸出視頻的垂直偏移量,默認值是0;值有兩種形式:整數型代表偏移像素,範圍[-4096,4096],單位px;小數型代表垂直偏移量與輸出分辨率高的比率,範圍(-1,1),支持4位小數,如0.9999,超出部分係統自動丟棄。 |
ReferPos |
String |
否 |
水印的位置,TopRight、TopLeft、BottomRight、BottomLeft,默認值TopRight。 |
Type |
String |
否 |
水印類型,Image、Text,默認值為Image,目前僅支持Image。 |
水印寬、高參數設置說明:
- 寬、高都不設置時,水印寬取輸出視頻分辨率寬的0.12倍,水印高按水印原圖寬高比例等比縮放;
- 寬或高設置一邊,另一邊不設置時,則另一邊按水印原圖寬高比等比縮放;
- 寬、高兩邊都設時,按實際設置值設置水印圖片。
水印位置坐標說明:

7 Container詳情
名稱 |
類型 |
必填項 |
描述 |
---|
Format |
String |
否 |
容器格式,默認值為mp4;視頻轉碼支持flv、mp4、ts、m3u8、gif;音頻轉碼支持mp3、mp4、ogg、flac; 容器格式為 gif 時,Video Codec設置隻能設置為GIF; 容器格式為 flv 時,Video Codec不能設置為H.265 |
8 Video詳情
名稱 |
類型 |
必填項 |
描述 |
---|
Codec |
String |
否 |
編解碼格式,支持H.264、H.265、GIF,默認值H.264。 |
Profile |
String |
否 |
編碼級別,支持baseline、main、high,默認值high, baseline:適合移動設備, main:適合標準分辨率設備, high:適合高分辨率設備。 目前僅H.264支持此參數 |
Bitrate |
String |
否 |
視頻輸出文件的碼率,值範圍[10,50000],單位Kbps。 |
Crf |
String |
否 |
碼率-質量控製因子,值範圍[0,51],默認值26。如果設置了Crf,則Bitrate的設置失效。 |
Width |
String |
否 |
寬,默認值是視頻原始寬度,值範圍[128,4096],單位px。 |
Height |
String |
否 |
高,默認值是視頻原始高度,值範圍[128,4096],單位px。 |
Fps |
String |
否 |
幀率,默認值取輸入文件幀率,當輸入文件幀率超過60時取60, 值範圍(0,60],單位fps。 |
Gop |
String |
否 |
關鍵幀間最大幀數,值範圍[1,100000],默認值250。 |
Preset |
String |
否 |
視頻算法器預置,支持veryfast、fast、medium、slow、slower,默認值medium。 目前僅H.264支持此參數 |
ScanMode |
String |
否 |
掃描模式,支持interlaced、progressive。 |
Bufsize |
String |
否 |
緩衝區大小,值範圍[1000,128000],默認值6000,單位Kb。 |
Maxrate |
String |
否 |
視頻碼率峰值,值範圍[10,50000],單位Kbps。 |
BitrateBnd |
String |
否 |
視頻碼率範圍,JSON對象字符串,見BitrateBnd詳情。 目前僅H.264支持此參數 |
PixFmt |
String |
否 |
視頻顏色格式,範圍yuv420p, yuvj420p等標準顏色格式,默認值yuv420p或原始顏色格式。 |
Remove |
String |
否 |
是否刪除視頻流,true表示刪除,false表示保留,默認值false |
Crop |
String |
否 |
視頻畫麵裁切,支持2種方式。 1)自動檢測黑邊並裁切,設置為”border” 2)自定義裁切,參數格式:width:height:left:top。 示例:1280:800:0:140 |
Pad |
String |
否 |
視頻貼黑邊。參數格式:width:height:left:top。 示例:1280:800:0:140 |
以下表格顯示視頻轉碼編解碼格式與容器格式的組合支持情況:
Container |
Audio Codecs |
Video Codecs |
---|
flv |
AAC、MP3 |
H.264 |
mp4 |
AAC、MP3 |
H.264、H.265 |
ts |
AAC、MP3 |
H.264、H.265 |
m3u8 |
AAC、MP3 |
H.264、H.265 |
gif |
不支持 |
GIF |
以下表格顯示視頻編解碼格式與視頻流配置參數的組合支持情況:
Video/Codec |
H.264 |
H.265 |
GIF |
---|
Profile |
Y |
N |
N |
Bitrate |
Y |
Y |
N |
Crf |
Y |
Y |
N |
Width |
Y |
Y |
Y |
Height |
Y |
Y |
Y |
Fps |
Y |
Y |
Y |
Gop |
Y |
Y |
N |
Preset |
Y |
N |
N |
ScanMode |
Y |
Y |
Y |
Bufsize |
Y |
Y |
N |
Maxrate |
Y |
Y |
N |
BitrateBnd |
Y |
N |
N |
PixFmt |
Y |
Y |
bgr8 |
9 BitrateBnd詳情
名稱 |
類型 |
必填項 |
描述 |
---|
Max |
String |
否 |
總碼率上限,[10,50000],單位Kbps。 |
Min |
String |
否 |
總碼率下限,[10,50000],單位Kbps。 |
10 Audio詳情
名稱 |
類型 |
必填項 |
描述 |
---|
Codec |
String |
否 |
音頻編解碼格式,AAC、MP3、VORBIS、FLAC,默認是AAC。 |
Profile |
String |
否 |
音頻編碼預置,當Codec為 AAC時,範圍aac_low、aac_he、aac_he_v2、aac_ld、aac_eld。 |
Samplerate |
String |
否 |
采樣率,默認值是44100,支持22050、32000、44100、48000、96000,單位為Hz。 若視頻容器格式為flv,音頻編解碼格式選擇為mp3時,采樣率不支持32000、48000、96000;音頻編解碼格式為mp3時,采樣率不支持96000 |
Bitrate |
String |
否 |
輸出文件的音頻碼率,值範圍[8,1000],默認值128,單位Kbps。 |
Channels |
String |
否 |
聲道數,默認值是2;當Codec設置為 mp3 時,聲道數隻支持1、2;當Codec設置為 aac 時,聲道數隻支持1、2、4、5、6、8 |
Remove |
String |
否 |
是否刪除音頻流,true表示刪除,false表示保留,默認值false |
以下表格顯示音頻轉碼編解碼格式與容器格式的組合支持情況:
Container |
Audio Codecs |
---|
mp3 |
MP3 |
mp4 |
AAC |
ogg |
VORBIS、FLAC |
flac |
FLAC |
音頻轉碼為公測階段,聲道數僅支持1、2。
11 SnapshotConfig參數詳情
名稱 |
類型 |
必填項 |
描述 |
---|
OutputFile |
String |
是 |
輸出文件定義,JSON對象,見OutputFile詳情,截圖輸出文件格式為jpg,若使用異步模式序列截圖且Num不等於1,則OutputFile的Object必須包含{Count},用於區分序列截圖多張輸出圖片的輸出地址,如序列截圖輸出3張圖片,OutputFile的Object為{Count}.jpg,則輸出圖片Object依次為00001.jpg,00002.jpg,00003.jpg |
Time |
String |
是 |
截圖時間,單位毫秒 |
Interval |
String |
否 |
截圖間隔時間,若指定則表示異步模式序列截圖,且值必須大於0,默認10,單位秒 |
Num |
String |
否 |
截圖數量,若指定則表示異步模式序列截圖,且必須大於0,當Time+Interval*Num的截取點超過視頻時長時,後續截圖自動失效,截圖完成時返回實際截取的個數;當Num=1,忽略Interval參數,表示異步單張截圖 |
Width |
String |
否 |
截圖輸出圖片寬度,單位px,範圍[8,4096] |
Height |
String |
否 |
截圖輸出圖片高度,單位px,範圍[8,4096] |
FrameType |
String |
否 |
截圖類型,普通幀:normal,I幀:intra,默認值intra |
14 Segment詳情
名稱 |
類型 |
必填項 |
描述 |
---|
Duration |
String |
否 |
分片時長,整數值,單位:秒,範圍[1,60]。 |
16 TransConfig詳情
名稱 |
類型 |
必填項 |
描述 |
---|
TransMode |
String |
否 |
轉碼模式,默認值onepass,可選範圍onepass、twopass、CBR。 |
IsCheckReso |
String |
否 |
是否檢查分辨率,如果輸出分辨率大於輸入分辨率,則輸出分辨率等於輸入分辨率。true表示檢查,false表示不檢查,默認值false。 |
IsCheckResoFail |
String |
否 |
是否檢查分辨率,如果輸出分辨率大於輸入分辨率,則返回轉碼失敗。true表示檢查,false表示不檢查,默認值false |
IsCheckVideoBitrate |
String |
否 |
是否檢查視頻碼率,如果視頻輸出碼率大於視頻輸入碼率,則視頻輸出碼率等於視頻輸入碼率。true表示檢查,false表示不檢查,默認值false |
IsCheckAudioBitrate |
String |
否 |
是否檢查音頻碼率,如果音頻輸出碼率大於音頻輸入碼率,則音頻輸出碼率等於音頻輸入碼率。true表示檢查,false表示不檢查,默認值false |
17 MuxConfig詳情
名稱 |
類型 |
必填項 |
描述 |
---|
Segment |
String |
否 |
JSON對象,切片配置字段,詳見14 Segment詳情,示例:
{
"Duration":"34"
} |
18 NotifyConfig詳情
名稱 |
類型 |
必填項 |
描述 |
---|
Queue |
String |
否 |
阿裏雲消息服務中創建的隊列;媒體轉碼服務支持在管道上綁定隊列,則該管道上的作業執行結束時會將執行結果發送到該隊列;獲取隊列中的消息參見隊列消息操作;管道上設置隊列時,請在消息服務中預先創建隊列。 |
Topic |
String |
否 |
阿裏雲消息服務中創建的主題;媒體轉碼服務支持在管道上綁定主題,則該管道上的作業執行結束時會將執行結果發送到該主題;主題會將執行結果以消息形式推送到訂閱的地址上;消息管道上設置主題時,請預先在消息服務中預先創建主題;該功能目前公測中。 |
19 轉碼作業輸入詳情
名稱 |
類型 |
必填項 |
描述 |
---|
Bucket |
String |
是 |
輸入文件所在OSS Bucket,需在控製台中資源控製頻道裏的Bucket授權頁麵授予此Bucket讀權限給媒體轉碼服務,遵守OSS Bucket定義,見術語表Bucket |
Location |
String |
是 |
輸入OSS Bucket所在數據中心(OSS Location),遵守OSS Location定義,見術語表Location |
Object |
String |
是 |
輸入文件 (OSS Object),須進行UrlEncode,使用UTF-8編碼,遵守OSS Object定義,見術語表Object |
Audio |
String |
否 |
源媒體文件的音頻配置,JSON對象,當輸入文件為ADPCM、PCM格式時此參數為必填項,詳見21 InputAudio詳情 ,示例
{
"Channels":"2",
"Samplerate":"44100"
} |
Container |
String |
否 |
源媒體文件容器配置,JSON對象,當輸入文件為ADPCM、PCM格式時此參數為必填項,詳見20 InputContainer詳情 ,示例
{
"Format":"u8"
} |
20 InputContainer詳情
名稱 |
類型 |
必填項 |
描述 |
---|
Format |
String |
是 |
源媒體音頻格式,取值為alaw, f32be, f32le, f64be, f64le, mulaw, s16be, s16le, s24be, s24le, s32be, s32le, s8, u16be, u16le, u24be, u24le, u32be, u32le, u8 |
21 InputAudio詳情
名稱 |
類型 |
必填項 |
描述 |
---|
Channels |
String |
是 |
源媒體音頻聲道數,範圍[1,8] |
Samplerate |
String |
是 |
源媒體音頻采樣率,取值為(0, 320000], 單位Hz |
22 AnalysisConfig詳情
名稱 |
類型 |
必填項 |
描述 |
---|
QualityControl |
String |
否 |
輸出質量控製,JSON對象,見23 QualityControl詳情 |
PropertiesControl |
String |
否 |
屬性控製,JSON對象,見24 PropertiesControl詳情 |
23 QualityControl詳情
名稱 |
類型 |
必填項 |
描述 |
---|
RateQuality |
String |
否 |
輸出質量等級,值範圍(0,51],值為整數,默認值25 |
MethodStreaming |
String |
否 |
播放方式,network或local,默認值network |
24 PropertiesControl詳情
名稱 |
類型 |
必填項 |
描述 |
---|
Deinterlace |
String |
否 |
強製掃描模式判定, Auto:自動; Force:強製做deinterlace;None:強製不做 |
Crop |
String |
否 |
視頻裁切配置,默認:自動 如此值不是空JOSN{},則它的屬性Mode必填.詳情25 |
25 Crop詳情
名稱 |
類型 |
必填項 |
描述 |
---|
Mode |
String |
否 |
取值 Auto:自動; Force:強製; None:強製不做,如Crop不是空JOSN{},則此值必填 |
Width |
Integer |
否 |
裁切後寬,範圍[8, 4096],如MODE為Aut、None,此值失效 |
Height |
Integer |
否 |
裁切後高,範圍[8, 4096],如MODE為Auto、None,此值失效 |
Top |
Integer |
否 |
裁切上邊距,範圍[8, 4096],如MODE為Auto、None,此值失效 |
Left |
Integer |
否 |
裁切左邊距,範圍[8, 4096],如MODE為Auto、None,此值失效 |
26 TransFeatures詳情
27 拚接參數詳情
28 作業輸出文件詳情
名稱 |
類型 |
必填項 |
描述 |
---|
URL |
String |
否 |
輸入文件的OSS URL,如https://example-bucket.oss-cn-hangzhou.aliyuncs.com/example.flv 若不指定URL,則Bucket、Location、Object必填 |
Bucket |
String |
否 |
若不製定URL,則此值必填;否則,此值失效,輸出文件所在OSS Bucket,需在控製台中資源控製頻道裏的Bucket授權頁麵授予此Bucket寫權限給媒體轉碼服務,遵守OSS Bucket定義,見術語表Bucket |
Location |
String |
否 |
若不製定URL,則此值必填;否則,此值失效,輸出OSS Bucket所在數據中心(OSS Location),遵守OSS Location定義,見術語表Location |
Object |
String |
否 |
若不製定URL,則此值必填;否則,此值失效,輸出文件 (OSS Object)須進行UrlEncode,使用UTF-8編碼, 遵守OSS Object定義,見術語表Object |
最後更新:2016-11-24 11:23:48