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	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	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	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	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	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	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	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	setArbDataVal (String fxParam, NvsArbitraryData val)
	Sets custom data parameter value. More...

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

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

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

NvsParticleSystemContext	getParticleSystemContext ()

NvsPaintingEffectContext	getPaintingEffectContext ()

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

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

inlineprotected

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

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

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

inline

Gets the description of the Effect.

Returns: Returns the description object of the Effect.

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

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

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

inlineprotected

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

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

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

inline

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

inline

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

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

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

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

inline

Releases internal resources.

Since: 2.5.0

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

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

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

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

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

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

inlineprotected

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

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

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

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

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

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

src/android/jar/com/meicam/effect/sdk/NvsEffect.java

Public Member Functions

Protected Member Functions

Detailed Description

Member Function Documentation