Effect配置說明 - ApsaraVideo VOD

素材效果Effect的具體結構與效果類型有關，本篇將按照不同的素材效果類型分別描述。

Effect Type:Text 橫幅文字

時間軸樣本：文字疊加

名稱	類型	是否必填	描述
X	Float	否	橫幅文字左上方距離輸出視頻左上方的橫向距離。支持度百分比和像素兩種形式。當取值為[0, 0.9999]時，表示相對輸出視頻寬的佔比。當取值為≥2的整數時，表示絕對像素。預設為0。該座標會按照素材尺寸和成片尺寸進行縮放。
Y	Float	否	橫幅文字左上方距離輸出視頻左上方的縱向距離。支持度百分比和像素兩種形式。當取值為[0, 0.9999]時，表示相對輸出視頻高的佔比。當取值為≥2的整數時，表示絕對像素。預設為0。該座標會按照素材尺寸和成片尺寸進行縮放。
TimelineIn	Float	否	橫幅文字出現在時間軸的起始位置。單位：秒，精確到小數點後4位。如果TimelineIn不填，則會與對應Clip的TimelineIn保持一致。
TimelineOut	Float	否	橫幅文字出現在時間軸的結束位置。單位：秒，精確到小數點後4位。如果TimelineOut不填，則會與對應Clip的TimelineOut保持一致。
Content	String	是	橫幅文字內容。
Font	String	否	橫幅文字的字型。預設為SimSun字型。具體支援的字型請參見字型列表。
FontSize	Int	是	橫幅文字的字型大小。該字型大小會根據素材尺寸和成片尺寸進行縮放。說明 FontSize與 FixedFontSize僅能填寫一個。如果都填寫，僅FontSize生效。
FixedFontSize	Int	是	橫幅文字的字型大小。該字型大小不會根據素材尺寸和成片尺寸進行縮放。說明 FontSize與 FixedFontSize僅能填寫一個。如果都填寫，僅FontSize生效。
FixedX	Float	否	橫幅文字左上方距離輸出視頻左上方的橫向距離。支持度百分比和像素兩種形式。當取值為[0, 0.9999]時，表示相對輸出視頻寬的佔比。當取值為≥2的整數時，表示絕對像素。預設為0。該座標不會按照素材尺寸和成片尺寸進行縮放。
FixedY	Float	否	橫幅文字左上方距離輸出視頻左上方的橫向距離。支持度百分比和像素兩種形式。當取值為[0, 0.9999]時，表示相對輸出視頻寬的佔比。當取值為≥2的整數時，表示絕對像素。預設為0。該座標不會按照素材尺寸和成片尺寸進行縮放。
FontColor	String	否	橫幅文字的顏色，格式為#後跟16進位值。樣本：#ffffff
FontColorOpacity	String	否	橫幅文字的透明度，表示文字的透明度，取值0-1。1為不透明，0為完全透明。預設為1。
FontFace	FontFace	否	橫幅文字的字型外觀。
Spacing	Integer	否	橫幅文字字間距。單位：像素值，預設為0。
Angle	Float	否	橫幅文字逆時針旋轉角度。單位：度，預設為0。
BorderStyle	Int	否	設定橫幅文字邊框和陰影格式。取值1或3，1=邊框+陰影，3=不透明底框。預設為1。
Outline	Int	否	橫幅文字描邊寬度。單位：像素值，預設為0。
OutlineColour	String	否	橫幅文字描邊顏色，格式為#後跟16進位值。樣本：#ffffff
Shadow	Int	否	橫幅文字投下陰影的深度，單位：像素值，預設為0。
BackColour	String	否	橫幅文字陰影顏色，格式為#後跟16進位值。樣本：#ffffff
Alignment	String	否	橫幅文字定位對齊，預設為TopLeft。取值： TopLeft：視頻左上方 TopCenter：視頻豎直中軸線上側 TopRight：視頻右上方 CenterLeft：視頻水平中軸線左側 CenterCenter：視頻中心位置 CenterRight：視頻水平中軸線右側 BottomLeft：視頻左下角 BottomCenter：視頻豎直中軸線下側 BottomRight：視頻右下角
AdaptMode	String	否	橫幅文字當超出視頻寬度或超出指定TextWidth時進行自動換行或縮放。取值： AutoWrap：自動換行 AutoScale：自動縮放 AutoWrapAtSpaces：只在空格位置自動換行（適用於純英文字幕自動換行情境）
TextWidth	String	否	字幕文字框寬度，當設定AdaptMode時生效。將按照該值設定文字框寬度進行自動換行或縮放。不填寫時，會按照視頻寬度進行自動換行或縮放。單位：像素值。
FontUrl	String	否	橫幅文字支援使用使用者OSS的字型檔路徑來產生字幕，支援ttf、otf、woff三種格式的字型檔。樣本：https://your-bucket.oss-cn-shanghai.aliyuncs.com/example-font.ttf
EffectColorStyle	String	否	橫幅文字花字樣式類型。花字種類及效果請參見花字效果樣本。
AaiMotionInEffect	String	否	當字幕類型為橫幅文字時，表示橫幅文字入場特效類型。字幕入場特效種類及效果請參見入場特效。
AaiMotionIn	Float	否	橫幅文字入場特效時間長度。單位：秒，精確到小數點後4位，如果AaiMotionIn不填，預設0.5s，如果文本時間長度小於0.5，則為總時間長度減去出場時間長度。
AaiMotionOutEffect	String	否	當字幕類型為橫幅文字時，表示橫幅文字出場特效類型。字幕出場特效種類及效果請參見出場特效。
AaiMotionOut	Float	否	當字幕類型為橫幅文字時，表示橫幅文字出場特效時間長度，單位秒，精確到小數點後4位，如果AaiMotionOut不填，預設0.5s，如果文本時間長度小於0.5，則為總文本時間長度。
AaiMotionLoopEffect	String	否	當字幕類型為橫幅文字時，表示橫幅文字迴圈特效類型，不可與字幕入場或者出場特效同時生效。迴圈特效種類以及效果請參見迴圈特效。
Ratio	Float	否	當字幕類型為橫幅文字時，表示橫幅文字迴圈特效播放速度，精確到小數點後4位。不填預設為1，大於1表示加速迴圈，小於1表示慢速迴圈。

