effect class. More...

Inheritance diagram for com.meicam.sdk.NvsFx:

Public Member Functions
NvsFxDescription	getDescription ()
	Get decription of Fx. More...

void	setIntVal (String fxParam, int val)
	Set the integer parameter of NvsFx. More...

int	getIntVal (String fxParam)
	Get the integer parameter of NvsFx. More...

void	setIntValAtTime (String fxParam, int val, long time)
	Set the NvsFx's integer parameter at a specified time point. More...

int	getIntValAtTime (String fxParam, long time)
	Get the NvsFx's integer parameter at a specified time point. More...

void	setFloatVal (String fxParam, double val)
	Set the float parameter of NvsFx. More...

double	getFloatVal (String fxParam)
	Get the float parameter of NvsFx. More...

void	setFloatValAtTime (String fxParam, double val, long time)
	Set the NvsFx's float parameter at a specified time point. More...

double	getFloatValAtTime (String fxParam, long time)
	Get the NvsFx's float parameter at a specified time point. More...

void	setBooleanVal (String fxParam, boolean val)
	Set the boolean parameter of NvsFx. More...

boolean	getBooleanVal (String fxParam)
	Get the boolean parameter of NvsFx. More...

void	setBooleanValAtTime (String fxParam, boolean val, long time)
	Set the NvsFx’s boolean parameter at a specified time point. More...

boolean	getBooleanValAtTime (String fxParam, long time)
	Get the NvsFx's boolean parameter at a specified time point. More...

void	setStringVal (String fxParam, String val)
	Set the string parameter of NvsFx. More...

String	getStringVal (String fxParam)
	Get the string parameter of NvsFx. More...

void	setStringValAtTime (String fxParam, String val, long time)
	Set the NvsFx's string parameter at a specified time point. More...

String	getStringValAtTime (String fxParam, long time, int flags)
	Get the NvsFx's string parameter at a specified time point. More...

void	setColorVal (String fxParam, NvsColor val)
	Set the color parameter of NvsFx. More...

NvsColor	getColorVal (String fxParam)
	Get the color parameter of NvsFx. More...

void	setColorValAtTime (String fxParam, NvsColor val, long time)
	Set the NvsFx's color parameter at a specified time point. More...

NvsColor	getColorValAtTime (String fxParam, long time)
	Get the NvsFx's color parameter at a specified time point. More...

void	setPosition2DVal (String fxParam, NvsPosition2D val)
	Set the two dimentional coordinates parameter of NvsFx. More...

NvsPosition2D	getPosition2DVal (String fxParam)
	Get the two dimentional coordinates parameter of NvsFx. More...

void	setPosition2DValAtTime (String fxParam, NvsPosition2D val, long time)
	Set the NvsFx's two dimentional coordinates parameter at a specified time point. More...

NvsPosition2D	getPosition2DValAtTime (String fxParam, long time)
	Get the NvsFx's two dimentional coordinates parameter at a specified time point. More...

void	setPosition3DVal (String fxParam, NvsPosition3D val)
	Set the three dimentional coordinates parameter of NvsFx. More...

NvsPosition3D	getPosition3DVal (String fxParam)
	Get the three dimentional coordinates parameter of NvsFx. More...

void	setPosition3DValAtTime (String fxParam, NvsPosition3D val, long time)
	Set the NvsFx's three dimentional coordinates parameter at a specified time point. More...

NvsPosition3D	getPosition3DValAtTime (String fxParam, long time)
	Get the NvsFx's three dimentional coordinates parameter at a specified time point. More...

void	setMenuVal (String fxParam, String val)
	Set the menu parameter of NvsFx. More...

String	getMenuVal (String fxParam)
	Get the menu parameter of NvsFx. More...

void	setMenuValAtTime (String fxParam, String val, long time)
	Set the NvsFx's menu parameter at a specified time point. More...

String	getMenuValAtTime (String fxParam, long time)
	Get the NvsFx menu parameter at a specified time point. More...

void	setArbDataVal (String fxParam, NvsArbitraryData val)
	Set custom data parameter value. More...

NvsArbitraryData	getArbDataVal (String fxParam)
	Get custom data parameter value. More...

void	setArbDataValAtTime (String fxParam, NvsArbitraryData val, long time)
	Sets custom data parameter value. More...

NvsArbitraryData	getArbDataValAtTime (String fxParam, NvsArbitraryData val, long time)
	Get custom data parameter value at a specified time point. More...

boolean	removeKeyframeAtTime (String fxParam, long time)
	Remove key frame at a specified time point from key frame list. More...

boolean	removeAllKeyframe (String fxParam)
	Remove all key frames from key frame list. More...

boolean	hasKeyframeList (String fxParam)
	Check whether the parameter has key frame list or not. More...

long	findKeyframeTime (String fxParam, long time, int flags)
	Get key frame at a specified time point. More...

boolean	setKeyFrameControlPoint (String fxParam, long time, NvsControlPointPair controlPointPair)
	Set key frame control point pair. More...

NvsControlPointPair	getKeyFrameControlPoint (String fxParam, long time)
	Get key frame control point pair. More...

boolean	setKeyFrameControlPointMode (String fxParam, long time, NvsControlPointModePair controlPointModePair)
	Set key frame control point mode pair. More...

NvsControlPointModePair	getKeyFrameControlPointMode (String fxParam, long time)
	Get key frame control point mode pair. More...

void	setFilterIntensity (float intensity)
	Set the intensity of the filter. More...

float	getFilterIntensity ()
	Get the intensity of the filter. More...

void	setFilterMask (boolean useMask)
	Set the mask of the filter. More...

boolean	getFilterMask ()
	Get the usage of the filter's mask. More...

void	setRegional (boolean isRegional)
	Set whether the filter is regional. More...

boolean	getRegional ()
	Get whether the filter is regional. More...

