MeiCam SDK For iOS  3.15.0
Effect name list

Effect name list

1. Overview of special effects

1.1、Builtin Audio Fx

  • Audio Echo
  • Male Voice
  • Female Voice
  • Cartoon Voice
  • Fast Cartoon Voice
  • Monster Voice
  • Audio Reverb
  • Audio Wahwah

1.2、Builtin Video Fx

  • Sage
  • Maid
  • Mace
  • Lace
  • Mall
  • Sap
  • Sara
  • Pinky
  • Sweet
  • Fresh
  • Beauty
Parameter Type Max Min Default
Reddening FLOAT 1.0 0.0 0.0
Whitening FLOAT 1.0 0.0 0.0
Strength FLOAT 1.0 0.0 0.0
  • Color Property
Parameter Type Max Min Default
Brightness FLOAT 10.0 0.0 1.0
Saturation FLOAT 10.0 0.0 1.0
Contrast FLOAT 10.0 0.0 1.0
  • Transform 2D

Description: Image 2d transform.

Note: Anchor X, Anchor Y, Trans X, Trans Y are in standard coordinates if parameter 'Is Normalized Coord' is false, otherwise they are in normalized coordinates.

Parameter Type Max Min Default Range Explain
Scale X FLOAT 1000.0 -1000.0 1.0 Scale's x value
Scale Y FLOAT 1000.0 -1000.0 1.0 Scale's y value
Rotation FLOAT 3600000.0 -3600000.0 0.0 Rotation's z value
Rotation X FLOAT 3600000.0 -3600000.0 0.0 Rotation's x value
Rotation Y FLOAT 3600000.0 -3600000.0 0.0 Rotation's y value
Anchor X FLOAT 100000.0 -100000.0 0.0 Anchor point' x value
Anchor Y FLOAT 100000.0 100000.0 0.0 Anchor point' y value
Trans X FLOAT 100000.0 -100000.0 0.0 Translation's x value
Trans Y FLOAT 100000.0 -100000.0 0.0 Translation's y value
Opacity FLOAT 1.0 0.0 1.0 Opacity
Tex Wrap Mode Menu Clamp To Edge Clamp To Edge,Mirrored Repeat,Repeat Tex wrap mode
Tex Anchor X FLOAT 100.0 -100.0 0.0 Horizontal anchor ( texture coordinates )
Tex Anchor Y FLOAT 100.0 -100.0 0.0 Vertical anchor ( texture coordinates )
Tex Scale X FLOAT 1000.0 -1000.0 1.0 Horizontal scale
Tex Scale Y FLOAT 1000.0 -1000.0 1.0 Vertical scale
Tex Rotation FLOAT 3600000.0 -3600000.0 0.0 Clock-wise rotation angle
Tex Trans X FLOAT 100000.0 -100000.0 0.0 Horizontal translation ( texture coordinates )
Tex Trans Y FLOAT 100000.0 -100000.0 0.0 Vertical translation ( texture coordinates )
Multisample BOOL FALSE Multisample or not
Is Normalized Coord BOOL FALSE Is in normalized coordinates or not
  • CC Basic
Parameter Type Max Min Default Explain
Is Process Other Tones BOOL FALSE Whether to process other tones. The value is FALSE, only the full tone (Master) takes effect, and other tones such as shadows, midtones, and highlights are invalid; if the value is true, other tones will take effect.
Master Saturation FLOAT 10.0 0.0 1.0
Master Contrast FLOAT 10.0 0.0 1.0
Master Balance Hue FLOAT 360.0 0.0 0.0
Master Balance Strength FLOAT 10.0 0.0 0.0
Master Gain Master FLOAT 10.0 0.0 1.0 Full channel gain. Note: The full channel gain is multiplied by the R, G, and B values.
Master Gain Red FLOAT 10.0 0.0 1.0
Master Gain Green FLOAT 10.0 0.0 1.0
Master Gain Blue FLOAT 10.0 0.0 1.0
Master Offset Master FLOAT 10.0 -10.0 0.0 Channel offset. Note: The offsets of all channels are added to the R, G, and B values respectively.
Master Offset Red FLOAT 10.0 -10.0 0.0
Master Offset Green FLOAT 10.0 -10.0 0.0
Master Offset Blue FLOAT 10.0 -10.0 0.0
Shadows Saturation FLOAT 10.0 0.0 1.0
Shadows Contrast FLOAT 10.0 0.0 1.0
Shadows Balance Hue FLOAT 360.0 0.0 0.0
Shadows Balance Strength FLOAT 10.0 0.0 0.0
Shadows Gain Master FLOAT 10.0 0.0 1.0 Full channel gain. Note: The full channel gain is multiplied by the R, G, and B values.
Shadows Gain Red FLOAT 10.0 0.0 1.0
Shadows Gain Green FLOAT 10.0 0.0 1.0
Shadows Gain Blue FLOAT 10.0 0.0 1.0
Shadows Offset Master FLOAT 10.0 -10.0 0.0 Full channel offset. Note: The offsets of all channels are added to the R, G, and B values respectively
Shadows Offset Red FLOAT 10.0 -10.0 0.0
Shadows Offset Green FLOAT 10.0 -10.0 0.0
Shadows Offset Blue FLOAT 10.0 -10.0 0.0
Midtones Saturation FLOAT 10.0 0.0 1.0
Midtones Contrast FLOAT 10.0 0.0 1.0
Midtones Balance Hue FLOAT 360.0 0.0 0.0
Midtones Balance Strength FLOAT 10.0 0.0 0.0
Midtones Gain Master FLOAT 10.0 0.0 1.0 Full channel gain. Note: The full channel gain is multiplied by the R, G, and B values.
Midtones Gain Red FLOAT 10.0 0.0 1.0
Midtones Gain Green FLOAT 10.0 0.0 1.0
Midtones Gain Blue FLOAT 10.0 0.0 1.0
Midtones Offset Master FLOAT 10.0 -10.0 0.0 Full channel offset. Note: The offsets of all channels are added to the R, G, and B values respectively.
Midtones Offset Red FLOAT 10.0 -10.0 0.0
Midtones Offset Green FLOAT 10.0 -10.0 0.0
Midtones Offset Blue FLOAT 10.0 -10.0 0.0
Highlights Saturation FLOAT 10.0 0.0 1.0
Highlights Contrast FLOAT 10.0 0.0 1.0
Highlights Balance Hue FLOAT 360.0 0.0 0.0
Highlights Balance Strength FLOAT 10.0 0.0 0.0
Highlights Gain Master FLOAT 10.0 0.0 1.0 Full channel gain. Note: The full channel gain is multiplied by the R, G, and B values.
Highlights Gain Red FLOAT 10.0 0.0 1.0
Highlights Gain Green FLOAT 10.0 0.0 1.0
Highlights Gain Blue FLOAT 10.0 0.0 1.0
Highlights Offset Master FLOAT 10.0 -10.0 0.0 Full channel offset. Note: The offsets of all channels are added to the R, G, and B values respectively
Highlights Offset Red FLOAT 10.0 -10.0 0.0
Highlights Offset Green FLOAT 10.0 -10.0 0.0
Highlights Offset Blue FLOAT 10.0 -10.0 0.0
  • Lut