Effect Type:DeWatermark 遮標

名稱	類型	是否必填	描述
X	Float	否	模糊地區左上方距離輸出視頻左上方的橫向距離。註：支持度百分比和像素兩種形式。當取值為[0, 0.9999]時，表示相對輸出視頻寬的佔比。當取值為>=2的整數時，表示絕對像素。預設為0。
Y	Float	否	模糊地區左上方距離輸出視頻左上方的縱向距離。註：支持度百分比和像素兩種形式。當取值為[0, 0.9999]時，表示相對輸出視頻高的佔比。當取值為>=2的整數時，表示絕對像素。預設為0。
Width	Float	是	模糊地區在輸出視頻中的寬度。註：支持度百分比和像素兩種形式。當取值為[0, 0.9999]時，表示相對輸出視頻寬的佔比。當取值為>=2的整數時，表示絕對像素。
Height	Float	是	模糊地區在輸出視頻中的高度。註：支持度百分比和像素兩種形式。當取值為[0, 0.9999]時，表示相對輸出視頻高的佔比。當取值為≥2的整數時，表示絕對像素。
TimelineIn	Float	否	模糊地區出現在時間軸的起始位置。單位：秒，精確到小數點後4位。如果TimelineIn不填，則會與對應Clip的TimelineIn保持一致。
TimelineOut	Float	否	模糊地區出現在時間軸的結束位置。單位：秒，精確到小數點後4位。如果TimelineOut不填，則會與對應Clip的TimelineOut保持一致。

Effect Type:Crop 裁剪

時間軸樣本：視頻裁剪——去掉上下黑邊

名稱	類型	是否必填	描述
X	Float	否	裁剪後保留的地區左上方距離輸出視頻左上方的橫向距離。支持度百分比和像素兩種形式。當取值為[0, 0.9999]時，表示相對輸出視頻寬的佔比。當取值為≥2的整數時，表示絕對像素。預設為0。
Y	Float	否	裁剪後保留的地區左上方距離輸出視頻左上方的縱向距離。支持度百分比和像素兩種形式。當取值為[0, 0.9999]時，表示相對輸出視頻高的佔比。當取值為≥2的整數時，表示絕對像素。預設為0。
Width	Float	是	裁剪後保留的地區在輸出視頻中的寬度。支持度百分比和像素兩種形式。當取值為[0, 0.9999]時，表示相對輸出視頻寬的佔比。當取值為≥2的整數時，表示絕對像素。
Height	Float	是	裁剪後保留的地區在輸出視頻中的高度。支持度百分比和像素兩種形式。當取值為[0, 0.9999]時，表示相對輸出視頻高的佔比。當取值為≥2的整數時，表示絕對像素。