void	setIgnoreBackground (boolean isIgnoreBackground)
	Set whether the regional filter ignores background. More...

boolean	getIgnoreBackground ()
	Get whether the regional filter ignores background. More...

void	setInverseRegion (boolean isInverseRegion)
	Set whether the regional filter inverses region. More...

boolean	getInverseRegion ()
	Get whether the regional filter inverses region. More...

void	setRegion (float[] region)
	Set the region of this regional filter. More...

float[]	getRegion ()
	Get the region of this regional filter. More...

void	setRegionInfo (NvsMaskRegionInfo info)
	Set the mask region informations of the regional filter. More...

NvsMaskRegionInfo	getRegionInfo ()
	Get the mask region informations of the regional filter. More...

void	setRegionInfoAtTime (NvsMaskRegionInfo info, long time)
	Set the regional filter's mask region informations at a specified time point. More...

NvsMaskRegionInfo	getRegionInfoAtTime (long time)
	Get the the regional filter's mask region informations at a specified time. More...

void	setRegionalFeatherWidth (float featherWidth)
	Set the feather width of the regional filter. More...

float	getRegionalFeatherWidth ()
	Get the feather width of the regional filter. More...

void	setRegionalFeatherWidthAtTime (float featherWidth, long time)
	Set the regional filter's feather width at a specified time point. More...

float	getRegionalFeatherWidthAtTime (long time)
	Get the regional filter's feather width at a specified time point. More...

void	setRegionCoordinateSystemType (int type)
	Set the coordinate system of the region. More...

int	getRegionCoordinateSystemType ()
	Get the coordinate system type of the region. More...

NvsParticleSystemContext	getParticleSystemContext ()
	Get the particle effect context object.Please refer to NvsParticleSystemContext. More...

NvsARFaceContext	getARFaceContext ()
	Get face effect context object.Please refer to NvsARFaceContext. More...

NvsPaintingEffectContext	getPaintingEffectContext ()
	Get the particle effect context object.Please refer to NvsPaintingEffectContext. More...

NvsARSceneManipulate	getARSceneManipulate ()
	Get the AR scene operation object.Please refer to NvsARSceneManipulate. More...

void	setExprVar (String varName, double varValue)
	Set the value of the defined parameter in the expression. More...

double	getExprVar (String varName)
	Get the value of the defined parameter in the expression. More...

void	setExprStringVar (String varName, String varValue)
	Set the value of the defined parameter in the expression. More...

String	getExprStringVar (String varName)
	Get the value of the defined parameter in the expression. More...

void	setExprObjectVar (String varName, Object varValue)
	Set the value of the defined parameter in the expression. More...

Object	getExprObjectVar (String varName)
	Get the value of the defined parameter in the expression. More...

void	clearExprVar (String varName)
	Clear the value of the defined parameter in the expression and set it to the default value of 0. More...

void	clearExprVarCtx ()
	Clear all parameter values defined in the expression and set them to the default value of 0. More...

Public Member Functions inherited from com.meicam.sdk.NvsObject
void	setAttachment (String key, Object value)
	Adds additional data to the NvsObject object to identify the NvsObject object or for other purpose. More...

void	setTemplateAttachment (String key, String value)
	Adds additional template data to the NvsObject object to identify the NvsObject template object. More...

Object	getAttachment (String key)
	Gets an attachment to NvsObject. More...

String	getTemplateAttachment (String key)
	Gets an template attachment to NvsObject. More...

Static Public Attributes
Key frame find mode

static final int	KEY_FRAME_FIND_MODE_INPUT_TIME_BEFORE = 1
	find key frame before current time More...

static final int	KEY_FRAME_FIND_MODE_INPUT_TIME_AFTER = 2

Region Coordinate System Type

static final int	REGION_COORDINATE_SYSTEM_TYPE_NDC = 0
	NDC coordinate system. More...

static final int	REGION_COORDINATE_SYSTEM_TYPE_TIMELINE = 1

Face Warp Effect Strategy

static final int	FACE_WARP_EFFECT_STRATEGY_CUSTOM = 0x7FFFFFFF

Static Public Attributes inherited from com.meicam.sdk.NvsObject
static final String	TEMPLATE_KEY_REPLACE_ID = "MSTemplate-ReplaceId"

static final String	TEMPLATE_KEY_FOOTAGE_CAN_REPLACE = "MSTemplate-FootageCanReplace"

static final String	TEMPLATE_KEY_FOOTAGE_ID = "MSTemplate-FootageId"

static final String	TEMPLATE_KEY_FOOTAGE_NAME = "MSTemplate-FootageName"

static final String	TEMPLATE_KEY_FOOTAGE_M3U8_NAME = "MSTemplate-FootageM3U8Name"

static final String	TEMPLATE_KEY_FOOTAGE_TAGS = "MSTemplate-FootageTags"

static final String	TEMPLATE_KEY_FOOTAGE_TYPE = "MSTemplate-FootageType"

static final String	TEMPLATE_KEY_FOOTAGE_NEED_REVERSE = "MSTemplate-FootageNeedReverse"

static final String	TEMPLATE_KEY_CLIP_RAW_WIDTH = "MSTemplate-ClipRawWidth"

static final String	TEMPLATE_KEY_CLIP_RAW_HEIGHT = "MSTemplate-ClipRawHeight"

static final String	TEMPLATE_KEY_VOLUME_TYPE = "MSTemplate-VolumeType"

static final String	TEMPLATE_KEY_FX_GROUP = "MSTemplate-FxGroup"

static final String	TEMPLATE_KEY_BEST_SEEK_TIME = "MSTemplate-BestSeekTime"

static final String	TEMPLATE_KEY_MASK_TYPE = "MSTemplate-MaskType"

static final String	TEMPLATE_VALUE_MASK_TYPE_LINE = "MSTemplate-MaskType-Line"