Description: Lut filter.

Parameter Type Max Min Default Explain
Data File Path STRING Lut file path. Import .mslut format file or png
Intensity FLOAT 4.0 0.0 1.0 Intensity
  • BasicImageAdjust
Parameter Type Max Min Default
Exposure FLOAT 1.0 -1.0 0.0
Highlight FLOAT 1.0 -1.0 0.0
Shadow FLOAT 1.0 -1.0 0.0
Brightness FLOAT 1.0 -1.0 0.0
Contrast FLOAT 1.0 -1.0 0.0
Blackpoint FLOAT 10.0 -10.0 0.0
Saturation FLOAT 1.0 -1.0 0.0
Vibrance FLOAT 1.0 -1.0 0.0
Video Mode BOOL FALSE, ensure effect consistency between frames.
  • Tint
Parameter Type Max Min Default
Temperature FLOAT 1.0 -1.0 0.0
Tint FLOAT 1.0 -1.0 0.0
  • Denoise
Parameter Type Max Min Default
Intensity FLOAT 1.0 0.0 0.8
  • Sharpen
Parameter Type Max Min Default
Radius FLOAT 10.0 0.0 5.1
Amount FLOAT 5.0 0.0 1.0
  • Vignette
Parameter Type Max Min Default
Degree FLOAT 1.0 0.0 0.0
Color COLOR 0.0 0.0 0.0 1.0
Min Alpha FLOAT 1.0 0.0 0.0
Max Alpha FLOAT 1.0 0.0 1.0
  • Definition
Parameter Type Max Min Default
Intensity FLOAT 1.0 0.0 0.5
Highlight Boost FLOAT 1.0 0.0 0.5
  • AR Scene

Description: A compound effect which contains props, beautification, shape beautification and makeup.

Note: It's only supported in MEISHE sdk with human detection features. Proper detection model should be loaded while initializing the application.

