MeiCam SDK For iOS  3.14.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
Num Parameter Type Max Min Default
001 Reddening FLOAT 1.0 0.0 0.0
002 Whitening FLOAT 1.0 0.0 0.0
003 Strength FLOAT 1.0 0.0 0.0
  • Color Property
Num Parameter Type Max Min Default
001 Brightness FLOAT 10.0 0.0 1.0
002 Saturation FLOAT 10.0 0.0 1.0
003 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.

Num Parameter Type Max Min Default Range Explain
001 Scale X FLOAT 1000.0 -1000.0 1.0 Scale's x value
002 Scale Y FLOAT 1000.0 -1000.0 1.0 Scale's y value
003 Rotation FLOAT 3600000.0 -3600000.0 0.0 Rotation's z value
004 Rotation X FLOAT 3600000.0 -3600000.0 0.0 Rotation's x value
005 Rotation Y FLOAT 3600000.0 -3600000.0 0.0 Rotation's y value
006 Anchor X FLOAT 100000.0 -100000.0 0.0 Anchor point' x value
007 Anchor Y FLOAT 100000.0 100000.0 0.0 Anchor point' y value
008 Trans X FLOAT 100000.0 -100000.0 0.0 Translation's x value
009 Trans Y FLOAT 100000.0 -100000.0 0.0 Translation's y value
010 Opacity FLOAT 1.0 0.0 1.0 Opacity
011 Tex Wrap Mode Menu Clamp To Edge Clamp To Edge,Mirrored Repeat,Repeat Tex wrap mode
012 Tex Anchor X FLOAT 100.0 -100.0 0.0 Horizontal anchor ( texture coordinates )
013 Tex Anchor Y FLOAT 100.0 -100.0 0.0 Vertical anchor ( texture coordinates )
014 Tex Scale X FLOAT 1000.0 -1000.0 1.0 Horizontal scale
015 Tex Scale Y FLOAT 1000.0 -1000.0 1.0 Vertical scale
016 Tex Rotation FLOAT 3600000.0 -3600000.0 0.0 Clock-wise rotation angle
017 Tex Trans X FLOAT 100000.0 -100000.0 0.0 Horizontal translation ( texture coordinates )
018 Tex Trans Y FLOAT 100000.0 -100000.0 0.0 Vertical translation ( texture coordinates )
019 Multisample BOOL FALSE Multisample or not
020 Is Normalized Coord BOOL FALSE Is in normalized coordinates or not
  • CC Basic
Num Parameter Type Max Min Default Explain
001 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.
002 Master Saturation FLOAT 10.0 0.0 1.0
003 Master Contrast FLOAT 10.0 0.0 1.0
004 Master Balance Hue FLOAT 360.0 0.0 0.0
005 Master Balance Strength FLOAT 10.0 0.0 0.0
006 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.
007 Master Gain Red FLOAT 10.0 0.0 1.0
008 Master Gain Green FLOAT 10.0 0.0 1.0
009 Master Gain Blue FLOAT 10.0 0.0 1.0
010 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.
011 Master Offset Red FLOAT 10.0 -10.0 0.0
012 Master Offset Green FLOAT 10.0 -10.0 0.0
013 Master Offset Blue FLOAT 10.0 -10.0 0.0
014 Shadows Saturation FLOAT 10.0 0.0 1.0
015 Shadows Contrast FLOAT 10.0 0.0 1.0
016 Shadows Balance Hue FLOAT 360.0 0.0 0.0
017 Shadows Balance Strength FLOAT 10.0 0.0 0.0
018 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.
019 Shadows Gain Red FLOAT 10.0 0.0 1.0
020 Shadows Gain Green FLOAT 10.0 0.0 1.0
021 Shadows Gain Blue FLOAT 10.0 0.0 1.0
022 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
023 Shadows Offset Red FLOAT 10.0 -10.0 0.0
024 Shadows Offset Green FLOAT 10.0 -10.0 0.0
025 Shadows Offset Blue FLOAT 10.0 -10.0 0.0
026 Midtones Saturation FLOAT 10.0 0.0 1.0
027 Midtones Contrast FLOAT 10.0 0.0 1.0
028 Midtones Balance Hue FLOAT 360.0 0.0 0.0
029 Midtones Balance Strength FLOAT 10.0 0.0 0.0
030 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.
031 Midtones Gain Red FLOAT 10.0 0.0 1.0
032 Midtones Gain Green FLOAT 10.0 0.0 1.0
033 Midtones Gain Blue FLOAT 10.0 0.0 1.0
034 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.
035 Midtones Offset Red FLOAT 10.0 -10.0 0.0
036 Midtones Offset Green FLOAT 10.0 -10.0 0.0
037 Midtones Offset Blue FLOAT 10.0 -10.0 0.0
038 Highlights Saturation FLOAT 10.0 0.0 1.0
039 Highlights Contrast FLOAT 10.0 0.0 1.0
040 Highlights Balance Hue FLOAT 360.0 0.0 0.0
041 Highlights Balance Strength FLOAT 10.0 0.0 0.0
042 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.
043 Highlights Gain Red FLOAT 10.0 0.0 1.0
044 Highlights Gain Green FLOAT 10.0 0.0 1.0
045 Highlights Gain Blue FLOAT 10.0 0.0 1.0
046 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
047 Highlights Offset Red FLOAT 10.0 -10.0 0.0
048 Highlights Offset Green FLOAT 10.0 -10.0 0.0
049 Highlights Offset Blue FLOAT 10.0 -10.0 0.0
  • Lut