static final String	TEMPLATE_VALUE_MASK_TYPE_MIRROR = "MSTemplate-MaskType-Mirror"

static final String	TEMPLATE_VALUE_MASK_TYPE_CIRCLE = "MSTemplate-MaskType-Circle"

static final String	TEMPLATE_VALUE_MASK_TYPE_RECT = "MSTemplate-MaskType-Rect"

static final String	TEMPLATE_VALUE_MASK_TYPE_HEART = "MSTemplate-MaskType-Heart"

static final String	TEMPLATE_VALUE_MASK_TYPE_STAR = "MSTemplate-MaskType-Star"

static final String	TEMPLATE_KEY_TRANS_TYPE_CUT = "MSTemplate-TransType-Cut"

static final String	TEMPLATE_KEY_CURVE_SPEED_TYPE = "MSTemplate-CurveSpeedType"

static final String	TEMPLATE_VALUE_CURVE_SPEED_TYPE_CUSTOM = "MSTemplate-CurveSpeedType-Custom"

static final String	TEMPLATE_VALUE_CURVE_SPEED_TYPE_MONTAGE = "MSTemplate-CurveSpeedType-Montage"

static final String	TEMPLATE_VALUE_CURVE_SPEED_TYPE_HERO = "MSTemplate-CurveSpeedType-Hero"

static final String	TEMPLATE_VALUE_CURVE_SPEED_TYPE_BULLET = "MSTemplate-CurveSpeedType-bullet"

static final String	TEMPLATE_VALUE_CURVE_SPEED_TYPE_PLUS = "MSTemplate-CurveSpeedType-Plus"

static final String	TEMPLATE_VALUE_CURVE_SPEED_TYPE_IN = "MSTemplate-CurveSpeedType-In"

static final String	TEMPLATE_VALUE_CURVE_SPEED_TYPE_OUT = "MSTemplate-CurveSpeedType-Out"

Additional Inherited Members
Protected Member Functions inherited from com.meicam.sdk.NvsObject
void	setInternalObject (long internalObject)

long	getInternalObject ()

Protected Attributes inherited from com.meicam.sdk.NvsObject
long	m_internalObject = 0

Detailed Description

effect class.

Effect class(NvsFx) is the basic class of different effect classes, include video effects(Video Fx), audio effects(Audio Fx), audio transition effects and video transition effects. In the SDK framework, effects are very important, as they are derived from the NvsFx class, with different kinds of effects. They can be added, removed or obtained from clips, timelines or tracks. Also, the effect class(NvsFx) provides different APIs to modify or obtain its parameters.

Warning: In the NvsFx class, all public APIs are used in UI thread!!!

Member Function Documentation

◆ clearExprVar()

void com.meicam.sdk.NvsFx.clearExprVar ( String varName )

inline

Clear the value of the defined parameter in the expression and set it to the default value of 0.

Parameters

varName The parameter defined in the expression

Since: 2.16.1

◆ clearExprVarCtx()

void com.meicam.sdk.NvsFx.clearExprVarCtx ( )

inline

Clear all parameter values defined in the expression and set them to the default value of 0.

Since: 2.16.1

◆ findKeyframeTime()

long com.meicam.sdk.NvsFx.findKeyframeTime	(	String	fxParam,
		long	time,
		int	flags
	)

inline

Get key frame at a specified time point.

Parameters

fxParam	The type of custom data parameter for the effect.
time	time point (In microseconds).
flags	flag of finding mode, Please refer to [KEY_FRAME_FIND_MODE].

Returns: Return key frame time point near the specified time point, If there is no key frame near this time point, return - 1

Reimplemented in com.meicam.sdk.NvsCompoundCaption.

◆ getArbDataVal()

NvsArbitraryData com.meicam.sdk.NvsFx.getArbDataVal ( String fxParam )

inline

Get custom data parameter value.

Parameters

fxParam The type of custom data parameter for the effect.

Returns: return custom arbitrary data.NvsArbitraryData对象

See also: setArbDataVal

◆ getArbDataValAtTime()

NvsArbitraryData com.meicam.sdk.NvsFx.getArbDataValAtTime	(	String	fxParam,
		NvsArbitraryData	val,
		long	time
	)

inline

Get custom data parameter value at a specified time point.

Parameters

fxParam	The type of custom data parameter for the effect.
time	time point

Returns: return custom arbitrary data.NvsArbitraryData对象

See also: setArbDataValAtTime

◆ getARFaceContext()

NvsARFaceContext com.meicam.sdk.NvsFx.getARFaceContext ( )

inline

Get face effect context object.Please refer to NvsARFaceContext.

Returns: Return face effect context object.

◆ getARSceneManipulate()

NvsARSceneManipulate com.meicam.sdk.NvsFx.getARSceneManipulate ( )

inline

Get the AR scene operation object.Please refer to NvsARSceneManipulate.

Returns: Return the AR scene operation object.

◆ getBooleanVal()

boolean com.meicam.sdk.NvsFx.getBooleanVal ( String fxParam )

inline

Get the boolean parameter of NvsFx.

Parameters

fxParam The type of the NvsFx's boolean parameter. Please refer to [PARAM_TYPE_BOOL].

Returns: Return the boolean value.

See also: setBooleanVal

◆ getBooleanValAtTime()

boolean com.meicam.sdk.NvsFx.getBooleanValAtTime	(	String	fxParam,
		long	time
	)

inline

Get the NvsFx's boolean parameter at a specified time point.

Parameters

fxParam	The type of the NvsFx's boolean parameter. Please refer to [PARAM_TYPE_BOOL].
time	time point (In microseconds).

Returns: Return the boolean value.

See also: setBooleanValAtTime

◆ getColorVal()

NvsColor com.meicam.sdk.NvsFx.getColorVal ( String fxParam )

inline

Get the color parameter of NvsFx.