Parameter Type Max Min Default Explain
Scene Id STRING Package ID
Description File STRING Package description file path
Single Buffer Mode BOOL True for Android, FALSE for iOS In single buffer mode, effects before AR Scene are dropped. Otherwise, there exists a effect lag.
Face Camera Fovy FLOAT 179 1 45 Camera FOVY
Beauty Effect BOOL FALSE Enable beauty (Beauty)
Beauty Strength FLOAT 1 0 0.5 Smooth intensity (Beauty)
Default Beauty Enabled BOOL TRUE Enable default Lut effect (Beauty)
Default Intensity FLOAT 1 0 1 Default Lut intensity (Beauty)
Default Beauty Lut File STRING Default Lut file path (Beauty)
Beauty Whitening FLOAT 1 0 0.5 Whitening intensity (Beauty)
Whitening Lut Enabled BOOL FALSE Enable whitening lut, otherwise the default non-lut whitening effect is applyied. (Beauty)
Whitening Lut File STRING Whitening lut file path (Beauty)
Beauty Reddening FLOAT 1 0 0.5 Reddening intensity (Beauty)
Reddening Lut File STRING Reddening lut file path (Beauty)
Default Sharpen Enabled BOOL FALSE Enable sharpen (Beauty)
Beauty Fast Mode Enabled BOOL FALSE Enable fast mode (Beauty)
Lut Data File Path STRING Lut file path
Lut Intensity FLOAT 4 0 1 Lut effect intensity
Unified Max Faces INT 8 1 5 Maximum faces could be detected
Max Faces Respect Min BOOL FALSE True means to take the minimum value among all 'max faces' settings, which could come from package, makeup, users, etc. False the opposite.
AI Face Occlusion Enabled BOOL FALSE Whether to turn on AI face occlusion detection. It only works for makeup for now.
Advanced Beauty Enable BOOL FALSE Enable advanced beauty
Advanced Beauty Intensity FLOAT 1 0 1 Smooth intensity
Advanced Beauty Type INT 2 0 0 Smooth type: 0 for standard on Android，1 for standard on iOS，2 for male
Advanced Beauty Remove Dark Circles Intensity FLOAT 1 0 0 Dark circles removal intensity
Advanced Beauty Remove Nasolabial Folds Intensity FLOAT 1 0 0 Nasolabial folds removal intensity
Advanced Beauty Brighten Eyes Intensity FLOAT 1 0 0 Eyes brightening intensity
Advanced Beauty Brighten Eyes Lut File STRING Eyes brightening lut file path (deprecated)
Advanced Beauty Whiten Teeth Intensity FLOAT 1 0 0 Teeth whitening intensity
Advanced Beauty Whiten Teeth Lut File STRING Teeth whitening lut file path
Advanced Beauty Face Lut Intensity FLOAT 1 0 0 Face lut intensity
Advanced Beauty Face Lut File STRING Face lut file path
Advanced Beauty Clear Intensity FLOAT 1 0 0 Clear intensity
Advanced Beauty Matte Intensity FLOAT 1 0 0 Matte intensity
Advanced Beauty Matte Fill Radius FLOAT 30 3 15 Matte radius (standard coordinates)
Advanced Beauty Smooth Consumption Level INT 2 0 0 Smooth consumption level，0 is the highest and 2 is the lowest. (Available when 'Advanced Beauty Smooth Disable Auto Consumption Level' is true)
Advanced Beauty Smooth Disable Auto Consumption Level BOOL FALSE Disable auto smooth consumption level
Beauty Shape BOOL FALSE Enable warp
Head Size Warp Degree FLOAT 1 -1 0 Head enlarging degree
Head Size Warp Strategy INT 0x7FFFFFFF 0 0 Head enlarging strategy (if custom head enlaring package is needed, this value should be set to 0x7FFFFFFF)
Head Size Warp Custom Package Id STRING Head enlarging custom package id
Face Mesh Internal Enabled BOOL FALSE Enable face mesh
Face Mesh Eye Size Degree FLOAT 1 -1 0 Eye enlarging degree
Face Mesh Eye Corner Stretch Degree FLOAT 1 -1 0 Eye corner outward stretching degree
Face Mesh Face Size Degree FLOAT 1 -1 0 Face shrinking degree
Face Mesh Face Width Degree FLOAT 1 -1 0 Face narrowing degree
Face Mesh Face Length Degree FLOAT 1 -1 0 Face shortening degree
Face Mesh Forehead Height Degree FLOAT 1 -1 0 Forehead lifting degree
Face Mesh Malar Width Degree FLOAT 1 -1 0 Malar narrowing degree
Face Mesh Jaw Width Degree FLOAT 1 -1 0 Jaw narrowing degree
Face Mesh Chin Length Degree FLOAT 1 -1 0 Chin shortening degree
Face Mesh Eye Distance Degree FLOAT 1 -1 0 Eye distance narrowing degree
Face Mesh Nose Length Degree FLOAT 1 -1 0 Nose stretching degree
Face Mesh Nose Width Degree FLOAT 1 -1 0 Nose narrowing degree
Face Mesh Mouth Size Degree FLOAT 1 -1 0 Mouth shrinking degree
Face Mesh Mouth Corner Lift Degree FLOAT 1 -1 0 Mouth corner lifting degree
Face Mesh Temple Width Degree FLOAT 1 -1 0 Temple outward stretching degree
Face Mesh Head Size Degree FLOAT 1 -1 0 Head shrinking degree
Face Mesh Eye Angle Degree FLOAT 1 -1 0 Eye rotation degree (outer corner up, inner corner down)
Face Mesh Nose Bridge Width Degree FLOAT 1 -1 0 Nose bridge narrowing degree
Face Mesh Philtrum Length Degree FLOAT 1 -1 0 Philtrum shortening degree
Face Mesh Eye Arc Degree FLOAT 1 -1 0 Eye corner lifting degree
Face Mesh Eye Width Degree FLOAT 1 -1 0 Eye horizontal stretching degree
Face Mesh Eye Height Degree FLOAT 1 -1 0 Eye vertical stretching degree
Face Mesh Eye Y Offset Degree FLOAT 1 -1 0 Eye position lifting degree
Face Mesh Eyebrow Angle Degree FLOAT 1 -1 0 Eyebrow rotation degree (outer corner up, inner corner down)
Face Mesh Eyebrow Thickness Degree FLOAT 1 -1 0 Eyebrow thickening degree
Face Mesh Eyebrow X Offset Degree FLOAT 1 -1 0 Eyebrow distance widening degree
Face Mesh Eyebrow Y Offset Degree FLOAT 1 -1 0 Eyebrow position lifting degree
Face Mesh Nose Head Width Degree FLOAT 1 -1 0 Nose tip narrowing degree
Face Mesh Eye Size Custom Package Id STRING Eye enlarging package ID
Face Mesh Eye Corner Stretch Custom Package Id STRING Eye corner outward stretching package ID
Face Mesh Face Size Custom Package Id STRING Face shrinking package ID
Face Mesh Face Width Custom Package Id STRING Face narrowing package ID
Face Mesh Face Length Custom Package Id STRING Face shortening package ID
Face Mesh Forehead Height Custom Package Id STRING Forehead lifting package ID
Face Mesh Malar Width Custom Package Id STRING Malar narrowing package ID
Face Mesh Jaw Width Custom Package Id STRING Jaw narrowing package ID
Face Mesh Chin Length Custom Package Id STRING Chin shortening package ID
Face Mesh Eye Distance Custom Package Id STRING Eye distance narrowing package ID
Face Mesh Nose Length Custom Package Id STRING Nose stretching package ID
Face Mesh Nose Width Custom Package Id STRING Nose narrowing package ID
Face Mesh Mouth Size Custom Package Id STRING Mouth shrinking package ID
Face Mesh Mouth Corner Lift Custom Package Id STRING Mouth corner lifting package ID
Face Mesh Temple Width Custom Package Id STRING Temple outward stretching package ID
Face Mesh Head Size Custom Package Id STRING Head shrinking package ID
Face Mesh Eye Angle Custom Package Id STRING Eye rotation package ID
Face Mesh Nose Bridge Width Custom Package Id STRING Nose bridge narrowing package ID
Face Mesh Philtrum Length Custom Package Id STRING Philtrum shortening package ID
Face Mesh Eye Arc Custom Package Id STRING Eye corner lifting package ID
Face Mesh Eye Width Custom Package Id STRING Eye horizontal stretching package ID
Face Mesh Eye Height Custom Package Id STRING Eye vertical stretching package ID
Face Mesh Eye Y Offset Custom Package Id STRING Eye position lifting package ID
Face Mesh Eyebrow Angle Custom Package Id STRING Eyebrow rotation package ID
Face Mesh Eyebrow Thickness Custom Package Id STRING Eyebrow thickening package ID
Face Mesh Eyebrow X Offset Custom Package Id STRING Eyebrow distance widening package ID
Face Mesh Eyebrow Y Offset Custom Package Id STRING Eyebrow position lifting package ID
Face Mesh Nose Head Width Custom Package Id STRING Nose tip narrowing package ID
Makeup Enabled BOOL TRUE Enable makeup
Makeup Intensity FLOAT 1 0 1 Makeup intensity
Makeup Lip Package Id STRING Makeup lip package ID
Makeup Eyebrow Package Id STRING Makeup eyebrow package ID
Makeup Eyeshadow Package Id STRING Makeup eyeshadow package ID
Makeup Eyelash Package Id STRING Makeup eyelash package ID
Makeup Eyeliner Package Id STRING Makeup eyeliner package ID
Makeup Blusher Package Id STRING Makeup blusher package ID
Makeup Shadow Package Id STRING Makeup shadow package ID
Makeup Brighten Package Id STRING Makeup brighten package ID
Makeup Eyeball Package Id STRING Makeup eyeball package ID
Makeup Lip Color COLOR 0, 0, 0, 0 Makeup lip color
Makeup Eyebrow Color COLOR 0, 0, 0, 0 Makeup eyebrow color
Makeup Eyeshadow Color COLOR 0, 0, 0, 0 Makeup eyeshadow color
Makeup Eyelash Color COLOR 0, 0, 0, 0 Makeup eyelash color
Makeup Eyeliner Color COLOR 0, 0, 0, 0 Makeup eyeliner color
Makeup Blusher Color COLOR 0, 0, 0, 0 Makeup blusher color
Makeup Shadow Color COLOR 0, 0, 0, 0 Makeup shadow color
Makeup Brighten Color COLOR 0, 0, 0, 0 Makeup brighten color
Makeup Eyeball Color COLOR 0, 0, 0, 0 Makeup eyeball color
Makeup Lip Intensity FLOAT 1 0 1 Makeup lip intensity
Makeup Eyebrow Intensity FLOAT 1 0 1 Makeup eyebrow intensity
Makeup Eyeshadow Intensity FLOAT 1 0 1 Makeup eyeshadow intensity
Makeup Eyelash Intensity FLOAT 1 0 1 Makeup eyelash intensity
Makeup Eyeliner Intensity FLOAT 1 0 1 Makeup eyeliner intensity
Makeup Blusher Intensity FLOAT 1 0 1 Makeup blusher intensity
Makeup Shadow Intensity FLOAT 1 0 1 Makeup shadow intensity
Makeup Brighten Intensity FLOAT 1 0 1 Makeup brighten intensity
Makeup Eyeball Intensity FLOAT 1 0 1 Makeup eyeball intensity
  • Mask Generator

