Special effect. More...

Inheritance diagram for com.meicam.effect.sdk.NvsEffect:

Public Member Functions
NvsFxDescription	getDescription ()
	Gets the description of the Effect. More...

void	setIntVal (String fxParam, int val)
	Sets the integer parameter value of the effect. More...

int	getIntVal (String fxParam)
	Gets the integer parameter value of the effect. More...

void	setIntValAtTime (String fxParam, int val, long time)
	Sets the integer parameter of NvsFx. More...

int	getIntValAtTime (String fxParam, long time)
	Gets the integer parameter of NvsFx. More...

void	setFloatVal (String fxParam, double val)
	Sets the float parameter value of the effect. More...

double	getFloatVal (String fxParam)
	Gets the float parameter value of the effect. More...

void	setFloatValAtTime (String fxParam, double val, long time)
	Sets the float parameter of NvsFx. More...

double	getFloatValAtTime (String fxParam, long time)
	Gets the float parameter of NvsFx. More...

void	setBooleanVal (String fxParam, boolean val)
	Sets the Boolean parameter value of the effect. More...

boolean	getBooleanVal (String fxParam)
	Gets the Boolean parameter value of the effect. More...

void	setBooleanValAtTime (String fxParam, boolean val, long time)
	Sets the boolean parameter of NvsFx. More...

boolean	getBooleanValAtTime (String fxParam, long time)
	Gets the boolean parameter of NvsFx. More...

void	setStringVal (String fxParam, String val)
	Sets the string parameter value of the effect. More...

String	getStringVal (String fxParam)
	Gets the string parameter value of the effect. More...

void	setStringValAtTime (String fxParam, String val, long time)
	Sets the string parameter of NvsFx. More...

String	getStringValAtTime (String fxParam, long time)
	Gets the string parameter of NvsFx. More...

void	setColorVal (String fxParam, NvsColor val)
	Sets the color parameter value of the effect. More...

NvsColor	getColorVal (String fxParam)
	Gets the color parameter value of the effect. More...

void	setColorValAtTime (String fxParam, NvsColor val, long time)
	Sets the color parameter of NvsFx. More...

NvsColor	getColorValAtTime (String fxParam, long time)
	Gets the color parameter of NvsFx. More...

void	setPosition2DVal (String fxParam, NvsPosition2D val)
	Sets the 2D coordinates parameter value of the effect. More...

NvsPosition2D	getPosition2DVal (String fxParam)
	Gets the 2D coordinates parameter value of the effect. More...

void	setPosition2DValAtTime (String fxParam, NvsPosition2D val, long time)
	Sets the two dimentional coordinates parameter of NvsFx. More...

NvsPosition2D	getPosition2DValAtTime (String fxParam, long time)
	Gets the two dimentional coordinates parameter of NvsFx. More...

void	setPosition3DVal (String fxParam, NvsPosition3D val)
	Sets the 3D coordinates parameter value of the effect. More...

NvsPosition3D	getPosition3DVal (String fxParam)
	Gets the 3D coordinates parameter value of the effect. More...

void	setPosition3DValAtTime (String fxParam, NvsPosition3D val, long time)
	Sets the three dimentional coordinates parameter of NvsFx. More...

NvsPosition3D	getPosition3DValAtTime (String fxParam, long time)
	Gets the three dimentional coordinates parameter of NvsFx. More...

void	setMenuVal (String fxParam, String val)
	Sets the menu parameter value of the effect. More...

String	getMenuVal (String fxParam)
	Gets the menu parameter value of the effect. More...

void	setMenuValAtTime (String fxParam, String val, long time)
	Sets the menu parameter of NvsFx. More...

String	getMenuValAtTime (String fxParam, long time)
	Gets the menu parameter of NvsFx. More...

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

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

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

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

boolean	hasKeyframeList (String fxParam)
	Check has key frame list of param. More...

long	findKeyframeTime (String fxParam, long time, int flags)
	Get key frame in list at current time. 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)
	Sets the intensity of the filter. More...

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

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

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

void	setIgnoreBackground (boolean isIgnoreBackground)
	Sets whether the regional filter ignores Background. More...