Description: Lut filter.

Num Parameter Type Max Min Default Explain
001 Data File Path STRING Lut file path. Import .mslut format file or png
002 Intensity FLOAT 4.0 0.0 1.0 Intensity
  • BasicImageAdjust
Num Parameter Type Max Min Default
001 Exposure FLOAT 1.0 -1.0 0.0
002 Highlight FLOAT 1.0 -1.0 0.0
003 Shadow FLOAT 1.0 -1.0 0.0
004 Brightness FLOAT 1.0 -1.0 0.0
005 Contrast FLOAT 1.0 -1.0 0.0
006 Blackpoint FLOAT 10.0 -10.0 0.0
007 Saturation FLOAT 1.0 -1.0 0.0
008 Vibrance FLOAT 1.0 -1.0 0.0
009 Video Mode BOOL FALSE, ensure effect consistency between frames.
  • Tint
Num Parameter Type Max Min Default
001 Temperature FLOAT 1.0 -1.0 0.0
002 Tint FLOAT 1.0 -1.0 0.0
  • Denoise
Num Parameter Type Max Min Default
001 Intensity FLOAT 1.0 0.0 0.8
  • Sharpen
Num Parameter Type Max Min Default
001 Radius FLOAT 10.0 0.0 5.1
002 Amount FLOAT 5.0 0.0 1.0
  • Vignette
Num Parameter Type Max Min Default
001 Degree FLOAT 1.0 0.0 0.0
002 Color COLOR 0.0 0.0 0.0 1.0
003 Min Alpha FLOAT 1.0 0.0 0.0
004 Max Alpha FLOAT 1.0 0.0 1.0
  • Definition
Num Parameter Type Max Min Default
001 Intensity FLOAT 1.0 0.0 0.5
002 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.