Description: Mask generator.

Note: If ‘Text Mask Description String’ is not empty, we use it to generate mask, and parameters except 'Is Caption' are ignored. By default mask's feather width might change according to the size of mask, while if parameter 'Fixed Feather Width' is set, it will be fixed.

Parameter Type Max Min Default Explain
Region Info ARBDATA Region info, in coordinates that parameter 'Coordinate System' describles, see NvsMaskRegionInfo.
Feather Width FLOAT 1000.0 0.0 0.0 Feather width intensity, which belongs to no coordinates
Fixed Feather Width BOOL FALSE Fix the feather width
Feather Compensation BOOL TRUE Enable antialiasing
Keep RGB BOOL FALSE Output the masked source image or the plane mask
Inverse Region BOOL FALSE Inverse region
Coordinate System STRING NDC Coordinates type: NDC or Timeline
Text Mask Description String STRING Mask description string
Is Caption BOOL FALSE 'Text Mask Description String' is caption string
  • Gaussian Blur
Parameter Type Max Min Default Explain
Radius FLOAT 64.0 0.0 64.0 Blur radius (standard coordinates)
  • Dir Blur
Parameter Type Max Min Default Explain
Length FLOAT 1000.0 0.0 15.0 Blur length (standard coordinates)
Angle FLOAT 3600000.0 - 3600000.0 0.0 counter clock-wise blur angle, 0 means horizontal blur
  • Zoom Blur
