Special effects. More...

#import <NvsEffect.h>

Inheritance diagram for NvsEffect:

Instance Methods
(void)	- setIntVal:val:
	Sets effect parameter of integer type. More...

(int)	- getIntVal:
	Get effect parameter of integer type. More...

(void)	- setFloatVal:val:
	Sets effect parameter of float type. More...

(double)	- getFloatVal:
	Gets effect parameter of float type. More...

(void)	- setBooleanVal:val:
	Sets effect parameter of BOOL type. More...

(BOOL)	- getBooleanVal:
	Gets effect parameter of BOOL type. More...

(void)	- setStringVal:val:
	Sets effect parameter of string type. More...

(NSString *)	- getStringVal:
	Gets effect parameter of string value. More...

(void)	- setColorVal:val:
	Sets effect parameter of color type. More...

(NvsEffectColor)	- getColorVal:
	Gets effect parameter of color value. More...

(void)	- setPosition2DVal:val:
	Sets effect parameter of 2D coordinates type. More...

(NvsEffectPosition2D)	- getPosition2DVal:
	Gets effect parameter of 2D coordinates value. More...

(void)	- setPosition3DVal:val:
	Sets effect parameter of 3D coordinates type. More...

(NvsEffectPosition3D)	- getPosition3DVal:
	Gets effect parameter of 3D coordinates value. More...

(void)	- setMenuVal:val:
	Sets effect parameter of menu type. More...

(NSString *)	- getMenuVal:
	Gets effect parameter of menu value. More...

(void)	- setArbDataVal:val:
	Sets the effect parameter of custom type. More...

(NvsArbitraryData *)	- getArbDataVal:
	Gets the effect parameter of custom type. More...

(void)	- setArbDataValAtTime:val:time:
	Sets custom data parameter value. More...

(NvsArbitraryData *)	- getArbDataValAtTime:time:
	Get custom data parameter value at a specified time point. More...

(bool)	- removeKeyframeAtTime:time:
	Remove key frame at a specified time point from key frame list. More...

(bool)	- removeAllKeyframe:
	Remove all key frames from key frame list. More...

(bool)	- hasKeyframeList:
	Check whether the parameter has key frame list or not. More...

(int64_t)	- findKeyframeTime:time:flags:
	Get key frame at a specified time point. More...

(bool)	- setKeyFrameControlPoint:time:controlPointPair:
	Set key frame control point pair. More...

(NvsControlPointPair *)	- getKeyFrameControlPoint:time:
	Get key frame control point pair. More...

(bool)	- setKeyFrameControlPointMode:time:controlPointModePair:
	Set key frame control point mode pair. More...

(NvsControlPointModePair *)	- getKeyFrameControlPointMode:time:
	Get key frame control point mode pair. More...

(void)	- setFilterIntensity:
	Set the filter intensity. More...

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

(void)	- setFilterMask:
	Sets the mask of the filter. More...

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

(void)	- setRegional:
	Sets whether the filter is regional. More...

(BOOL)	- getRegional
	Gets whether the filter is regional. More...

(void)	- setIgnoreBackground:
	Sets whether the regional filter ignore Background. More...

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

(void)	- setInverseRegion:
	Sets whether the regional filter inverse region. More...

(BOOL)	- getInverseRegion
	Gets whether the regional filter inverse region. More...

(void)	- setRegion:
	Sets the region of this regional filter. More...

(NSArray *)	- getRegion
	Get the region of this regional filter. More...

(NvsMaskRegionInfo *)	- getRegionInfo
	Get the region of this regional filter. More...

(void)	- setRegionInfo:
	Sets the region of this regional filter. More...

(void)	- setRegionInfoAtTime:time:
	Sets the region of this regional filter at certain time. More...

(void)	- setRegionalFeatherWidth:
	Sets the feather width of this regional filter. More...

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

(void)	- setRegionCoordinateSystemType:
	Sets the coordinate system of the region. More...

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

(NvsParticleSystemContext *)	- getParticleSystemContext
	Gets the particle effect context. More...

(NvsPaintingEffectContext *)	- getPaintingEffectContext
	Gets the particle effect context. More...

(NvsARSceneManipulate *)	- getARSceneManipulate
	Get the AR scene operation pointer. More...

(void)	- setExprVar:varValue:
	Sets the value of the defined parameter in the expression. More...

(double)	- getExprVar:
	Gets the value of the defined parameter in the expression. More...

(void)	- clearExprVar:
	Clears the value of the defined parameter in the expression and sets it to the default value of 0. More...

(void)	- clearExprVarCtx
	Clears the value of all parameters defined in the expression and sets it to the default value of 0. More...

Properties
NvsEffectDescription *	description

Detailed Description

Special effects.