Parameters

fxParam The type of the NvsFx's color parameter. Please refer to [PARAM_TYPE_COLOR].

Returns: Return the customized color object[NvsColor].

See also: setColorVal

◆ getColorValAtTime()

NvsColor com.meicam.sdk.NvsFx.getColorValAtTime	(	String	fxParam,
		long	time
	)

inline

Get the NvsFx's color parameter at a specified time point.

Parameters

fxParam	The type of the NvsFx's color parameter. Please refer to [PARAM_TYPE_COLOR].
time	point time (In microseconds).

Returns: Return the customized color object[NvsColor].

See also: setColorValAtTime

◆ getDescription()

NvsFxDescription com.meicam.sdk.NvsFx.getDescription ( )

inline

Get decription of Fx.

Returns: Return the NvsFxDescription object.

◆ getExprObjectVar()

Object com.meicam.sdk.NvsFx.getExprObjectVar ( String varName )

inline

Get the value of the defined parameter in the expression.

Parameters

varName The parameters defined in the expression

Returns: Returns the value of the parameter defined in the expression

See also: setExprStringVar

Since: 3.5.2

◆ getExprStringVar()

String com.meicam.sdk.NvsFx.getExprStringVar ( String varName )

inline

Get the value of the defined parameter in the expression.

Parameters

varName The parameters defined in the expression

Returns: Returns the value of the parameter defined in the expression

See also: setExprStringVar

Since: 2.16.1

◆ getExprVar()

double com.meicam.sdk.NvsFx.getExprVar ( String varName )

inline

Get the value of the defined parameter in the expression.

Parameters

varName The parameters defined in the expression

Returns: Returns the value of the parameter defined in the expression

See also: setExprVar

Since: 2.16.1

◆ getFilterIntensity()

float com.meicam.sdk.NvsFx.getFilterIntensity ( )

inline

Get the intensity of the filter.

Returns: Return the degree of intensity of the filter.

See also: setFilterIntensity

Since: 2.0.2

◆ getFilterMask()

boolean com.meicam.sdk.NvsFx.getFilterMask ( )

inline

Get the usage of the filter's mask.

Returns: Return used or not.

See also: setFilterMask

Since: 2.14.1

◆ getFloatVal()

double com.meicam.sdk.NvsFx.getFloatVal ( String fxParam )

inline

Get the float parameter of NvsFx.

Parameters

fxParam The type of the NvsFx's float parameter. Please refer to [PARAM_TYPE_FLOAT].

Returns: Return the double value.

See also: setFloatVal

◆ getFloatValAtTime()

double com.meicam.sdk.NvsFx.getFloatValAtTime	(	String	fxParam,
		long	time
	)

inline

Get the NvsFx's float parameter at a specified time point.

Parameters

fxParam	The type of the NvsFx's float parameter. Please refer to [PARAM_TYPE_FLOAT].
time	time point (In microseconds).

Returns: Return the double value.

See also: setFloatValAtTime

◆ getIgnoreBackground()

boolean com.meicam.sdk.NvsFx.getIgnoreBackground ( )

inline

Get whether the regional filter ignores background.

Returns: Return whether the regional filter ignores background or not.

See also: setIgnoreBackground

Since: 2.15.1

◆ getIntVal()

int com.meicam.sdk.NvsFx.getIntVal ( String fxParam )

inline

Get the integer parameter of NvsFx.

Parameters

fxParam The type of the NvsFx's integer parameter. Please refer to [PARAM_TYPE_INT].

Returns: Return the integer value.

See also: setIntVal

◆ getIntValAtTime()

int com.meicam.sdk.NvsFx.getIntValAtTime	(	String	fxParam,
		long	time
	)

inline

Get the NvsFx's integer parameter at a specified time point.

Parameters

fxParam	The type of the NvsFx's integer parameter. Please refer to [PARAM_TYPE_INT].
time	time point (In microseconds).

Returns: Return the integer value.

See also: setIntValAtTime

◆ getInverseRegion()

boolean com.meicam.sdk.NvsFx.getInverseRegion ( )

inline

Get whether the regional filter inverses region.

Returns: Return whether the regional filter inverses region or not.

See also: setInverseRegion

Since: 2.15.1

◆ getKeyFrameControlPoint()

NvsControlPointPair com.meicam.sdk.NvsFx.getKeyFrameControlPoint	(	String	fxParam,
		long	time
	)

inline

Get key frame control point pair.

Parameters

fxParam	The type of custom data parameter for the effect.
time	time point (In microseconds).

Returns: return key frame control point data.NvsControlPointPair对象

See also: setKeyFrameControlPoint

Since: 2.21.0

◆ getKeyFrameControlPointMode()

NvsControlPointModePair com.meicam.sdk.NvsFx.getKeyFrameControlPointMode	(	String	fxParam,
		long	time
	)

inline

Get key frame control point mode pair.

Parameters

fxParam	The type of custom data parameter for the effect.
time	time point (In microseconds).

Returns: return key frame control point mode data.NvsControlPointModePair对象

See also: setKeyFrameControlPointMode

Since: 3.6.0

◆ getMenuVal()

String com.meicam.sdk.NvsFx.getMenuVal ( String fxParam )

inline

Get the menu parameter of NvsFx.

Parameters

fxParam The type of the NvsFx's menu parameter. Please refer to [PARAM_TYPE_MENU].

Returns: Return the menu value of NvsFx.

See also: setMenuVal

◆ getMenuValAtTime()

String com.meicam.sdk.NvsFx.getMenuValAtTime	(	String	fxParam,
		long	time
	)

inline

Get the NvsFx menu parameter at a specified time point.

Parameters

fxParam	The type of the NvsFx's menu parameter. Please refer to [PARAM_TYPE_MENU].
time	time point (In microseconds).

Returns: Return the menu value of NvsFx.