Effect Type:Scale 縮放

時間軸樣本：視頻畫中畫

說明

當未指定Scale效果，且素材畫面寬高與輸出視頻畫面不一致時，自動將素材畫面縮放到寬或高與輸出畫面一致，另外兩邊自動貼上下黑邊或垂直黑邊，素材畫面置中。

名稱

類型

是否必填

描述

Width

Float

是

縮放後保留的地區在輸出視頻中的寬度。

支持度百分比和像素兩種形式。當取值為[0, 0.9999]時，表示相對輸出視頻寬的佔比。當取值為≥1的整數時，表示絕對像素。

Height

Float

是

縮放後保留的地區在輸出視頻中的高度。

支持度百分比和像素兩種形式。當取值為[0, 0.9999]時，表示相對輸出視頻高的佔比。當取值為≥1的整數時，表示絕對像素。

Effect Type:Pad 貼邊

時間軸樣本：視頻橫轉豎——補充上下模糊地區

說明

當未指定Pad效果，且素材畫面比例與輸出視頻畫面比例不符時，自動將素材畫面縮放到寬或高與輸出畫面一致，另外兩邊自動貼上下黑邊或垂直黑邊，素材畫面置中。

名稱	類型	是否必填	描述
Left	Float	否	素材畫面左邊輸出視頻左邊的距離。支持度百分比和像素兩種形式。當取值為[0, 0.9999]時，表示相對輸出視頻寬的佔比。當取值為≥1的整數時，表示絕對像素。
Right	Float	否	素材畫面右邊輸出視頻右邊的距離。支持度百分比和像素兩種形式。當取值為[0, 0.9999]時，表示相對輸出視頻寬的佔比。當取值為≥1的整數時，表示絕對像素。
Top	Float	否	素材畫面上邊輸出視頻上邊的距離。支持度百分比和像素兩種形式。當取值為[0, 0.9999]時，表示相對輸出視頻高的佔比。當取值為≥1的整數時，表示絕對像素。
Bottom	Float	否	素材畫面下邊輸出視頻下邊的距離。支持度百分比和像素兩種形式。當取值為[0, 0.9999]時，表示相對輸出視頻高的佔比。當取值為≥1的整數時，表示絕對像素。
Color	String	否	貼邊顏色，格式為#後跟16進位值。例如：#000000。預設值為黑色。

Effect Type:Background 背景設定

背景設定包括背景模糊、背景顏色，當素材尺寸和成片尺寸不一致時，此特效可對空白地區進行設定。

背景設定可與裁剪、縮放、特效、轉場等Effect疊加使用。

時間軸樣本：視頻橫轉豎——補充上下模糊地區

名稱	類型	是否必填	描述
SubType	String	是	子類型。取值： Blur：背景模糊 Color：背景顏色
Radius	Float	否	模糊半徑，當SubType=Blur時，此參數生效，取值範圍[0.01, 1]。
Color	String	否	當SubType=Color時，此參數生效，表示顏色值，16進位RGB顏色表示。樣本：#FFFFFF

Effect Type:Transition 轉場

轉場效果出現在兩個素材之間，只需要在對前一個素材設定轉場過渡的時間長度，轉場效果會作用於前一個素材的尾部與後一個素材的頭部，在轉場中，視頻畫面會進行疊加，因此其時間長度將比沒有加轉場效果少，減少的部分即為轉場過渡的時間長度。

例如：視頻軌有2個素材，Clip1和Clip2，Clip1時間長度為10s，Clip2為8s，在Clip1與Clip2之間添加4s的轉場效果，則視頻軌的總時間長度由18s縮短到14s。

名稱

類型

是否必填

描述

SubType

String

是

轉場子類型。支援傳入多個轉場子類型，用英文逗號隔開，將從中隨機選取一個，或者傳入random，將從所有轉場子類型中隨機選取一個，完整的取值範圍及效果請參見轉場效果樣本。

樣本：directional

Duration

Float

否

轉場效果的時間長度。單位：秒，精確到小數點後4位。預設為1s。

Effect Type:VFX 特效

名稱	類型	是否必填	描述
SubType	String	是	特效子類型。支援傳入多個特效子類型，用英文逗號隔開，將從中隨機選取一個，或者傳入random，將從所有特效子類型中隨機選取一個，完整取值範圍及效果請參見特效效果樣本。樣本值：colorfulradial
X	Float	否	該欄位僅支援SubType為mosaic_rect/blur的情況。特效地區左上方距離輸出視頻左上方的橫向距離。支持度百分比和像素兩種形式。當取值為[0, 0.9999]時，表示相對輸出視頻寬的佔比。當取值為≥2的整數時，表示絕對像素。
Y	Float	否	該欄位僅支援SubType為mosaic_rect/blur的情況。特效地區距離輸出視頻左上方的縱向距離。支持度百分比和像素兩種形式。當取值為[0, 0.9999]時，表示相對輸出視頻高的佔比。當取值為≥2的整數時，表示絕對像素。
Width	Float	否	該欄位僅支援SubType為mosaic_rect/blur的情況。特效地區在輸出視頻中的寬度。支持度百分比和像素兩種形式。當取值為[0, 0.9999]時，表示相對輸出視頻寬的佔比。當取值為≥2的整數時，表示絕對像素。
Height	Float	否	該欄位僅支援SubType為mosaic_rect/blur的情況。特效地區在輸出視頻中的高度。支持度百分比和像素兩種形式。當取值為[0, 0.9999]時，表示相對輸出視頻高的佔比。當取值為≥2的整數時，表示絕對像素。

Effect Type:Filter 濾鏡

名稱	類型	是否必填	描述
SubType	String	是	濾鏡子類型，支援傳入多個濾鏡子類型，用英文逗號隔開，將從中隨機選取一個，或者傳入random，將從所有濾鏡子類型中隨機選取一個，完整取值範圍及效果請參見濾鏡效果樣本。樣本值：M1
TimelineIn	Float	否	濾鏡出現在時間軸的起始位置。單位：秒，精確到小數點後4位。如果TimelineIn不填，則會與對應Clip的TimelineIn保持一致。
TimelineOut	Float	否	濾鏡出現在時間軸的結束位置。單位：秒，精確到小數點後4位。如果TimelineOut不填，則會與對應Clip的TimelineOut保持一致。
ExtParams	String	否	濾鏡相關拓展參數。該欄位僅在SubType=color，即顏色濾鏡時生效，調色濾鏡ExtParams相關配置參數請參見調色濾鏡ExtParams參數說明及樣本。

調色濾鏡ExtParams參數說明及樣本

時間軸樣本：調色濾鏡

參數	類型	取值範圍	說明	預設值
brightness	int	[-255,255]	亮度	0
contrast	int	[-100,100]	對比	0
saturation	int	[-100,100]	飽和度	0
kelvin_temperature	int	[1000,40000]	溫度，配合 temperature_ratio生效	6000
temperature_ratio	int	[0,100]	溫度比例	0
tint	int	[-100,100]	色調	0
dark_corner_ratio	int	[0,100]	暗角比例	0

Effect Type:Volume 調音

時間軸樣本：整體靜音樣本、視頻調節音量＋音頻調節音量樣本

名稱	類型	是否必填	描述
Gain	Float	否	音量增益。取值範圍：0-10。值越小音量越低，0表示靜音；1表示原始音量；小於1表示低於原始音量；大於1表示高於原始音量。預設為1。

Effect Type:AFade 音頻淡入淡出

時間軸樣本：視頻的音頻配置淡入淡出、音頻配置淡入淡出

名稱	類型	是否必填	描述
SubType	String	是	音頻淡入淡出子類型。取值如下： In（淡入） Out（淡出）
Duration	Float	否	淡入或淡出的時間長度，淡入作用在素材片段的頭部，淡出作用在素材片段的尾部。預設時間長度為0，即淡入淡出不生效。
Curve	String	否	音頻淡入淡出音量曲線。預設為exp。取值： exp：音量指數型漸強/漸弱 tri：音量線性漸強/漸弱

Effect Type:Rotate 素材旋轉

將素材旋轉一定角度，目前僅支援旋轉90°、180°、270°。可放置於視頻軌或圖片軌素材的Effects 中。

時間軸樣本：素材旋轉

名稱	類型	是否必填	描述
Degree	Integer	是	素材順時針旋轉的角度。目前僅支援旋轉90°、180°、270°。