Num Parameter Type Max Min Default Explain
001 Scene Id STRING Package ID
002 Description File STRING Package description file path
003 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.
004 Face Camera Fovy FLOAT 179 1 45 Camera FOVY
005 Beauty Effect BOOL FALSE Enable beauty (Beauty)
006 Beauty Strength FLOAT 1 0 0.5 Smooth intensity (Beauty)
007 Default Beauty Enabled BOOL TRUE Enable default Lut effect (Beauty)
008 Default Intensity FLOAT 1 0 1 Default Lut intensity (Beauty)
009 Default Beauty Lut File STRING Default Lut file path (Beauty)
010 Beauty Whitening FLOAT 1 0 0.5 Whitening intensity (Beauty)
011 Whitening Lut Enabled BOOL FALSE Enable whitening lut, otherwise the default non-lut whitening effect is applyied. (Beauty)
012 Whitening Lut File STRING Whitening lut file path (Beauty)
013 Beauty Reddening FLOAT 1 0 0.5 Reddening intensity (Beauty)
014 Reddening Lut File STRING Reddening lut file path (Beauty)
015 Default Sharpen Enabled BOOL FALSE Enable sharpen (Beauty)
016 Beauty Fast Mode Enabled BOOL FALSE Enable fast mode (Beauty)
017 Lut Data File Path STRING Lut file path
018 Lut Intensity FLOAT 4 0 1 Lut effect intensity
019 Unified Max Faces INT 8 1 5 Maximum faces could be detected
020 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.
021 Advanced Beauty Enable BOOL FALSE Enable advanced beauty
022 Advanced Beauty Intensity FLOAT 1 0 1 Smooth intensity
023 Advanced Beauty Type INT 2 0 0 Smooth type: 0 for standard on Android，1 for standard on iOS，2 for male
024 Advanced Beauty Remove Dark Circles Intensity FLOAT 1 0 0 Dark circles removal intensity
025 Advanced Beauty Remove Nasolabial Folds Intensity FLOAT 1 0 0 Nasolabial folds removal intensity
026 Advanced Beauty Brighten Eyes Intensity FLOAT 1 0 0 Eyes brightening intensity
027 Advanced Beauty Brighten Eyes Lut File STRING Eyes brightening lut file path
028 Advanced Beauty Whiten Teeth Intensity FLOAT 1 0 0 Teeth whitening intensity
029 Advanced Beauty Whiten Teeth Lut File STRING Teeth whitening lut file path
030 Advanced Beauty Face Lut Intensity FLOAT 1 0 0 Face lut intensity
031 Advanced Beauty Face Lut File STRING Face lut file path
032 Advanced Beauty Clear Intensity FLOAT 1 0 0 Clear intensity
033 Advanced Beauty Matte Intensity FLOAT 1 0 0 Matte intensity
034 Advanced Beauty Matte Fill Radius FLOAT 30 3 15 Matte radius (standard coordinates)
035 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)
036 Advanced Beauty Smooth Disable Auto Consumption Level BOOL FALSE Disable auto smooth consumption level
037 Face Mesh Internal Enabled BOOL FALSE Enable shape beautification
038 Face Mesh Eye Size Degree FLOAT 1 -1 0 Eye enlarging degree
039 Face Mesh Eye Corner Stretch Degree FLOAT 1 -1 0 Eye corner outward stretching degree
040 Face Mesh Face Size Degree FLOAT 1 -1 0 Face shrinking degree
041 Face Mesh Face Width Degree FLOAT 1 -1 0 Face narrowing degree
042 Face Mesh Face Length Degree FLOAT 1 -1 0 Face shortening degree
043 Face Mesh Forehead Height Degree FLOAT 1 -1 0 Forehead lifting degree
044 Face Mesh Malar Width Degree FLOAT 1 -1 0 Malar narrowing degree
045 Face Mesh Jaw Width Degree FLOAT 1 -1 0 Jaw narrowing degree
046 Face Mesh Chin Length Degree FLOAT 1 -1 0 Chin shortening degree
047 Face Mesh Eye Distance Degree FLOAT 1 -1 0 Eye distance narrowing degree
048 Face Mesh Nose Length Degree FLOAT 1 -1 0 Nose stretching degree
049 Face Mesh Nose Width Degree FLOAT 1 -1 0 Nose narrowing degree
050 Face Mesh Mouth Size Degree FLOAT 1 -1 0 Mouth shrinking degree
051 Face Mesh Mouth Corner Lift Degree FLOAT 1 -1 0 Mouth corner lifting degree
052 Face Mesh Temple Width Degree FLOAT 1 -1 0 Temple outward stretching degree
053 Face Mesh Head Size Degree FLOAT 1 -1 0 Head shrinking degree
054 Face Mesh Eye Angle Degree FLOAT 1 -1 0 Eye rotation degree (outer corner up, inner corner down)
055 Face Mesh Nose Bridge Width Degree FLOAT 1 -1 0 Nose bridge narrowing degree
056 Face Mesh Philtrum Length Degree FLOAT 1 -1 0 Philtrum shortening degree
057 Face Mesh Eye Arc Degree FLOAT 1 -1 0 Eye corner lifting degree
058 Face Mesh Eye Width Degree FLOAT 1 -1 0 Eye horizontal stretching degree
059 Face Mesh Eye Height Degree FLOAT 1 -1 0 Eye vertical stretching degree
060 Face Mesh Eye Y Offset Degree FLOAT 1 -1 0 Eye position lifting degree
061 Face Mesh Eyebrow Angle Degree FLOAT 1 -1 0 Eyebrow rotation degree (outer corner up, inner corner down)
062 Face Mesh Eyebrow Thickness Degree FLOAT 1 -1 0 Eyebrow thickening degree
063 Face Mesh Eyebrow X Offset Degree FLOAT 1 -1 0 Eyebrow distance widening degree
064 Face Mesh Eyebrow Y Offset Degree FLOAT 1 -1 0 Eyebrow position lifting degree
065 Face Mesh Nose Head Width Degree FLOAT 1 -1 0 Nose tip narrowing degree
066 Face Mesh Eye Size Custom Package Id STRING Eye enlarging package ID
067 Face Mesh Eye Corner Stretch Custom Package Id STRING Eye corner outward stretching package ID
068 Face Mesh Face Size Custom Package Id STRING Face shrinking package ID
069 Face Mesh Face Width Custom Package Id STRING Face narrowing package ID
070 Face Mesh Face Length Custom Package Id STRING Face shortening package ID
071 Face Mesh Forehead Height Custom Package Id STRING Forehead lifting package ID
072 Face Mesh Malar Width Custom Package Id STRING Malar narrowing package ID
073 Face Mesh Jaw Width Custom Package Id STRING Jaw narrowing package ID
074 Face Mesh Chin Length Custom Package Id STRING Chin shortening package ID
075 Face Mesh Eye Distance Custom Package Id STRING Eye distance narrowing package ID
076 Face Mesh Nose Length Custom Package Id STRING Nose stretching package ID
077 Face Mesh Nose Width Custom Package Id STRING Nose narrowing package ID
078 Face Mesh Mouth Size Custom Package Id STRING Mouth shrinking package ID
079 Face Mesh Mouth Corner Lift Custom Package Id STRING Mouth corner lifting package ID
080 Face Mesh Temple Width Custom Package Id STRING Temple outward stretching package ID
081 Face Mesh Head Size Custom Package Id STRING Head shrinking package ID
082 Face Mesh Eye Angle Custom Package Id STRING Eye rotation package ID
083 Face Mesh Nose Bridge Width Custom Package Id STRING Nose bridge narrowing package ID
084 Face Mesh Philtrum Length Custom Package Id STRING Philtrum shortening package ID
085 Face Mesh Eye Arc Custom Package Id STRING Eye corner lifting package ID
086 Face Mesh Eye Width Custom Package Id STRING Eye horizontal stretching package ID
087 Face Mesh Eye Height Custom Package Id STRING Eye vertical stretching package ID
088 Face Mesh Eye Y Offset Custom Package Id STRING Eye position lifting package ID
089 Face Mesh Eyebrow Angle Custom Package Id STRING Eyebrow rotation package ID
090 Face Mesh Eyebrow Thickness Custom Package Id STRING Eyebrow thickening package ID
091 Face Mesh Eyebrow X Offset Custom Package Id STRING Eyebrow distance widening package ID
092 Face Mesh Eyebrow Y Offset Custom Package Id STRING Eyebrow position lifting package ID
093 Face Mesh Nose Head Width Custom Package Id STRING Nose tip narrowing package ID
094 Makeup Enabled BOOL TRUE Enable makeup
095 Makeup Intensity FLOAT 1 0 1 Makeup intensity
096 Makeup Lip Package Id STRING Makeup lip package ID
097 Makeup Eyebrow Package Id STRING Makeup eyebrow package ID
098 Makeup Eyeshadow Package Id STRING Makeup eyeshadow package ID
099 Makeup Eyelash Package Id STRING Makeup eyelash package ID
100 Makeup Eyeliner Package Id STRING Makeup eyeliner package ID
101 Makeup Blusher Package Id STRING Makeup blusher package ID
102 Makeup Shadow Package Id STRING Makeup shadow package ID
103 Makeup Brighten Package Id STRING Makeup brighten package ID
104 Makeup Eyeball Package Id STRING Makeup eyeball package ID
105 Makeup Lip Color COLOR 0, 0, 0, 0 Makeup lip color
106 Makeup Eyebrow Color COLOR 0, 0, 0, 0 Makeup eyebrow color
107 Makeup Eyeshadow Color COLOR 0, 0, 0, 0 Makeup eyeshadow color
108 Makeup Eyelash Color COLOR 0, 0, 0, 0 Makeup eyelash color
109 Makeup Eyeliner Color COLOR 0, 0, 0, 0 Makeup eyeliner color
110 Makeup Blusher Color COLOR 0, 0, 0, 0 Makeup blusher color
111 Makeup Shadow Color COLOR 0, 0, 0, 0 Makeup shadow color
112 Makeup Brighten Color COLOR 0, 0, 0, 0 Makeup brighten color
113 Makeup Eyeball Color COLOR 0, 0, 0, 0 Makeup eyeball color
114 Makeup Lip Intensity FLOAT 1 0 1 Makeup lip intensity
115 Makeup Eyebrow Intensity FLOAT 1 0 1 Makeup eyebrow intensity
116 Makeup Eyeshadow Intensity FLOAT 1 0 1 Makeup eyeshadow intensity
117 Makeup Eyelash Intensity FLOAT 1 0 1 Makeup eyelash intensity
118 Makeup Eyeliner Intensity FLOAT 1 0 1 Makeup eyeliner intensity
119 Makeup Blusher Intensity FLOAT 1 0 1 Makeup blusher intensity
120 Makeup Shadow Intensity FLOAT 1 0 1 Makeup shadow intensity
121 Makeup Brighten Intensity FLOAT 1 0 1 Makeup brighten intensity
122 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.

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

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