See also: setMenuValAtTime

◆ getPaintingEffectContext()

NvsPaintingEffectContext com.meicam.sdk.NvsFx.getPaintingEffectContext ( )

inline

Get the particle effect context object.Please refer to NvsPaintingEffectContext.

Returns: Return the particle effect context object.

Since: 2.2.0

◆ getParticleSystemContext()

NvsParticleSystemContext com.meicam.sdk.NvsFx.getParticleSystemContext ( )

inline

Get the particle effect context object.Please refer to NvsParticleSystemContext.

Returns: Return a particle effect context object.

◆ getPosition2DVal()

NvsPosition2D com.meicam.sdk.NvsFx.getPosition2DVal ( String fxParam )

inline

Get the two dimentional coordinates parameter of NvsFx.

Parameters

fxParam The type of the NvsFx's two dimentional coordinates parameter. Please refer to [PARAM_TYPE_POSITION2D].

Returns: Return the two dimentional coordinates object[NvPosition2D].

See also: setPosition2DVal; getPosition3DVal

◆ getPosition2DValAtTime()

NvsPosition2D com.meicam.sdk.NvsFx.getPosition2DValAtTime	(	String	fxParam,
		long	time
	)

inline

Get the NvsFx's two dimentional coordinates parameter at a specified time point.

Parameters

fxParam	The type of the NvsFx's two dimentional coordinates parameter. Please refer to [PARAM_TYPE_POSITION2D].
time	time point (In microseconds).

Returns: Return the two dimentional coordinates object[NvPosition2D].

See also: setPosition2DValAtTime; getPosition3DValAtTime

◆ getPosition3DVal()

NvsPosition3D com.meicam.sdk.NvsFx.getPosition3DVal ( String fxParam )

inline

Get the three dimentional coordinates parameter of NvsFx.

Parameters

fxParam The type of the NvsFx's three dimentional coordinates parameter. Please refer to [PARAM_TYPE_POSITION3D].

Returns: Return the three dimentional coordinates object[NvPosition3D].

See also: setPosition3DVal; getPosition2DVal

◆ getPosition3DValAtTime()

NvsPosition3D com.meicam.sdk.NvsFx.getPosition3DValAtTime	(	String	fxParam,
		long	time
	)

inline

Get the NvsFx's three dimentional coordinates parameter at a specified time point.

Parameters

fxParam	The type of the NvsFx's three dimentional coordinates parameter. Please refer to [PARAM_TYPE_POSITION3D].
time	current time (In microseconds).

Returns: Return the three dimentional coordinates object[NvPosition3D].

See also: setPosition3DValAtTime; getPosition2DValAtTime

◆ getRegion()

float [] com.meicam.sdk.NvsFx.getRegion ( )

inline

Get the region of this regional filter.

Returns: Return the effective region of the filter。It is composed with a series of points, which are in NDC coordinate system.

See also: setRegion

Since: 2.16.1

◆ getRegional()

boolean com.meicam.sdk.NvsFx.getRegional ( )

inline

Get whether the filter is regional.

Returns: Return whether the filter is regional or not.

See also: setRegional

Since: 2.10.1

◆ getRegionalFeatherWidth()

float com.meicam.sdk.NvsFx.getRegionalFeatherWidth ( )

inline

Get the feather width of the regional filter.

Returns: Return the feather width of the regional filter.

See also: setRegionalFeatherWidth

Since: 2.10.1

◆ getRegionalFeatherWidthAtTime()

float com.meicam.sdk.NvsFx.getRegionalFeatherWidthAtTime ( long time )

inline

Get the regional filter's feather width at a specified time point.

Parameters

time	time point

Returns: Return the feather width of the regional filter.

See also: setRegionalFeatherWidthAtTime

Since: 2.16.1

◆ getRegionCoordinateSystemType()

int com.meicam.sdk.NvsFx.getRegionCoordinateSystemType ( )

inline

Get the coordinate system type of the region.

Returns: Return the coordinate system type of the region.

See also: setRegionCoordinateSystemType

Since: 2.16.1

◆ getRegionInfo()

NvsMaskRegionInfo com.meicam.sdk.NvsFx.getRegionInfo ( )

inline

Get the mask region informations of the regional filter.

Returns: Return the mask region informations of the filter. It could be series of points, cubic bezier curve or ellipse, which are in NDC coordinate system.

See also: setRegionInfo

Since: 2.16.0

◆ getRegionInfoAtTime()

NvsMaskRegionInfo com.meicam.sdk.NvsFx.getRegionInfoAtTime ( long time )

inline

Get the the regional filter's mask region informations at a specified time.

Returns: Return the filter's mask region informations. It could be series of points, cubic bezier curve or ellipse, which are in NDC coordinate system.

See also: setRegionInfoAtTime

Since: 2.16.0

◆ getStringVal()

String com.meicam.sdk.NvsFx.getStringVal ( String fxParam )

inline

Get the string parameter of NvsFx.

Parameters

fxParam The type of the NvsFx's string parameter. Please refer to [PARAM_TYPE_STRING].

Returns: Return the string value.

See also: setStringVal

◆ getStringValAtTime()

String com.meicam.sdk.NvsFx.getStringValAtTime	(	String	fxParam,
		long	time,
		int	flags
	)

inline

Get the NvsFx's string parameter at a specified time point.

Parameters

fxParam	The type of the NvsFx's string parameter. Please refer to [PARAM_TYPE_STRING].
time	time point (In microseconds).

Returns: Return the string value.

See also: setStringValAtTime

◆ hasKeyframeList()

boolean com.meicam.sdk.NvsFx.hasKeyframeList ( String fxParam )

inline

Check whether the parameter has key frame list or not.

Parameters

fxParam The type of custom data parameter for the effect.

Returns: Return exist or not.

Reimplemented in com.meicam.sdk.NvsCompoundCaption.

