All Products
Search
Document Center

Intelligent Media Services:Effect configurations

Last Updated:Aug 24, 2026

Effects define transformations applied to clips in a timeline. Each effect type provides a distinct set of parameters that control its behavior, positioning, timing, and appearance.

Effect type overview

The following table lists all available effect types and their primary functions.

Effect type

Description

Text

Adds banner text (subtitles) to the output video.

DeWatermark

Removes watermarks by blurring a specified area.

Crop

Crops the clip to a specified rectangular region.

Scale

Scales the clip to a specified size.

Pad

Adds padding around the clip image.

Background

Configures background blur or color when clip and output sizes do not match.

Transition

Adds a transition between two adjacent clips.

DLTransition

Adds a frame-interpolated transition that preserves the output duration.

VFX

Applies visual effects, including mask effects.

Filter

Applies color filters and color grading.

Volume

Adjusts the volume gain of a clip.

AFade

Adds audio fade in or fade out.

AI_ASR

Generates subtitles from audio using speech recognition.

Rotate

Rotates a clip by 90°, 180°, or 270°.

AI_Matting

Extracts subjects from green or blue backgrounds.

AI_RealMatting

Extracts human figures from live-action scenes.

AI_Delogo

Intelligently removes station logos from videos.

Clip

Randomly clips a time segment from the original clip.

Flip

Flips a video or image horizontally or vertically.

KenBurns

Applies a Ken Burns panning and zooming effect.

ADenoise

Reduces audio noise.

Zoom

Adds a zoom effect to a clip.

Harmonization

Adapts digital human video clips to background lighting and color.

ALoudNorm

Normalizes audio loudness.

AEqualize

Applies global loudness equalization.

FreezeFrame

Freezes the last frame of a video clip.

Text and subtitle effects

Effect type: Text (banner text)

Timeline example: Subtitles and subtitle templates

Positioning and timing

Name

Type

Required

Description

X

Float

No

The horizontal distance between the upper-left corner of the banner text and the upper-left corner of the output video. Both percentage and pixel formats are supported. A value in the range of [0, 0.9999] specifies the ratio relative to the width of the output video. An integer value greater than or equal to 2 specifies absolute pixels. Default value: 0. This coordinate is scaled based on the clip size and the output video size.

Y

Float

No

The vertical distance between the upper-left corner of the banner text and the upper-left corner of the output video. Both percentage and pixel formats are supported. A value in the range of [0, 0.9999] specifies the ratio relative to the height of the output video. An integer value greater than or equal to 2 specifies absolute pixels. Default value: 0. This coordinate is scaled based on the clip size and the output video size.

FixedX

Float

No

The horizontal distance between the upper-left corner of the banner text and the upper-left corner of the output video. Both percentage and pixel formats are supported. A value in the range of [0, 0.9999] specifies the ratio relative to the width of the output video. An integer value greater than or equal to 2 specifies absolute pixels. Default value: 0. This coordinate is not scaled based on the clip size and the output video size.

FixedY

Float

No

The vertical distance between the upper-left corner of the banner text and the upper-left corner of the output video. Both percentage and pixel formats are supported. A value in the range of [0, 0.9999] specifies the ratio relative to the height of the output video. An integer value greater than or equal to 2 specifies absolute pixels. Default value: 0. This coordinate is not scaled based on the clip size and the output video size.

TimelineIn

Float

No

The start position of the banner text on the timeline. Unit: seconds, accurate to four decimal places. If you leave this parameter empty, the value is the same as the TimelineIn value of the corresponding clip.

TimelineOut

Float

No

The end position of the banner text on the timeline. Unit: seconds, accurate to four decimal places. If you leave this parameter empty, the value is the same as the TimelineOut value of the corresponding clip.

Text content and font

Name

Type

Required

Description

Content

String

Yes

The content of the banner text.

Font

String

No

The font of the banner text. For the supported fonts, see Font list. Default value: SimSun.

FontSize

Int

Yes

The font size of the banner text. This font size is scaled based on the clip size and the output video size. Default value: 0. Maximum value: 5000. Specify only one of FontSize and FixedFontSize. If you specify both, only FontSize takes effect.

FixedFontSize

Int

Yes

The font size of the banner text. This font size is not scaled based on the clip size and the output video size. Specify only one of FontSize and FixedFontSize. If you specify both, only FontSize takes effect.

SizeRequestType

String

No

The method used to calculate the actual rendered text size from the font size. Default value: RealDim. Valid values: Nominal: the rendered subtitle height in pixels equals the FontSize value. RealDim: for some fonts, the rendered subtitle height in pixels may be smaller than the FontSize value.

FontUrl

String

No

The path to a custom font file in your OSS bucket. TTF, OTF, and WOFF formats are supported. Example: https://your-bucket.oss-cn-shanghai.aliyuncs.com/example-font.ttf

