Video effect. More...

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

Public Member Functions
int	getVideoFxType ()
	Gets video special effect type. More...

String	getBuiltinVideoFxName ()
	Gets built-in video effect's name. More...

String	getVideoFxPackageId ()
	Gets the video effect resource package ID. More...

PointF	mapPointFromCanonicalToParticleSystem (NvsVideoResolution videoRes, PointF ptCononical)
	Converts canonical coordinates to particle system coordinates. More...

void	setVideoResolution (NvsVideoResolution resolution)
	Set the video effect's video resolution. More...

long	changeInPoint (long newInPoint)
	Changes the in-point of the effect on the Clip. More...

long	changeOutPoint (long newOutPoint)
	Changes the out-point of the effect on the Clip. More...

long	getInPoint ()
	Get the in-point of the effect on the Clip. More...

long	getOutPoint ()
	The out-point of the effect on the Clip. More...

void	movePosition (long offset)
	Changes the display position of the effect on the Clip (the in and out points are offset from the offset value at the same time). More...

Public Member Functions inherited from com.meicam.effect.sdk.NvsEffect
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
Video effect type

static final int	VIDEOFX_TYPE_BUILTIN = 0

static final int	VIDEOFX_TYPE_PACKAGE = 1

static final int	VIDEOFX_TYPE_CUSTOM = 2

Static Public Attributes inherited from com.meicam.effect.sdk.NvsEffect
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

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

static final int	REGION_COORDINATE_SYSTEM_TYPE_TIMELINE = 1

static final int	FACE_WARP_EFFECT_STRATEGY_CUSTOM = 0x7FFFFFFF

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

long	getInternalObject ()

void	finalize () throws Throwable

Detailed Description

Video effect.

Video effect is the special effect on the video clips, which can change the overall or partial color, brightness, transparency, etc. of the video frame, so that the video can show a special effect. On video clips, users can add, remove, and get multiple video effects.

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

Member Function Documentation

◆ changeInPoint()

long com.meicam.effect.sdk.NvsVideoEffect.changeInPoint ( long newInPoint )

inline

Changes the in-point of the effect on the Clip.

Parameters

newInPoint The new in-point of the effect on the timeline (in microseconds).

Returns: Returns the in-point of the effect on the Clip (in microseconds).

Warning: This interface will cause the streaming engine state to jump to the engine stop state. For details, please refer to Engine Change.

See also: changeOutPoint; getInPoint; movePosition

Since: 3.10.0

◆ changeOutPoint()

long com.meicam.effect.sdk.NvsVideoEffect.changeOutPoint ( long newOutPoint )

inline

Changes the out-point of the effect on the Clip.

Parameters

newOutPoint The new out-point of the effect on the Clip (in microseconds).

Returns: Returns the out-point of the effect on the Clip (in microseconds).

Warning: This interface will cause the streaming engine state to jump to the engine stop state. For details, please refer to [Engine Change].(Engine of Changing).

See also: changeInPoint; getOutPoint; movePosition

Since: 3.10.0

◆ getBuiltinVideoFxName()

String com.meicam.effect.sdk.NvsVideoEffect.getBuiltinVideoFxName ( )

inline

Gets built-in video effect's name.

Returns: Returns the name of the built-in video effect. If it is not a built-in video effect, a null string value is returned.

Since: 2.3.0

◆ getInPoint()

long com.meicam.effect.sdk.NvsVideoEffect.getInPoint ( )

inline

Get the in-point of the effect on the Clip.

Returns: The in-point of the effect on the Clip (in microseconds).

See also: getOutPoint; changeInPoint

Since: 3.10.0

◆ getOutPoint()

long com.meicam.effect.sdk.NvsVideoEffect.getOutPoint ( )

inline

The out-point of the effect on the Clip.

Returns: The out-point of the effect on the Clip (in microseconds).

See also: getInPoint; changeOutPoint

Since: 3.10.0

◆ getVideoFxPackageId()

String com.meicam.effect.sdk.NvsVideoEffect.getVideoFxPackageId ( )

inline

Gets the video effect resource package ID.

Returns: Returns the video effect resource package ID. If it is not a resource package video effect, a null string value is returned.

Since: 2.3.0

◆ getVideoFxType()

int com.meicam.effect.sdk.NvsVideoEffect.getVideoFxType ( )

inline

Gets video special effect type.

Returns: Returns the video effect type. Please refer to Video Effects Type.

Since: 2.3.0

◆ mapPointFromCanonicalToParticleSystem()

PointF com.meicam.effect.sdk.NvsVideoEffect.mapPointFromCanonicalToParticleSystem	(	NvsVideoResolution	videoRes,
		PointF	ptCononical
	)

inline

Converts canonical coordinates to particle system coordinates.

Parameters

videoRes	Resolution of video
ptCononical	Timeline coordinates

Returns: Returns the transformed PointF object in particle system coordinates.

Since: 2.3.0

◆ movePosition()

void com.meicam.effect.sdk.NvsVideoEffect.movePosition ( long offset )

inline

Changes the display position of the effect on the Clip (the in and out points are offset from the offset value at the same time).

Parameters

offset Offset value for in and out points changes (in microseconds).

Warning: This interface will cause the streaming engine state to jump to the engine stop state. For details, please refer to Engine Change.

See also: changeInPoint; changeOutPoint

Since: 3.10.0

◆ setVideoResolution()

void com.meicam.effect.sdk.NvsVideoEffect.setVideoResolution ( NvsVideoResolution resolution )

inline

Set the video effect's video resolution.

Parameters

resolution The video effect's video resolution

Since: 3.7.0

Member Data Documentation

◆ VIDEOFX_TYPE_BUILTIN

final int com.meicam.effect.sdk.NvsVideoEffect.VIDEOFX_TYPE_BUILTIN = 0

static

◆ VIDEOFX_TYPE_CUSTOM

final int com.meicam.effect.sdk.NvsVideoEffect.VIDEOFX_TYPE_CUSTOM = 2

static

◆ VIDEOFX_TYPE_PACKAGE

final int com.meicam.effect.sdk.NvsVideoEffect.VIDEOFX_TYPE_PACKAGE = 1

static

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

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

Public Member Functions

Static Public Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ changeInPoint()

◆ changeOutPoint()

◆ getBuiltinVideoFxName()

◆ getInPoint()

◆ getOutPoint()

◆ getVideoFxPackageId()

◆ getVideoFxType()

◆ mapPointFromCanonicalToParticleSystem()

◆ movePosition()

◆ setVideoResolution()

Member Data Documentation

◆ VIDEOFX_TYPE_BUILTIN

◆ VIDEOFX_TYPE_CUSTOM

◆ VIDEOFX_TYPE_PACKAGE