◆ removeAllKeyframe()

boolean com.meicam.sdk.NvsFx.removeAllKeyframe ( String fxParam )

inline

Remove all key frames from key frame list.

Parameters

fxParam The type of custom data parameter for the effect.

Returns: Return success or not

Reimplemented in com.meicam.sdk.NvsCompoundCaption.

◆ removeKeyframeAtTime()

boolean com.meicam.sdk.NvsFx.removeKeyframeAtTime	(	String	fxParam,
		long	time
	)

inline

Remove key frame at a specified time point from key frame list.

Parameters

fxParam	The type of custom data parameter for the effect.
time	time point (In microseconds).

Returns: Return success or not

Reimplemented in com.meicam.sdk.NvsCompoundCaption.

◆ setArbDataVal()

void com.meicam.sdk.NvsFx.setArbDataVal	(	String	fxParam,
		NvsArbitraryData	val
	)

inline

Set custom data parameter value.

Parameters

fxParam	The type of custom data parameter for the effect.
val	custom arbitrary data.

See also: getArbDataVal

◆ setArbDataValAtTime()

void com.meicam.sdk.NvsFx.setArbDataValAtTime	(	String	fxParam,
		NvsArbitraryData	val,
		long	time
	)

inline

Sets custom data parameter value.

Parameters

fxParam	The type of custom data parameter for the effect.
time	current time (In microseconds).
val	String.

See also: getArbDataValAtTime

◆ setBooleanVal()

void com.meicam.sdk.NvsFx.setBooleanVal	(	String	fxParam,
		boolean	val
	)

inline

Set the boolean parameter of NvsFx.

Parameters

fxParam	The type of the NvsFx's float parameter. Please refer to [PARAM_TYPE_BOOL].
val	boolean value.

See also: getBooleanVal

◆ setBooleanValAtTime()

void com.meicam.sdk.NvsFx.setBooleanValAtTime	(	String	fxParam,
		boolean	val,
		long	time
	)

inline

Set the NvsFx’s boolean parameter at a specified time point.

Parameters

fxParam	The type of the NvsFx's boolean parameter. Please refer to [PARAM_TYPE_BOOL].
val	boolean value.
time	time point (In microseconds).

See also: getBooleanValAtTime

◆ setColorVal()

void com.meicam.sdk.NvsFx.setColorVal	(	String	fxParam,
		NvsColor	val
	)

inline

Set the color parameter of NvsFx.

Parameters

fxParam	The type of the NvsFx's color parameter. Please refer to [PARAM_TYPE_COLOR].
val	NvsColor Customized color object.

See also: getColorVal

◆ setColorValAtTime()

void com.meicam.sdk.NvsFx.setColorValAtTime	(	String	fxParam,
		NvsColor	val,
		long	time
	)

inline

Set the NvsFx's color parameter at a specified time point.

Parameters

fxParam	The type of the NvsFx's color parameter. Please refer to [PARAM_TYPE_COLOR].
val	NvsColor Customized color object.
time	point time (In microseconds).

See also: getColorValAtTime

◆ setExprObjectVar()

void com.meicam.sdk.NvsFx.setExprObjectVar	(	String	varName,
		Object	varValue
	)

inline

Set the value of the defined parameter in the expression.

Parameters

varName	The parameters defined in the expression
varValue	The value of a parameter in the expression

See also: getExprStringVar

Since: 3.5.2

◆ setExprStringVar()

void com.meicam.sdk.NvsFx.setExprStringVar	(	String	varName,
		String	varValue
	)

inline

Set the value of the defined parameter in the expression.

Parameters

varName	The parameters defined in the expression
varValue	The value of a parameter in the expression

See also: getExprStringVar

Since: 2.16.1

◆ setExprVar()

void com.meicam.sdk.NvsFx.setExprVar	(	String	varName,
		double	varValue
	)

inline

Set the value of the defined parameter in the expression.

Parameters

varName	The parameters defined in the expression
varValue	The value of a parameter in the expression

See also: getExprVar

Since: 2.16.1

◆ setFilterIntensity()

void com.meicam.sdk.NvsFx.setFilterIntensity ( float intensity )

inline

Set the intensity of the filter.

Parameters

intensity The degree of intensity of the filter, ranging from 0 to 1, with 0 means no effects and 1 means the default effects.

See also: getFilterIntensity

Since: 2.0.2

◆ setFilterMask()

void com.meicam.sdk.NvsFx.setFilterMask ( boolean useMask )

inline

Set the mask of the filter.

Parameters

useMask Whether use mask to limit the filter's region.

See also: getFilterMask

Since: 2.14.1

◆ setFloatVal()

void com.meicam.sdk.NvsFx.setFloatVal	(	String	fxParam,
		double	val
	)

inline

Set the float parameter of NvsFx.

Parameters

fxParam	The type of the NvsFx's float parameter. Please refer to [PARAM_TYPE_FLOAT].
val	float value.

See also: getFloatVal

◆ setFloatValAtTime()

void com.meicam.sdk.NvsFx.setFloatValAtTime	(	String	fxParam,
		double	val,
		long	time
	)

inline

Set the NvsFx's float parameter at a specified time point.

Parameters

fxParam	The type of the NvsFx's float parameter. Please refer to [PARAM_TYPE_FLOAT].
val	float value.
time	time point (In microseconds).

See also: getFloatValAtTime

◆ setIgnoreBackground()

void com.meicam.sdk.NvsFx.setIgnoreBackground ( boolean isIgnoreBackground )

inline

Set whether the regional filter ignores background.

Parameters

isIgnoreBackground Whether the regional filter ignores background. True means ignored, false means the opposite.

See also: getIgnoreBackground

Since: 2.15.1

◆ setIntVal()

void com.meicam.sdk.NvsFx.setIntVal	(	String	fxParam,
		int	val
	)

