All Products
Search
Document Center

Intelligent Media Services:Effect configurations

Last Updated:Apr 22, 2025

The structure of the Effect parameter varies based on effect types. This topic describes the structure of the Effect parameter.

Text

For timeline examples, see Subtitles and subtitle templates.

Parameter

Type

Required

Description

X

Float

No

The horizontal distance between the upper-left corner of the text and the upper-left corner of the output video. Note: You can set the value to a percentage or the number of pixels. If the value ranges from 0 to 0.9999, the value indicates a percentage. If the value is an integer greater than or equal to 2, the value indicates an absolute pixel value. Default value: 0. The coordinates are scaled based on the size of the source and the output videos.

Y

Float

No

The vertical distance between the upper-left corner of the text and the upper-left corner of the output video. Note: You can set the value to a percentage or the number of pixels. If the value ranges from 0 to 0.9999, the value indicates a percentage. If the value is an integer greater than or equal to 2, the value indicates an absolute pixel value. Default value: 0. The coordinates are scaled based on the size of the source and the output videos.

TimelineIn

Float

No

The time when the text is displayed in the timeline. Unit: seconds. The value is accurate to four decimal places. If this parameter is not specified, the TimelineIn value of the clip is used.

TimelineOut

Float

No

The time when the text stops to be displayed in the timeline. Unit: seconds. The value is accurate to four decimal places. If this parameter is not specified, the TimelineOut value of the clip is used.

Content

String

Yes

The content of the banner text.

Font

String

No

The font of the banner text. For more information about the supported fonts, see Fonts. Default value: SimSun.

FontSize

Int

Yes

The font size of the banner text. The font size is scaled based on the size of the source and output videos. Default value: 0. Maximum value: 5000.

Note:

  • You can specify either the FontSize or FixedFontSize parameter. If you specify both parameters, only the FontSize parameter takes effect.

SizeRequestType

String

No

The calculation method of the rendered font size of the banner text. Default value: RealDim. Valid values:

  • Nominal: The subtitle rendering height (in pixels) is the same as the value of the FontSize parameter.

  • RealDim: For specific fonts, the subtitle rendering height (in pixels) may be less than the value of the FontSize parameter.

FixedFontSize

Int

Yes

The font size of the banner text. The font size is not scaled based on the size of the material and the output video.

Note:

  • You can specify either the FontSize or FixedFontSize parameter. If you specify both parameters, only the FontSize parameter takes effect.

FixedX

Float

No

The horizontal distance between the upper-left corner of the text and the upper-left corner of the output video. Note: You can set the value to a percentage or the number of pixels. If the value ranges from 0 to 0.9999, the value indicates a percentage. If the value is an integer greater than or equal to 2, the value indicates an absolute pixel value. Default value: 0. The coordinates are not scaled based on the size of the material and the output video.

FixedY

Float

No

The horizontal distance between the upper-left corner of the text and the upper-left corner of the output video. Note: You can set the value to a percentage or the number of pixels. If the value ranges from 0 to 0.9999, the value indicates a percentage. If the value is an integer greater than or equal to 2, the value indicates an absolute pixel value. Default value: 0. The coordinates are not scaled based on the size of the material and the output video.

FontColor

String

No