Special effects are the basic types of different types of effects such as Video effect. Special effects are a key part of the SDK framework. It can be added by the createVideoEffect:aspectRatio: method of the NvsEffectSdkContext class.

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

Method Documentation

◆ clearExprVar:

- (void) clearExprVar: (NSString *) varName

Clears the value of the defined parameter in the expression and sets it to the default value of 0.

Parameters

varName The parameters defined in the expression

Since: 2.16.1

◆ clearExprVarCtx

- (void) clearExprVarCtx

Clears the value of all parameters defined in the expression and sets it to the default value of 0.

Parameters

varName The parameters defined in the expression

Since: 2.16.1

◆ findKeyframeTime:time:flags:

- (int64_t) findKeyframeTime:	(NSString *)	fxParam
time:	(int64_t)	time
flags:	(int)	flags

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

Implemented in NvsVideoEffectCompoundCaption.

◆ getArbDataVal:

- (NvsArbitraryData *) getArbDataVal: (NSString *) fxParam

Gets the effect parameter of custom type.

Parameters

fxParam The type of custom data parameter for the effect

Returns: Returns the custom data of NvsFx.

◆ getArbDataValAtTime:time:

- (NvsArbitraryData *) getArbDataValAtTime:	(NSString *)	fxParam
time:	(int64_t)	time

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:val:time:

◆ getARSceneManipulate

- (NvsARSceneManipulate *) getARSceneManipulate

Get the AR scene operation pointer.

Returns: Return the AR scene operation pointer.

◆ getBooleanVal:

- (BOOL) getBooleanVal: (NSString *) fxParam

Gets effect parameter of BOOL type.

Parameters

fxParam Effect parameter BOOL type,please refer toNVS_PARAM_TYPE_BOOL

Returns: Returns BOOL value,YES means it successfully get the boolean value; NO means it fails.

See also: - setBooleanVal:val:

◆ getColorVal:

- (NvsEffectColor) getColorVal: (NSString *) fxParam

Gets effect parameter of color value.

Parameters

fxParam Effect parameter color type,please refer toNVS_PARAM_TYPE_COLOR

Returns: Returns Color value.

See also: - setColorVal:val:

◆ getExprVar:

- (double) getExprVar: (NSString *) varName

Gets 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

Since: 2.16.1

◆ getFilterIntensity

- (float) getFilterIntensity

Gets the filter intensity.

Returns: Returns the filter intensity.

See also: - setFilterIntensity:

Since: 2.0.2

◆ getFilterMask

- (bool) getFilterMask

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) getFloatVal: (NSString *) fxParam

Gets effect parameter of float type.

Parameters

fxParam Effect parameter float type,please refer toNVS_PARAM_TYPE_FLOAT

Returns: Returns double value

See also: - setFloatVal:val:

◆ getIgnoreBackground

- (BOOL) getIgnoreBackground

Gets whether the regional filter ignores Background.

Returns: Returns whether the regional filter ignores Background.

See also: setIgnoreBackground

Since: 2.15.1

◆ getIntVal:

- (int) getIntVal: (NSString *) fxParam

Get effect parameter of integer type.

Parameters

fxParam Effect parameter integer type,please refer toNVS_PARAM_TYPE_INT.

Returns: Returns integer value

See also: - setIntVal:val:

◆ getInverseRegion

- (BOOL) getInverseRegion

Gets whether the regional filter inverse region.

Returns: Returns whether the regional filter inverses region.

See also: setInverseRegion

Since: 2.15.1

◆ getKeyFrameControlPoint:time:

- (NvsControlPointPair*) getKeyFrameControlPoint:	(NSString *)	fxParam
time:	(int64_t)	time

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:time:controlPointPair:

Since: 2.21.0

◆ getKeyFrameControlPointMode:time:

- (NvsControlPointModePair*) getKeyFrameControlPointMode:	(NSString *)	fxParam
time:	(int64_t)	time

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:time:controlPointModePair:

Since: 3.6.0

◆ getMenuVal:

- (NSString *) getMenuVal: (NSString *) fxParam

Gets effect parameter of menu value.

Parameters

fxParam Effect parameter menu type,please refer toNVS_PARAM_TYPE_MENU

Returns: Returns menu value.

See also: - setMenuVal:val:

◆ getPaintingEffectContext

- (NvsPaintingEffectContext *) getPaintingEffectContext

Gets the particle effect context.

Returns: Returns a pointer to a hand-drawn effect context.

◆ getParticleSystemContext

- (NvsParticleSystemContext *) getParticleSystemContext

Gets the particle effect context.

Returns: Returns a pointer to a particle effect context.

◆ getPosition2DVal:

- (NvsEffectPosition2D) getPosition2DVal: (NSString *) fxParam

Gets effect parameter of 2D coordinates value.

Parameters