boolean	getIgnoreBackground ()
	Gets whether the regional filter ignores Background. More...

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

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

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

void	setRegionInfo (NvsMaskRegionInfo info)
	Sets the region of this regional filter. More...

void	setRegionInfoAtTime (NvsMaskRegionInfo info, long time)
	Sets the region of this regional filter at certain time. More...

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

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

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

int	getRegionCoordinateSystemType ()
	Gets the coordinate system of the region. More...

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

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

void	release ()
	Releases internal resources. More...

NvsParticleSystemContext	getParticleSystemContext ()

NvsPaintingEffectContext	getPaintingEffectContext ()

NvsARFaceContext	getARFaceContext ()
	Get face effect context. More...

NvsARSceneManipulate	getARSceneManipulate ()
	获得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...

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

Protected Member Functions
void	setInternalObject (long internalObject)

long	getInternalObject ()

void	finalize () throws Throwable

Detailed Description

Special effect.

Special effects are the basic types of different types of effects such as Video Fx, Audio Fx, Audio Transition, and Video Transition. Special effects are a key part of the SDK framework. Effects derived from NvsEffect class can be added, removed, and retrieved via clip instance, timeline instance, or track instance. At the same time, different API interfaces are provided in the special effects class to set and get the effect parameter types.

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

Member Function Documentation

◆ finalize()

void com.meicam.effect.sdk.NvsEffect.finalize ( ) throws Throwable

inlineprotected

◆ findKeyframeTime()

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

inline

Get key frame in list at current time.

Parameters

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

Returns: Returns key frame time before current time, If there is no key before this time point, return - 1

Reimplemented in com.meicam.effect.sdk.NvsVideoEffectCompoundCaption.

◆ getARFaceContext()

NvsARFaceContext com.meicam.effect.sdk.NvsEffect.getARFaceContext ( )

inline

Get face effect context.

◆ getARSceneManipulate()

NvsARSceneManipulate com.meicam.effect.sdk.NvsEffect.getARSceneManipulate ( )

inline

获得NvsARSceneManipulate接口

Returns: 返回NvsARSceneManipulate接口

Since: 2.14.0

◆ getBooleanVal()

boolean com.meicam.effect.sdk.NvsEffect.getBooleanVal ( String fxParam )

inline

Gets the Boolean parameter value of the effect.

Parameters

fxParam The type of Boolean parameter of the effect. Please refer to PARAM_TYPE_BOOL.

Returns: Returns the boolean value obtained.

See also: setBooleanVal

◆ getBooleanValAtTime()

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

inline

Gets the boolean parameter of NvsFx.

Parameters

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

Returns: Returns the boolean value.

See also: setBooleanVal

◆ getColorVal()

NvsColor com.meicam.effect.sdk.NvsEffect.getColorVal ( String fxParam )

inline

Gets the color parameter value of the effect.

Parameters

fxParam The type of color parameter of the effect. Please refer to PARAM_TYPE_COLOR.

Returns: Returns the obtained color object.

See also: setColorVal

◆ getColorValAtTime()

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

inline

Gets the color parameter of NvsFx.

Parameters

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

Returns: Returns the customized color object[NvsColor].

See also: setColorVal

◆ getDescription()

NvsFxDescription com.meicam.effect.sdk.NvsEffect.getDescription ( )

inline

Gets the description of the Effect.

Returns: Returns the description object of the Effect.

◆ getExprVar()

double com.meicam.effect.sdk.NvsEffect.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.effect.sdk.NvsEffect.getFilterIntensity ( )

inline

Gets the intensity of the filter.

Returns: Returns the intensity value of the filter.

See also: setFilterIntensity

Since: 2.0.2

◆ getFilterMask()

boolean com.meicam.effect.sdk.NvsEffect.getFilterMask ( )

inline

Gets the usage of the filter's mask.

Returns: Returns the usage of the filter's mask.

See also: setFilterMask

Since: 2.14.1

◆ getFloatVal()

double com.meicam.effect.sdk.NvsEffect.getFloatVal ( String fxParam )

inline

Gets the float parameter value of the effect.

Parameters

fxParam The type of float parameter of the effect. Please refer to PARAM_TYPE_FLOAT.

Returns: Returns the obtained double value.

See also: setFloatVal

◆ getFloatValAtTime()

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

inline

Gets the float parameter of NvsFx.

Parameters

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

Returns: Returns the double value.

See also: setFloatVal

◆ getIgnoreBackground()

boolean com.meicam.effect.sdk.NvsEffect.getIgnoreBackground ( )

inline

Gets whether the regional filter ignores Background.

Returns: Returns whether the regional filter ignores Background.

See also: setIgnoreBackground

Since: 2.15.1

◆ getInternalObject()

long com.meicam.effect.sdk.NvsEffect.getInternalObject ( )

inlineprotected

◆ getIntVal()

int com.meicam.effect.sdk.NvsEffect.getIntVal ( String fxParam )

inline

Gets the integer parameter value of the effect.

Parameters

fxParam The type of the integer parameter of the effect. Please refer toPARAM_TYPE_INT.

Returns: Returns the obtained integer value.

See also: setIntVal

◆ getIntValAtTime()

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

inline

Gets the integer parameter of NvsFx.

Parameters

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

Returns: Returns the integer value.

See also: setIntVal

◆ getInverseRegion()

boolean com.meicam.effect.sdk.NvsEffect.getInverseRegion ( )

inline

Gets whether the regional filter inverses region.

Returns: Returns whether the regional filter inverses region.

See also: setInverseRegion

Since: 2.15.1

◆ getKeyFrameControlPoint()

NvsControlPointPair com.meicam.effect.sdk.NvsEffect.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.effect.sdk.NvsEffect.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.effect.sdk.NvsEffect.getMenuVal ( String fxParam )

inline

Gets the menu parameter value of the effect.

Parameters

fxParam The type of menu parameter of the effect. Please refer to PARAM_TYPE_MENU.

Returns: Returns the obtained menu.

See also: setMenuVal

◆ getMenuValAtTime()

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

inline

Gets the menu parameter of NvsFx.

Parameters

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

Returns: Returns the menu value of NvsFx.

See also: setMenuVal

◆ getPaintingEffectContext()

NvsPaintingEffectContext com.meicam.effect.sdk.NvsEffect.getPaintingEffectContext ( )

inline

◆ getParticleSystemContext()

NvsParticleSystemContext com.meicam.effect.sdk.NvsEffect.getParticleSystemContext ( )

inline

◆ getPosition2DVal()

NvsPosition2D com.meicam.effect.sdk.NvsEffect.getPosition2DVal ( String fxParam )

inline

Gets the 2D coordinates parameter value of the effect.

Parameters

fxParam The type of 2D coordinates parameter of the effect. Please refer to PARAM_TYPE_POSITION2D.

Returns: Returns the obtained 2D coordinates object.

See also: setPosition2DVal; getPosition3DVal

◆ getPosition2DValAtTime()

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

inline

Gets 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].
time	point time (In microseconds).

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

See also: setPosition2DVal; getPosition3DVal

◆ getPosition3DVal()

NvsPosition3D com.meicam.effect.sdk.NvsEffect.getPosition3DVal ( String fxParam )

inline

Gets the 3D coordinates parameter value of the effect.

Parameters

fxParam The type of 3D coordinates parameter of the effect. See PARAM_TYPE_POSITION3D.

Returns: Returns the obtained 3D coordinates object.

See also: setPosition3DVal; getPosition2DVal

◆ getPosition3DValAtTime()

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

inline

Gets 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].
time	point time (In microseconds).

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

See also: setPosition3DVal; getPosition2DVal

◆ getRegional()

boolean com.meicam.effect.sdk.NvsEffect.getRegional ( )

inline

Gets whether the filter is regional.

Returns: Returns whether the filter is regional.

See also: setRegional

Since: 2.10.1

◆ getRegionalFeatherWidth()

float com.meicam.effect.sdk.NvsEffect.getRegionalFeatherWidth ( )

inline

Gets the feather width of this regional filter.

Returns: Returns the feather width of this regional filter.

See also: setRegionalFeatherWidth

Since: 2.10.1

◆ getRegionCoordinateSystemType()

int com.meicam.effect.sdk.NvsEffect.getRegionCoordinateSystemType ( )

inline

Gets the coordinate system of the region.

Returns: Returns the coordinate system of the region.

See also: setRegionCoordinateSystemType

Since: 2.16.1

◆ getStringVal()

String com.meicam.effect.sdk.NvsEffect.getStringVal ( String fxParam )

inline

Gets the string parameter value of the effect.

Parameters

fxParam The type of string parameter of the effect. Please refer to PARAM_TYPE_STRING.

Returns: Returns the obtained string.

See also: setStringVal

◆ getStringValAtTime()

String com.meicam.effect.sdk.NvsEffect.getStringValAtTime	(	String	fxParam,
		long	time
	)

inline

Gets the string parameter of NvsFx.

Parameters

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

Returns: Returns the string value.

See also: setStringVal

◆ hasKeyframeList()

boolean com.meicam.effect.sdk.NvsEffect.hasKeyframeList ( String fxParam )

inline

Check has key frame list of param.

Parameters

fxParam The type of custom data parameter for the effect.

Returns: Returns whether there is a key frame list

Reimplemented in com.meicam.effect.sdk.NvsVideoEffectCompoundCaption.

◆ release()

void com.meicam.effect.sdk.NvsEffect.release ( )

inline

Releases internal resources.

Since: 2.5.0

◆ removeAllKeyframe()

boolean com.meicam.effect.sdk.NvsEffect.removeAllKeyframe ( String fxParam )

inline

Remove all key frame from key frame list.

Parameters

fxParam The type of custom data parameter for the effect.

Returns: Returns succeeded

Reimplemented in com.meicam.effect.sdk.NvsVideoEffectCompoundCaption.

◆ removeKeyframeAtTime()

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

inline

Remove key frame at time from key frame list.

Parameters

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

Returns: Returns succeeded

See also: getMenuVal

Reimplemented in com.meicam.effect.sdk.NvsVideoEffectCompoundCaption.

◆ setArbDataVal()

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

inline

Sets custom data parameter value.

Parameters

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

See also: getMenuVal

◆ setArbDataValAtTime()

void com.meicam.effect.sdk.NvsEffect.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	point time (In microseconds).
val	String.

See also: getMenuVal

◆ setBooleanVal()

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

inline

Sets the Boolean parameter value of the effect.

Parameters

fxParam	The type of Boolean parameter of the effect. Please refer to PARAM_TYPE_BOOL.
val	Bool value.

See also: getBooleanVal

◆ setBooleanValAtTime()

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

inline

Sets the boolean parameter of NvsFx.

Parameters

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

See also: getBooleanVal

◆ setColorVal()

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

inline

Sets the color parameter value of the effect.

Parameters

fxParam	The type of color parameter of the effect. Please refer to PARAM_TYPE_COLOR.
val	Color value.

See also: getColorVal

◆ setColorValAtTime()

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

inline

Sets 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.
time	point time (In microseconds).

See also: getColorVal

◆ setExprVar()

void com.meicam.effect.sdk.NvsEffect.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.effect.sdk.NvsEffect.setFilterIntensity ( float intensity )

inline

Sets the intensity of the filter.

Parameters

intensity The filter intensity value, the value range is generally [0,1]. 0 means no effect, while 1 indicates the default effect.

See also: getFilterIntensity

Since: 2.0.2

◆ setFilterMask()

void com.meicam.effect.sdk.NvsEffect.setFilterMask ( boolean useMask )

inline

Sets the mask of the filter.

Parameters

useMask Wether use mask to limit the filter's region

See also: getFilterMask

Since: 2.14.1

◆ setFloatVal()

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

inline

Sets the float parameter value of the effect.

Parameters

fxParam	The type of float parameter of the effect. Please refer to PARAM_TYPE_FLOAT.
val	Floating point value.

See also: getFloatVal

◆ setFloatValAtTime()

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

inline

Sets the float parameter of NvsFx.

Parameters

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

See also: getFloatVal

◆ setIgnoreBackground()

void com.meicam.effect.sdk.NvsEffect.setIgnoreBackground ( boolean isIgnoreBackground )

inline

Sets whether the regional filter ignores Background.

Parameters

IgnoreBackground whether the regional filter ignores Background. true means ignored, while false means the opposite.

See also: getIgnoreBackground

Since: 2.15.1

◆ setInternalObject()

void com.meicam.effect.sdk.NvsEffect.setInternalObject ( long internalObject )

inlineprotected

◆ setIntVal()

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

inline

Sets the integer parameter value of the effect.

Parameters

fxParam	The type of the integer parameter of the effect. Please refer to PARAM_TYPE_INT.
val	Integer

See also: getIntVal

◆ setIntValAtTime()

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

inline

Sets the integer parameter of NvsFx.

Parameters

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

See also: getIntVal

◆ setInverseRegion()

void com.meicam.effect.sdk.NvsEffect.setInverseRegion ( boolean isInverseRegion )

inline

Sets whether the regional filter inverses region.

Parameters

InverseRegion whether the regional filter inverses region. true means inversed, while false means the opposite.

See also: getInverseRegion

Since: 2.15.1

◆ setKeyFrameControlPoint()

boolean com.meicam.effect.sdk.NvsEffect.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.effect.sdk.NvsEffect.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.effect.sdk.NvsEffect.setMenuVal	(	String	fxParam,
		String	val
	)

inline

Sets the menu parameter value of the effect.

Parameters

fxParam	The type of menu parameter of the effect. Please refer to PARAM_TYPE_MENU.
val	String.

See also: getMenuVal

◆ setMenuValAtTime()

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

inline

Sets 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.
time	point time (In microseconds).

See also: getMenuVal

◆ setPosition2DVal()

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

inline

Sets the 2D coordinates parameter value of the effect.

Parameters

fxParam	The type of 2D coordinates parameter of the effect. Please refer to PARAM_TYPE_POSITION2D.
val	2D coordinates object.

See also: getPosition2DVal; setPosition3DVal

◆ setPosition2DValAtTime()

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

inline

Sets 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].
time	point time (In microseconds).
val	Two dimentional coordinates object[NvsPosition2D].

See also: getPosition2DVal; setPosition3DVal

◆ setPosition3DVal()

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

inline

Sets the 3D coordinates parameter value of the effect.

Parameters

fxParam	The type of 3D coordinates parameter of the effect. Please refer to PARAM_TYPE_POSITION3D.
val	3D coordinates value

See also: getPosition3DVal; setPosition2DVal

◆ setPosition3DValAtTime()

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

inline

Sets 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].
time	point time (In microseconds).

See also: getPosition3DVal; setPosition2DVal

◆ setRegion()

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

inline

Sets 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.

Since: 2.10.1

◆ setRegional()

void com.meicam.effect.sdk.NvsEffect.setRegional ( boolean isRegional )

inline

Sets whether the filter is regional.

Parameters

regional whether the filter is regional. true means regional, while false means the opposite.

See also: getRegional

Since: 2.10.1

◆ setRegionalFeatherWidth()

void com.meicam.effect.sdk.NvsEffect.setRegionalFeatherWidth ( float featherWidth )

inline

Sets the feather width of this regional filter.

Parameters

featherWidth feather width of regional filter

Since: 2.10.1

◆ setRegionCoordinateSystemType()

void com.meicam.effect.sdk.NvsEffect.setRegionCoordinateSystemType ( int type )

inline

Sets the coordinate system of the region.

Parameters

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

Since: 2.16.1

◆ setRegionInfo()

void com.meicam.effect.sdk.NvsEffect.setRegionInfo ( NvsMaskRegionInfo info )

inline

Sets the region of this regional filter.

Parameters

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

Since: 2.16.0

◆ setRegionInfoAtTime()

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

inline

Sets the region of this regional filter at certain time.

Parameters

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

Since: 2.16.0

◆ setStringVal()

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

inline

Sets the string parameter value of the effect.

Parameters

fxParam	The type of string parameter of the effect. Please refer to PARAM_TYPE_STRING.
val	String

See also: getStringVal

◆ setStringValAtTime()

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

inline

Sets the string parameter of NvsFx.

Parameters

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

See also: getStringVal

Member Data Documentation

◆ FACE_WARP_EFFECT_STRATEGY_CUSTOM

final int com.meicam.effect.sdk.NvsEffect.FACE_WARP_EFFECT_STRATEGY_CUSTOM = 0x7FFFFFFF

static

Face warp effect custom strategy

◆ KEY_FRAME_FIND_MODE_INPUT_TIME_AFTER

final int com.meicam.effect.sdk.NvsEffect.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.effect.sdk.NvsEffect.KEY_FRAME_FIND_MODE_INPUT_TIME_BEFORE = 1

static

find key frame before current time

◆ REGION_COORDINATE_SYSTEM_TYPE_NDC

final int com.meicam.effect.sdk.NvsEffect.REGION_COORDINATE_SYSTEM_TYPE_NDC = 0

static

NDC coordinate system.

◆ REGION_COORDINATE_SYSTEM_TYPE_TIMELINE

final int com.meicam.effect.sdk.NvsEffect.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/effect/sdk/NvsEffect.java

Public Member Functions

Static Public Attributes

Protected Member Functions

Detailed Description

Member Function Documentation

◆ finalize()

◆ findKeyframeTime()

◆ getARFaceContext()

◆ getARSceneManipulate()

◆ getBooleanVal()

◆ getBooleanValAtTime()

◆ getColorVal()

◆ getColorValAtTime()

◆ getDescription()

◆ getExprVar()

◆ getFilterIntensity()

◆ getFilterMask()

◆ getFloatVal()

◆ getFloatValAtTime()

◆ getIgnoreBackground()

◆ getInternalObject()

◆ getIntVal()

◆ getIntValAtTime()

◆ getInverseRegion()

◆ getKeyFrameControlPoint()

◆ getKeyFrameControlPointMode()

◆ getMenuVal()

◆ getMenuValAtTime()

◆ getPaintingEffectContext()

◆ getParticleSystemContext()

◆ getPosition2DVal()

◆ getPosition2DValAtTime()

◆ getPosition3DVal()

◆ getPosition3DValAtTime()

◆ getRegional()

◆ getRegionalFeatherWidth()

◆ getRegionCoordinateSystemType()

◆ getStringVal()

◆ getStringValAtTime()

◆ hasKeyframeList()

◆ release()

◆ removeAllKeyframe()

◆ removeKeyframeAtTime()

◆ setArbDataVal()

◆ setArbDataValAtTime()

◆ setBooleanVal()

◆ setBooleanValAtTime()

◆ setColorVal()

◆ setColorValAtTime()

◆ setExprVar()

◆ setFilterIntensity()

◆ setFilterMask()

◆ setFloatVal()

◆ setFloatValAtTime()

◆ setIgnoreBackground()

◆ setInternalObject()

◆ setIntVal()

◆ setIntValAtTime()

◆ setInverseRegion()

◆ setKeyFrameControlPoint()

◆ setKeyFrameControlPointMode()

◆ setMenuVal()

◆ setMenuValAtTime()

◆ setPosition2DVal()

◆ setPosition2DValAtTime()

◆ setPosition3DVal()

◆ setPosition3DValAtTime()

◆ setRegion()

◆ setRegional()

◆ setRegionalFeatherWidth()

◆ setRegionCoordinateSystemType()

◆ setRegionInfo()

◆ setRegionInfoAtTime()

◆ setStringVal()

◆ setStringValAtTime()

Member Data Documentation

◆ FACE_WARP_EFFECT_STRATEGY_CUSTOM

◆ KEY_FRAME_FIND_MODE_INPUT_TIME_AFTER

◆ KEY_FRAME_FIND_MODE_INPUT_TIME_BEFORE

◆ REGION_COORDINATE_SYSTEM_TYPE_NDC