MeiCam SDK For iOS  3.16.3
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 Min Max Default Range Explain
Strength FLOAT 0.0 1.0 0.5 Strength
Whitening FLOAT 0.0 1.0 0.0 Whitening
Reddening FLOAT 0.0 1.0 0.0 Reddening
Default Beauty Enabled BOOL TRUE Whether to enable default beauty
Default Sharpen Enabled BOOL FALSE Whether to enable default sharpen
Default Intensity FLOAT 0.0 1.0 1.0 Default intensity
Default Beauty Lut File STRING Default beauty lut file
Whitening Lut File STRING Whitening lut file
Reddening Lut File STRING Reddening lut file
Whitening Lut Enabled BOOL FALSE Whether to enable whitening lut
Fast Mode Enabled BOOL FALSE Whether to enable fast mode
  • Color Property
Parameter Type Min Max Default Range Explain
Brightness FLOAT 0.0 10.0 1.0 Brightness
Saturation FLOAT 0.0 10.0 1.0 Saturation
Contrast FLOAT 0.0 10.0 1.0 Contrast
  • 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 Min Max Default Range Explain
Scale X FLOAT -10000.0 10000.0 1.0 Scale's x value
Scale Y FLOAT -10000.0 10000.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 0.0 1.0 1.0 Opacity
Tex Wrap Mode Menu 0:Clamp To Edge 0:Clamp To Edge, 1:Mirrored Repeat, 2: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
Custom Matrix STRING Custom Matrix
  • CC Basic
Parameter Type Min Max Default Range 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 0.0 10.0 1.0 Master Saturation
Master Contrast FLOAT 0.0 10.0 1.0 Master Contrast
Master Balance Hue FLOAT 0.0 360.0 0.0 Master Balance Hue
Master Balance Strength FLOAT 0.0 10.0 0.0 Master balance strength
Master Gain Master FLOAT 0.0 10.0 1.0 Full channel gain. Note: The full channel gain is multiplied by the R, G, and B values
Master Gain Red FLOAT 0.0 10.0 1.0 Master Gain Red
Master Gain Green FLOAT 0.0 10.0 1.0 Master Gain Green
Master Gain Blue FLOAT 0.0 10.0 1.0 Master Gain Blue
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 Red
Master Offset Green FLOAT -10.0 10.0 0.0 Master Offset Green
Master Offset Blue FLOAT -10.0 10.0 0.0 Master Offset Blue
Shadows Saturation FLOAT 0.0 10.0 1.0 Shadows Saturation
Shadows Contrast FLOAT 0.0 10.0 1.0 Shadows Contrast
Shadows Balance Hue FLOAT 0.0 360.0 0.0 Shadows Balance Hue
Shadows Balance Strength FLOAT 0.0 10.0 0.0 Shadows balance strength
Shadows Gain Master FLOAT 0.0 10.0 1.0 Full channel gain. Note: The full channel gain is multiplied by the R, G, and B values
Shadows Gain Red FLOAT 0.0 10.0 1.0 Shadows Gain Red
Shadows Gain Green FLOAT 0.0 10.0 1.0 Shadows Gain Green
Shadows Gain Blue FLOAT 0.0 10.0 1.0 Shadows Gain Blue
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 Red
Shadows Offset Green FLOAT -10.0 10.0 0.0 Shadows Offset Green
Shadows Offset Blue FLOAT -10.0 10.0 0.0 Shadows Offset Blue
Midtones Saturation FLOAT 0.0 10.0 1.0 Midtones Saturation
Midtones Contrast FLOAT 0.0 10.0 1.0 Midtones Contrast
Midtones Balance Hue FLOAT 0.0 360.0 0.0 Midtones Balance Hue
Midtones Balance Strength FLOAT 0.0 10.0 0.0 Midtones balance strength
Midtones Gain Master FLOAT 0.0 10.0 1.0 Full channel gain. Note: The full channel gain is multiplied by the R, G, and B values
Midtones Gain Red FLOAT 0.0 10.0 1.0 Midtones Gain Red
Midtones Gain Green FLOAT 0.0 10.0 1.0 Midtones Gain Green
Midtones Gain Blue FLOAT 0.0 10.0 1.0 Midtones Gain Blue
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 Red
Midtones Offset Green FLOAT -10.0 10.0 0.0 Midtones Offset Green
Midtones Offset Blue FLOAT -10.0 10.0 0.0 Midtones Offset Blue
Highlights Saturation FLOAT 0.0 10.0 1.0 Highlights Saturation
Highlights Contrast FLOAT 0.0 10.0 1.0 Highlights Contrast
Highlights Balance Hue FLOAT 0.0 360.0 0.0 Highlights Balance Hue
Highlights Balance Strength FLOAT 0.0 10.0 0.0 Highlights balance strength
Highlights Gain Master FLOAT 0.0 10.0 1.0 Full channel gain. Note: The full channel gain is multiplied by the R, G, and B values
Highlights Gain Red FLOAT 0.0 10.0 1.0 Highlights Gain Red
Highlights Gain Green FLOAT 0.0 10.0 1.0 Highlights Gain Green
Highlights Gain Blue FLOAT 0.0 10.0 1.0 Highlights Gain Blue
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 Red
Highlights Offset Green FLOAT -10.0 10.0 0.0 Highlights Offset Green
Highlights Offset Blue FLOAT -10.0 10.0 0.0 Highlights Offset Blue
  • Lut