The color of the text in the hexadecimal format. The value starts with a number sign (#). Example: #ffffff.

FontColorOpacity

String

No

The transparency of the banner text. Valid values: 0 to 1. The value of 1 indicates that the text is not transparent, and the value of 0 indicates that the text is completely transparent. Default value: 1.

FontFace

FontFace

No

The appearance of the banner text.

Spacing

Integer

No

The word 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 rotation angle of the banner text in the counterclockwise direction. Unit: degrees. Default value: 0.

BorderStyle

Int

No

The border style of the banner text. Valid values: 1 and 3. A value of 1 specifies that the text has a border and a shadow. A value of 3 specifies that the text has a background. Default value: 1.

Outline

Int

No

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

OutlineColour

String

No

The stroke color of the banner text in the hexadecimal format. The value starts with a number sign (#). Example: #ffffff.

Shadow

Int

No

The shadow size of the banner text. Unit: pixels. Default value: 0.

BackColour

String

No

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

Alignment

String

No

The text alignment mode. Default value: TopLeft. Valid values:

  • TopLeft

  • TopCenter

  • TopRight

  • CenterLeft

  • CenterCenter

  • CenterRight

  • BottomLeft

  • BottomCenter

  • BottomRight

If you want to locate the accurate positions of subtitles in different alignment modes, we recommend that you set this parameter to one of the following values:

  • Left: left alignment. The value specifies the coordinates of the upper-left vertex of the subtitle in the upper-left corner of the video for X and Y.

  • Center: center alignment. The value specifies the coordinates of the boundary intersection on the central axis of the subtitle in the upper-left corner of the video for X and Y.

  • Right: right alignment. The value specifies the coordinates of the upper-right vertex of the subtitle in the upper-left corner of the video for X and Y.

AdaptMode

String

No

Specifies whether to enable automatic line breaking or automatic scaling when the banner text exceeds the video width or the specified text box width. Valid values:

  • AutoWrap: enables automatic line breaking.

  • AutoScale: enables automatic scaling.

  • AutoWrapAtSpaces: automatically wraps text only at spaces. This option is applicable only to all English subtitles.

TextWidth

String

No

The width of the text box. This parameter takes effect if you specify the AdaptMode parameter. This parameter is used when you enable automatic line breaking or automatic scaling. If you do not specify this parameter, the video width is used for automatic line breaking or automatic scaling. When the value is greater than 0 and less than or equal to 1, the value indicates the percentage of the width of the text box to the width of the output video. When the value is greater than 1, the value indicates the number of pixels.

FontUrl

String

No

The URL of the font file in Object Storage Service (OSS). The following formats of font files are supported: ttf, otf, and woff. Example: https://your-bucket.oss-cn-shanghai.aliyuncs.com/example-font.ttf.

EffectColorStyle

String

No

The word art effect of the banner text. Word art effect examples

SubtitleEffects

SubtitleEffect[]

No

The multilayer effect of the banner text. You can configure multilayer outlines, multilayer shadows, Gaussian blurs, and subtitle background effects. Gaussian blurs are supported only if the subtitle text is set to have a shadow.

Note:

  • If you specify the SubtitleEffects parameter, the Outline and Shadow parameters of the subtitle track become invalid.

  • If you configure multilayer outlines, multilayer shadows, or subtitle background effects, the subtitle effects are overlaid based on the sequence of the elements in the array of the SubtitleEffects parameter. The first element is rendered at the bottom, and the last element is rendered at the top.

AaiMotionInEffect

String

No

The entrance effect of the banner text. This parameter takes effect if you set the type to Text. Subtitle effect examples

AaiMotionIn

Float

No

The duration of the entrance effect. Unit: seconds. The value is accurate to four decimal places. If the AaiMotionIn parameter is not specified, the default value of this parameter is 0.5 seconds. If the banner text is displayed for less than 0.5 seconds, the duration of the entrance effect is the total duration of the banner text minus the duration of the exit effect.

AaiMotionOutEffect

String

No

The exit effect of the banner text. This parameter takes effect if you set the type to Text. Subtitle effect examples

AaiMotionOut

Float

No

The duration of the exit effect of the banner text. This parameter takes effect if you set the type to Text. Unit: seconds. The value is accurate to four decimal places. If you do not specify the AaiMotionOut parameter, the default duration of 0.5 seconds is used. If the text is displayed for less than 0.5 seconds, the duration of the exit effect is the total duration of the text.

AaiMotionLoopEffect

String

No

The loop effect of the banner text. This parameter takes effect if you set the type to Text. The loop effect cannot take effect together with the entrance effect or the exit effect. Subtitle effect examples

Ratio

Float

No

The speed of the loop effect of the banner text. This parameter takes effect if you set the type to Text. The value is accurate to four decimal places. If you do not specify this parameter, 1 is used. A value greater than 1 indicates a higher speed, and a value less than 1 indicates a lower speed.

TextureURL

String

No

The URL of the texture of the banner text. This parameter takes effect if you set the type to Text. Only OSS objects in the PNG, JPG, JPEG, or BMP format are supported. Example: https://your-bucket.oss-cn-shanghai.aliyuncs.com/your-image.png.

BubbleStyleId

String

No

The bubble effect ID of the banner text. This parameter takes effect if you set the type to Text. For more information about bubble effects, see Sample bubble effects.

BubbleWidth

Float

No

The width of the bubble basemap in the output video. This parameter takes effect only if bubble subtitles are used. A value greater than 1 indicates an absolute pixel value. A value less than or equal to 1 indicates a percentage.

BubbleHeight

Float

No

The height of the bubble basemap in the output video. This parameter takes effect only if bubble subtitles are used. A value greater than 1 indicates an absolute pixel value. A value less than or equal to 1 indicates a percentage.

DeWatermark: logo blurring

Parameter

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. Note: You can set the value to a percentage or the number of pixels. If the value ranges from 0 to 0.9999, the value indicates a percentage. If the value is an integer greater than or equal to 2, the value indicates an absolute pixel value. 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. Note: You can set the value to a percentage or the number of pixels. If the value ranges from 0 to 0.9999, the value indicates a percentage. If the value is an integer greater than or equal to 2, the value indicates an absolute pixel value. Default value: 0.

Width

Float

Yes

The width of the blurred area in the output video. Note: You can set the value to a percentage or the number of pixels. If the value ranges from 0 to 0.9999, the value indicates a percentage. If the value is an integer greater than or equal to 2, the value indicates an absolute pixel value.

Height

Float

Yes

The height of the blurred area in the output video. Note: You can set the value to a percentage or the number of pixels. If the value ranges from 0 to 0.9999, the value indicates a percentage. If the value is an integer greater than or equal to 2, the value indicates an absolute pixel value.

Crop

Parameter

Type

Required

Description

X

Float

No

The horizontal distance between the upper-left corner of the video image after cropping and the upper-left corner of the output video. Note: You can set the value to a percentage or the number of pixels. If the value ranges from 0 to 0.9999, the value indicates a percentage. If the value is an integer greater than or equal to 2, the value indicates an absolute pixel value. Default value: 0.

Y

Float

No

The vertical distance between the upper-left corner of the video image after cropping and the upper-left corner of the output video. Note: You can set the value to a percentage or the number of pixels. If the value ranges from 0 to 0.9999, the value indicates a percentage. If the value is an integer greater than or equal to 2, the value indicates an absolute pixel value. Default value: 0.

Width

Float

Yes

The width of the video image in the output video after cropping. Note: You can set the value to a percentage or the number of pixels. If the value ranges from 0 to 0.9999, the value indicates a percentage. If the value is an integer greater than or equal to 2, the value indicates an absolute pixel value.

Height

Float

Yes

The height of the video image in the output video after cropping. Note: You can set the value to a percentage or the number of pixels. If the value ranges from 0 to 0.9999, the value indicates a percentage. If the value is an integer greater than or equal to 2, the value indicates an absolute pixel value.

Scale

If the width or height of the material is different from those of the output video and scaling is not configured, the system automatically scales the width or height of the material to the width or height of the output video, centers the material, and adds black bars to fill the view.

For timeline examples, see Configure picture-in-picture.

Parameter

Type

Required

Description

Width

Float

Yes

The width of the video image in the output video after scaling. Note: You can set the value to a percentage or the number of pixels. If the value ranges from 0 to 0.9999, the value indicates a percentage. If the value is an integer greater than or equal to 1, the value indicates an absolute pixel value.

Height

Float

Yes

The height of the video image in the output video after scaling. Note: You can set the value to a percentage or the number of pixels. If the value ranges from 0 to 0.9999, the value indicates a percentage. If the value is an integer greater than or equal to 1, the value indicates an absolute pixel value.

Pad

If the aspect ratio of the material is different from that of the output video and padding is not configured, the system automatically scales the width or height of the material to the width or height of the output video, centers the material, and adds black bars to fill the view.

For timeline examples, see Rotate a video from the landscape mode to the portrait mode and blur the blank area.

Parameter

Type

Required

Description

Left

Float

No

The distance between the left side of the material and the left side of the output video. Note: You can set the value to a percentage or the number of pixels. If the value ranges from 0 to 0.9999, the value indicates a percentage. If the value is an integer greater than or equal to 1, the value indicates an absolute pixel value.

Right

Float

No

The distance between the right side of the material and the right side of the output video. Note: You can set the value to a percentage or the number of pixels. If the value ranges from 0 to 0.9999, the value indicates a percentage. If the value is an integer greater than or equal to 1, the value indicates an absolute pixel value.

Top

Float

No

The distance between the top of the material and the top of the output video. Note: You can set the value to a percentage or the number of pixels. If the value ranges from 0 to 0.9999, the value indicates a percentage. If the value is an integer greater than or equal to 1, the value indicates an absolute pixel value.

Bottom

Float

No

The distance between the bottom of the material and the bottom of the output video. Note: You can set the value to a percentage or the number of pixels. If the value ranges from 0 to 0.9999, the value indicates a percentage. If the value is an integer greater than or equal to 1, the value indicates an absolute pixel value.

Color

String

No

The color of the paddings in the hexadecimal format. The value must start with a number sign (#). Example: #000000. The default color is black.

Background

If the size of the material is inconsistent with the size of the output video, you can specify to blur the blank area or fill the blank area with a specified color.

Background settings can be used together with effects such as cropping, scaling, and transition.

For timeline examples, see Rotate a video from the landscape mode to the portrait mode and blur the blank area.

Parameter

Type

Required

Description

SubType

String

Yes

The type of the background setting. Valid values:

Blur

Color

Radius

Float

No

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

Color

String

No

The RGB color value in the hexadecimal format. This parameter takes effect only when the SubType parameter is set to Color. Example: #FFFFFF.

Transition

Important

A transition overlaps the layers of the two materials at the same time, which shortens the duration of the output video. To prevent this issue, you can use DLTransition.

A transition effect connects two materials. You need to specify the transition duration only for the previous material. Then, the transition effect connects the end of the previous material and the beginning of the next material by overlaying the video images. After you add a transition effect between two materials, the total duration of the materials is shortened by the duration of the transition effect.

For example, a video track has two materials Clip 1 and Clip 2, the duration of Clip 1 is 10 seconds, the duration of Clip 2 is 8 seconds. If you add a 4-second transition effect between Clip 1 and Clip 2, the total duration of the video track is reduced from 18 seconds to 14 seconds.

The following table describes the transition parameters. For more information about transition effects, see Examples of transition effects.

For timeline examples, see Transition timeline configuration example

Parameter

Type

Required

Description

SubType

String

Yes

The subtype of the transition effect. You can specify multiple transition effects and separate them with commas (,). The system randomly selects one of the transition effects. Alternatively, you can set the parameter to random for the system to randomly select a transition effect from all transition effects. Example: directional. For more information about the valid values and effects, see Transition effect examples.

Duration

Float

No

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

DLTransition: frame interpolation transition

Compared with the standard transition effect, the frame interpolation transition effect named Duration Lock Transition (DLTransition) fills in a still frame during a transition to maintain the duration of the output video.

The internal parameters of DLTransition are used in the same you use the parameters of the standard transition effect.

Parameter

Type

Required

Description

SubType

String

Yes

The subtype of the transition effect. You can specify multiple transition effects and separate them with commas (,). The system randomly selects one of the transition effects. Alternatively, you can set the parameter to random for the system to randomly select a transition effect from all transition effects. Example: directional. For more information about the valid values and effects, see Transition effect examples.

Duration

Float

No

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

VFX: visual effects

For timeline examples, see Use visual effects

Parameter

Type

Required

Description

SubType

String

Yes

The subtype of the effect. You can specify multiple visual effects and separate them with commas (,). The system randomly selects one of the visual effects. Alternatively, you can set the parameter to random for the system to randomly select a transition effect from all transition effects. Example: colorfulradial. For more information about the valid values and effects, see Special effect examples.

X

Float

No

This parameter takes effect only if you set the SubType parameter to mosaic_rect/blur. The horizontal distance between the upper-left corner of the effect area and the upper-left corner of the output video.

Note: You can set the value to a percentage or the number of pixels. If the value ranges from 0 to 0.9999, the value indicates a percentage. If the value is an integer greater than or equal to 2, the value indicates an absolute pixel value.

Y

Float

No

This parameter takes effect only if you set the SubType parameter to mosaic_rect/blur.

The vertical distance between the upper-left corner of the effect area and the upper-left corner of the output video. Note: You can set the value to a percentage or the number of pixels. If the value ranges from 0 to 0.9999, the value indicates a percentage. If the value is an integer greater than or equal to 2, the value indicates an absolute pixel value.

Width

Float

No

This parameter takes effect only if you set the SubType parameter to mosaic_rect/blur. The width of the effect area in the output video. Note: You can set the value to a percentage or the number of pixels. If the value ranges from 0 to 0.9999, the value indicates a percentage. If the value is an integer greater than or equal to 2, the value indicates an absolute pixel value.

Height

Float

No

This parameter takes effect only if you set the SubType parameter to mosaic_rect/blur. The height of the effect area in the output video. Note: You can set the value to a percentage or the number of pixels. If the value ranges from 0 to 0.9999, the value indicates a percentage. If the value is an integer greater than or equal to 2, the value indicates an absolute pixel value.

ExtParams

String

No

The extended parameters related to special effects. This parameter takes effect only when SubType is set to mask_circle, mask_rec, mask_linear, or mask_minor. The following section introduces the structure of ExtParams.

For effect examples, see Create circle, rectangle, linear, and mirror masks

Important

If the data type is float, the value must be formatted as a floating-point number, such as 0.5 and 2.0

Circle masks

SubType=mask_circle

ExtParams description

Parameter

Type

Valid values

Valid values

Description

x

float

[0.0, material width]

0.5

The X coordinate of the center of the circle relative to the top-left corner of the material. When the value is in the range of [0.0, 1.0], it indicates the coordinate relative to the material width. When the value is greater than 1.0, it indicates the absolute pixel value.

y

float

[0.0, material high]

0.5

The Y coordinate of the center of the circle relative to the top-left corner of the material. When the value is in the range of [0.0, 1.0], it indicates the coordinate relative to the material height. When the value is greater than 1.0, it indicates the absolute pixel value.

width

float

[0.0, material width]

0.8

The width of the ellipse relative to the width of the material. When the value is in the range of [0.0, 1.0], it indicates the width relative to the material width. When the value is greater than 1.0, it indicates the absolute pixel value.

height

float

[0.0, material high]

0.8

The height of the ellipse relative to the height of the material. When the value is in the range of [0.0, 1.0], it indicates the height relative to the material height. When the value is greater than 1.0, it indicates the absolute pixel value.

antialias

float

[0.0, 1.0]

0.1

The antialiasing parameter of the ellipse. The larger the value, the higher the degree of edge feathering.

angle

float

[-9999.0, 9999.0]

0.0

The rotation angle.

Rectangle masks

SubType=mask_rec

ExtParams description

Parameter

Type

Valid values

Default value

Description

x

float

[0.0, material width]

0.5

The X coordinate of the center of the rectangle relative to the top-left corner of the material. When the value is in the range of [0.0, 1.0], it indicates the coordinate relative to the material width. When the value is greater than 1.0, it indicates the absolute pixel value.

y

float

[0.0, material high]

0.5

The Y coordinate of the center of the rectangle relative to the top-left corner of the material. When the value is in the range of [0.0, 1.0], it indicates the coordinate relative to the material height. When the value is greater than 1.0, it indicates the absolute pixel value.

width

float

[0.0, material width]

0.8

The width of the rectangle. When the value is in the range of [0.0, 1.0], it indicates the width relative to the material width. When the value is greater than 1.0, it indicates the absolute pixel value.

height

float

[0.0, material height]

0.8

The height of the rectangle. When the value is in the range of [0.0, 1.0], it indicates the height relative to the material height. When the value is greater than 1.0, it indicates the absolute pixel value.

antialias

float

[0.0, 1.0]

0.1

The antialiasing parameter of the rectangle. The larger the value, the higher the degree of edge feathering.

radius

float

[0.0, the larger value of material width or height]

0.1

The border radius of the rectangle. When the value is in the range of [0.0, 1.0], it indicates the radius relative to the larger value of the material width or height. When the value is greater than 1.0, it indicates the absolute pixel value.

angle

float

[-9999.0, 9999.0]

0.0

The rotation angle.

Linear masks

SubType=mask_linear

ExtParams description

Parameter

Type

Valid values

Default value

Description

x

float

[0.0, material width]

0.5

The X coordinate of the center reference point of the linear mask relative to the top-left corner of the material. When the value is in the range of [0.0, 1.0], it indicates the coordinate relative to the material width. When the value is greater than 1.0, it indicates the absolute pixel value.

y

float

[0.0, material height]

0.5

The Y coordinate of the center reference point of the linear mask relative to the top-left corner of the video material. When the value is in the range of [0.0, 1.0], it indicates the coordinate relative to the material height. When the value is greater than 1.0, it indicates the absolute pixel value.

antialias

float

[0.0, 1.0]

0.1

The antialiasing parameter of the linear mask. The larger the value, the higher the degree of edge feathering.

angle

float

[-9999.0, 9999.0]

0.0

The rotation angle.

Mirror masks

SubType=mask_minor

ExtParams description

Parameter

Type

Valid values

Default value

Description

x

float

[0.0, material width]

0.5

The X coordinate of the center reference point of the mirror mask relative to the top-left corner of the material. When the value is in the range of [0.0, 1.0], it indicates the coordinate relative to the material width. When the value is greater than 1.0, it indicates the absolute pixel value.

y

float

[0.0, material height]

0.5

The Y coordinate of the center reference point of the mirror mask relative to the top-left corner of the material. When the value is in the range of [0.0, 1.0], it indicates the coordinate relative to the material height. When the value is greater than 1.0, it indicates the absolute pixel value.

antialias

float

[0.0, 1.0]

0.1

The antialiasing parameter of the mirror mask. The larger the value, the higher the degree of edge feathering.

angle

float

[-9999.0, 9999.0]

0.0

The rotation angle.

Filter

For timeline examples, see Use rendering filters.

Parameter

Type

Required

Description

SubType

String

Yes

The subtype of the filter. You can specify multiple filter subtypes and separate them with commas (,). The system randomly selects one of the filter subtypes. Alternatively, you can set the parameter to random for the system to randomly select a transition effect from all transition effects. Example: M1. For more information about the valid values and effects, see Filter effect examples.

TimelineIn

Float

No

The time when the filter is applied in the timeline. Unit: seconds. The value is accurate to four decimal places. If this parameter is not specified, the TimelineIn value of the clip is used.

TimelineOut

Float

No

The time when the filter is lifted in the timeline. Unit: seconds. The value is accurate to four decimal places. If this parameter is not specified, the TimelineOut value of the clip is used.

ExtParams

String

No

The parameters related to filters. This parameter takes effect only when the SubType parameter is set to color. In this case, a color toning filter is applied. The following table describes the fields of the ExtParams parameter.

ExtParams

For timeline examples, see Use color filters.

Parameter

Type

Valid values

Description

Default value

brightness

int

[-255,255]

The brightness.

0

contrast

int

[-100,100]

The contrast.

0

saturation

int

[-100,100]

The saturation.

0

kelvin_temperature

int

[1000,40000]

The color temperature. This parameter takes effect when the temperature_ratio parameter is specified.

6000

temperature_ratio

int

[0,100]

The color temperature ratio.

0

tint

int

[-100,100]

The tint.

0

dark_corner_ratio

int

[0,100]

The vignetting ratio.

0

Volume

For timeline examples, see Mute an entire video and Adjust the volume.

Parameter

Type

Required

Description

Gain

Float

No

The volume. Valid values: 0 to 10. A smaller value indicates a lower volume. 0 indicates mute, and 1 indicates the original volume. Default value: 1. We recommend that you do not configure a large value. If you set the parameter to a large value, the sound may be distorted.

AFade: Audio fade-in and fade-out

For timeline examples, see Audio fade-in and fade-out.

Parameter

Type

Required

Description

SubType

String

Yes

The subtype of audio fading. Valid values:

  • In

  • Out

Duration

Float

No

The duration of audio fading. Audio fade-in is applied at the beginning of a material and audio fade-out is applied at the end of a material. Default value: 0. The value of 0 indicates that no audio fading is applied.

Curve

String

No

The volume curve of audio fading. Default value: exp.

Valid values:

  • exp: exponential curve

  • tri: linear curve

AI_ASR: speech-to-text conversion

Subtitles are generated based on the audio. The subtitles can be placed in the effects of a video track or an audio track. For more information about the involved parameters, see Text. By default, the subtitles are centered at the bottom of the video. This feature is available in the China (Beijing), China (Shanghai), and China (Hangzhou) regions.

Parameter

Type

Required

Description

X

Float

No

The horizontal distance between the upper-left corner of the text and the upper-left corner of the output video. Note: You can set the value to a percentage or the number of pixels. If the value ranges from 0 to 0.9999, the value indicates a percentage. If the value is an integer greater than or equal to 2, the value indicates an absolute pixel value.

Y

Float

No

The vertical distance between the upper-left corner of the text and the upper-left corner of the output video. Note: You can set the value to a percentage or the number of pixels. If the value ranges from 0 to 0.9999, the value indicates a percentage. If the value is an integer greater than or equal to 2, the value indicates an absolute pixel value.

Font

String

No

The font of the banner text. For more information about the supported fonts, see Fonts. Default value: SimSun.

FontSize

Int

Yes

The font size of the banner text.

FontColor

String

No

The color of the text in the hexadecimal format. The value starts with a number sign (#). Example: #ffffff.

FontColorOpacity

String

No

The transparency of the banner text. Valid values: 0 to 1. The value of 1 indicates that the text is not transparent, and the value of 0 indicates that the text is completely transparent. Default value: 1.

FontFace

FontFace

No

The appearance of the banner text.

Rotate

You can rotate a material by 90, 180, or 270 degrees. You can specify a rotation angle in the video track or image track.

For timeline examples, see Configure material rotation.

Parameter

Type

Required

Description

Degree

Integer

Yes

The rotation angle in the clockwise direction. You can rotate a material only by 90, 180, or 270 degrees.

AI_Matting: image matting

The subject is extracted from the green or blue background and overlaid onto another video or image. This feature is available in the China (Beijing), China (Shanghai), and China (Hangzhou) regions.

Parameter

Type

Required

Description

Color

String

Yes

The background color. Green and blue are supported.

Auto

Integer

Yes

Specifies whether the background color is automatically determined. Valid values:

  • 0: The background color is determined based on the threshold.

  • 1: The background color is automatically determined.

Thres

Float

No

The background color discrimination threshold. A larger value indicates a looser discrimination. Valid values: [0, 10].

AI_RealMatting: real-time background removal

You can use this feature to extract a figure from a video and overlay it onto another video or image. This feature is available in the China (Beijing), China (Shanghai), and China (Hangzhou) regions.

Parameter

Type

Required

Description

Thres

Float

No

The background color discrimination threshold. A larger value indicates a looser discrimination. Valid values: [0, 10]. Default value: 2.

AI_Delogo: intelligent logo removal

You can use this feature to intelligently recognize and remove logos from videos. This feature is available in the China (Beijing) and China (Shanghai) regions.

Clip: random clip capture

You can randomly capture a clip from the original material and add the clip to the timeline.

Parameter

Type

Required

Description

SubType

String

Yes

The type of the capture. Valid value: RandomClip.

ClipDuration

Float

Yes

The duration of the clip.

Flip

You can flip videos or images in a video track along the x-axis or y-axis.

For timeline examples, see Horizontal and vertical flipping.

Parameter

Type

Required

Description

Direction

String

Yes

  • horizontal: flips videos or images along the x-axis

  • vertical: flips videos or images along the y-axis

KenBurns

You can add the Ken Burns effect to videos and images in the video track.

Limits:

  • You can apply this effect only to images and videos. You can use the Ken Burns effect together with visual effects, filters, and transitions.

  • You can specify the WindowW and WindowH parameters to configure the width and height of the output video. After you specify the WindowW and WindowH parameters, you cannot crop, scale, pad, or configure the background for the output video.

Parameter

Type

Required

Description

Example

Duration

Float

No

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

5

WindowW

Float

No

The width of the clip. By default, the value equals to the width of the output video. Unit: pixels.

If the value of WindowW is in the range of (0,1], the value is a relative value. If the value is greater than 1, the value is an absolute value.

1

WindowH

Float

No

The height of the clip. By default, the value equals to 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.

If the value is greater than 1, the value is an 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.

If the value is greater than or equal to 1, the value is 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.

If the value is greater than or equal to 1, the value is an absolute value.

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.

If the value is greater than 1, the value is an 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.

If the value is greater than 1, the value is 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.

If the value is greater than or equal to 1, the value is an absolute value.

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.

If the value is greater than or equal to 1, the value is an absolute value.

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.

If the value is greater than 1, the value is an 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.

If the value is greater than 1, the value is an absolute value.

1

ADenoise: audio noise reduction

Noise reduction is supported for videos with audio in a video track or audio in an audio track support.

Parameter

Type

Required

Description

Mode

Integer

No

  • 0 (default): does not take actions.

  • 1: slightly reduces noise.

  • 2: protects music and removes stationary noise. This is suitable for music content.

  • 3: forcefully removes stationary noise. This is suitable for speech without music content.

  • 4: extracts speech and removes stationary and non-stationary noise. This is suitable for non-music content.

Zoom

You can add zooming effects only to clips in the video track.

Important

Zooming is supported only for material clips in video tracks.

Parameter

Type

Required

Description

StartRate

Float

No

  • The current zoom value.

  • Default value: 1.0

  • Valid values: [1.0,5.0].

EndRate

Float

No

  • The desired zoom value.

  • Default value: The value of the StartRate parameter plus 0.3.

  • Valid values: [Value of the StartRate parameter,5.0]

Duration

Float

No

  • The duration of the zooming effect.

  • Default value: the rendering duration of the clip.

  • Valid values: [0,clip rendering duration]

Harmonization: background blending

You can add a background blending effect to a material clip. This effect is suitable for avatar video clips. After you add the effect to an avatar video clip, the effect automatically adapts to the light, brightness, and temperature effects of the background image without compromising the integration of the avatar video clip and the background image.

Important
  1. Zooming is supported only for material clips in video tracks.

  2. Only one background blending effect is allowed in one clipping request.

No other request parameters are used for the background blending effect.

ALoudNorm: volume normalization

ALoudNorm applies only to a single audio or video material. If you have multiple audio and video materials and want to use the same loudness for the materials, you may need to separately configure ALoudNorm for each material.

Note

ALoudNorm applies only to audio and video clips. When you use ALoudNorm together with ADenoise or Volume, they are applied in the following order: ADenoise, Volume, and then ALoudNorm.

For timeline examples, see Volume normalization.

Parameter

Type

Required

Description

Loudness

Float

No

The loudness, which determines the volume and conforms to the EBU R128 measurement standard. Valid values: [-70.0,-5.0]. Default value: -24.0.

TruePeak

Float

No

True peak level of the audio signal. Valid values: [-9.0,+0.0]. Default value: -2.0.

AEqualize: volume equalization

This feature is applicable to effect tracks and is a global effect. The effect is used to perform uniform volume equalization for global audio.

Note

The effect is applicable to all clips.

For timeline examples, see Volume equalization.

Parameter

Type

Required

Description

Peak

Float

No

The peak value of the audio. Default value: 0.95. We recommend that the value that you specify does not exceed the default value.

Valid values: (0,1).

Gain

Float

No

The maximum gain coefficient. Valid values: 1.0 to 100.0. Default value: 10.0.

The dynamic audio standardizer determines the maximum possible (local) gain coefficient for each input frame, which ensures that no clipping or distortion occurs.

FreezeFrame

This feature creates a freeze frame using the last frame of a video material on the video track. It deos not apply to image and audio materials.

Note

FreezeFrame cannot be used with transition effects simultaneously.

Parameter

Type

Required

Description

Duration

Float

No

The duration of the freeze frame. Unit: seconds. Default value: 0.