effect class. More...

#import <NvsFx.h>

Inheritance diagram for NvsFx:

Instance Methods
(void)	- setIntVal:val:
	Set the integer parameter of NvsFx. More...

(int)	- getIntVal:
	Get the integer parameter of NvsFx. More...

(void)	- setIntValAtTime:val:time:
	Set the NvsFx's integer parameter at a specified time point. More...

(int)	- getIntValAtTime:time:
	Get the NvsFx's integer parameter at a specified time point. More...

(void)	- setFloatVal:val:
	Set the float parameter of NvsFx. More...

(double)	- getFloatVal:
	Get the float parameter of NvsFx. More...

(void)	- setFloatValAtTime:val:time:
	Set the NvsFx's float parameter at a specified time point. More...

(double)	- getFloatValAtTime:time:
	Get the NvsFx's float parameter at a specified time point. More...

(void)	- setBooleanVal:val:
	Set the BOOL parameter of NvsFx. More...

(BOOL)	- getBooleanVal:
	Get the BOOL parameter of NvsFx. More...

(void)	- setBooleanValAtTime:val:time:
	Set the NvsFx’s BOOL parameter at a specified time point. More...

(BOOL)	- getBooleanValAtTime:time:
	Get the NvsFx's BOOL parameter at a specified time point. More...

(void)	- setStringVal:val:
	Set the string parameter of NvsFx. More...

(NSString *)	- getStringVal:
	Get the string parameter of NvsFx. More...

(void)	- setStringValAtTime:val:time:
	Set the NvsFx's string parameter at a specified time point. More...

(NSString *)	- getStringValAtTime:time:
	Get the NvsFx's string parameter at a specified time point. More...

(void)	- setColorVal:val:
	Set the color parameter of NvsFx. More...

(NvsColor)	- getColorVal:
	Get the color parameter of NvsFx. More...

(void)	- setColorValAtTime:val:time:
	Set the NvsFx's color parameter at a specified time point. More...

(NvsColor)	- getColorValAtTime:time:
	Get the NvsFx's color parameter at a specified time point. More...

(void)	- setPosition2DVal:val:
	Set the two dimentional coordinates parameter of NvsFx. More...

(NvsPosition2D)	- getPosition2DVal:
	Get the two dimentional coordinates parameter of NvsFx. More...

(void)	- setPosition2DValAtTime:val:time:
	Set the NvsFx's two dimentional coordinates parameter at a specified time point. More...

(NvsPosition2D)	- getPosition2DValAtTime:time:
	Get the NvsFx's two dimentional coordinates parameter at a specified time point. More...

(void)	- setPosition3DVal:val:
	Set the three dimentional coordinates parameter of NvsFx. More...

(NvsPosition3D)	- getPosition3DVal:
	Get the three dimentional coordinates parameter of NvsFx. More...

(void)	- setPosition3DValAtTime:val:time:
	Set the NvsFx's three dimentional coordinates parameter at a specified time point. More...

(NvsPosition3D)	- getPosition3DValAtTime:time:
	Get the NvsFx's three dimentional coordinates parameter at a specified time point. More...

(void)	- setMenuVal:val:
	Set the menu parameter of NvsFx. More...

(NSString *)	- getMenuVal:
	Get the menu parameter of NvsFx. More...

(void)	- setMenuValAtTime:val:time:
	Set the NvsFx's menu parameter at a specified time point. More...

(NSString *)	- getMenuValAtTime:time:
	Get the NvsFx menu parameter at a specified time point. More...

(void)	- setArbDataVal:val:
	Set custom data parameter value. More...

(NvsArbitraryData *)	- getArbDataVal:
	Get custom data parameter value. 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 intensity of the filter. More...

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

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

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

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

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

(void)	- setIgnoreBackground:
	Set whether the regional filter ignores background. More...

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

(void)	- setInverseRegion:
	Set whether the regional filter inverses region. More...

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

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

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

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