Text appearance

Name

Type

Required

Description

FontColor

String

No

The color of the banner text, in the format of a number sign (#) followed by a hexadecimal value. Example: #ffffff.

FontColorOpacity

String

No

The opacity of the banner text. Valid values: 0 to 1. A value of 1 indicates opaque. A value of 0 indicates fully transparent. Default value: 1.

FontFace

FontFace

No

The font appearance of the banner text.

Spacing

Integer

No

The character spacing of the banner text. Unit: pixels. Default value: 0.

LineSpacing

Integer

No

The line spacing of the banner text. Unit: pixels. Default value: 0.

Angle

Float

No

The counterclockwise rotation angle of the banner text. Unit: degrees. Default value: 0.

BorderStyle

Int

No

The border and shadow style of the banner text. Valid values: 1 (border and shadow) and 3 (opaque background box). Default value: 1.

Outline

Int

No

The outline width of the banner text. Unit: pixels. Default value: 0.

OutlineColour

String

No

The outline color of the banner text, in the format of a number sign (#) followed by a hexadecimal value. Example: #ffffff.

Shadow

Int

No

The depth of the shadow cast by the banner text. Unit: pixels. Default value: 0.

BackColour

String

No

The shadow color of the banner text, in the format of a number sign (#) followed by a hexadecimal value. Example: #ffffff.

Alignment and adaptation

Name

Type

Required

Description

Alignment

String

No

The positioning and alignment mode of the banner text. Default value: TopLeft. This parameter has two aspects: Position anchor — determines where on the video the text is placed. Valid values: TopLeft (upper-left corner), TopCenter (upper part of the vertical center line), TopRight (upper-right corner), CenterLeft (left part of the horizontal center line), CenterCenter (center of the video), CenterRight (right part of the horizontal center line), BottomLeft (lower-left corner), BottomCenter (lower part of the vertical center line), BottomRight (lower-right corner). Text alignment mode — determines how X and Y coordinates map to the subtitle text. For precise positioning, use one of the following modes: Left (left-aligned; X and Y specify the coordinates of the upper-left vertex of the subtitle relative to the upper-left corner of the video), Center (center-aligned; X and Y specify the coordinates of the intersection point on the upper boundary of the subtitle center line relative to the upper-left corner of the video), Right (right-aligned; X and Y specify the coordinates of the upper-right vertex of the subtitle relative to the upper-left corner of the video).

AdaptMode

String

No

Specifies whether the banner text automatically wraps or scales when it exceeds the video width or the specified TextWidth value. Valid values: AutoWrap (automatic line wrapping), AutoScale (automatic scaling), AutoWrapAtSpaces (automatic line wrapping only at spaces, applicable to English-only subtitles).

TextWidth

String

No

The width of the subtitle text box. This parameter takes effect when AdaptMode is specified. Line wrapping or scaling is performed based on this text box width. If you leave this parameter empty, line wrapping or scaling is performed based on the video width. A value greater than 0 and less than or equal to 1 specifies the width relative to the output video. A value greater than 1 specifies absolute pixels.

EnableLocalStyleAutoScale

Boolean

No

Specifies whether the font size, outline size, and shadow size of a local subtitle style are scaled based on the output video size and the FECanvas size. Default value: false.

SupportBidi

Boolean

No

Specifies whether to enable bidirectional text rendering. Enable this feature when subtitle text contains both left-to-right (LTR) text such as English, digits, and Latin letters, and right-to-left (RTL) text. Default value: false.

Animation and effects

Name

Type

Required

Description

EffectColorStyle

String

No

The artistic text style type of the banner text. For more information, see Word art.

TextureURL

String

No

The subtitle texture effect. PNG, JPG, JPEG, and BMP formats are supported. Only OSS files are supported. Example: https://your-bucket.oss-cn-shanghai.aliyuncs.com/your-image.png

AaiMotionInEffect

String

No

The entrance effect type of the banner text. For more information, see Subtitle effect examples.

AaiMotionIn

Float

No

The duration of the entrance effect. Unit: seconds, accurate to four decimal places. Default value: 0.5. If the text duration is less than 0.5, the value is the total duration minus the exit effect duration.

AaiMotionOutEffect

String

No

The exit effect type of the banner text. For more information, see Subtitle effect examples.

AaiMotionOut

Float

No

The duration of the exit effect. Unit: seconds, accurate to four decimal places. Default value: 0.5. If the text duration is less than 0.5, the value is the total text duration.

AaiMotionLoopEffect

String

No

The loop effect type of the banner text. This parameter cannot take effect together with the subtitle entrance effect or exit effect. For more information, see Subtitle effect examples.

Ratio

Float

No

The playback speed of the loop effect, accurate to four decimal places. Default value: 1. A value greater than 1 indicates an accelerated loop. A value less than 1 indicates a slowed-down loop.

SubtitleEffects

SubtitleEffect[]

No

The multi-layer effects of the banner text. Multi-layer outlines, multi-layer shadows, Gaussian blur (supported only when the type is shadow), and subtitle background effects are supported. If you specify SubtitleEffects, the Outline and Shadow fields in the subtitle track no longer take effect. When you configure multi-layer outline, shadow, or background effects, the order of the SubtitleEffects array specifies the layer order. The first SubtitleEffect in the array is rendered at the bottom layer, and the last SubtitleEffect in the array is rendered at the top layer.

Bubble text

Name

Type

Required

Description

BubbleStyleId

String

No

The bubble text style type. For the bubble types and effects, see Text bubble effect examples.

BubbleWidth

Float

No

The width of the bubble background image relative to the output video. This parameter takes effect only when bubble text is used. A value greater than 1 specifies absolute pixels. A value less than or equal to 1 specifies a relative value.

BubbleHeight

Float

No

The height of the bubble background image relative to the output video. This parameter takes effect only when bubble text is used. A value greater than 1 specifies absolute pixels. A value less than or equal to 1 specifies a relative value.

Effect type: AI_ASR (speech-to-text)

Generates subtitles based on audio. You can place this effect in the Effects array of a video track or an audio track. The parameters are the same as those in . By default, the subtitles are centered at the bottom of the video.

Note

This effect can be called only in the Beijing, Shanghai, and Hangzhou regions.

Timeline example: Use AI_ASR to convert speech to text and merge the captions into a video

Name

Type

Required

Description

X

Float

No

The horizontal distance between the upper-left corner of the banner text and the upper-left corner of the output video. Both percentage and pixel formats are supported. A value in the range of [0, 0.9999] specifies the ratio relative to the width of the output video. An integer value greater than or equal to 2 specifies absolute pixels.

Y

Float

No

The vertical distance between the upper-left corner of the banner text and the upper-left corner of the output video. Both percentage and pixel formats are supported. A value in the range of [0, 0.9999] specifies the ratio relative to the height of the output video. An integer value greater than or equal to 2 specifies absolute pixels.

Font

String

No

The font of the banner text. For the supported fonts, see Font list. Default value: SimSun.

FontSize

Int

Yes

The font size of the banner text.

FontColor

String

No

The color of the banner text, in the format of a number sign (#) followed by a hexadecimal value. Example: #ffffff.

FontColorOpacity

String

No

The opacity of the banner text. Valid values: 0 to 1. A value of 1 indicates opaque. A value of 0 indicates fully transparent. Default value: 1.

FontFace

FontFace

No

The font appearance of the banner text.

NeedHighlighting

Boolean

No

Specifies whether to enable automatic highlighting for ASR subtitles.

HighlightingStyle

Style

No

The style of the highlighted subtitles.

AlignmentText

String

No

The subtitle timing text. After you specify this parameter, the ASR recognition result is aligned with the provided text, and sentences are automatically split and filled into the corresponding time positions.

Video effects

Effect type: DeWatermark (watermark removal)

Name

Type

Required

Description

X

Float

No

The horizontal distance between the upper-left corner of the blurred area and the upper-left corner of the output video. Both percentage and pixel formats are supported. A value in the range of [0, 0.9999] specifies the ratio relative to the width of the output video. An integer value greater than or equal to 2 specifies absolute pixels. Default value: 0.

Y

Float

No

The vertical distance between the upper-left corner of the blurred area and the upper-left corner of the output video. Both percentage and pixel formats are supported. A value in the range of [0, 0.9999] specifies the ratio relative to the height of the output video. An integer value greater than or equal to 2 specifies absolute pixels. Default value: 0.

Width

Float

Yes

The width of the blurred area in the output video. Both percentage and pixel formats are supported. A value in the range of [0, 0.9999] specifies the ratio relative to the width of the output video. An integer value greater than or equal to 2 specifies absolute pixels.

Height

Float

Yes

The height of the blurred area in the output video. Both percentage and pixel formats are supported. A value in the range of [0, 0.9999] specifies the ratio relative to the height of the output video. An integer value greater than or equal to 2 specifies absolute pixels.

Effect type: Crop

Timeline example: Crop a video

Name

Type

Required

Description

X

Float

No

The horizontal distance between the upper-left corner of the retained area after cropping and the upper-left corner of the output video. Both percentage and pixel formats are supported. A value in the range of [0, 0.9999] specifies the ratio relative to the width of the output video. An integer value greater than or equal to 2 specifies absolute pixels. Default value: 0.

Y

Float

No

The vertical distance between the upper-left corner of the retained area after cropping and the upper-left corner of the output video. Both percentage and pixel formats are supported. A value in the range of [0, 0.9999] specifies the ratio relative to the height of the output video. An integer value greater than or equal to 2 specifies absolute pixels. Default value: 0.

Width

Float

Yes

The width of the retained area after cropping in the output video. Both percentage and pixel formats are supported. A value in the range of [0, 0.9999] specifies the ratio relative to the width of the output video. An integer value greater than or equal to 2 specifies absolute pixels.

Height

Float

Yes

The height of the retained area after cropping in the output video. Both percentage and pixel formats are supported. A value in the range of [0, 0.9999] specifies the ratio relative to the height of the output video. An integer value greater than or equal to 2 specifies absolute pixels.

Effect type: Scale

Note

If the Scale effect is not specified and the width and height of the clip image do not match those of the output video, the clip image is automatically scaled until its width or height matches the output image. Black bars are automatically added to the top and bottom or to the left and right, and the clip image is centered.

Timeline example: Scale modes

Name

Type

Required

Description

Width

Float

Yes

The width of the retained area after scaling in the output video. Both percentage and pixel formats are supported. A value in the range of [0, 0.9999] specifies the ratio relative to the width of the output video. An integer value greater than or equal to 1 specifies absolute pixels.

Height

Float

Yes

The height of the retained area after scaling in the output video. Both percentage and pixel formats are supported. A value in the range of [0, 0.9999] specifies the ratio relative to the height of the output video. An integer value greater than or equal to 1 specifies absolute pixels.

Effect type: Pad (padding)

Note

If the Pad effect is not specified and the aspect ratio of the clip image does not match that of the output video, the clip image is automatically scaled until its width or height matches the output image. Black bars are automatically added to the top and bottom or to the left and right, and the clip image is centered.

Timeline example: Convert a landscape video to portrait and add blurred areas

Name

Type

Required

Description

Left

Float

No

The distance between the left edge of the clip image and the left edge of the output video. Both percentage and pixel formats are supported. A value in the range of [0, 0.9999] specifies the ratio relative to the width of the output video. An integer value greater than or equal to 1 specifies absolute pixels.

Right

Float

No

The distance between the right edge of the clip image and the right edge of the output video. Both percentage and pixel formats are supported. A value in the range of [0, 0.9999] specifies the ratio relative to the width of the output video. An integer value greater than or equal to 1 specifies absolute pixels.

Top

Float

No

The distance between the top edge of the clip image and the top edge of the output video. Both percentage and pixel formats are supported. A value in the range of [0, 0.9999] specifies the ratio relative to the height of the output video. An integer value greater than or equal to 1 specifies absolute pixels.

Bottom

Float

No

The distance between the bottom edge of the clip image and the bottom edge of the output video. Both percentage and pixel formats are supported. A value in the range of [0, 0.9999] specifies the ratio relative to the height of the output video. An integer value greater than or equal to 1 specifies absolute pixels.

Color

String

No

The padding color, in the format of a number sign (#) followed by a hexadecimal value. Example: #000000. Default value: black.

Effect type: Background (background settings)

Background settings include background blur and background color. When the clip size and the output video size do not match, you can use this effect to configure the blank area. Background settings can be used together with effects such as crop, scale, visual effect, and transition.

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

Name

Type

Required

Description

SubType

String

Yes

The background subtype. Valid values: Blur (background blur), Color (background color).

Radius

Float

No

The blur radius. This parameter takes effect when SubType is set to Blur. Valid values: [0.01, 1].

Color

String

No

The background color value, expressed as a hexadecimal RGB color. This parameter takes effect when SubType is set to Color. Example: #FFFFFF.

Effect type: Rotate (clip rotation)

Rotates a clip by a specific angle. Only 90°, 180°, and 270° rotations are supported. You can place this effect in the Effects array of a clip in a video track or an image track.

Timeline example: Rotate a material

Name

Type

Required

Description

Degree

Integer

Yes

The clockwise rotation angle of the clip. Valid values: 90, 180, and 270.

Effect type: Flip

Flips a video or image in a video track horizontally or vertically.

Timeline example: Horizontal and vertical flips

Name

Type

Required

Description

Direction

String

Yes

The flip direction. Valid values: horizontal (flips the image horizontally), vertical (flips the image vertically).

Effect type: VFX (visual effect)

Timeline example: Visual effects

Name

Type

Required

Description

SubType

String

Yes

The visual effect subtype. You can specify multiple subtypes separated by commas (,), and one of them is randomly selected. You can also specify random to randomly select one from all visual effect subtypes. Example value: colorfulradial. For the complete valid values and effects, see Special effect examples.

X

Float

No

Supported only when SubType is set to mosaic_rect or blur. The horizontal distance between the upper-left corner of the effect area and the upper-left corner of the output video. Both percentage and pixel formats are supported. A value in the range of [0, 0.9999] specifies the ratio relative to the width of the output video. An integer value greater than or equal to 2 specifies absolute pixels.

Y

Float

No

Supported only when SubType is set to mosaic_rect or blur. The vertical distance between the upper-left corner of the effect area and the upper-left corner of the output video. Both percentage and pixel formats are supported. A value in the range of [0, 0.9999] specifies the ratio relative to the height of the output video. An integer value greater than or equal to 2 specifies absolute pixels.

Width

Float

No

Supported only when SubType is set to mosaic_rect or blur. The width of the effect area in the output video. Both percentage and pixel formats are supported. A value in the range of [0, 0.9999] specifies the ratio relative to the width of the output video. An integer value greater than or equal to 2 specifies absolute pixels.

Height

Float

No

Supported only when SubType is set to mosaic_rect or blur. The height of the effect area in the output video. Both percentage and pixel formats are supported. A value in the range of [0, 0.9999] specifies the ratio relative to the height of the output video. An integer value greater than or equal to 2 specifies absolute pixels.

ExtParams

String

No

The extended parameters of the visual effect. This parameter takes effect only when SubType is set to mask_circle, mask_rec, mask_linear, or mask_minor (mask scenarios). For the ExtParams configuration parameters of masks, see the following sections.

Mask examples and output video effects: Mask effects

Note

For the following mask parameters, if the parameter type is float, you must specify the value strictly in float format, such as 0.5 or 2.0.

Circular mask parameters

SubType = mask_circle

Parameter

Type

Valid values

Default value

Description

x

float

[0.0, clip width]

0.5

The X coordinate of the center of the mask circle in the clip, relative to the upper-left corner of the clip. A value in the range of [0.0, 1.0] specifies a coordinate relative to the clip width. A value greater than 1.0 specifies absolute pixels.

y

float

[0.0, clip height]

0.5

The Y coordinate of the center of the mask circle in the clip, relative to the upper-left corner of the clip. A value in the range of [0.0, 1.0] specifies a coordinate relative to the clip height. A value greater than 1.0 specifies absolute pixels.

width

float

[0.0, clip width]

0.8

The width of the mask ellipse, relative to the clip width. A value in the range of [0.0, 1.0] specifies a width relative to the clip width. A value greater than 1.0 specifies absolute pixels.

height

float

[0.0, clip height]

0.8

The height of the mask ellipse, relative to the clip height. A value in the range of [0.0, 1.0] specifies a height relative to the clip height. A value greater than 1.0 specifies absolute pixels.

antialias

float

[0.0, 1.0]

0.1

The antialiasing parameter of the mask ellipse. A larger value results in a higher degree of edge feathering.

angle

float

[-9999.0, 9999.0]

0.0

The rotation angle.

blur_intensity

float

[0.0, 1.0]

0

The blur intensity inside the mask. A value of 0.0 disables blur. A larger value results in a higher degree of blur in the mask area.

outer_alpha

float

[0.0, 1.0]

0

The opacity of the area outside the mask. A value of 0.0 indicates that the area outside the mask is fully transparent. A value of 1.0 indicates that the original image outside the mask is fully retained. A value in between indicates semi-transparent retention.

Rectangular mask parameters

SubType = mask_rec

Parameter

Type

Valid values

Default value

Description

x

float

[0.0, clip width]

0.5

The X coordinate of the center of the mask rectangle in the video clip, relative to the upper-left corner of the clip. A value in the range of [0.0, 1.0] specifies a coordinate relative to the clip width. A value greater than 1.0 specifies absolute pixels.

y

float

[0.0, clip height]

0.5

The Y coordinate of the center of the mask rectangle in the video clip, relative to the upper-left corner of the clip. A value in the range of [0.0, 1.0] specifies a coordinate relative to the clip height. A value greater than 1.0 specifies absolute pixels.

width

float

[0.0, clip width]

0.8

The width of the mask rectangle. A value in the range of [0.0, 1.0] specifies a width relative to the clip width. A value greater than 1.0 specifies absolute pixels.

height

float

[0.0, clip height]

0.8

The height of the mask rectangle. A value in the range of [0.0, 1.0] specifies a height relative to the clip height. A value greater than 1.0 specifies absolute pixels.

antialias

float

[0.0, 1.0]

0.1

The antialiasing parameter of the mask rectangle. A larger value results in a higher degree of edge feathering.

radius

float

[0.0, the greater of the clip width and height]

0.1

The corner radius of the mask rectangle. A value in the range of [0.0, 1.0] specifies a radius relative to the greater of the clip width and height. A value greater than 1.0 specifies absolute pixels.

angle

float

[-9999.0, 9999.0]

0.0

The rotation angle.

blur_intensity

float

[0.0, 1.0]

0

The blur intensity inside the mask. A value of 0.0 disables blur. A larger value results in a higher degree of blur in the mask area.

outer_alpha

float

[0.0, 1.0]

0

The opacity of the area outside the mask. A value of 0.0 indicates that the area outside the mask is fully transparent. A value of 1.0 indicates that the original image outside the mask is fully retained. A value in between indicates semi-transparent retention.

Linear mask parameters

SubType = mask_linear

Parameter

Type

Valid values

Default value

Description

x

float

[0.0, clip width]

0.5

The X coordinate of the center reference point of the linear mask in the clip, relative to the upper-left corner of the clip. A value in the range of [0.0, 1.0] specifies a coordinate relative to the clip width. A value greater than 1.0 specifies absolute pixels.

y

float

[0.0, clip height]

0.5

The Y coordinate of the center reference point of the linear mask in the video clip, relative to the upper-left corner of the video. A value in the range of [0.0, 1.0] specifies a coordinate relative to the clip height. A value greater than 1.0 specifies absolute pixels.

antialias

float

[0.0, 1.0]

0.1

The antialiasing parameter of 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.

blur_intensity

float

[0.0, 1.0]

0

The blur intensity inside the mask. A value of 0.0 disables blur. A larger value results in a higher degree of blur in the mask area.

outer_alpha

float

[0.0, 1.0]

0

The opacity of the area outside the mask. A value of 0.0 indicates that the area outside the mask is fully transparent. A value of 1.0 indicates that the original image outside the mask is fully retained. A value in between indicates semi-transparent retention.

Mirror mask parameters

SubType = mask_minor

Parameter

Type

Valid values

Default value

Description

x

float

[0.0, clip width]

0.5

The X coordinate of the center reference point of the mirror mask in the clip, relative to the upper-left corner of the clip. A value in the range of [0.0, 1.0] specifies a coordinate relative to the clip width. A value greater than 1.0 specifies absolute pixels.

y

float

[0.0, clip height]

0.5

The Y coordinate of the center reference point of the mirror mask in the clip, relative to the upper-left corner of the clip. A value in the range of [0.0, 1.0] specifies a coordinate relative to the clip height. A value greater than 1.0 specifies absolute pixels.

antialias

float

[0.0, 1.0]

0.1

The antialiasing parameter of 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.

blur_intensity

float

[0.0, 1.0]

0

The blur intensity inside the mask. A value of 0.0 disables blur. A larger value results in a higher degree of blur in the mask area.

outer_alpha

float

[0.0, 1.0]

0

The opacity of the area outside the mask. A value of 0.0 indicates that the area outside the mask is fully transparent. A value of 1.0 indicates that the original image outside the mask is fully retained. A value in between indicates semi-transparent retention.

Effect type: Filter

Timeline example: Filters

Name

Type

Required

Description

SubType

String

Yes

The filter subtype. You can specify multiple subtypes separated by commas (,), and one of them is randomly selected. You can also specify random to randomly select one from all filter subtypes. Example value: M1. For the complete valid values and effects, see Filter examples.

TimelineIn

Float

No

The start position of the filter on the timeline. Unit: seconds, accurate to four decimal places. If you leave this parameter empty, the value is the same as the TimelineIn value of the corresponding clip.

TimelineOut

Float

No

The end position of the filter on the timeline. Unit: seconds, accurate to four decimal places. If you leave this parameter empty, the value is the same as the TimelineOut value of the corresponding clip.

ExtParams

String

No

The extended parameters of the filter. This parameter takes effect only when SubType is set to color (color filter). For the ExtParams configuration parameters of the color grading filter, see the following section.

Color grading filter parameters

Timeline example: Use a color filter

Parameter

Type

Valid values

Default value

Description

brightness

int

[-255, 255]

0

The brightness adjustment.

contrast

int

[-100, 100]

0

The contrast adjustment.

saturation

int

[-100, 100]

0

The saturation adjustment.

kelvin_temperature

int

[1000, 40000]

6000

The color temperature. Takes effect together with temperature_ratio.

temperature_ratio

int

[0, 100]

0

The color temperature ratio.

tint

int

[-100, 100]

0

The tint adjustment.

dark_corner_ratio

int

[0, 100]

0

The vignette ratio.

Effect type: Zoom

Adds a zoom effect to the corresponding clip. This effect is supported only for clips in a VideoTrack.

Name

Type

Required

Description

StartRate

Float

No

The start zoom ratio. Default value: 1.0. Valid values: [1.0, 5.0].

EndRate

Float

No

The end zoom ratio. Default value: StartRate + 0.3. Valid values: [StartRate, 5.0].

Duration

Float

No

The duration of the effect. Default value: the rendering duration of the current Clip. Valid values: [0, the rendering duration of the current Clip].

Effect type: KenBurns (Ken Burns effect)

Applies a Ken Burns effect to a video or image in a video track.

Considerations:

  • This effect applies to images and videos, and can be used together with VFX, filters, and transitions.

  • This effect supports setting the width and height of the output image (see the WindowW and WindowH parameters). Therefore, it cannot be used together with the Crop, Scale, Pad, or Background effect.

Timeline example: Ken Burns

Name

Type

Required

Description

Example

Duration

Float

No

The duration of the effect. Default value: the clip duration. Maximum value: 10. Unit: seconds.

5

WindowW

Float

No

The image width of the final output segment. Default value: the width of the output video. Unit: pixels. A value in the range of (0, 1] specifies a relative value. A value greater than 1 specifies an absolute value.

1

WindowH

Float

No

The image height of the final output segment. Default value: the height of the output video. Unit: pixels. A value in the range of (0, 1] specifies a relative value. A value greater than 1 specifies an absolute value.

1

Start

String

No

The position of the upper-left corner of the frame in the original clip when the effect starts. Format: "StartX,StartY,StartW,StartH". All values are optional. Constraints: 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 frame in the original clip when the effect starts. A value in the range of [0, 1) specifies a relative value. A value greater than or equal to 1 specifies absolute pixels.

0

StartY

Float

No

The Y coordinate of the upper-left corner of the frame in the original clip when the effect starts. A value in the range of [0, 1) specifies a relative value. A value greater than or equal to 1 specifies absolute pixels.

0

StartW

Float

No

The width of the frame in the original clip when the effect starts. A value in the range of (0, 1] specifies a relative value. A value greater than 1 specifies absolute pixels.

0.9

StartH

Float

No

The height of the frame in the original clip when the effect starts. A value in the range of (0, 1] specifies a relative value. A value greater than 1 specifies absolute pixels.

0.9

End

String

No

The position of the upper-left corner of the frame in the original clip when the effect ends. Format: "EndX,EndY,EndW,EndH". All values are optional. Constraints: 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 frame in the original clip when the effect ends. A value in the range of [0, 1) specifies a relative value. A value greater than or equal to 1 specifies absolute pixels.

0

EndY

Float

No

The Y coordinate of the upper-left corner of the frame in the original clip when the effect ends. A value in the range of [0, 1) specifies a relative value. A value greater than or equal to 1 specifies absolute pixels.

0

EndW

Float

No

The width of the frame in the original clip when the effect ends. A value in the range of (0, 1] specifies a relative value. A value greater than 1 specifies absolute pixels.

1

EndH

Float

No

The height of the frame in the original clip when the effect ends. A value in the range of (0, 1] specifies a relative value. A value greater than 1 specifies absolute pixels.

1

Effect type: FreezeFrame (freeze frame)

Applies freeze-frame processing to the last frame of a video clip. This effect applies only to video clips in a video track. It does not apply to image clips in a video track or to clips in an audio track.

This effect cannot be used together with a transition. For more information, see .

Timeline example: Video freeze frame

Name

Type

Required

Description

Duration

Float

No

The freeze-frame duration. Default value: 0. Unit: seconds.

Transition effects

Effect type: Transition

A transition overlaps the layers of two adjacent clips within the same period of time, which shortens the duration of the output video. To avoid a shortened duration, use the DLTransition (frame-interpolated transition) effect.

A transition effect is placed between two clips. You only need to set the transition duration for the preceding clip. The transition applies to the end of the preceding clip and the beginning of the following clip. During the transition, the video images are overlaid, so the total duration is reduced by an amount equal to the transition duration.

For example, a video track contains two clips: Clip1 (10 seconds) and Clip2 (8 seconds). If you add a 4-second transition between Clip1 and Clip2, the total duration of the video track decreases from 18 seconds to 14 seconds.

For the available transition effects, see Transition effect examples.

Timeline example: Transition timeline configuration example

Name

Type

Required

Description

SubType

String

Yes

The transition subtype. You can specify multiple subtypes separated by commas (,), and one of them is randomly selected. You can also specify random to randomly select one from all transition subtypes. Example value: directional. For the complete valid values and effects, see Transition effect examples.

Duration

Float

No

The duration of the transition effect. Unit: seconds, accurate to four decimal places. Default value: 1.

Effect type: DLTransition (frame-interpolated transition)

Unlike the standard Transition, DLTransition (Duration Lock Transition) fills the transition with freeze frames so that the duration of the output video is not shortened.

The parameters are used in the same way as those of the Transition effect.

Name

Type

Required

Description

SubType

String

Yes

The transition subtype. You can specify multiple subtypes separated by commas (,), and one of them is randomly selected. You can also specify random to randomly select one from all transition subtypes. Example value: directional. For the complete valid values and effects, see Transition effect examples.

Duration

Float

No

The duration of the transition effect. Unit: seconds, accurate to four decimal places. Default value: 1.

Audio effects

Effect type: Volume (volume adjustment)

Timeline examples: Mute an entire video, Example of adjusting the volume of a video and the volume of an audio clip

Name

Type

Required

Description

Gain

Float

Yes

The volume gain. Valid values: 0 to 10. A value of 0 indicates mute. A value of 1 indicates the original volume. A value less than 1 indicates a volume lower than the original volume. A value greater than 1 indicates a volume higher than the original volume. Do not set an excessively large volume gain, which may cause audio distortion.

Effect type: AFade (audio fade in and fade out)

Timeline example: Configure fade in and fade out for an audio-only clip and for the audio in a video clip

Name

Type

Required

Description

SubType

String

Yes

The fade subtype. Valid values: In (fade in), Out (fade out).

Duration

Float

No

The duration of the fade in or fade out. Fade in applies to the beginning of the clip. Fade out applies to the end of the clip. Default value: 0, which indicates that fade in and fade out do not take effect.

Curve

String

No

The volume curve of the fade effect. Default value: exp. Valid values: exp (exponential volume increase or decrease), tri (linear volume increase or decrease).

Effect type: ADenoise (audio noise reduction)

Reduces noise for audio in a video track or an audio track.

Name

Type

Required

Description

Mode

Integer

No

The noise reduction mode. Valid values: 0 (no processing, default), 1 (noise reduction with a small amplitude), 2 (removes stationary noise while protecting music, suitable for music content), 3 (strongly removes stationary noise, suitable for speech content without music), 4 (speech extraction, removes both stationary and non-stationary noise, suitable for non-music content).

Effect type: ALoudNorm (loudness normalization)

ALoudNorm applies only to a single audio or video clip. If you have multiple audio or video clips and want them to have the same loudness, configure ALoudNorm separately for each clip.

This effect applies only to audio and video clips. If ALoudNorm is used together with ADenoise or Volume, the application order is: ADenoise > Volume > ALoudNorm.

Timeline example: Normalize audio

Name

Type

Required

Description

Loudness

Float

No

The target loudness, which determines the volume level and complies with the EBU R128 measurement. Valid values: [-70.0, -5.0]. Default value: -24.0.

TruePeak

Float

No

The true peak level, which limits the highest peak level of the audio signal. Valid values: [-9.0, +0.0]. Default value: -2.0.

Effect type: AEqualize (loudness equalization)

Applies uniform loudness equalization to the global audio. This effect applies to the effect track and is a global effect. It is not supported for a single clip.

Timeline example: Equalize the volume

Name

Type

Required

Description

Peak

Float

No

The target peak of the audio. Default value: 0.95. Do not exceed this value. Valid values: (0, 1).

Gain

Float

No

The maximum gain factor. Valid values: 1.0 to 100.0. Default value: 10.0. The dynamic audio normalizer determines the maximum possible (local) gain factor for each input frame, that is, the maximum gain factor that does not cause clipping or distortion.

AI-powered effects

Effect type: AI_Matting (image matting)

Extracts the subject from a green or blue background color and overlays it on another background video or image.

Note

This effect can be called only in the Beijing, Shanghai, and Hangzhou regions.

Timeline example: AI_Matting: Green screen matting

Name

Type

Required

Description

Color

String

Yes

The background color. Only green (image matting) and blue (blue screen matting) are supported.

Auto

Integer

Yes

Specifies whether the background color is automatically determined. Valid values: 0 (determined based on the threshold), 1 (automatically determined).

Thres

Float

No

The threshold for determining the background color. A larger value results in a more lenient determination. Valid values: [0, 10].

Effect type: AI_RealMatting (live-action matting)

Extracts the human figure in a video from a live-action scene and overlays it on another background video or image.

Note

This effect can be called only in the Beijing, Shanghai, and Hangzhou regions.

Timeline example: AI_RealMatting: Background replacement

Name

Type

Required

Description

Thres

Float

No

The threshold for determining the background color. A larger value results in a more lenient determination. Valid values: [0, 10]. Default value: 2.

Effect type: AI_Delogo (intelligent logo removal)

Intelligently identifies and removes the station logo in a video.

Note

This effect can be called only in the Beijing and Shanghai regions.

Effect type: Harmonization (background harmonization)

Adds a background harmonization effect to the corresponding clip. This effect applies mainly to digital human video clips. After you add this effect to a digital human video clip, the effect adapts to the lighting, brightness, and color temperature of the background image, which reduces the visual mismatch between the digital human video clip and the background image.

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

  • Only one background harmonization effect can be added in a single editing request.

    This effect has no additional input parameters.

Other effects

Effect type: Clip (random clipping)

The clipping feature. Only random clipping is supported. A time segment is randomly clipped from the original clip and inserted into 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.