Description: Lut filter.

Parameter Type Min Max Default Range Explain
Data File Path STRING Lut file path. Import .mslut format file or png
Intensity FLOAT 0.0 4.0 1.0 Intensity
  • BasicImageAdjust
Parameter Type Min Max Default Range Explain
Brilliance FLOAT -1.0 1.0 0.0 Brilliance
Exposure FLOAT -1.0 1.0 0.0 Exposure
Highlight FLOAT -1.0 1.0 0.0 Highlight
Shadow FLOAT -1.0 1.0 0.0 Shadow
Brightness FLOAT -1.0 1.0 0.0 Brightness
Contrast FLOAT -1.0 1.0 0.0 Contrast
Blackpoint FLOAT -1.0 1.0 0.0 Blackpoint
Whitepoint FLOAT -1.0 1.0 0.0 Whitepoint
Saturation FLOAT -1.0 1.0 0.0 Saturation
Vibrance FLOAT -1.0 1.0 0.0 Vibrance
Definition FLOAT -1.0 1.0 0.0 Definition
Video Mode BOOL TRUE Whether to enable video mode
Keep Previous Frame Cache BOOL FALSE Whether to enable keep previous frame cache
  • Tint
Parameter Type Min Max Default Range Explain
Temperature FLOAT -1.0 1.0 0.0 Temperature
Tint FLOAT -1.0 1.0 0.0 Tint
  • Denoise
Parameter Type Min Max Default Range Explain
Intensity FLOAT 0.0 1.0 0.8 Intensity
Type INT 0 1 0 Type
  • Sharpen
Parameter Type Min Max Default Range Explain
Radius FLOAT 0.0 10.0 5.1 Radius
Amount FLOAT 0.0 5.0 1.0 Amount
  • Vignette
Parameter Type Min Max Default Range Explain
Degree FLOAT 0.0 1.0 0.0 Degree
Color COLOR {0.0f, 0.0f, 0.0f, 1.0f} Color
Min Alpha FLOAT 0.0 1.0 0.0 Min Alpha
Max Alpha FLOAT 0.0 1.0 1.0 Max Alpha
  • Definition
Parameter Type Min Max Default Range Explain
Intensity FLOAT 0.0 1.0 0.5 Intensity
Highlight Boost FLOAT 0.0 1.0 0.5 Highlight Boost
Fast Mode BOOL TRUE Whether to enable fast mode
Keep Previous Frame Cache BOOL FALSE Whether to enable keep previous frame cache
  • 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 Min Max Default Range Explain