inline

Set the integer parameter of NvsFx.

Parameters

fxParam	The type of the NvsFx's integer parameter. Please refer to PARAM_TYPE_INT.
val	integer value.

See also: getIntVal

◆ setIntValAtTime()

void com.meicam.sdk.NvsFx.setIntValAtTime	(	String	fxParam,
		int	val,
		long	time
	)

inline

Set the NvsFx's integer parameter at a specified time point.

Parameters

fxParam	The type of the NvsFx's integer parameter. Please refer to PARAM_TYPE_INT.
val	integer value.
time	time point (In microseconds).

See also: getIntValAtTime

◆ setInverseRegion()

void com.meicam.sdk.NvsFx.setInverseRegion ( boolean isInverseRegion )

inline

Set whether the regional filter inverses region.

Parameters

isInverseRegion Whether the regional filter inverses region. True means inversed, false means the opposite.

See also: getInverseRegion

Since: 2.15.1

◆ setKeyFrameControlPoint()

boolean com.meicam.sdk.NvsFx.setKeyFrameControlPoint	(	String	fxParam,
		long	time,
		NvsControlPointPair	controlPointPair
	)

inline

Set key frame control point pair.

Parameters

fxParam	The type of custom data parameter for the effect.
time	time point (In microseconds).
controlPointPair	control point pair.

See also: getKeyFrameControlPoint

Since: 2.21.0

◆ setKeyFrameControlPointMode()

boolean com.meicam.sdk.NvsFx.setKeyFrameControlPointMode	(	String	fxParam,
		long	time,
		NvsControlPointModePair	controlPointModePair
	)

inline

Set key frame control point mode pair.

Parameters

fxParam	The type of custom data parameter for the effect.
time	time point (In microseconds).
controlPointModePair	control point mode pair.

See also: getKeyFrameControlPointMode

Since: 3.6.0

◆ setMenuVal()

void com.meicam.sdk.NvsFx.setMenuVal	(	String	fxParam,
		String	val
	)

inline

Set the menu parameter of NvsFx.

Parameters

fxParam	The type of the NvsFx's menu parameter. Please refer to [PARAM_TYPE_MENU].
val	A string value.

See also: getMenuVal

◆ setMenuValAtTime()

void com.meicam.sdk.NvsFx.setMenuValAtTime	(	String	fxParam,
		String	val,
		long	time
	)

inline

Set the NvsFx's menu parameter at a specified time point.

Parameters

fxParam	The type of the NvsFx's menu parameter. Please refer to [PARAM_TYPE_MENU].
val	string value.
time	time point (In microseconds).

See also: getMenuValAtTime

◆ setPosition2DVal()

void com.meicam.sdk.NvsFx.setPosition2DVal	(	String	fxParam,
		NvsPosition2D	val
	)

inline

Set the two dimentional coordinates parameter of NvsFx.

Parameters

fxParam	The type of the NvsFx's two dimentional coordinates parameter. Please refer to [PARAM_TYPE_POSITION2D].
val	Two dimentional coordinates object[NvsPosition2D].

See also: getPosition2DVal; setPosition3DVal

◆ setPosition2DValAtTime()

void com.meicam.sdk.NvsFx.setPosition2DValAtTime	(	String	fxParam,
		NvsPosition2D	val,
		long	time
	)

inline

Set the NvsFx's two dimentional coordinates parameter at a specified time point.

Parameters

fxParam	The type of the NvsFx's two dimentional coordinates parameter. Please refer to [PARAM_TYPE_POSITION2D].
time	point time (In microseconds).
val	Two dimentional coordinates object[NvsPosition2D].

See also: getPosition2DValAtTime; setPosition3DValAtTime

◆ setPosition3DVal()

void com.meicam.sdk.NvsFx.setPosition3DVal	(	String	fxParam,
		NvsPosition3D	val
	)

inline

Set the three dimentional coordinates parameter of NvsFx.

Parameters

fxParam	The type of the NvsFx's three dimentional coordinates parameter. Please refer to [PARAM_TYPE_POSITION3D].
val	Three dimentional coordinates object[NvsPosition3D].

See also: getPosition3DVal; setPosition2DVal

◆ setPosition3DValAtTime()

void com.meicam.sdk.NvsFx.setPosition3DValAtTime	(	String	fxParam,
		NvsPosition3D	val,
		long	time
	)

inline

Set the NvsFx's three dimentional coordinates parameter at a specified time point.

Parameters

fxParam	The type of the NvsFx's three dimentional coordinates parameter. Please refer to [PARAM_TYPE_POSITION3D].
val	Three dimentional coordinates object[NvsPosition3D].
time	time point (In microseconds).

See also: getPosition3DValAtTime; setPosition2DValAtTime

◆ setRegion()

void com.meicam.sdk.NvsFx.setRegion ( float[] region )

inline

Set the region of this regional filter.

Parameters

region The effective region of this filter. It is composed with a series of points, which are in NDC coordinate system.

See also: getRegion

Since: 2.10.1

◆ setRegional()

void com.meicam.sdk.NvsFx.setRegional ( boolean isRegional )

inline

Set whether the filter is regional.

Parameters

isRegional Whether the filter is regional. True means regional, false means the opposite.

See also: getRegional

Since: 2.10.1

◆ setRegionalFeatherWidth()

void com.meicam.sdk.NvsFx.setRegionalFeatherWidth ( float featherWidth )

inline

Set the feather width of the regional filter.

Parameters

featherWidth feather width of the regional filter

See also: getRegionalFeatherWidth

Since: 2.10.1

◆ setRegionalFeatherWidthAtTime()

void com.meicam.sdk.NvsFx.setRegionalFeatherWidthAtTime	(	float	featherWidth,
		long	time
	)

inline

Set the regional filter's feather width at a specified time point.

Parameters