Num Parameter Type Max Min Default Explain
001 Invert Alpha BOOL FALSE Invert the alpha input image
002 Use Alpha Channel BOOL FALSE Output image's alpha channel is input alpha image's alpha channel or red channel
003 Use Solid Src Color BOOL FALSE Take solid color as the source image
004 Src Color Red FLOAT 1.0 0.0 1.0 Solid color's R value (only works when 'Use Solid Src Color' is true)
005 Src Color Green FLOAT 1.0 0.0 1.0 Solid color's G value (only works when 'Use Solid Src Color' is true)
006 Src Color Blue FLOAT 1.0 0.0 1.0 Solid color's B value (only works when 'Use Solid Src Color' is true)
007 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
Num Parameter Type Max Min Default Explain
001 Unit Size FLOAT 1.0 0.0 0.05 Fuzzy unit size
002 Align Center BOOL FALSE Align to the center
  • Glitter
Num Parameter Type Max Min Default Explain
001 Quantity FLOAT 1.0 0.0 0.5 Glitter number
002 Source Path STRING Glitter texture file path
003 Minus Thresh FLOAT 1.0 0.0 0.15 Threshold
004 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.

Num Parameter Type Max Min Default Explain
001 Grayscale BOOL FALSE Output grayscale effect
002 Stroke Only BOOL FALSE Only draw the outline
003 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.