Scene Id STRING Package ID
Description File STRING Package description file path
Single Buffer Mode BOOL ANDROID为TRUE,iOS为FALSE In single buffer mode, effects before AR Scene are dropped. Otherwise, there exists a effect lag
Face Camera Fovy FLOAT 1.0 179.0 45.0 Camera FOVY
Beauty Effect BOOL FALSE Enable beauty (Beauty)
Beauty Strength FLOAT 0.0 1.0 0.5 Smooth intensity (Beauty)
Beauty Whitening FLOAT 0.0 1.0 0.0 Whitening intensity (Beauty)
Beauty Reddening FLOAT 0.0 1.0 0.0 Reddening intensity (Beauty)
Default Beauty Enabled BOOL FALSE Enable default Lut effect (Beauty)
Default Intensity FLOAT 0.0 1.0 1.0 Default Lut intensity (Beauty)
Default Sharpen Enabled BOOL FALSE Enable sharpen (Beauty)
Default Beauty Lut File STRING Default Lut file path (Beauty)
Whitening Lut File STRING Whitening lut file path (Beauty)
Reddening Lut File STRING Reddening lut file path (Beauty)
Whitening Lut Enabled BOOL FALSE Enable whitening lut, otherwise the default non-lut whitening effect is applyied. (Beauty)
Beauty Fast Mode Enabled BOOL FALSE Enable fast mode (Beauty)
Beauty Shape BOOL FALSE Enable warp
Head Size Warp Degree FLOAT -1.0 1.0 0.0 Head enlarging degree
Head Size Warp Strategy INT 0 0x7FFFFFFF 0 Head enlarging strategy (if custom head enlaring package is needed, this value should be set to 0x7FFFFFFF)
Warp Head Size Custom Package Id STRING Warp head size custom package id
Lut Data File Path STRING Lut file path
Lut Intensity FLOAT 0.0 4.0 1.0 Lut effect intensity
AI Face Occlusion Enabled BOOL FALSE Whether to turn on AI face occlusion detection. It only works for makeup for now
Unified Max Faces INT 1 8 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
Advanced Beauty Enable BOOL FALSE Enable advanced beauty
Advanced Beauty Intensity FLOAT 0.0 1.0 1.0 Smooth intensity
Advanced Beauty Type INT -1 3 0 Advanced beauty smoothing type: 0: standard effect, 1: standard effect + skin mask, 2: male effect, 3: GAN beauty
Advanced Beauty Remove Dark Circles Intensity FLOAT 0.0 1.0 0.0 Dark circles removal intensity
Advanced Beauty Remove Nasolabial Folds Intensity FLOAT 0.0 1.0 0.0 Nasolabial folds removal intensity
Advanced Beauty Brighten Eyes Intensity FLOAT 0.0 1.0 0.0 Eyes brightening intensity
Advanced Beauty Brighten Eyes Lut File STRING Eyes brightening lut file path (deprecated) [Deprecated]
Advanced Beauty Whiten Teeth Intensity FLOAT 0.0 1.0 0.0 Teeth whitening intensity
Advanced Beauty Whiten Teeth Lut File STRING Teeth whitening lut file path
Advanced Beauty Face Lut Intensity FLOAT 0.0 1.0 0.0 Face lut intensity
Advanced Beauty Face Lut File STRING Face lut file path
Advanced Beauty Clear Intensity FLOAT 0.0 1.0 0.0 Clear intensity
Advanced Beauty Matte Intensity FLOAT 0.0 1.0 0.0 Matte intensity
Advanced Beauty Matte Fill Radius FLOAT 3.0 30.0 15.0 Matte radius (standard coordinates)
Advanced Beauty Smooth Consumption Level INT 0 2 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
Makeup Enabled BOOL TRUE Enable makeup
Makeup Intensity FLOAT 0.0 1.0 1.0 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 0.0 1.0 1.0 Makeup lip intensity
Makeup Eyebrow Intensity FLOAT 0.0 1.0 1.0 Makeup eyebrow intensity
Makeup Eyeshadow Intensity FLOAT 0.0 1.0 1.0 Makeup eyeshadow intensity
Makeup Eyelash Intensity FLOAT 0.0 1.0 1.0 Makeup eyelash intensity
Makeup Eyeliner Intensity FLOAT 0.0 1.0 1.0 Makeup eyeliner intensity
Makeup Blusher Intensity FLOAT 0.0 1.0 1.0 Makeup blusher intensity
Makeup Shadow Intensity FLOAT 0.0 1.0 1.0 Makeup shadow intensity
Makeup Brighten Intensity FLOAT 0.0 1.0 1.0 Makeup brighten intensity
Makeup Eyeball Intensity FLOAT 0.0 1.0 1.0 Makeup eyeball intensity
Face Mesh Internal Enabled BOOL FALSE Enable face mesh
Face Mesh Eye Size Degree FLOAT -1.0 1.0 0.0 Eye enlarging degree
Face Mesh Eye Corner Stretch Degree FLOAT -1.0 1.0 0.0 Eye corner outward stretching degree
Face Mesh Face Size Degree FLOAT -1.0 1.0 0.0 Face shrinking degree
Face Mesh Face Width Degree FLOAT -1.0 1.0 0.0 Face narrowing degree
Face Mesh Face Length Degree FLOAT -1.0 1.0 0.0 Face shortening degree
Face Mesh Forehead Height Degree FLOAT -1.0 1.0 0.0 Forehead lifting degree
Face Mesh Hairline Height Degree FLOAT -1.0 1.0 0.0 Face Mesh Hairline Height Degree
Face Mesh Malar Width Degree FLOAT -1.0 1.0 0.0 Malar narrowing degree
Face Mesh Jaw Width Degree FLOAT -1.0 1.0 0.0 Jaw narrowing degree
Face Mesh Chin Length Degree FLOAT -1.0 1.0 0.0 Chin shortening degree
Face Mesh Eyebrow Width Degree FLOAT -1.0 1.0 0.0 Face Mesh Eyebrow Width Degree
Face Mesh Eye Distance Degree FLOAT -1.0 1.0 0.0 Eye distance narrowing degree
Face Mesh Nose Length Degree FLOAT -1.0 1.0 0.0 Nose stretching degree
Face Mesh Nose Width Degree FLOAT -1.0 1.0 0.0 Nose narrowing degree
Face Mesh Mouth Size Degree FLOAT -1.0 1.0 0.0 Mouth shrinking degree
Face Mesh Mouth Width Degree FLOAT -1.0 1.0 0.0 Face Mesh Mouth Width Degree
Face Mesh Mouth Corner Lift Degree FLOAT -1.0 1.0 0.0 Mouth corner lifting degree
Face Mesh Temple Width Degree FLOAT -1.0 1.0 0.0 Temple outward stretching degree
Face Mesh Head Size Degree FLOAT -1.0 1.0 0.0 Head shrinking degree
Face Mesh Eye Angle Degree FLOAT -1.0 1.0 0.0 Eye rotation degree (outer corner up, inner corner down)
Face Mesh Nose Bridge Width Degree FLOAT -1.0 1.0 0.0 Nose bridge narrowing degree
Face Mesh Philtrum Length Degree FLOAT -1.0 1.0 0.0 Philtrum shortening degree
Face Mesh Eye Arc Degree FLOAT -1.0 1.0 0.0 Eye corner lifting degree
Face Mesh Eye Width Degree FLOAT -1.0 1.0 0.0 Eye horizontal stretching degree
Face Mesh Eye Height Degree FLOAT -1.0 1.0 0.0 Eye vertical stretching degree
Face Mesh Eye Y Offset Degree FLOAT -1.0 1.0 0.0 Eye position lifting degree
Face Mesh Eyebrow Angle Degree FLOAT -1.0 1.0 0.0 Eyebrow rotation degree (outer corner up, inner corner down)
Face Mesh Eyebrow Thickness Degree FLOAT -1.0 1.0 0.0 Eyebrow thickening degree
Face Mesh Eyebrow X Offset Degree FLOAT -1.0 1.0 0.0 Eyebrow distance widening degree
Face Mesh Eyebrow Y Offset Degree FLOAT -1.0 1.0 0.0 Eyebrow position lifting degree
Face Mesh Nose Head Width Degree FLOAT -1.0 1.0 0.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 Hairline Height Custom Package Id STRING Face mesh hairline height custom 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 Eyebrow Width Custom Package Id STRING Face mesh eyebrow width custom 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 Width Custom Package Id STRING Face mesh mouth width custom 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
  • 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 Min Max Default Range Explain
Region Info ARBDATA Region info, in coordinates that parameter 'Coordinate System' describles, see NvsMaskRegionInfo.
Feather Width FLOAT 0.0 1000.0 0.0 Feather width intensity, which belongs to no coordinates
Keep RGB BOOL FALSE Output the masked source image or the plane mask
Inverse Region BOOL FALSE Inverse region
Coordinate System STRING ndc Coordinate system type: "Timeline", "NDC"
Feather Compensation BOOL TRUE Enable antialiasing
Text Mask Description String STRING Mask description string
Is Caption BOOL FALSE 'Text Mask Description String' is caption string
Fixed Feather Width BOOL FALSE Fix the feather width
  • Gaussian Blur
Parameter Type Min Max Default Range Explain
Radius FLOAT 0.0 1000.0 5.0 Blur radius (standard coordinates)
  • Dir Blur
Parameter Type Min Max Default Range Explain
Length FLOAT 0.0 1000.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 Min Max Default Range Explain
Length FLOAT 0.0 1000.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 Min Max Default Range Explain
Center X FLOAT -10000.0 10000.0 0.0 Blur center'x value (standard coordinates)
Center Y FLOAT -10000.0 10000.0 0.0 Blur center'y value (standard coordinates)
Radius FLOAT 0.0 10000.0 2000.0 Radius of the circular area producing the spiral blur effect (always uses standard coordinates and is unaffected by Coordinate System Type)
Angle FLOAT -3600000.0 3600000.0 10.0 Blur field angle
Rotation Angle FLOAT -3600000.0 3600000.0 0.0 Counter clock-wise rotation angle of whole image
Full Screen BOOL TRUE Enable full screen blur and parameter 'Radius' will be ignored
Coordinate System Type Menu 0:NDC 0:NDC, 1:Timeline Coordinate system type
  • 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 Min Max Default Range Explain
Type Menu 0:Rectangle 0:Rectangle, 1:Ellipse, 2:Path 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 1.0 Horizontal scale factor
ScaleY FLOAT -1000.0 1000.0 1.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 0.0 100000.0 0.0 Shape's width, only for rectangle and ellipse
Height FLOAT 0.0 100000.0 0.0 Shape's height, only for rectangle and ellipse
BorderRadius FLOAT 0.0 100000.0 0.0 Border's radius, only for rectangle
PathDesc STRING Path description string, only for path
FillMode Menu 0:Color 0:Color, 1:Gradient Fill mode: Color or Gradient
Color COLOR {1, 1, 1, 1} 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 Min Max Default Range Explain
Pattern Path STRING Style file path
  • Line Effect
Parameter Type Min Max Default Range Explain
Angle FLOAT 0.0 360.0 0.0 Direction of line motion, can only be 0, 90, 180, or 270
Progress FLOAT 0.0 1.0 0.0 process of line motion
Style STRING "swipe" Style: "swipe" or "blur"
  • 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 Min Max Default Range Explain
Clip Trim Used BOOL FALSE Whether to enable clip trim used
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 0.0 1.0 1.0 Solid color's R value (only works when 'Use Solid Src Color' is true)
Src Color Green FLOAT 0.0 1.0 1.0 Solid color's G value (only works when 'Use Solid Src Color' is true)
Src Color Blue FLOAT 0.0 1.0 1.0 Solid color's B value (only works when 'Use Solid Src Color' is true)
Src Color Alpha FLOAT 0.0 1.0 1.0 Solid color's A value (only works when 'Use Solid Src Color' is true)
  • Mosaic
Parameter Type Min Max Default Range Explain
Unit Size FLOAT 0.0 1.0 0.05 Fuzzy unit size
Align Center BOOL FALSE Align to the center
  • Glitter
Parameter Type Min Max Default Range Explain
Quantity FLOAT 0.0 1.0 0.5 Glitter number
Source Path STRING Glitter texture file path
Minus Thresh FLOAT 0.0 1.0 0.15 Threshold
Glitter Size FLOAT 0.0 1.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 Min Max Default Range Explain
Grayscale BOOL FALSE Output grayscale effect
Stroke Only BOOL FALSE Only draw the outline
Lut File STRING :/videoeffect/assets/cartoon.mslut 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 Min Max Default Range Explain
Fill Mode Menu 1:AspectFit 0:PanAndScan, 1:AspectFit, 2:Stretch, 3:Fill Image fill mode
Scan Value FLOAT -1.0 1.0 0.0 Zoom (only in Pan&Scan mode)
Pan Value FLOAT -1.0 1.0 0.0 Pan (only in Pan&Scan mode)
Scale X FLOAT -10000.0 10000.0 1.0 Horizontal zoom in X direction
Scale Y FLOAT -10000.0 10000.0 1.0 Vertical zoom in Y direction
Rotation FLOAT -3600000.0 3600000.0 0.0 Rotation
Anchor X FLOAT -100000.0 100000.0 0.0 Anchor X
Anchor Y FLOAT -100000.0 100000.0 0.0 Anchor Y
Trans X FLOAT -100000.0 100000.0 0.0 Trans X
Trans Y FLOAT -100000.0 100000.0 0.0 Trans Y
Enable MultiSample BOOL FALSE Whether to enable multisample
Opacity FLOAT 0.0 1.0 1.0 Opacity
Wrap Mode Menu 0:Clamp To Edge 0:Clamp To Edge, 1:Mirrored Repeat, 2:Repeat Wrap mode
Background Mode Menu 0:Color Solid 0:Color Solid, 1:Blur, 2:Image File Background mode
Background Color COLOR defBackgroundColor 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 0.0 360.0 0.0 Set the background blur degree (only the blur mode is valid)
Background Blur New Mode Enable BOOL FALSE Whether to enable background blur new mode enable
Enable Background Rotation BOOL FALSE Set whether the blurred background image rotates with the foreground image
Package Id 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 STRING 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 Resource file path
Package Effect In FLOAT 0.0 max 0.0 The start time of the filter effect
Package Effect Out FLOAT 0.0 max 0.0 The effect end time of the filter effect
Package2 Effect In FLOAT 0.0 max 0.0 The effect start time of the second filter effect
Package2 Effect Out FLOAT 0.0 max 0.0 The effect end time of the second filter effect
Mask Region Info ARBDATA See NvsMaskRegionInfo.
Mask Feather Width FLOAT 0.0 1000.0 0.0 Mask feather width
Mask Inverse Region BOOL FALSE Whether to enable mask inverse region
Mask Coordinate System STRING ndc Mask Coordinate System
Disable Ambiguous Crop BOOL FALSE Whether to enable disable ambiguous crop
  • Particle System

Description：particle.

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

Description：use to smooth face.

Parameter Type Min Max Default Range Explain
Intensity FLOAT 0.0 1.0 0.8 Intensity
Details Intensity FLOAT 0.0 1.0 0.15 Details intensity
Blur Thresh FLOAT 0.0 1.0 0.10 Blur Thresh
Blur Radius FLOAT 0.0 20.0 20.0 Blur radius
Employ Skin Key BOOL FALSE Whether to enable employ skin key
  • 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 Min Max Default Range Explain
Segment Type Menu 0:Background 0:Background, 1:Sky, 2:Half Body 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 Min Max Default Range Explain
Width FLOAT 0.0 1000.0 5.0 Edge width
Color COLOR {1.0f, 1.0f, 1.0f, 1.0f} Edge color
Keep Input Color BOOL FALSE Whether to keep input color not
  • Line Painting

Description：Arrow, line painting effect.

Parameter Type Min Max Default Range Explain
Tex File Path STRING Tex file path
Wrap Mode Menu 2:Mirror 0:Clamp, 1:Repeat, 2:Mirror Wrap mode
Desc File Path STRING Desc file path
Desc String STRING Desc String
  • Matte

Description：matte.

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

Description：Mesh warping effect.

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

Description：Midtones。

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

Description：Video echo。

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

Description：Image matting。

Parameter Type Min Max Default Range Explain
Key Color COLOR defKeyColor 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 0.0 1.0 0.25 Spill removal intensity
Shrink Intensity FLOAT 0.0 1.0 0.0 Edge shrinking itensity
Disable Premultiply BOOL FALSE Disable color premultiply
Keyer Mode Menu 0:Master Mode 0:Master Mode, 1:Hsv Mode, 2:RGB Mode Keyer mode
Aperture FLOAT 0.0 360.0 90.0 Aperture of key color
Sat Width FLOAT 0.0 2.0 0.2 Sat width
Val Width FLOAT 0.0 2.0 0.2 Val width
Hue Roll Off FLOAT 0.0 1.0 0.0 Hue Roll Off
Sat Roll Off FLOAT 0.0 1.0 0.0 Sat Roll Off
Val Roll Off FLOAT 0.0 1.0 0.0 Val Roll Off
RGB Softness FLOAT 0.0 1.0 0.0 RGB Softness
  • Liquefaction

Description：Liquefaction。

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

Description：Horror。

  • Grid

Description：Tranform image into grids, points or lines。

Parameter Type Min Max Default Range Explain
Amplitude FLOAT 0.0 3.0 1.0 Transform intensity
Mode Menu 0:Grid 0:Grid, 1:Line, 2:Point Transform mode: Grid，Point，Line
  • Noise Wave

Description：Apply horizontal noise and waves to image。

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

Description：Multi shots。

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

Description：Apply noise to image。

Parameter Type Min Max Default Range Explain
Intensity FLOAT 0.0 1.0 0.5 Noise intensity
Density FLOAT 0.0 1.0 0.5 Noise density
Grayscale BOOL FALSE enalbe grayscale noise
Blur Radius FLOAT 0.0 10.0 0.0 Blur radius
Tex File Path STRING Tex noise file path
Tex Intensity FLOAT 0.0 1.0 1.0 Tex noise intensity
Tex Scale FLOAT 0.0 1000.0 1.0 Tex scale
Use Luma Curve BOOL FALSE Whether to use luma curve
  • Blend With Mask

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

Parameter Type Min Max Default Range Explain
Ignore Background BOOL FALSE Ignore background input image
Inverse Mask BOOL FALSE Inverse mask
Background Color COLOR {0.0f, 0.0f, 0.0f, 0.0f} Background color

1.3、Conditional Compiled Builtin Video Fx

  • Painting Effect

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

Parameter Type Min Max Default Range Explain
No Background BOOL FALSE Whether to enable no background
Enable Antialiasing BOOL FALSE Whether to enable antialiasing
Fill Mode Menu 0:Stretch 0:Stretch, 1:PanAndScan, 2:None Fill mode
  • Broken
Parameter Type Min Max Default Range Explain
Cge File STRING Cge file
Trans Normalized X FLOAT -1.0 1.0 0.0 Trans Normalized X
Trans Normalized Y FLOAT -1.0 1.0 0.0 Trans Normalized Y
  • Stroke Effect

Note: Need supported from third party.

Parameter Type Min Max Default Range Explain
Source File Path STRING Source file path
  • Fluid
Parameter Type Min Max Default Range Explain
Edge File STRING Edge file
  • 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 Min Max Default Range Explain
Face Type Menu 0:Default 0:Default, 1:Goddness, 2:Internet Celebrity, 3:Natural, 4:Custom Face type
Face Shape Level FLOAT 0.0 1.0 0.5 Face shape level
Cheek Thinning FLOAT 0.0 1.0 1.0 Cheek Thinning
Eye Enlarging FLOAT 0.0 1.0 0.5 Eye Enlarging
Beautification Package STRING Beautification Package
Face Ornament STRING Face Ornament
FlipX BOOL FALSE Whether to enable flipx
FlipY BOOL FALSE Whether to enable flipy
  • 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 Min Max Default Range Explain
Reddening FLOAT 0.0 1.0 0.0 Reddening
Whitening FLOAT 0.0 1.0 0.0 Whitening
Strength FLOAT 0.0 1.0 0.0 Strength
Strength Mode FLOAT 0.0 1.0 1.0 Strength mode
Eye Enlarging FLOAT 0.0 1.0 0.0 Eye Enlarging
Shrink Face FLOAT 0.0 1.0 0.0 Shrink Face
Shrink JAW FLOAT 0.0 1.0 0.0 Shrink JAW
Contrast FLOAT 0.0 1.0 0.0 Contrast
Saturation FLOAT 0.0 1.0 0.0 Saturation
Sticker Mode STRING Sticker mode
Sticker Music Disabled BOOL FALSE Whether to enable sticker music disabled
Eye Enlarge Ratio FLOAT -1.0 1.0 0.0 Eye Enlarge Ratio
Eye Corner Stretch Ratio FLOAT -1.0 1.0 0.0 Eye Corner Stretch Ratio
Shrink Face Ratio FLOAT -1.0 1.0 0.0 Shrink Face Ratio
Face Width Warp Ratio FLOAT -1.0 1.0 0.0 Face Width Warp Ratio
Face Length Warp Ratio FLOAT -1.0 1.0 0.0 Face Length Warp Ratio
Forehead Warp Ratio FLOAT -1.0 1.0 0.0 Forehead Warp Ratio
Hairline Warp Ratio FLOAT -1.0 1.0 0.0 Hairline Warp Ratio
Malar Warp Ratio FLOAT -1.0 1.0 0.0 Malar Warp Ratio
Jaw Warp Ratio FLOAT -1.0 1.0 0.0 Jaw Warp Ratio
Chin Warp Ratio FLOAT -1.0 1.0 0.0 Chin Warp Ratio
Eyebrow Warp Ratio FLOAT -1.0 1.0 0.0 Eyebrow Warp Ratio
Eye Distance Warp Ratio FLOAT -1.0 1.0 0.0 Eye Distance Warp Ratio
Nose Length Warp Ratio FLOAT -1.0 1.0 0.0 Nose Length Warp Ratio
Nose Width Warp Ratio FLOAT -1.0 1.0 0.0 Nose Width Warp Ratio
Mouth Size Warp Ratio FLOAT -1.0 1.0 0.0 Mouth Size Warp Ratio
Mouth Width Warp Ratio FLOAT -1.0 1.0 0.0 Mouth Width Warp Ratio
Mouth Corner Lift Ratio FLOAT -1.0 1.0 0.0 Mouth Corner Lift Ratio
Narrow Nose Param FLOAT 0.0 1.0 0.0 Narrow Nose Param
Nose Length Param FLOAT -1.0 1.0 0.0 Nose Length Param
Chin Length Param FLOAT -1.0 1.0 0.0 Chin Length Param
Mouth Size Param FLOAT -1.0 1.0 0.0 Mouth Size Param
Philtrum Length Param FLOAT -1.0 1.0 0.0 Philtrum Length Param
Hairline Height Param FLOAT -1.0 1.0 0.0 Hairline Height Param
Thin Face Shape Param FLOAT 0.0 1.0 0.0 Thin Face Shape Param
Eye Distance Param FLOAT -1.0 1.0 0.0 Eye Distance Param
Eye Angle Param FLOAT -1.0 1.0 0.0 Eye Angle Param
Open Canthus Param FLOAT 0.0 1.0 0.0 Open Canthus Param
Profile Rhinoplasty Param FLOAT 0.0 1.0 0.0 Profile Rhinoplasty Param
Bright Eye Param FLOAT 0.0 1.0 0.0 Bright Eye Param
Remove Dark Circles Param FLOAT 0.0 1.0 0.0 Remove Dark Circles Param
Remove Nasolabial Folds Param FLOAT 0.0 1.0 0.0 Remove Nasolabial Folds Param
White Teeth Param FLOAT 0.0 1.0 0.0 White Teeth Param
Apple Musle Param FLOAT 0.0 1.0 0.0 Apple Musle Param
Open External Canthus Param FLOAT 0.0 1.0 0.0 Open External Canthus Param
Shrink Cheekbone Param FLOAT 0.0 1.0 0.0 Shrink Cheekbone Param
Custom Input Event INT 0 INT_MAX 0 Custom Input Event
Makeup Eye Resource STRING Makeup Eye Resource
Makeup Eye Strength FLOAT 0.0 1.0 1.0 Makeup eye strength
Makeup Face Resource STRING Makeup Face Resource
Makeup Face Strength FLOAT 0.0 1.0 1.0 Makeup face strength
Makeup Lip Resource STRING Makeup Lip Resource
Makeup Lip Strength FLOAT 0.0 1.0 1.0 Makeup lip strength
Makeup Nose Resource STRING Makeup Nose Resource
Makeup Nose Strength FLOAT 0.0 1.0 1.0 Makeup nose strength
Makeup Brow Resource STRING Makeup Brow Resource
Makeup Brow Strength FLOAT 0.0 1.0 1.0 Makeup brow strength
Makeup Eyeliner Resource STRING Makeup Eyeliner Resource
Makeup Eyeliner Strength FLOAT 0.0 1.0 1.0 Makeup eyeliner strength
Makeup Eyelash Resource STRING Makeup Eyelash Resource
Makeup Eyelash Strength FLOAT 0.0 1.0 1.0 Makeup eyelash strength
Makeup Eyeball Resource STRING Makeup Eyeball Resource
Makeup Eyeball Strength FLOAT 0.0 1.0 1.0 Makeup eyeball strength
Enable Landmark Callback BOOL FALSE Whether to enable landmark callback
Avatar Package STRING Avatar Package

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