Effect configurations

Effect Type: Text (banner text)

Timeline example:Captions and caption templates.

Name	Type	Required	Description
X	Float	No	The horizontal distance from the top-left corner of the banner text to the top-left corner of the output video. The value can be a percentage or a pixel value. A value in the range [0, 0.9999] represents a percentage of the output video's width. An integer value of 2 or greater represents an absolute pixel value. The default value is 0. These coordinates are scaled based on the material and output video sizes.
Y	Float	No	The vertical distance from the top-left corner of the banner text to the top-left corner of the output video. The value can be a percentage or a pixel value. A value in the range [0, 0.9999] represents a percentage of the output video's height. An integer value of 2 or greater represents an absolute pixel value. The default value is 0. These coordinates are scaled based on the material and output video sizes.
TimelineIn	Float	No	The time when the banner text appears on the timeline. Unit: seconds. The value is accurate to four decimal places. If you do not specify this parameter, the `TimelineIn` value of the corresponding clip is used.
TimelineOut	Float	No	The time when the banner text disappears from the timeline. Unit: seconds. The value is accurate to four decimal places. If you do not specify this parameter, the `TimelineOut` value of the corresponding clip is used.
Content	String	Yes	The content of the banner text.
Font	String	No	The font of the banner text. Supported fonts:Font list. Default: SimSun.
FontSize	Int	Yes	The font size of the banner text. This font size is scaled based on the material and output video sizes. The default value is 0. The maximum value is 5000. Note: Specify either `FontSize` or `FixedFontSize`. If you specify both, only `FontSize` takes effect.
SizeRequestType	String	No	The method used to calculate the actual rendered size of the banner text from the font size. The default value is `RealDim`. `Nominal`: The rendered height of the caption in pixels is equal to the `FontSize` value. `RealDim`: For some fonts, the rendered height of the caption in pixels may be smaller than the `FontSize` value.
FixedFontSize	Int	Yes	The font size of the banner text. This font size is not scaled based on the material and output video sizes. Note: Specify either `FontSize` or `FixedFontSize`. If you specify both, only `FontSize` takes effect.
FixedX	Float	No	The horizontal distance from the top-left corner of the banner text to the top-left corner of the output video. The value can be a percentage or a pixel value. A value in the range [0, 0.9999] represents a percentage of the output video's width. An integer value of 2 or greater represents an absolute pixel value. The default value is 0. These coordinates are not scaled based on the material and output video sizes.
FixedY	Float	No	The horizontal offset of the banner text from the top-left corner of the output video. You can specify this value in either percentage or pixel format. A value in the range of [0, 0.9999] is treated as a ratio relative to the width of the output video. An integer value of 2 or greater is treated as an absolute value in pixels. The default value is 0. The coordinate is relative to the output video and is not scaled based on the dimensions of the source material.
FontColor	String	No	The color of the banner text. The value is a hexadecimal color code that starts with a number sign (#). Example: `#ffffff`.
FontColorOpacity	String	No	The opacity of the banner text. Range: [0, 1]. 1 = opaque, 0 = fully transparent. Default: 1.
FontFace	FontFace	No	The font face of the banner text.
Spacing	Integer	No	The character spacing for the banner text. Unit: pixels. The default value is 0.
LineSpacing	Integer	No	The line spacing for the banner text. Unit: pixels. The default value is 0.
Angle	Float	No	The counter-clockwise rotation angle of the banner text. Unit: degrees. The default value is 0.
BorderStyle	Int	No	The border and shadow format for the banner text. Valid values: 1 (border + shadow), 3 (opaque background box). Default: 1.
Outline	Int	No	The outline width of the banner text. Unit: pixels. The default value is 0.
OutlineColour	String	No	The outline color of the banner text. The value is a hexadecimal color code that starts with a number sign (#). Example: `#ffffff`.
Shadow	Int	No	The depth of the shadow cast by the banner text. Unit: pixels. The default value is 0.
BackColour	String	No	The shadow color of the banner text. The value is a hexadecimal color code that starts with a number sign (#). Example: `#ffffff`.
Alignment	String	No	The alignment of the banner text. The default value is `TopLeft`. Valid values: `TopLeft`: Top-left corner of the video. `TopCenter`: Top center of the video's vertical axis. `TopRight`: Top-right corner of the video. `CenterLeft`: Left center of the video's horizontal axis. `CenterCenter`: Center of the video. `CenterRight`: Right center of the video's horizontal axis. `BottomLeft`: Bottom-left corner of the video. `BottomCenter`: Bottom center of the video's vertical axis. `BottomRight`: Bottom-right corner of the video. To accurately position captions in different alignment modes, set this parameter to one of the following values: `Left`: Left alignment. Set `X` and `Y` to the coordinates of the caption's top-left vertex relative to the video's top-left corner. `Center`: Center alignment. Set `X` and `Y` to the coordinates of the intersection of the caption's central axis and top edge, relative to the video's top-left corner. `Right`: Right alignment. Set `X` and `Y` to the coordinates of the caption's top-right vertex relative to the video's top-left corner.
AdaptMode	String	No	Specifies whether to automatically wrap or scale the banner text when it exceeds the video width or the specified `TextWidth`. `AutoWrap`: Automatically wraps the text. `AutoScale`: Automatically scales the text. `AutoWrapAtSpaces`: Automatically wraps the text only at spaces. This is suitable for auto-wrapping captions that are entirely in English.
TextWidth	String	No	The width of the text box. This parameter is valid only when `AdaptMode` is set. The text box width is used for automatic wrapping or scaling. If you do not specify this parameter, the video width is used for automatic wrapping or scaling. A value greater than 0 and less than or equal to 1 represents a width relative to the output video's width. A value greater than 1 represents an absolute pixel value.
FontUrl	String	No	The path to a font file in your OSS bucket to generate captions. Font files in TTF, OTF, and WOFF formats are supported. Example: `https://your-bucket.oss-cn-shanghai.aliyuncs.com/example-font.ttf`
EffectColorStyle	String	No	The word art style for the banner text.Word art effect examples.
SubtitleEffects	SubtitleEffect[]	No	The multilayer effects for the banner text. You can set multilayer outlines, multilayer shadows, Gaussian blur effects, and caption background effects. Gaussian blur is supported only when the type is set to shadow. Note: If you set `SubtitleEffects`, the `Outline` and `Shadow` fields in the caption track do not take effect. When you set multilayer outline, shadow, or background effects, the order of the `SubtitleEffects` array determines the layer order. The first `SubtitleEffect` in the array is rendered at the bottom layer, and the last `SubtitleEffect` is rendered at the top layer.
AaiMotionInEffect	String	No	The entrance effect for banner text. Valid only for banner text captions.Caption effect examples.
AaiMotionIn	Float	No	The duration of the entrance effect for the banner text. Unit: seconds. The value is accurate to four decimal places. If you do not specify `AaiMotionIn`, the default value is 0.5s. If the text duration is less than 0.5s, the value is the total duration minus the exit duration.
AaiMotionOutEffect	String	No	The exit effect for banner text. Valid only for banner text captions.Caption effect examples.
AaiMotionOut	Float	No	The duration of the exit effect for the banner text. This parameter is valid when the caption type is banner text. Unit: seconds. The value is accurate to four decimal places. If you do not specify `AaiMotionOut`, the default value is 0.5s. If the text duration is less than 0.5s, the value is the total text duration.
AaiMotionLoopEffect	String	No	The loop effect for banner text. Valid only for banner text captions. Cannot coexist with entrance or exit effects.Caption effect examples.
Ratio	Float	No	The playback speed of the loop effect for banner text. Valid only for banner text captions. Accurate to four decimal places. Default: 1. Values greater than 1 speed up the loop; values less than 1 slow it down.
TextureURL	String	No	The texture effect for the caption. This parameter is valid when the caption type is banner text. PNG, JPG, JPEG, and BMP formats are supported. Currently, only OSS files are supported. Example: `https://your-bucket.oss-cn-shanghai.aliyuncs.com/your-image.png`
BubbleStyleId	String	No	The bubble style for banner text. Valid only for banner text captions.Bubble caption examples.
BubbleWidth	Float	No	The width of the bubble background relative to the output video. This parameter is valid only when using bubble captions. A value greater than 1 represents an absolute pixel value. A value less than or equal to 1 represents a relative value.
BubbleHeight	Float	No	The height of the bubble background relative to the output video. This parameter is valid only when using bubble captions. A value greater than 1 represents an absolute pixel value. A value less than or equal to 1 represents a relative value.

Effect Type: DeWatermark (masking)

Name	Type	Required	Description
X	Float	No	The horizontal distance from the top-left corner of the blurred area to the top-left corner of the output video. The value can be a percentage or a pixel value. A value in the range [0, 0.9999] represents a percentage of the output video's width. An integer value of 2 or greater represents an absolute pixel value. The default value is 0.
Y	Float	No	The vertical distance from the top-left corner of the blurred area to the top-left corner of the output video. The value can be a percentage or a pixel value. A value in the range [0, 0.9999] represents a percentage of the output video's height. An integer value of 2 or greater represents an absolute pixel value. The default value is 0.
Width	Float	Yes	The width of the blurred area in the output video. The value can be a percentage or a pixel value. A value in the range [0, 0.9999] represents a percentage of the output video's width. An integer value of 2 or greater represents an absolute pixel value.
Height	Float	Yes	The height of the blurred area in the output video. The value can be a percentage or a pixel value. A value in the range [0, 0.9999] represents a percentage of the output video's height. An integer value of 2 or greater represents an absolute pixel value.

Effect Type: Crop

Timeline example:Video cropping.

Name	Type	Required	Description
X	Float	No	The horizontal distance from the top-left corner of the retained area after cropping to the top-left corner of the output video. The value can be a percentage or a pixel value. A value in the range [0, 0.9999] represents a percentage of the output video's width. An integer value of 2 or greater represents an absolute pixel value. The default value is 0.
Y	Float	No	The vertical distance from the top-left corner of the retained area after cropping to the top-left corner of the output video. The value can be a percentage or a pixel value. A value in the range [0, 0.9999] represents a percentage of the output video's height. An integer value of 2 or greater represents an absolute pixel value. The default value is 0.
Width	Float	Yes	The width of the retained area in the output video after cropping. The value can be a percentage or a pixel value. A value in the range [0, 0.9999] represents a percentage of the output video's width. An integer value of 2 or greater represents an absolute pixel value.
Height	Float	Yes	The height of the retained area in the output video after cropping. The value can be a percentage or a pixel value. A value in the range [0, 0.9999] represents a percentage of the output video's height. An integer value of 2 or greater represents an absolute pixel value.

Effect Type: Scale (scaling)

If a material's aspect ratio differs from the output video and no scaling effect is configured, the material auto-scales to fit width or height, centers, and fills remaining space with black bars.

Timeline example:Scaling configuration.

Name	Type	Required	Description
Width	Float	Yes	The width of the retained area in the output video after scaling. The value can be a percentage or a pixel value. A value in the range [0, 0.9999] represents a percentage of the output video's width. An integer value of 1 or greater represents an absolute pixel value.
Height	Float	Yes	The height of the retained area in the output video after scaling. The value can be a percentage or a pixel value. A value in the range [0, 0.9999] represents a percentage of the output video's height. An integer value of 1 or greater represents an absolute pixel value.

Effect Type: Pad (padding)

If a material's aspect ratio differs from the output video and no padding effect is configured, the material auto-scales to fit width or height, centers, and fills remaining space with black bars.

Timeline example:Convert landscape to portrait with blurred padding.

Name	Type	Required	Description
Left	Float	No	The distance from the left edge of the material to the left edge of the output video. The value can be a percentage or a pixel value. A value in the range [0, 0.9999] represents a percentage of the output video's width. An integer value of 1 or greater represents an absolute pixel value.
Right	Float	No	The distance from the right edge of the material to the right edge of the output video. The value can be a percentage or a pixel value. A value in the range [0, 0.9999] represents a percentage of the output video's width. An integer value of 1 or greater represents an absolute pixel value.
Top	Float	No	The distance from the top edge of the material to the top edge of the output video. The value can be a percentage or a pixel value. A value in the range [0, 0.9999] represents a percentage of the output video's height. An integer value of 1 or greater represents an absolute pixel value.
Bottom	Float	No	The distance from the bottom edge of the material to the bottom edge of the output video. The value can be a percentage or a pixel value. A value in the range [0, 0.9999] represents a percentage of the output video's height. An integer value of 1 or greater represents an absolute pixel value.
Color	String	No	The color of the padding. The value is a hexadecimal color code that starts with a number sign (#). Example: `#000000`. The default color is black.

Effect Type: Background (background settings)

Background settings include blur and solid color to fill blank areas when material and output sizes differ.

Compatible with Crop, Scale, VFX, and Transition effects.

Timeline example:Convert landscape video to portrait and set background color.

Name	Type	Required	Description
SubType	String	Yes	The subtype. Valid values: `Blur`: Background blur. `Color`: Background color.
Radius	Float	No	The blur radius. This parameter is valid only when `SubType` is `Blur`. The value must be in the range [0.01, 1].
Color	String	No	The color value. This parameter is valid only when `SubType` is `Color`. The value is a hexadecimal RGB color code. Example: `#FFFFFF`.

Effect Type: Transition

Important

This transition effect is created by overlapping two clips, which shortens the duration of the final video. To avoid shortening the duration, use the `DLTransition` effect described below.

A transition occurs between two clips. Configure it on the first clip only. The effect overlaps the end of clip 1 with the start of clip 2, reducing total video duration by the transition length.

For example, a video track has two clips: Clip1 (10s) and Clip2 (8s). If you add a 4s transition between them, the total duration of the video track becomes 14s instead of 18s.

The following table describes transition properties. Specific transition effects:Transition effect examples.

Timeline example:Transition timeline configuration example.

Name	Type	Required	Description
SubType	String	Yes	The transition subtype. Specify one or more transition subtypes, separated by commas (,). A random subtype is selected from the list. You can also specify `random` to select a random subtype from all available transitions. Example: `directional`. All values and effects:Transition effect examples.
Duration	Float	No	The duration of the transition effect. Unit: seconds. The value is accurate to four decimal places. The default value is 1s.

Effect Type: DLTransition (frame-filling transition)

Unlike a standard `Transition` effect, a Duration Lock Transition (`DLTransition`) does not shorten the final video's duration. Instead, it fills the transition period with still frames.

The parameters for `DLTransition` are the same as for `Transition`.

Name	Type	Required	Description
SubType	String	Yes	The transition subtype. Specify one or more transition subtypes, separated by commas (,). A random subtype is selected from the list. You can also specify `random` to select a random subtype from all available transitions. Example: `directional`. All values and effects:Transition effect examples.
Duration	Float	No	The duration of the transition effect. Unit: seconds. The value is accurate to four decimal places. The default value is 1s.

Effect Type: VFX

Timeline example:VFX.

Name	Type	Required	Description
SubType	String	Yes	The effect subtype. Specify one or more effect subtypes, separated by commas (,). A random subtype is selected from the list. You can also specify `random` to select a random subtype from all available effects. Example: `colorfulradial`. All values and effects:Effect examples.
X	Float	No	This field is valid only when `SubType` is `mosaic_rect` or `blur`. It specifies the horizontal distance from the top-left corner of the effect area to the top-left corner of the output video. Note: The value can be a percentage or a pixel value. A value in the range [0, 0.9999] represents a percentage of the output video's width. An integer value of 2 or greater represents an absolute pixel value.
Y	Float	No	This field is valid only when `SubType` is `mosaic_rect` or `blur`. It specifies the vertical distance from the effect area to the top-left corner of the output video. Note: The value can be a percentage or a pixel value. A value in the range [0, 0.9999] represents a percentage of the output video's height. An integer value of 2 or greater represents an absolute pixel value.
Width	Float	No	This field is valid only when `SubType` is `mosaic_rect` or `blur`. It specifies the width of the effect area in the output video. Note: The value can be a percentage or a pixel value. A value in the range [0, 0.9999] represents a percentage of the output video's width. An integer value of 2 or greater represents an absolute pixel value.
Height	Float	No	This field is valid only when `SubType` is `mosaic_rect` or `blur`. It specifies the height of the effect area in the output video. Note: The value can be a percentage or a pixel value. A value in the range [0, 0.9999] represents a percentage of the output video's height. An integer value of 2 or greater represents an absolute pixel value.
ExtParams	String	No	Extended parameters for the effect. This field is valid only for masking scenarios, when `SubType` is `mask_circle`, `mask_rec`, `mask_linear`, or `mask_minor`. The configuration parameters for `ExtParams` in masking scenarios are described below.

Masking examples and output effects:Masking effects.

Important

For the following mask parameters, you must specify float values in a floating-point format, such as 0.5 or 2.0.

Parameters for circular mask effects

SubType=mask_circle

ExtParams parameter description

Parameter	Type	Value range	Default	Description
x	float	[0.0, material width]	0.5	The X coordinate of the mask's center relative to the top-left corner of the material. A value in the range [0.0, 1.0] represents a coordinate relative to the material's width. A value greater than 1.0 represents an absolute pixel value.
y	float	[0.0, material height]	0.5	The Y coordinate of the mask's center relative to the top-left corner of the material. A value in the range [0.0, 1.0] represents a coordinate relative to the material's height. A value greater than 1.0 represents an absolute pixel value.
width	float	[0.0, material width]	0.8	The width of the ellipse mask relative to the material's width. A value in the range [0.0, 1.0] represents a width relative to the material's width. A value greater than 1.0 represents an absolute pixel value.
height	float	[0.0, material height]	0.8	The height of the ellipse mask relative to the material's width. A value in the range [0.0, 1.0] represents a height relative to the material's height. A value greater than 1.0 represents an absolute pixel value.
antialias	float	[0.0, 1.0]	0.1	The anti-aliasing parameter for the ellipse mask. A larger value results in a higher degree of edge feathering.
angle	float	[-9999.0, 9999.0]	0.0	The rotation angle.

Parameters for rectangular mask effects

SubType=mask_rec

ExtParams parameter description

Parameter	Type	Value range	Default	Description
x	float	[0.0, material width]	0.5	The X coordinate of the rectangle mask's center in the video material, relative to the material's top-left corner. A value in the range [0.0, 1.0] represents a coordinate relative to the material's width. A value greater than 1.0 represents an absolute pixel value.
y	float	[0.0, material height]	0.5	The Y coordinate of the rectangle mask's center in the video material, relative to the material's top-left corner. A value in the range [0.0, 1.0] represents a coordinate relative to the material's height. A value greater than 1.0 represents an absolute pixel value.
width	float	[0.0, material width]	0.8	The width of the rectangle mask. A value in the range [0.0, 1.0] represents a width relative to the material's width. A value greater than 1.0 represents an absolute pixel value.
height	float	[0.0, material height]	0.8	The height of the rectangle mask. A value in the range [0.0, 1.0] represents a height relative to the material's height. A value greater than 1.0 represents an absolute pixel value.
antialias	float	[0.0, 1.0]	0.1	The anti-aliasing parameter for the rectangle mask. A larger value results in a higher degree of edge feathering.
radius	float	[0.0, the larger of the material's width or height]	0.1	The border radius of the rectangle mask. A value in the range [0.0, 1.0] represents a radius relative to the larger of the material's width or height. A value greater than 1.0 represents an absolute pixel value.
angle	float	[-9999.0, 9999.0]	0.0	The rotation angle.

Parameters for linear mask effects

SubType=mask_linear

ExtParams parameter description

Parameter	Type	Value range	Default	Description
x	float	[0.0, material width]	0.5	The X coordinate of the linear mask's center reference point, relative to the material's top-left corner. A value in the range [0.0, 1.0] represents a coordinate relative to the material's width. A value greater than 1.0 represents an absolute pixel value.
y	float	[0.0, material height]	0.5	The Y coordinate of the linear mask's center reference point in the video material, relative to the video's top-left corner. A value in the range [0.0, 1.0] represents a coordinate relative to the material's width. A value greater than 1.0 represents an absolute pixel value.
antialias	float	[0.0, 1.0]	0.1	The anti-aliasing parameter for the linear mask. A larger value results in a higher degree of edge feathering.
angle	float	[-9999.0, 9999.0]	0.0	The rotation angle.

Parameters for mirror mask effects

SubType=mask_minor

ExtParams parameter description

Parameter	Type	Value range	Default	Description
x	float	[0.0, material width]	0.5	The X coordinate of the mirror mask's center reference point, relative to the material's top-left corner. A value in the range [0.0, 1.0] represents a coordinate relative to the material's width. A value greater than 1.0 represents an absolute pixel value.
y	float	[0.0, material height]	0.5	The Y coordinate of the mirror mask's center reference point, relative to the material's top-left corner. A value in the range [0.0, 1.0] represents a coordinate relative to the material's height. A value greater than 1.0 represents an absolute pixel value.
antialias	float	[0.0, 1.0]	0.1	The anti-aliasing parameter for the mirror mask. A larger value results in a higher degree of edge feathering.
angle	float	[-9999.0, 9999.0]	0.0	The rotation angle.

Effect Type: Filter

Timeline example:Filter.

Name	Type	Required	Description
SubType	String	Yes	The filter subtype. Specify one or more filter subtypes, separated by commas (,). A random subtype is selected from the list. You can also specify `random` to select a random subtype from all available filters. Example: `M1`. All values and effects:Filter effect examples.
TimelineIn	Float	No	The time when the filter is applied on the timeline. Unit: seconds. The value is accurate to four decimal places. If you do not specify this parameter, the `TimelineIn` value of the corresponding clip is used.
TimelineOut	Float	No	The time when the filter is removed from the timeline. Unit: seconds. The value is accurate to four decimal places. If you do not specify this parameter, the `TimelineOut` value of the corresponding clip is used.
ExtParams	String	No	Extended parameters for the filter. This field is valid only when `SubType` is `color`, which applies a color filter. The configuration parameters for `ExtParams` for a color filter are described below.

Parameters for color filter ExtParams

Timeline example:Use color filters.

ExtParams parameter description

Parameter	Type	Value range	Description	Default
brightness	int	[-255,255]	Brightness	0
contrast	int	[-100,100]	Contrast	0
saturation	int	[-100,100]	Saturation	0
kelvin_temperature	int	[1000,40000]	The temperature. This parameter works with The temperature_ratio parameter is applied.	6000
temperature_ratio	int	[0,100]	The temperature ratio.	0
tint	int	[-100,100]	Hue	0
dark_corner_ratio	int	[0,100]	The vignetting ratio.	0

Effect Type: Volume (volume adjustment)

Timeline examples:Mute an entire video and Adjust video and audio volume.

Name	Type	Required	Description
Gain	Float	No	The volume gain. Range: [0, 10]. 0 = mute, 1 = original volume, less than 1 = quieter, greater than 1 = louder. Default: 1. Excessively high values may cause distortion.

Effect Type: AFade (audio fade)

Timeline example:Configure fade-in and fade-out for audio-only clips and audio in videos.

Name	Type	Required	Description
SubType	String	Yes	The audio fade subtype. Valid values: `In` (fade in) `Out` (fade out)
Duration	Float	No	The duration of the fade. A fade-in is applied to the beginning of the clip. A fade-out is applied to the end of the clip. The default value is 0, which means the effect is disabled.
Curve	String	No	The volume curve for the audio fade. The default value is `exp`. Valid values: `exp` (Exponential volume curve) `tri` (Linear volume curve)

Effect Type: AI_ASR (speech-to-text)

This effect generates captions from audio. You can place this effect in the `Effects` object of a video or audio track. The parameters are the same as for Effect Type: Text (banner text). By default, the captions are centered at the bottom of the video. This feature is available only in the China (Beijing), China (Shanghai), and China (Hangzhou) regions.

Name	Type	Required	Description
X	Float	No	The horizontal distance from the top-left corner of the banner text to the top-left corner of the output video. The value can be a percentage or a pixel value. A value in the range [0, 0.9999] represents a percentage of the output video's width. An integer value of 2 or greater represents an absolute pixel value.
Y	Float	No	The vertical distance from the top-left corner of the banner text to the top-left corner of the output video. The value can be a percentage or a pixel value. A value in the range [0, 0.9999] represents a percentage of the output video's height. An integer value of 2 or greater represents an absolute pixel value.
Font	String	No	The font of the banner text. Supported fonts:Font list. Default: SimSun.
FontSize	Int	Yes	The font size of the banner text.
FontColor	String	No	The color of the banner text. The value is a hexadecimal color code that starts with a number sign (#). Example: `#ffffff`.
FontColorOpacity	String	No	The opacity of the banner text. Range: [0, 1]. 1 = opaque, 0 = fully transparent. Default: 1.
FontFace	FontFace	No	The font face of the banner text.
NeedHighlighting	Boolean	No	Specifies whether to enable automatic highlighting for ASR captions.
HighlightingStyle	Style	No	The style for highlighted captions.

Effect Type: Rotate (rotate material)

This effect rotates a material by a specified angle. Only 90, 180, and 270 degrees are supported. Applies to materials on video or image tracks.

Timeline example:Material rotation.

Name	Type	Required	Description
Degree	Integer	Yes	The clockwise rotation angle of the material. Only 90, 180, and 270 degrees are supported.

Effect Type: AI_Matting (green screen matting)

This effect extracts a subject from a green or blue screen background and overlays it onto another background video or image. This feature is available only in the China (Beijing), China (Shanghai), and China (Hangzhou) regions.

Name	Type	Required	Description
Color	String	Yes	The background color to key out. Only `green` (green screen matting) and `blue` (blue screen matting) are supported.
Auto	Integer	Yes	Specifies whether to automatically detect the background color. Valid values: 0: Detect based on the threshold. 1: Automatic detection.
Thres	Float	No	The threshold for background color detection. A larger value means looser detection. The value must be in the range [0, 10].

Effect Type: AI_RealMatting (real-world matting)

This effect extracts a person from a real-world scene in a video and overlays them onto another background video or image. This feature is available only in the China (Beijing), China (Shanghai), and China (Hangzhou) regions.

Name	Type	Required	Description
Thres	Float	No	The threshold for background color detection. A larger value means looser detection. The value must be in the range [0, 10]. The default value is 2.

Effect Type: AI_Delogo (intelligent logo removal)

This effect intelligently recognizes and removes logos from videos. This feature is available only in the China (Beijing) and China (Shanghai) regions.

Effect Type: Clip (random clip)

This effect randomly clips a segment from the source material and adds it to the timeline.

Name	Type	Required	Description
SubType	String	Yes	The clipping type. Only random clipping is supported: `RandomClip`.
ClipDuration	Float	Yes	The duration of the clipped segment.

Effect Type: Flip

You can flip videos or images in a video track horizontally or vertically.

Timeline example:Horizontal and vertical flipping.

Name	Type	Required	Description
Direction	String	Yes	`horizontal`: Flip horizontally. `vertical`: Flip vertically.

Effect Type: KenBurns (Ken Burns effect)

This effect applies a Ken Burns effect to a video or image in a video track.

Limits:

This effect applies to images and videos. It can be used with VFX, filters, and transitions.
Because this effect lets you set the output frame width and height using the `WindowW` and `WindowH` parameters, it cannot be used with the `Crop`, `Scale`, `Pad`, or `Background` effects.

Name		Type	Required	Description	Example
Duration		Float	No	The duration of the effect. The default is the clip duration. The maximum value is 10. Unit: seconds (s).	5
WindowW		Float	No	The width of the clip. By default, the value is equal to the width of the output video. Unit: pixels. A value in the range `0 < WindowW <= 1` is a relative value. A value greater than 1 is an absolute value.	1
WindowH		Float	No	The height of the clip. By default, the value equals the height of the output video. Unit: pixels. If the value of WindowH is in the range of (0,1], the value is a relative value. > A value of 1 indicates the absolute value.	1
Start		String	No	The position of the effect area before the Ken Burns effect is applied. The position is determined by the x and y coordinates of the upper-left corner and the width and height of the effect area. The parameters are optional. The values must be separated by commas (,). "StartX, StartY, StartW, StartH" Limits: 0 < StartX + StartW <=1 0 < StartY + StartH <=1	"0,0,0.9,0.9"
	StartX	Float	No	The x coordinate of the upper-left corner of the effect area before the Ken Burns effect is applied. Unit: pixels. If the value of the StartX parameter is in the range of [0,1), the value is a relative value. A value of 1 or greater indicates an absolute value.	0
	StartY	Float	No	The y coordinate of the upper-left corner of the effect area before the Ken Burns effect is applied. Unit: pixels. If the value of the StartY parameter is in the range of [0,1), the value is a relative value. The absolute value must be greater than or equal to 1.	0
	StartW	Float	No	The width of the effect area before the Ken Burns effect is applied. Unit: pixels. If the value of the StartW parameter is in the range of (0,1], the value is a relative value. > A value of 1 indicates the absolute value.	0.9
	StartH	Float	No	The height of the effect area before the Ken Burns effect is applied. Unit: pixels. If the value of the StartH parameter is in the range of (0,1], the value is a relative value. > 1 indicates an absolute value.	0.9
End		String	No	The position of the effect area after the Ken Burns effect is applied. The position is determined by the x and y coordinates of the upper-left corner and the width and height of the effect area. The parameters are optional. The values must be separated by commas (,). "EndX, EndY, EndW, EndH" Limits: 0 < EndX + EndW <=1 0 < EndY + EndH <=1	"0,0,1,1"
	EndX	Float	No	The x coordinate of the upper-left corner of the effect area after the Ken Burns effect is applied. Unit: pixels. If the value of the StartX parameter is in the range of [0,1), the value is a relative value. The absolute value must be greater than or equal to 1.	0
	EndY	Float	No	The y coordinate of the upper-left corner of the effect area after the Ken Burns effect is applied. Unit: pixels. If the value of the StartY parameter is in the range of [0,1), the value is a relative value. The absolute value must be greater than or equal to 1.	0
	EndW	Float	No	The width of the effect area after the Ken Burns effect is applied. Unit: pixels. If the value of the StartW parameter is in the range of (0,1], the value is a relative value. > A value of 1 indicates the absolute value.	1
	EndH	Float	No	The height of the effect area after the Ken Burns effect is applied. Unit: pixels. If the value of the StartH parameter is in the range of (0,1], the value is a relative value. > 1 specifies the absolute value.	1

Effect Type: ADenoise (audio denoising)

You can apply this effect to videos with audio on a video track or to audio clips on an audio track.

Name	Type	Required	Description
Mode	Integer	No	0: No processing (default). 1: Minor noise reduction. 2: Protects music while removing stationary noise. Suitable for musical content. 3: Strong removal of stationary noise. Suitable for speech content without music. 4: Speech extraction. Removes both stationary and non-stationary noise. Suitable for non-musical content.

Effect Type: Zoom

This effect adds a zoom effect to the corresponding clip.

Important

This effect is supported only for clips in a `VideoTrack`.

Name	Type	Required	Description
StartRate	Float	No	The starting zoom ratio. Default: 1.0. Value range: [1.0, 5.0].
EndRate	Float	No	The ending zoom ratio. Default: `StartRate` + 0.3. Value range: [`StartRate`, 5.0].
Duration	Float	No	The duration of the effect. Default: The rendering duration of the current clip. Value range: [0, rendering duration of the current clip].

Effect Type: Harmonization (background harmonization)

This effect adds a background harmonization effect to the corresponding clip and is mainly intended for digital human video clips. When you apply this effect to a digital human video clip, the clip's lighting, brightness, and color temperature are adjusted to match the background image. This reduces the visual mismatch between the digital human clip and the background.

Important

This effect is supported only for clips in a `VideoTrack`.
You can add only one harmonization effect in a single video editing request.

This effect has no other input parameters.

Effect Type: ALoudNorm (volume normalization)

The `ALoudNorm` effect applies to a single audio or video material. If you have multiple audio or video materials and want them to have the same loudness, you must configure `ALoudNorm` on each material separately.

Note

This effect applies only to audio and video clips. If `ALoudNorm` is used with `ADenoise` or `Volume`, the effects are applied in the following order: `ADenoise` > `Volume` > `ALoudNorm`.

Timeline example:Volume normalization.

Name	Type	Required	Description
Loudness	Float	No	The target loudness, which determines the volume level and complies with the EBU R128 standard. Value range: [-70.0, -5.0]. Default: -24.0.
TruePeak	Float	No	The true peak level, which limits the highest peak level of the audio signal. Value range: [-9.0, +0.0]. Default: -2.0.

Effect Type: AEqualize (volume equalization)

This is a global effect that applies to the effects track. It applies uniform volume equalization to the final audio mix.

Note

This effect is global and cannot be applied to a single clip.

Timeline example:Volume equalization.

Name

Type

Required

Description

Peak

Float

No

The target peak level of the audio. The default value is 0.95. Do not exceed this value.

The value must be in the open interval (0, 1).

Gain

Float

No

The maximum gain coefficient. The value must be in the range [1.0, 100.0]. The default value is 10.0.

The dynamic audio normalizer determines the maximum possible (local) gain factor for each input frame that does not cause clipping or distortion.

Effect Type: FreezeFrame (freeze frame)

This effect applies to video materials on a video track and creates a freeze frame from the last frame of the video.

Note

This effect applies only to video materials on a video track. It does not apply to image materials on a video track or to materials on an audio track.

This effect cannot be used with the Effect Type: Transition effect.

Timeline example:Video freeze frame.

Name	Type	Required	Description
Duration	Float	No	The duration of the freeze frame. The default value is 0. Unit: seconds (s).