Num Parameter Type Max Min Default Ranges Explain
001 Fill Mode Menu AspectFit "PanAndScan" "AspectFit" "Stretch" "Fill" Image fill mode
002 Scan Value FLOAT 1.0 -1.0 0.0 Zoom (only in Pan&Scan mode)
003 Pan Value FLOAT -1.0 0.0 Pan (only in Pan&Scan mode)
004 Scale X FLOAT 1000.0 -1000.0 0 Horizontal zoom in X direction
005 Scale Y FLOAT 1000.0 - 1000.0 1.0 Vertical zoom in Y direction
006 Rotation FLOAT 3600000.0 - 3600000.0 0.0
007 Anchor X FLOAT 100000.0 -100000.0 0.0
008 Anchor Y FLOAT 100000.0 - 100000.0 0.0
009 Trans X FLOAT 100000.0 - 100000.0 0.0
010 Trans Y FLOAT 100000.0 - 100000.0 0.0
011 Enable MultiSample BOOL FALSE
012 Opacity FLOAT 1.0 0.0 1.0
013 Wrap Mode Menu Clamp To Edge "Clamp To Edge" "Mirrored Repeat" "Repeat"
014 Background Mode Menu Color Solid "Color Solid" "Blur" "Image File"
015 Background Color COLOR 0.0.0.0 Set the background color (only the color mode is valid)
016 Background Image STRING Set the background picture path (only valid in picture mode)
017 Background Image Pan FLOAT 1.0 -1.0 0.0 Set the background image translation (only valid in image mode)
018 Background Blur Radius FLOAT 64.0 0.0 0.0 Set the background blur degree (only the blur mode is valid)
019 Enable Background Rotation BOOL FALSE Set whether the blurred background image rotates with the foreground image
020 Package Id STRING Empty string Set the filter resource pack id (the effect scope is only the original picture)
021 Description File STRING Description file path of the story version stunt (the stunt range is only the original picture)
022 Description String STRING The description of the special effect in the story version (the scope of the special effect is only the original screen)
023 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)
024 Post Package Id STRING Set the filter resource pack id (the effect range is the entire timeline frame)
025 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)
026 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)
027 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)
028 Package2 Id STRING Set the second filter resource package id (the effect scope is only the original picture)
029 Package2 Description File The description file path of the second story stunt (the scope of the stunt is only the original screen)
030 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)
031 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)
032 Post Package2 Id STRING Set the second filter resource pack id (the effect range is the entire timeline frame)
033 Post Package2 Description File STRING The description file path of the second story special effect (the special effect range is the entire timeline frame)
034 Post Package2 Description String STRING The description of the second story special effect (the special effect range is the entire timeline frame)
035 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)
036 Resource Dir STRING Empty string Resource file path
037 Package Effect In FLOAT INT32_MAX 0.0 0.0 The start time of the filter effect
038 Package Effect Out FLOAT INT32_MAX 0.0 0.0 The effect end time of the filter effect
039 Package2 Effect In FLOAT INT32_MAX 0.0 0.0 The effect start time of the second filter effect
040 Package2 Effect Out FLOAT INT32_MAX 0.0 0.0 The effect end time of the second filter effect
041 Mask Region Info ARBDATA null See NvsMaskRegionInfo.
042 Mask Feather Width FLOAT 1000.0 0.0 0.0
043 Mask Inverse Region BOOL FALSE
044 Mask Coordinate System STRING ndc “ndc”： Normalized coordinate system “timeline”： timeline coordinate system
  • Particle System