(void)	- setRegionInfo:
	Set the mask region informations of the regional filter. More...

(void)	- setRegionInfoAtTime:time:
	Set the regional filter's mask region informations at a specified time point. More...

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

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

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

(void)	- setRegionalFeatherWidthAtTime:time:
	Set the regional filter's feather width at a specified time point. More...

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

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

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

(NvsParticleSystemContext *)	- getParticleSystemContext
	Get the particle effect context pointer.Please refer to NvsParticleSystemContext. More...

(NvsARFaceContext *)	- getARFaceContext
	Get face effect context pointer.Please refer to NvsARFaceContext. More...

(NvsPaintingEffectContext *)	- getPaintingEffectContext
	Get the particle effect context pointer.Please refer to NvsPaintingEffectContext. More...

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

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

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

(void)	- setColorExprVar:varValue:
	Set the color value of the defined parameter in the expression. More...

(NvsColor)	- getColorExprVar:
	Get the color value of the defined parameter in the expression. More...

(void)	- clearExprVar:
	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...

Instance Methods inherited from NvsObject
(void)	- setAttachment:forKey:
	Adds an attachment to the NvsObject object to identify the object of the NvsObject or for other purposes. More...

(void)	- setTemplateAttachment:forKey:
	Adds additional template data to the NvsObject object to identify the NvsObject template object. More...

(NSObject *)	- getAttachment:
	Gets attached attachments. More...

(NSString *)	- getTemplateAttachment:
	Gets an template attachment to NvsObject. More...

Properties
NvsFxDescription *	description
	Special effect description. More...

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!!!

Method Documentation

◆ clearExprVar:

- (void) clearExprVar: (NSString *) varName

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

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

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

◆ getArbDataVal:

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

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

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

◆ getARFaceContext

- (NvsARFaceContext *) getARFaceContext

Get face effect context pointer.Please refer to NvsARFaceContext.

Returns: Return face effect context pointer.

◆ getARSceneManipulate

- (NvsARSceneManipulate *) getARSceneManipulate

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

Returns: Return the AR scene operation pointer.

◆ getBooleanVal:

- (BOOL) getBooleanVal: (NSString *) fxParam

Get the BOOL parameter of NvsFx.

Parameters

fxParam The type of the NvsFx's BOOL parameter. Please refer to [NVS_PARAM_TYPE_BOOL].

Returns: Return the BOOL value.

See also: - setBooleanVal:val:

◆ getBooleanValAtTime:time:

- (BOOL) getBooleanValAtTime:	(NSString *)	fxParam
time:	(int64_t)	time

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

Parameters

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

Returns: Return the BOOL value.

See also: - setBooleanValAtTime:val:time:

◆ getColorExprVar:

- (NvsColor) getColorExprVar: (NSString *) varName

Get the color 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:varValue:

Since: 3.5.2

◆ getColorVal:

- (NvsColor) getColorVal: (NSString *) fxParam

Get the color parameter of NvsFx.

Parameters

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

Returns: Return the customized color object[NvsColor].

See also: - setColorVal:val:

◆ getColorValAtTime:time:

- (NvsColor) getColorValAtTime:	(NSString *)	fxParam
time:	(int64_t)	time

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

Parameters

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

Returns: Return the customized color object[NvsColor].

See also: - setColorValAtTime:val:time:

◆ getExprVar:

- (double) getExprVar: (NSString *) varName

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

Since: 2.16.1

◆ getFilterIntensity

- (float) getFilterIntensity

Get the intensity of the filter.

Returns: Return the degree of intensity of the filter.

See also: - setFilterIntensity:

Since: 2.0.2

◆ getFilterMask

- (bool) getFilterMask

Get the usage of the filter's mask.

Returns: Return used or not.

See also: - setFilterMask:

Since: 2.14.1

◆ getFloatVal:

- (double) getFloatVal: (NSString *) fxParam