fxParam Effect parameter 2D coordinates type,please refer toNVS_PARAM_TYPE_POSITION2D

Returns: Returns 2D coordinates value.

See also: - setPosition2DVal:val:

◆ getPosition3DVal:

- (NvsEffectPosition3D) getPosition3DVal: (NSString *) fxParam

Gets effect parameter of 3D coordinates value.

Parameters

fxParam Effect parameter 3D coordinates type,please refer toNVS_PARAM_TYPE_POSITION3D

Returns: Returns 3D coordinates value.

See also: - setPosition2DVal:val:

◆ getRegion

- (NSArray *) getRegion

Get the region of this regional filter.

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

See also: - setRegion:

Since: 2.14.0

◆ getRegional

- (BOOL) getRegional

Gets whether the filter is regional.

Returns: Returns whether the filter is regional.

See also: setRegional

Since: 2.10.1

◆ getRegionalFeatherWidth

- (float) getRegionalFeatherWidth

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) getRegionCoordinateSystemType

Gets the coordinate system of the region.

Returns: Returns the coordinate system of the region.

See also: setRegionCoordinateSystemType

Since: 2.16.1

◆ getRegionInfo

- (NvsMaskRegionInfo *) getRegionInfo

Get the region of this regional filter.

Returns: 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.1

◆ getStringVal:

- (NSString *) getStringVal: (NSString *) fxParam

Gets effect parameter of string value.

Parameters

fxParam Effect parameter string type,please refer toNVS_PARAM_TYPE_STRING

Returns: Returns string value.

See also: - setStringVal:val:

◆ hasKeyframeList:

- (bool) hasKeyframeList: (NSString *) fxParam

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.

Implemented in NvsVideoEffectCompoundCaption.

◆ removeAllKeyframe:

- (bool) removeAllKeyframe: (NSString *) fxParam

Remove all key frames from key frame list.

Parameters

fxParam The type of custom data parameter for the effect.

Returns: Return success or not

Implemented in NvsVideoEffectCompoundCaption.

◆ removeKeyframeAtTime:time:

- (bool) removeKeyframeAtTime:	(NSString *)	fxParam
time:	(int64_t)	time

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

Implemented in NvsVideoEffectCompoundCaption.

◆ setArbDataVal:val:

- (void) setArbDataVal:	(NSString *)	fxParam
val:	(NvsArbitraryData *)	val

Sets the effect parameter of custom type.

Parameters

fxParam	The type of custom data parameter for the effect
val	NvsArbitraryData data value

◆ setArbDataValAtTime:val:time:

- (void) setArbDataValAtTime:	(NSString *)	fxParam
val:	(NvsArbitraryData *)	val
time:	(int64_t)	time

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:time:

◆ setBooleanVal:val:

- (void) setBooleanVal:	(NSString *)	fxParam
val:	(BOOL)	val

Sets effect parameter of BOOL type.

Parameters

fxParam	Effect parameter BOOL type,please refer toNVS_PARAM_TYPE_BOOL
val	BOOL value

See also: - getBooleanVal:

◆ setColorVal:val:

- (void) setColorVal:	(NSString *)	fxParam
val:	(NvsEffectColor *)	val

Sets effect parameter of color type.

Parameters

fxParam	Effect parameter color type,please refer toNVS_PARAM_TYPE_COLOR
val	Color value

See also: - getColorVal:

◆ setExprVar:varValue:

- (void) setExprVar:	(NSString *)	varName
varValue:	(double)	varValue

Sets the value of the defined parameter in the expression.

Parameters

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

Since: 2.16.1

◆ setFilterIntensity:

- (void) setFilterIntensity: (float) intensity

Set the filter intensity.

Parameters

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

See also: - getFilterIntensity

Since: 2.0.2

◆ setFilterMask:

- (void) setFilterMask: (bool) useMask

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:val:

- (void) setFloatVal:	(NSString *)	fxParam
val:	(double)	val

Sets effect parameter of float type.

Parameters

fxParam	Effect parameter float type,please refer toNVS_PARAM_TYPE_FLOAT
val	Float value

See also: - getFloatVal:

◆ setIgnoreBackground:

- (void) setIgnoreBackground: (BOOL) isIgnoreBackground

Sets whether the regional filter ignore Background.

Parameters

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

See also: - getIgnoreBackground

Since: 2.15.1

◆ setIntVal:val:

- (void) setIntVal:	(NSString *)	fxParam
val:	(int)	val

Sets effect parameter of integer type.

Parameters

fxParam	Effect parameter integer type,please refer toNVS_PARAM_TYPE_INT.
val	Integer value

See also: - getIntVal:

◆ setInverseRegion:

- (void) setInverseRegion: (BOOL) isInverseRegion

Sets whether the regional filter inverse region.