Description：particle.

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

Description：use to smooth face.

Num Parameter Type Max Min Default
001 Intensity FLOAT 1.0 0.0 0.8
002 Details Intensity FLOAT 1.0 0.0 0.5
003 Blur Thresh FLOAT 1.0 0.0 0.2
004 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.

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

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

Num Parameter Type Max Min Default Explain
001 Width FLOAT 1000.0 0.0 5.0 Edge width
002 Color COLOR 1.0:1.0:1.0:1.0 Edge color
  • Line Painting

Description：Arrow, line painting effect.

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

Description：matte.

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

Description：Mesh warping effect.

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

Description：Midtones。

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

Description：Video echo。

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

Description：Image matting。

Num Parameter Type Max Min Default Explain
001 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
002 Softeness Amendment FLOAT 1.0 -1.0 0.0 Width of soft edge
003 Spill Removal BOOL FALSE Enable spill removal
004 Spill Removal Intensity FLOAT 1.0 0.0 0.25 Spill removal intensity
005 Shrink Intensity FLOAT 1.0 0.0 0.0 Edge shrinking itensity
006 Disable Premultiply BOOL FALSE Disable color premultiply
007 Aperture FLOAT 360.0 0.0 90.0 Aperture of key color
  • Liquefaction

Description：Liquefaction。

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

Description：Horror。

  • Grid

Description：Tranform image into grids, points or lines。

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

Description：Apply horizontal noise and waves to image。

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

Description：Multi shots。

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

Description：Apply noise to image。

Num Parameter Type Max Min Default Explain
001 Intensity FLOAT 1.0 0.0 0.5 Noise intensity
002 Density FLOAT 1.0 0.0 0.5 Noise density
003 Grayscale BOOL FALSE enalbe grayscale noise
004 Tex File Path STRING Tex noise file path
005 Tex Intensity FLOAT 1.0 0.0 1.0 Tex noise intensity
006 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.

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

Description：Hue/Saturation。

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

1.3、Conditional Compiled Builtin Video Fx

  • Painting Effect

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

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

Note: Need supported from third party.

Num Parameter Type Max Min Default
001 Source File Path STRING
  • Fluid
Num Parameter Type Max Min Default
001 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.

Num Parameter Type Max Min Default
001 Face Type STRING NULL
002 Face Shape Level FLOAT 1.0 0.0 0.5
003 Cheek Thinning FLOAT 1.0 0.0 1.0
004 Eye Enlarging FLOAT 1.0 0.0 0.5
005 Beautification Package STRING
006 Face Ornament STRING
007 FlipX BOOL FALSE
008 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.