Get the float parameter of NvsFx.

Parameters

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

Returns: Return the double value.

See also: - setFloatVal:val:

◆ getFloatValAtTime:time:

- (double) getFloatValAtTime:	(NSString *)	fxParam
time:	(int64_t)	time

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

Parameters

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

Returns: Return the double value.

See also: - setFloatValAtTime:val:time:

◆ getIgnoreBackground

- (BOOL) getIgnoreBackground

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

Get the integer parameter of NvsFx.

Parameters

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

Returns: Return the integer value.

See also: setIntVal:val

◆ getIntValAtTime:time:

- (int) getIntValAtTime:	(NSString *)	fxParam
time:	(int64_t)	time

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

Parameters

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

Returns: Return the integer value.

See also: setIntValAtTime:time:

◆ getInverseRegion

- (BOOL) getInverseRegion

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

Get the menu parameter of NvsFx.

Parameters

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

Returns: Return the menu value of NvsFx.

See also: - setMenuVal:val:

◆ getMenuValAtTime:time:

- (NSString *) getMenuValAtTime:	(NSString *)	fxParam
time:	(int64_t)	time

Get the NvsFx menu parameter at a specified time point.

Parameters

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

Returns: Return the menu value of NvsFx.

See also: - setMenuValAtTime:val:time:

◆ getPaintingEffectContext

- (NvsPaintingEffectContext *) getPaintingEffectContext

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

Returns: Return the particle effect context pointer.

Since: 2.2.0

◆ getParticleSystemContext

- (NvsParticleSystemContext *) getParticleSystemContext

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

Returns: Return the particle effect context pointer.

◆ getPosition2DVal:

- (NvsPosition2D) getPosition2DVal: (NSString *) fxParam

Get the two dimentional coordinates parameter of NvsFx.

Parameters

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

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

See also: - setPosition2DVal:val:; getPosition3DVal:val:

◆ getPosition2DValAtTime:time:

- (NvsPosition2D) getPosition2DValAtTime:	(NSString *)	fxParam
time:	(int64_t)	time

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

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

See also: - setPosition2DValAtTime:val:time:; - getPosition3DValAtTime:time:

◆ getPosition3DVal:

- (NvsPosition3D) getPosition3DVal: (NSString *) fxParam

Get the three dimentional coordinates parameter of NvsFx.

Parameters

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

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

See also: - setPosition3DVal:val:; - getPosition2DVal:

◆ getPosition3DValAtTime:time:

- (NvsPosition3D) getPosition3DValAtTime:	(NSString *)	fxParam
time:	(int64_t)	time

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 [NVS_PARAM_TYPE_POSITION3D].
time	current time (In microseconds).

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

See also: - setPosition3DValAtTime:val:time:; - getPosition2DValAtTime:time:

◆ getRegion

- (NSArray *) getRegion

Get the region of this regional filter.

Returns: Return 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

Get whether the filter is regional.

Returns: Return whether the filter is regional or not.

See also: - setRegional:

Since: 2.10.1

◆ getRegionalFeatherWidth

- (float) getRegionalFeatherWidth

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) getRegionalFeatherWidthAtTime: (int64_t) time

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

Since: 2.16.1

◆ getRegionCoordinateSystemType

- (int) getRegionCoordinateSystemType

Get the coordinate system of the region.

Returns: Return the coordinate system of the region.

See also: - setRegionCoordinateSystemType:

Since: 2.16.1

◆ getRegionInfo

- (NvsMaskRegionInfo *) getRegionInfo

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 *) getRegionInfoAtTime: (int64_t) time

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

Since: 2.16.0

◆ getStringVal:

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

Get the string parameter of NvsFx.

Parameters

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

Returns: Return the string value.

See also: - setStringVal:val:

◆ getStringValAtTime:time:

- (NSString *) getStringValAtTime:	(NSString *)	fxParam
time:	(int64_t)	time

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