Parameters

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

See also: - getInverseRegion

Since: 2.15.1

◆ setKeyFrameControlPoint:time:controlPointPair:

- (bool) setKeyFrameControlPoint:	(NSString *)	fxParam
time:	(int64_t)	time
controlPointPair:	(NvsControlPointPair *)	controlPointPair

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:time:

Since: 2.21.0

◆ setKeyFrameControlPointMode:time:controlPointModePair:

- (bool) setKeyFrameControlPointMode:	(NSString *)	fxParam
time:	(int64_t)	time
controlPointModePair:	(NvsControlPointModePair *)	controlPointModePair

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:time:

Since: 3.6.0

◆ setMenuVal:val:

- (void) setMenuVal:	(NSString *)	fxParam
val:	(NSString *)	val

Sets effect parameter of menu type.

Parameters

fxParam	Effect parameter menu type,please refer toNVS_PARAM_TYPE_MENU
val	Menu value

See also: - getMenuVal:

◆ setPosition2DVal:val:

- (void) setPosition2DVal:	(NSString *)	fxParam
val:	(NvsEffectPosition2D *)	val

Sets effect parameter of 2D coordinates type.

Parameters

fxParam	Effect parameter 2D coordinates type,please refer toNVS_PARAM_TYPE_POSITION2D
val	2D coordinates value

See also: - getPosition2DVal:

◆ setPosition3DVal:val:

- (void) setPosition3DVal:	(NSString *)	fxParam
val:	(NvsEffectPosition3D *)	val

Sets effect parameter of 3D coordinates type.

Parameters

fxParam	Effect parameter 3D coordinates type,please refer toNVS_PARAM_TYPE_POSITION3D
val	3D coordinates value

See also: - getPosition3DVal:

◆ setRegion:

- (void) setRegion: (NSArray *) region

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) setRegional: (BOOL) isRegional

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) setRegionalFeatherWidth: (float) featherWidth

Sets the feather width of this regional filter.

Parameters

featherWidth feather width of regional filter

See also: - getRegionalFeatherWidth

Since: 2.10.1

◆ setRegionCoordinateSystemType:

- (void) setRegionCoordinateSystemType: (int) type

Sets 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) setRegionInfo: (NvsMaskRegionInfo *) info

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:time:

- (void) setRegionInfoAtTime:	(NvsMaskRegionInfo *)	info
time:	(int64_t)	time

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:val:

- (void) setStringVal:	(NSString *)	fxParam
val:	(NSString *)	val

Sets effect parameter of string type.

Parameters

fxParam	Effect parameter string type,please refer toNVS_PARAM_TYPE_STRING
val	String value

See also: - getStringVal:

Property Documentation

◆ description

- (NvsEffectDescription*) description

readatomicassign

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

include/sdkcore/ios/NvsEffect.h

Instance Methods

Properties

Detailed Description

Method Documentation

◆ clearExprVar:

◆ clearExprVarCtx

◆ findKeyframeTime:time:flags:

◆ getArbDataVal:

◆ getArbDataValAtTime:time:

◆ getARSceneManipulate

◆ getBooleanVal:

◆ getColorVal:

◆ getExprVar:

◆ getFilterIntensity

◆ getFilterMask

◆ getFloatVal:

◆ getIgnoreBackground

◆ getIntVal:

◆ getInverseRegion

◆ getKeyFrameControlPoint:time:

◆ getKeyFrameControlPointMode:time:

◆ getMenuVal:

◆ getPaintingEffectContext

◆ getParticleSystemContext

◆ getPosition2DVal:

◆ getPosition3DVal:

◆ getRegion

◆ getRegional

◆ getRegionalFeatherWidth

◆ getRegionCoordinateSystemType

◆ getRegionInfo

◆ getStringVal:

◆ hasKeyframeList:

◆ removeAllKeyframe:

◆ removeKeyframeAtTime:time:

◆ setArbDataVal:val:

◆ setArbDataValAtTime:val:time:

◆ setBooleanVal:val:

◆ setColorVal:val:

◆ setExprVar:varValue:

◆ setFilterIntensity:

◆ setFilterMask:

◆ setFloatVal:val:

◆ setIgnoreBackground:

◆ setIntVal:val:

◆ setInverseRegion:

◆ setKeyFrameControlPoint:time:controlPointPair:

◆ setKeyFrameControlPointMode:time:controlPointModePair:

◆ setMenuVal:val:

◆ setPosition2DVal:val:

◆ setPosition3DVal:val:

◆ setRegion:

◆ setRegional:

◆ setRegionalFeatherWidth:

◆ setRegionCoordinateSystemType:

◆ setRegionInfo:

◆ setRegionInfoAtTime:time:

◆ setStringVal:val:

Property Documentation

◆ description