Num Parameter Type Max Min Default
001 Reddening FLOAT 1.0 0.0 0.0
002 Whitening FLOAT 1.0 0.0 0.0
003 Strength FLOAT 1.0 0.0 0.0
004 Strength Mode FLOAT 1.0 0.0 1.0
005 Eye Enlarging FLOAT 1.0 0.0 0.0
006 Shrink Face FLOAT 1.0 0.0 0.0
007 Shrink JAW FLOAT 1.0 0.0 0.0
008 Contrast FLOAT 1.0 0.0 0.0
009 Saturation FLOAT 1.0 0.0 0.0
010 Sticker Mode STRING
011 Sticker Music Disabled BOOL FALSE
012 Eye Enlarge Ratio FLOAT 1.0 -1.0 0.0
013 Eye Corner Stretch Ratio FLOAT 1.0 -1.0 0.0
014 Shrink Face Ratio FLOAT 1.0 -1.0 0.0
015 Face Width Warp Ratio FLOAT 1.0 -1.0 0.0
016 Face Length Warp Ratio FLOAT 1.0 -1.0 0.0
017 Forehead Warp Ratio FLOAT 1.0 -1.0 0.0
018 Hairline Warp Ratio FLOAT 1.0 -1.0 0.0
019 Malar Warp Ratio FLOAT 1.0 -1.0 0.0
020 Jaw Warp Ratio FLOAT 1.0 -1.0 0.0
021 Chin Warp Ratio FLOAT 1.0 -1.0 0.0
022 Eyebrow Warp Ratio FLOAT 1.0 -1.0 0.0
023 Eye Distance Warp Ratio FLOAT 1.0 -1.0 0.0
024 Nose Length Warp Ratio FLOAT 1.0 -1.0 0.0
025 Nose Width Warp Ratio FLOAT 1.0 -1.0 0.0
026 Mouth Size Warp Ratio FLOAT 1.0 -1.0 0.0
027 Mouth Width Warp Ratio FLOAT 1.0 -1.0 0.0
028 Mouth Corner Lift Ratio FLOAT 1.0 -1.0 0.0
029 Narrow Nose Param FLOAT 1.0 0.0 0.0
030 Nose Length Param FLOAT 1.0 -1.0 0.0
031 Chin Length Param FLOAT 1.0 -1.0 0.0
032 Mouth Size Param FLOAT 1.0 -1.0 0.0
033 Philtrum Length Param FLOAT 1.0 -1.0 0.0
034 Hairline Height Param FLOAT 1.0 -1.0 0.0
035 Thin Face Shape Param FLOAT 1.0 0.0 0.0
036 Eye Distance Param FLOAT 1.0 -1.0 0.0
037 Eye Angle Param FLOAT 1.0 -1.0 0.0
038 Open Canthus Param FLOAT 1.0 0.0 0.0
039 Profile Rhinoplasty Param FLOAT 1.0 0.0 0.0
040 Bright Eye Param FLOAT 1.0 0.0 0.0
041 Remove Dark Circles Param FLOAT 1.0 0.0 0.0
042 Remove Nasolabial Folds Param FLOAT 1.0 0.0 0.0
043 White Teeth Param FLOAT 1.0 0.0 0.0
044 Apple Musle Param FLOAT 1.0 0.0 0.0
045 Open External Canthus Param FLOAT 1.0 0.0 0.0
046 Shrink Cheekbone Param FLOAT 1.0 0.0 0.0
047 Custom Input Event INT 2147483647 0 0
048 Makeup Eye Resource STRING
049 Makeup Eye Strength FLOAT 1.0 0.0 1.0
050 Makeup Face Resource STRING
051 Makeup Face Strength FLOAT 1.0 0.0 1.0
052 Makeup Lip Resource STRING
053 Makeup Lip Strength FLOAT 1.0 0.0 1.0
054 Makeup Nose Resource STRING
055 Makeup Nose Strength FLOAT 1.0 0.0 1.0
056 Makeup Brow Resource STRING
057 Makeup Brow Strength FLOAT 1.0 0.0 1.0
058 Makeup Eyeliner Resource STRING
059 Makeup Eyeliner Strength FLOAT 1.0 0.0 1.0
060 Makeup Eyelash Resource STRING
061 Makeup Eyelash Strength FLOAT 1.0 0.0 1.0
062 Makeup Eyeball Resource STRING
063 Makeup Eyeball Strength FLOAT 1.0 0.0 1.0
064 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