Parameter Type Max Min Default Explain
Length FLOAT 1000.0 0.0 50.0 Blur length (standard coordinates)
Center X FLOAT 1.0 -1.0 0.0 Blur center'x value (standard coordinates)
Center Y FLOAT 1.0 -1.0 0.0 Blur center'y value (standard coordinates)
Mipmap BOOL FALSE Enable mipmap solution, smoother but low efficiency
  • Spiral Blur
Parameter Type Max Min Default Explain
Center X FLOAT 1.0 -1.0 0.0 Blur center'x value (standard coordinates)
Center Y FLOAT 1.0 -1.0 0.0 Blur center'y value (standard coordinates)
Radius FLOAT 10000.0 0.0 2000.0 Blur radius (standard coordinates)
Angle FLOAT 3600000.0 - 3600000.0 0.0 Blur field angle
Rotation Angle FLOAT 3600000.0 - 3600000.0 0.0 Counter clock-wise rotation angle of whole image
Full Screen BOOL FALSE Enable full screen blur and parameter 'Radius' will be ignored
Mipmap BOOL FALSE Enable mipmap solution, smoother but low efficiency
  • Shape

Description: It is used to draw vector shapes, such as rectangles, ovals, and paths, and fill shapes in monochromatic or gradient colors.

Parameter Type Max Min Default Explain
Type MENU Rectangle Geometry type: Rectangle, Ellipse or Path
AnchorX FLOAT 100000.0 -100000.0 0.0 Anchor's x value for 2d transform
AnchorY FLOAT 100000.0 -100000.0 0.0 Anchor's y value for 2d transform
ScaleX FLOAT 1000.0 -1000.0 0.0 Horizontal scale factor
ScaleY FLOAT 1000.0 -1000.0 0.0 Vertical scale factor
RotZ FLOAT 3600000.0 -3600000.0 0.0 Counter clock-wise rotation angle
TransX FLOAT 100000.0 -100000.0 0.0 Translation's x value
TransY FLOAT 100000.0 -100000.0 0.0 Translation's y value
CenterX FLOAT 100000.0 -100000.0 0.0 Center's x value, only for rectangle and ellipse
CenterY FLOAT 100000.0 -100000.0 0.0 Center's y value, only for rectangle and ellipse
Width FLOAT 100000.0 0.0 0.0 Shape's width, only for rectangle and ellipse
Height FLOAT 100000.0 0.0 0.0 Shape's height, only for rectangle and ellipse
BorderRadius FLOAT 100000.0 0.0 0.0 Border's radius, only for rectangle
PathDesc STRING Path description string, only for path
FillMode MENU Fill mode: Color or Gradient
Color COLOR 1.0,1.0,1.0,1.0 Fill color, only for color fill mode
GradientDesc STRING Gradient description string, only for gradient fill mode.
Antialiasing BOOL TRUE Enable antialiasing
  • Water Ripple
Parameter Type Max Min Default Explain
Pattern Path STRING Style file path
  • Line Effect
Parameter Type Max Min Default Explain
Angle FLOAT 360.0 0.0 0.0 Direction of line motion, can only be 0, 90, 180, or 270.
Progress FLOAT 1.0 0.0 0.0 process of line motion
Style STRING swipe style of line motion
  • Set Alpha

Description: It needs two input images, source image and alpha image. It will replace the source's alpha channel ( or the solid color's alpha channel) with the alpha image.

Parameter Type Max Min Default Explain
Invert Alpha BOOL FALSE Invert the alpha input image
Use Alpha Channel BOOL FALSE Output image's alpha channel is input alpha image's alpha channel or red channel
Use Solid Src Color BOOL FALSE Take solid color as the source image
Src Color Red FLOAT 1.0 0.0 1.0 Solid color's R value (only works when 'Use Solid Src Color' is true)
Src Color Green FLOAT 1.0 0.0 1.0 Solid color's G value (only works when 'Use Solid Src Color' is true)
Src Color Blue FLOAT 1.0 0.0 1.0 Solid color's B value (only works when 'Use Solid Src Color' is true)
Src Color Alpha FLOAT 1.0 0.0 1.0 Solid color's A value (only works when 'Use Solid Src Color' is true)
  • Mosaic
Parameter Type Max Min Default Explain
Unit Size FLOAT 1.0 0.0 0.05 Fuzzy unit size
Align Center BOOL FALSE Align to the center
  • Glitter
Parameter Type Max Min Default Explain
Quantity FLOAT 1.0 0.0 0.5 Glitter number
Source Path STRING Glitter texture file path
Minus Thresh FLOAT 1.0 0.0 0.15 Threshold
Glitter Size FLOAT 1.0 0.0 0.5 Glitter size
  • Cartoon