Effect Type:Clip 隨機截取

截取功能，目前只支援隨機截取，從原始素材中隨機截取一段時間片段，拼入到時間軸中。

時間軸樣本：隨機效果

名稱	類型	是否必填	描述
SubType	String	是	截取類型。目前僅支援隨機截取：RandomClip。
ClipDuration	Float	是	截取片段的時間長度。

Effect Type:Flip 翻轉

視頻軌道中的視頻或者圖片，支援在水平方向或者垂直方向進行畫面翻轉。

時間軸樣本：視頻水平翻轉、豎直翻轉

名稱	類型	是否必填	描述
Direction	String	是	horizontal：水平方向翻轉 vertical：豎直方向翻轉

Effect Type:KenBurns 鏡頭推拉

對於視頻軌道中的視頻或者圖片，施加鏡頭推拉的特效效果。

使用限制：

本特效適用於圖片、視頻，可以和VFX、濾鏡、轉場一起使用。
本效果支援設定輸出畫面的寬高（見下方WindowW/WindowH參數），因此不支援與Crop/Scale/Pad/Background特效一起使用。

名稱		類型	對否必填	說明	樣本
Duration		Float	否	特效期間，預設等於clip時間長度，最大值10，單位（s）	5
WindowW		Float	否	最終輸出片段的畫面寬度，預設等於輸出視頻的寬度，單位：像素（px）。 0 < WindowW <= 1 表示相對值，> 1 表示絕對值。	1
WindowH		Float	否	最終輸出片段的畫面高度，預設等於輸出視頻的高度，單位：像素（px）。 0 < WindowH <= 1 表示相對值 > 1 表示絕對值。	1
Start		String	否	特效開始時，畫框左上方在原始素材中的位置（橫座標、縱座標、寬度、高度）, 以英文逗號隔開，皆非必填。 "StartX,StartY,StartW,StartH" 限制： 0 < StartX + StartW <=1 0 < StartY + StartH <=1	"0,0,0.9,0.9"
	StartX	Float	否	特效開始時，畫框左上方在原始素材中的橫座標，單位：像素（px）。 0 <= StartX < 1 表示相對值 >= 1 表示絕對值。	0
	StartY	Float	否	特效開始時，畫框左上方在原始素材中的縱座標，單位：像素（px）。 0 <= StartY < 1 表示相對值 >= 1 表示絕對值。	0
	StartW	Float	否	特效開始時，畫框在原始素材中的寬度，單位：像素（px）。 0 < StartW <= 1 表示相對值 > 1 表示絕對值。	0.9
	StartH	Float	否	特效開始時，畫框在原始素材中的高度，單位：像素（px）。 0 < StartH <= 1 表示相對值 > 1 表示絕對值。	0.9
End		String	否	特效結束時，畫框左上方在原始素材中的位置（橫座標、縱座標、寬度、高度）, 以英文逗號隔開，皆非必填。 "EndX,EndY,EndW,EndH" 限制： 0 < EndX + EndW <=1 0 < EndY + EndH <=1	"0,0,1,1"
	EndX	Float	否	特效結束時，畫框左上方在原始素材中的橫座標，單位：像素（px）。 0 <= StartX < 1 表示相對值 >= 1 表示絕對值。	0
	EndY	Float	否	特效結束時，畫框左上方在原始素材中的縱座標，單位：像素（px）。 0 <= StartY < 1 表示相對值 >= 1 表示絕對值。	0
	EndW	Float	否	特效結束時，畫框在原始素材中的寬度，單位：像素（px）。 0 < StartW <= 1 表示相對值 > 1 表示絕對值。	1
	EndH	Float	否	特效結束時，畫框在原始素材中的高度，單位：像素（px）。 0 < StartH <= 1 表示相對值 > 1 表示絕對值。	1

Effect Type: Zoom 變焦

為對應的素材 Clip 增加變焦效果。

重要

僅可使用視訊軌道VideoTrack中的素材Clip使用。

名稱	類型	是否必填	描述
StartRate	Float	否	起始縮放比率預設值：1.0 取值範圍：[1.0, 5.0]
EndRate	Float	否	結束縮放比率預設值：StartRate + 0.3 取值範圍：[StartRate, 5.0]
Duration	Float	否	效果持續時間長度預設值：當前 Clip 渲染時間長度取值範圍：[0, 當前 Clip 渲染時間長度]