featherWidth	feather width of regional filter
time	time point

See also: getRegionalFeatherWidthAtTime

Since: 2.16.1

◆ setRegionCoordinateSystemType()

void com.meicam.sdk.NvsFx.setRegionCoordinateSystemType ( int type )

inline

Set the coordinate system of the region.

Parameters

type	coordinate system type of the region, NDC as the default.

See also: getRegionCoordinateSystemType

Since: 2.16.1

◆ setRegionInfo()

void com.meicam.sdk.NvsFx.setRegionInfo ( NvsMaskRegionInfo info )

inline

Set the mask region informations of the regional filter.

Parameters

info	the mask region informations of the filter. It could be series of points, cubic bezier curve or ellipse, which are in NDC coordinate system.

See also: getRegionInfo

Since: 2.16.0

◆ setRegionInfoAtTime()

void com.meicam.sdk.NvsFx.setRegionInfoAtTime	(	NvsMaskRegionInfo	info,
		long	time
	)

inline

Set the regional filter's mask region informations at a specified time point.

Parameters

info	mask region informations. It could be series of points, cubic bezier curve or ellipse, which are in NDC coordinate system.
time	time point.

See also: getRegionInfoAtTime

Since: 2.16.0

◆ setStringVal()

void com.meicam.sdk.NvsFx.setStringVal	(	String	fxParam,
		String	val
	)

inline

Set the string parameter of NvsFx.

Parameters

fxParam	The type of the NvsFx's string parameter. Please refer to [PARAM_TYPE_STRING].
val	string value.

See also: getStringVal

◆ setStringValAtTime()

void com.meicam.sdk.NvsFx.setStringValAtTime	(	String	fxParam,
		String	val,
		long	time
	)

inline

Set the NvsFx's string parameter at a specified time point.

Parameters

fxParam	The type of the NvsFx's string parameter. Please refer to [PARAM_TYPE_STRING].
val	string value.
time	time point (In microseconds).

See also: getStringValAtTime

Member Data Documentation

◆ FACE_WARP_EFFECT_STRATEGY_CUSTOM

final int com.meicam.sdk.NvsFx.FACE_WARP_EFFECT_STRATEGY_CUSTOM = 0x7FFFFFFF

static

Face warp effect custom strategy

◆ KEY_FRAME_FIND_MODE_INPUT_TIME_AFTER

final int com.meicam.sdk.NvsFx.KEY_FRAME_FIND_MODE_INPUT_TIME_AFTER = 2

static

find key frame after current time

◆ KEY_FRAME_FIND_MODE_INPUT_TIME_BEFORE

final int com.meicam.sdk.NvsFx.KEY_FRAME_FIND_MODE_INPUT_TIME_BEFORE = 1

static

find key frame before current time

◆ REGION_COORDINATE_SYSTEM_TYPE_NDC

final int com.meicam.sdk.NvsFx.REGION_COORDINATE_SYSTEM_TYPE_NDC = 0

static

NDC coordinate system.

◆ REGION_COORDINATE_SYSTEM_TYPE_TIMELINE

final int com.meicam.sdk.NvsFx.REGION_COORDINATE_SYSTEM_TYPE_TIMELINE = 1

static

timeline coordinate system

The documentation for this class was generated from the following file:

src/android/jar/com/meicam/sdk/NvsFx.java

Public Member Functions

Static Public Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ clearExprVar()

◆ clearExprVarCtx()

◆ findKeyframeTime()

◆ getArbDataVal()

◆ getArbDataValAtTime()

◆ getARFaceContext()

◆ getARSceneManipulate()

◆ getBooleanVal()

◆ getBooleanValAtTime()

◆ getColorVal()

◆ getColorValAtTime()

◆ getDescription()

◆ getExprObjectVar()

◆ getExprStringVar()

◆ getExprVar()

◆ getFilterIntensity()

◆ getFilterMask()

◆ getFloatVal()

◆ getFloatValAtTime()

◆ getIgnoreBackground()

◆ getIntVal()

◆ getIntValAtTime()

◆ getInverseRegion()

◆ getKeyFrameControlPoint()

◆ getKeyFrameControlPointMode()

◆ getMenuVal()

◆ getMenuValAtTime()

◆ getPaintingEffectContext()

◆ getParticleSystemContext()

◆ getPosition2DVal()

◆ getPosition2DValAtTime()

◆ getPosition3DVal()

◆ getPosition3DValAtTime()

◆ getRegion()

◆ getRegional()

◆ getRegionalFeatherWidth()

◆ getRegionalFeatherWidthAtTime()

◆ getRegionCoordinateSystemType()

◆ getRegionInfo()

◆ getRegionInfoAtTime()

◆ getStringVal()

◆ getStringValAtTime()

◆ hasKeyframeList()

◆ removeAllKeyframe()

◆ removeKeyframeAtTime()

◆ setArbDataVal()

◆ setArbDataValAtTime()

◆ setBooleanVal()

◆ setBooleanValAtTime()

◆ setColorVal()

◆ setColorValAtTime()

◆ setExprObjectVar()

◆ setExprStringVar()

◆ setExprVar()

◆ setFilterIntensity()

◆ setFilterMask()

◆ setFloatVal()

◆ setFloatValAtTime()

◆ setIgnoreBackground()

◆ setIntVal()

◆ setIntValAtTime()

◆ setInverseRegion()

◆ setKeyFrameControlPoint()

◆ setKeyFrameControlPointMode()

◆ setMenuVal()

◆ setMenuValAtTime()

◆ setPosition2DVal()

◆ setPosition2DValAtTime()

◆ setPosition3DVal()

◆ setPosition3DValAtTime()

◆ setRegion()

◆ setRegional()

◆ setRegionalFeatherWidth()

◆ setRegionalFeatherWidthAtTime()

◆ setRegionCoordinateSystemType()