Description: Cartoon effect.

Note: If Both 'Grayscale' and 'Stroke Only' are true, only 'Stroke Only' takes effect.

Parameter Type Max Min Default Explain
Grayscale BOOL FALSE Output grayscale effect
Stroke Only BOOL FALSE Only draw the outline
Lut File STRING Lut file path
  • Positioner

Note: The positioner is a special effect that comes with videoclip, which is turned off by default. The positioner can be turned on or off through the enablePropertyVideoFx interface.

Parameter Type Max Min Default Ranges Explain
Fill Mode Menu AspectFit "PanAndScan" "AspectFit" "Stretch" "Fill" Image fill mode
Scan Value FLOAT 1.0 -1.0 0.0 Zoom (only in Pan&Scan mode)
Pan Value FLOAT -1.0 0.0 Pan (only in Pan&Scan mode)
Scale X FLOAT 1000.0 -1000.0 0 Horizontal zoom in X direction
Scale Y FLOAT 1000.0 - 1000.0 1.0 Vertical zoom in Y direction
Rotation FLOAT 3600000.0 - 3600000.0 0.0
Anchor X FLOAT 100000.0 -100000.0 0.0
Anchor Y FLOAT 100000.0 - 100000.0 0.0
Trans X FLOAT 100000.0 - 100000.0 0.0
Trans Y FLOAT 100000.0 - 100000.0 0.0
Enable MultiSample BOOL FALSE
Opacity FLOAT 1.0 0.0 1.0
Wrap Mode Menu Clamp To Edge "Clamp To Edge" "Mirrored Repeat" "Repeat"
Background Mode Menu Color Solid "Color Solid" "Blur" "Image File"
Background Color COLOR 0.0.0.0 Set the background color (only the color mode is valid)
Background Image STRING Set the background picture path (only valid in picture mode)
Background Image Pan FLOAT 1.0 -1.0 0.0 Set the background image translation (only valid in image mode)
Background Blur Radius FLOAT 64.0 0.0 0.0 Set the background blur degree (only the blur mode is valid)
Enable Background Rotation BOOL FALSE Set whether the blurred background image rotates with the foreground image
Package Id STRING Empty string Set the filter resource pack id (the effect scope is only the original picture)
Description File STRING Description file path of the story version stunt (the stunt range is only the original picture)
Description String STRING The description of the special effect in the story version (the scope of the special effect is only the original screen)
Is Storyboard 3D BOOL FALSE Whether it is a three-dimensional story version of the special effects (the scope of the special effects is only the original picture)
Post Package Id STRING Set the filter resource pack id (the effect range is the entire timeline frame)
Post Description File STRING The description file path of the special effect of the story version (the range of the special effect is the entire timeline frame)
Post Description String STRING The description of the special effect in the story version (the range of the special effect is the entire timeline frame)
Is Post Storyboard 3D BOOL FALSE Whether it is a three-dimensional story version of the special effects (the range of special effects is the entire timeline frame)
Package2 Id STRING Set the second filter resource package id (the effect scope is only the original picture)
Package2 Description File The description file path of the second story stunt (the scope of the stunt is only the original screen)
Package2 Description String STRING The description of the second story version of the special effect (the scope of the special effect is only the original screen)
Package2 Is Storyboard 3D BOOL FALSE Whether the second story stunt is a three-dimensional story stunt (the scope of the stunt is only the original picture)
Post Package2 Id STRING Set the second filter resource pack id (the effect range is the entire timeline frame)
Post Package2 Description File STRING The description file path of the second story special effect (the special effect range is the entire timeline frame)
Post Package2 Description String STRING The description of the second story special effect (the special effect range is the entire timeline frame)
Package2 Is Post Storyboard 3D BOOL FALSE Whether the second story stunt is a three-dimensional story stunt (the stunt range is the entire timeline frame)
Resource Dir STRING Empty string Resource file path
Package Effect In FLOAT INT32_MAX 0.0 0.0 The start time of the filter effect
Package Effect Out FLOAT INT32_MAX 0.0 0.0 The effect end time of the filter effect
Package2 Effect In FLOAT INT32_MAX 0.0 0.0 The effect start time of the second filter effect
Package2 Effect Out FLOAT INT32_MAX 0.0 0.0 The effect end time of the second filter effect
Mask Region Info ARBDATA null See NvsMaskRegionInfo.
Mask Feather Width FLOAT 1000.0 0.0 0.0
Mask Inverse Region BOOL FALSE
Mask Coordinate System STRING ndc “ndc”： Normalized coordinate system “timeline”： timeline coordinate system
  • Particle System

Description：particle.

Parameter Type Max Min Default Explain
Tail Fading Duration FLOAT 2.0 0.0 0.0 Particle tail fading duration
Resource Dir STRING Resource file path
Description String STRING The description of the effect
Description File STRING Description file path of the effect
  • Neat

Description：use to smooth face.

Parameter Type Max Min Default
Intensity FLOAT 1.0 0.0 0.8
Details Intensity FLOAT 1.0 0.0 0.5
Blur Thresh FLOAT 1.0 0.0 0.2
Blur Radius FLOAT 1.0 0.0 0.5
  • Segmentation

Description：Retrieve segments of human body or sky. Note： It's only supported in MEISHE sdk with human detection features. Segmentation model should be loaded while initializing the application.

Parameter Type Max Min Default Explain
Segment Type STRING Background Segment Type:”Background”，”Half Body”，”Sky”
Inverse Segment BOOL FALSE Inverse
Output Mask BOOL FALSE output mask or the masked image
  • Segmentation Edge

Description：Produce edge effect from result of 'Segmentation' above.

Parameter Type Max Min Default Explain
Width FLOAT 1000.0 0.0 5.0 Edge width
Color COLOR 1.0:1.0:1.0:1.0 Edge color
Keep Input Color BOOL FALSE Whether to keep input color not
  • Line Painting

Description：Arrow, line painting effect.

Parameter Type Max Min Default
Tex File Path STRING Texture file path
Desc File Path STRING Description file path, which has higher priority to description string.
Desc String STRING Description string
Wrap Mode STRING Wrap mode: Clamp To Edge, Mirrored Repeat or Repeat
  • Matte

Description：matte.

Parameter Type Max Min Default
Intensity FLOAT 1.0 0.0 0.0
Fill Radius FLOAT 30.0 3.0 15.0
  • Mesh Warp

Description：Mesh warping effect.

Parameter Type Max Min Default Explain
Warp Info ARBDATA warping info, see NvsMeshWarpInfo.
Antialiasing BOOL FALSE Is open antialiasing
  • Midtones

Description：Midtones。

Parameter Type Max Min Default Explain
Color Tolerance FLOAT 1.0 0.0 0.0 Color tolerance
Gray Min FLOAT 1.0 0.0 0.0 Minimum gray
Gray Max FLOAT 1.0 0.0 0.0 Maximum gray
Inverse BOOL FALSE Inverse
  • Video Echo

Description：Video echo。

Parameter Type Max Min Default Explain
Echo Frame Count INT 22 2 15 Echo frame count
Echo Frame Interval INT 5 1 1 Echo frame interval
Opacity Array ARBDATA Opacity array
Color Array ARBDATA Color array
  • Master keyer

Description：Image matting。

Parameter Type Max Min Default Explain
Key Color COLOR 1.0, 1.0, 1.0, 1.0 0.0, 0.0, 0.0, 0.0 0.0, 0.0, 0.0, 0.0 Key color
Softeness Amendment FLOAT 1.0 -1.0 0.0 Width of soft edge
Spill Removal BOOL FALSE Enable spill removal
Spill Removal Intensity FLOAT 1.0 0.0 0.25 Spill removal intensity
Shrink Intensity FLOAT 1.0 0.0 0.0 Edge shrinking itensity
Disable Premultiply BOOL FALSE Disable color premultiply
Aperture FLOAT 360.0 0.0 90.0 Aperture of key color
  • Liquefaction

Description：Liquefaction。

Parameter Type Max Min Default Explain
Point X FLOAT 1.0 0.0 0.5 Center X coordinate (texture coordinates)
Point Y FLOAT 1.0 0.0 0.5 Center Y coordinate (texture coordinates)
Radius FLOAT 1.0 0.0 0.25 Radius (texture coordinates)
Type STRING Out Type:In or Out
  • Horror

Description：Horror。

  • Grid

Description：Tranform image into grids, points or lines。

Parameter Type Max Min Default Explain
Amplitude FLOAT 3.0 0.0 1.0 Transform intensity
Mode STRING Grid Transform mode: Grid，Point，Line
  • Noise Wave

Description：Apply horizontal noise and waves to image。

Parameter Type Max Min Default Explain
Wave Length FLOAT 0.5 0.0 0.05 Wave length
Wave Amplify FLOAT 0.1 0.0 0.01 Wave amplify
Noise Magnitude FLOAT 0.5 0.0 0.01 Noise magnitude
Wave Frequency FLOAT 50.0 0.0 1.0 Wave frequency
  • Multi Shots

Description：Multi shots。

Parameter Type Max Min Default Explain
Horizontal Shot Count INT 3 1 1 Horizontal shot count
Vertical Shot Count INT 3 1 1 Vertical shot count
  • Noise

Description：Apply noise to image。

Parameter Type Max Min Default Explain
Intensity FLOAT 1.0 0.0 0.5 Noise intensity
Density FLOAT 1.0 0.0 0.5 Noise density
Grayscale BOOL FALSE enalbe grayscale noise
Tex File Path STRING Tex noise file path
Tex Intensity FLOAT 1.0 0.0 1.0 Tex noise intensity
Tex Scale FLOAT 1000.0 0.0 1.0 Tex scale
  • Blend With Mask

Description：Blend two image with mask，it needs three inputs, namely background, foreground and mask.

Parameter Type Max Min Default Explain
Ignore Background BOOL FALSE Ignore background input image.
Inverse Mask BOOL FALSE Inverse mask
  • Hue Saturation

Description：Hue/Saturation。

Parameter Type Max Min Default Explain
Hue ARBDATA Settings，see (NvsHueSaturationSettingInfo).

1.3、Conditional Compiled Builtin Video Fx

  • Painting Effect

Note：paintbrush(Parameter setting：(NvsPaintingEffectContext) ).

Parameter Type Max Min Default Explain
  • Broken
Parameter Type Max Min Default
Cge File STRING
Trans Normalized X FLOAT 1.0 -1.0 0.0
Trans Normalized Y FLOAT 1.0 -1.0 0.0
  • Stroke Effect

Note: Need supported from third party.

Parameter Type Max Min Default
Source File Path STRING
  • Fluid
Parameter Type Max Min Default
Edge File STRING
  • Face Effect

Description: A compound effect which contains props, beautification, shape beautification and makeup.

Note: Proper detection model should be loaded while initializing the application. Its detection and rendering solution come from third party.

Parameter Type Max Min Default
Face Type STRING NULL
Face Shape Level FLOAT 1.0 0.0 0.5
Cheek Thinning FLOAT 1.0 0.0 1.0
Eye Enlarging FLOAT 1.0 0.0 0.5
Beautification Package STRING
Face Ornament STRING
FlipX BOOL FALSE
FlipY BOOL FALSE
  • Face Effect2

Description: A compound effect which contains beautification, shape beautification and makeup.

Note: Proper detection model should be loaded while initializing the application. Its detection and rendering solution come from third party.

Parameter Type Max Min Default
Reddening FLOAT 1.0 0.0 0.0
Whitening FLOAT 1.0 0.0 0.0
Strength FLOAT 1.0 0.0 0.0
Strength Mode FLOAT 1.0 0.0 1.0
Eye Enlarging FLOAT 1.0 0.0 0.0
Shrink Face FLOAT 1.0 0.0 0.0
Shrink JAW FLOAT 1.0 0.0 0.0
Contrast FLOAT 1.0 0.0 0.0
Saturation FLOAT 1.0 0.0 0.0
Sticker Mode STRING
Sticker Music Disabled BOOL FALSE
Eye Enlarge Ratio FLOAT 1.0 -1.0 0.0
Eye Corner Stretch Ratio FLOAT 1.0 -1.0 0.0
Shrink Face Ratio FLOAT 1.0 -1.0 0.0
Face Width Warp Ratio FLOAT 1.0 -1.0 0.0
Face Length Warp Ratio FLOAT 1.0 -1.0 0.0
Forehead Warp Ratio FLOAT 1.0 -1.0 0.0
Hairline Warp Ratio FLOAT 1.0 -1.0 0.0
Malar Warp Ratio FLOAT 1.0 -1.0 0.0
Jaw Warp Ratio FLOAT 1.0 -1.0 0.0
Chin Warp Ratio FLOAT 1.0 -1.0 0.0
Eyebrow Warp Ratio FLOAT 1.0 -1.0 0.0
Eye Distance Warp Ratio FLOAT 1.0 -1.0 0.0
Nose Length Warp Ratio FLOAT 1.0 -1.0 0.0
Nose Width Warp Ratio FLOAT 1.0 -1.0 0.0
Mouth Size Warp Ratio FLOAT 1.0 -1.0 0.0
Mouth Width Warp Ratio FLOAT 1.0 -1.0 0.0
Mouth Corner Lift Ratio FLOAT 1.0 -1.0 0.0
Narrow Nose Param FLOAT 1.0 0.0 0.0
Nose Length Param FLOAT 1.0 -1.0 0.0
Chin Length Param FLOAT 1.0 -1.0 0.0
Mouth Size Param FLOAT 1.0 -1.0 0.0
Philtrum Length Param FLOAT 1.0 -1.0 0.0
Hairline Height Param FLOAT 1.0 -1.0 0.0
Thin Face Shape Param FLOAT 1.0 0.0 0.0
Eye Distance Param FLOAT 1.0 -1.0 0.0
Eye Angle Param FLOAT 1.0 -1.0 0.0
Open Canthus Param FLOAT 1.0 0.0 0.0
Profile Rhinoplasty Param FLOAT 1.0 0.0 0.0
Bright Eye Param FLOAT 1.0 0.0 0.0
Remove Dark Circles Param FLOAT 1.0 0.0 0.0
Remove Nasolabial Folds Param FLOAT 1.0 0.0 0.0
White Teeth Param FLOAT 1.0 0.0 0.0
Apple Musle Param FLOAT 1.0 0.0 0.0
Open External Canthus Param FLOAT 1.0 0.0 0.0
Shrink Cheekbone Param FLOAT 1.0 0.0 0.0
Custom Input Event INT 2147483647 0 0
Makeup Eye Resource STRING
Makeup Eye Strength FLOAT 1.0 0.0 1.0
Makeup Face Resource STRING
Makeup Face Strength FLOAT 1.0 0.0 1.0
Makeup Lip Resource STRING
Makeup Lip Strength FLOAT 1.0 0.0 1.0
Makeup Nose Resource STRING
Makeup Nose Strength FLOAT 1.0 0.0 1.0
Makeup Brow Resource STRING
Makeup Brow Strength FLOAT 1.0 0.0 1.0
Makeup Eyeliner Resource STRING
Makeup Eyeliner Strength FLOAT 1.0 0.0 1.0
Makeup Eyelash Resource STRING
Makeup Eyelash Strength FLOAT 1.0 0.0 1.0
Makeup Eyeball Resource STRING
Makeup Eyeball Strength FLOAT 1.0 0.0 1.0
Enable Landmark Callback BOOL FALSE

2、Builtin Video Transition

  • Fade
  • Turning
  • Swap
  • Stretch In
  • Page Curl
  • Lens Flare
  • Star
  • Dip To Black
  • Dip To White
  • Push To Right
  • Push To Top
  • Upper Left Into
Generated by   doxygen 1.8.18