Effect配置说明 - 视频点播

素材效果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 渲染时长]