Parameters

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

Returns: Return the string value.

See also: - setStringValAtTime:val:time:

◆ 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 NvsCompoundCaption.

◆ 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 NvsCompoundCaption.

◆ 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 NvsCompoundCaption.

◆ setArbDataVal:val:

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

Set custom data parameter value.

Parameters

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

See also: - getArbDataVal:

◆ 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

Set the BOOL parameter of NvsFx.

Parameters

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

See also: - getBooleanVal:

◆ setBooleanValAtTime:val:time:

- (void) setBooleanValAtTime:	(NSString *)	fxParam
val:	(BOOL)	val
time:	(int64_t)	time

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

Parameters

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

See also: - getBooleanValAtTime:time:

◆ setColorExprVar:varValue:

- (void) setColorExprVar:	(NSString *)	varName
varValue:	(NvsColor *)	color

Set the color value of the defined parameter in the expression.

Parameters

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

See also: - getColorExprVar:

Since: 3.5.2

◆ setColorVal:val:

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

Set the color parameter of NvsFx.

Parameters

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

See also: - getColorVal:

◆ setColorValAtTime:val:time:

- (void) setColorValAtTime:	(NSString *)	fxParam
val:	(NvsColor *)	val
time:	(int64_t)	time

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

Parameters

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

See also: - getColorValAtTime:time:

◆ setExprVar:varValue:

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

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) setFilterIntensity: (float) intensity

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) setFilterMask: (bool) useMask

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

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

Set the float parameter of NvsFx.

Parameters

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

See also: - getFloatVal:

◆ setFloatValAtTime:val:time:

- (void) setFloatValAtTime:	(NSString *)	fxParam
val:	(double)	val
time:	(int64_t)	time

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

Parameters

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

See also: - getFloatValAtTime:time:

◆ setIgnoreBackground:

- (void) setIgnoreBackground: (BOOL) isIgnoreBackground

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

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

Set the integer parameter of NvsFx.

Parameters

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

See also: - getIntVal:

◆ setIntValAtTime:val:time:

- (void) setIntValAtTime:	(NSString *)	fxParam
val:	(int)	val
time:	(int64_t)	time

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

Parameters

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

See also: getIntValAtTime:val:time:

◆ setInverseRegion:

- (void) setInverseRegion: (BOOL) isInverseRegion

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

Set the menu parameter of NvsFx.

Parameters

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

See also: - getMenuVal:

◆ setMenuValAtTime:val:time:

- (void) setMenuValAtTime:	(NSString *)	fxParam
val:	(NSString *)	val
time:	(int64_t)	time

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

Parameters

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

See also: - getMenuValAtTime:time:

◆ setPosition2DVal:val:

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

Set the two dimentional coordinates parameter of NvsFx.

Parameters

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

See also: - getPosition2DVal:; setPosition3DVal:

◆ setPosition2DValAtTime:val:time:

- (void) setPosition2DValAtTime:	(NSString *)	fxParam
val:	(NvsPosition2D *)	val
time:	(int64_t)	time

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

See also: - getPosition2DValAtTime:time:; - setPosition3DValAtTime:val:time:

◆ setPosition3DVal:val:

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

Set the three dimentional coordinates parameter of NvsFx.

Parameters

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

See also: - getPosition3DVal:; - setPosition2DVal:val:

◆ setPosition3DValAtTime:val:time:

- (void) setPosition3DValAtTime:	(NSString *)	fxParam
val:	(NvsPosition3D *)	val
time:	(int64_t)	time

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 [NVS_PARAM_TYPE_POSITION3D].
val	Three dimentional coordinates object[NvsPosition3D].
time	time point (In microseconds).

See also: - getPosition3DValAtTime:time:; - setPosition2DValAtTime:val:time:

◆ setRegion:

- (void) setRegion: (NSArray *) region

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.

Since: 2.10.1

◆ setRegional:

- (void) setRegional: (BOOL) isRegional

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

Set the feather width of the regional filter.

Parameters

featherWidth feather width of the regional filter

See also: - getRegionalFeatherWidth

Since: 2.10.1

◆ setRegionalFeatherWidthAtTime:time:

- (void) setRegionalFeatherWidthAtTime:	(float)	featherWidth
time:	(int64_t)	time

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

Since: 2.16.1

◆ setRegionCoordinateSystemType:

- (void) setRegionCoordinateSystemType: (int) type

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

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

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

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

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

Set the string parameter of NvsFx.

Parameters

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

See also: - getStringVal:

◆ setStringValAtTime:val:time:

- (void) setStringValAtTime:	(NSString *)	fxParam
val:	(NSString *)	val
time:	(int64_t)	time

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

Parameters

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

See also: - getStringValAtTime:time:

Property Documentation

◆ description

- (NvsFxDescription*) description

readatomicassign

Special effect description.

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

include/sdkcore/ios/NvsFx.h

Instance Methods

Properties

Detailed Description

Method Documentation

◆ clearExprVar:

◆ clearExprVarCtx

◆ findKeyframeTime:time:flags:

◆ getArbDataVal:

◆ getArbDataValAtTime:time:

◆ getARFaceContext

◆ getARSceneManipulate

◆ getBooleanVal:

◆ getBooleanValAtTime:time:

◆ getColorExprVar:

◆ getColorVal:

◆ getColorValAtTime:time:

◆ getExprVar:

◆ getFilterIntensity

◆ getFilterMask

◆ getFloatVal:

◆ getFloatValAtTime:time:

◆ getIgnoreBackground

◆ getIntVal:

◆ getIntValAtTime:time:

◆ getInverseRegion

◆ getKeyFrameControlPoint:time:

◆ getKeyFrameControlPointMode:time:

◆ getMenuVal:

◆ getMenuValAtTime:time:

◆ getPaintingEffectContext

◆ getParticleSystemContext

◆ getPosition2DVal:

◆ getPosition2DValAtTime:time:

◆ getPosition3DVal:

◆ getPosition3DValAtTime:time:

◆ getRegion

◆ getRegional

◆ getRegionalFeatherWidth

◆ getRegionalFeatherWidthAtTime:

◆ getRegionCoordinateSystemType

◆ getRegionInfo

◆ getRegionInfoAtTime:

◆ getStringVal:

◆ getStringValAtTime:time:

◆ hasKeyframeList:

◆ removeAllKeyframe:

◆ removeKeyframeAtTime:time:

◆ setArbDataVal:val:

◆ setArbDataValAtTime:val:time:

◆ setBooleanVal:val:

◆ setBooleanValAtTime:val:time:

◆ setColorExprVar:varValue:

◆ setColorVal:val:

◆ setColorValAtTime:val:time:

◆ setExprVar:varValue:

◆ setFilterIntensity:

◆ setFilterMask:

◆ setFloatVal:val:

◆ setFloatValAtTime:val:time:

◆ setIgnoreBackground:

◆ setIntVal:val:

◆ setIntValAtTime:val:time:

◆ setInverseRegion:

◆ setKeyFrameControlPoint:time:controlPointPair:

◆ setKeyFrameControlPointMode:time:controlPointModePair:

◆ setMenuVal:val:

◆ setMenuValAtTime:val:time:

◆ setPosition2DVal:val:

◆ setPosition2DValAtTime:val:time:

◆ setPosition3DVal:val:

◆ setPosition3DValAtTime:val:time:

◆ setRegion:

◆ setRegional:

◆ setRegionalFeatherWidth:

◆ setRegionalFeatherWidthAtTime:time:

◆ setRegionCoordinateSystemType:

◆ setRegionInfo:

◆ setRegionInfoAtTime:time:

◆ setStringVal:val:

◆ setStringValAtTime:val:time: