#import <NvsEffect.h>

类 NvsEffect 继承关系图:

构造函数
(void)	- setIntVal:val:
	设置特效参数整数值更多...

(int)	- getIntVal:
	获得特效参数整数值更多...

(void)	- setFloatVal:val:
	设置特效参数浮点值更多...

(double)	- getFloatVal:
	获得特效参数浮点值更多...

(void)	- setBooleanVal:val:
	设置特效参数布尔值更多...

(BOOL)	- getBooleanVal:
	获得特效参数布尔值更多...

(void)	- setStringVal:val:
	设置特效参数字符串值更多...

(NSString *)	- getStringVal:
	获得特效参数字符串值更多...

(void)	- setColorVal:val:
	设置特效参数颜色值更多...

(NvsEffectColor)	- getColorVal:
	获得特效参数颜色值更多...

(void)	- setPosition2DVal:val:
	设置特效参数二维坐标更多...

(NvsEffectPosition2D)	- getPosition2DVal:
	获得特效参数二维坐标更多...

(void)	- setPosition3DVal:val:
	设置特效参数三维坐标更多...

(NvsEffectPosition3D)	- getPosition3DVal:
	获得特效参数三维坐标更多...

(void)	- setMenuVal:val:
	设置特效参数菜单值更多...

(NSString *)	- getMenuVal:
	获得特效参数菜单值更多...

(void)	- setArbDataVal:val:
	设置自定义数据参数值更多...

(NvsArbitraryData *)	- getArbDataVal:
	设置自定义数据参数值更多...

(void)	- setArbDataValAtTime:val:time:
	设置自定义数据参数值更多...

(NvsArbitraryData *)	- getArbDataValAtTime:time:
	返回自定义数据参数值更多...

(bool)	- removeKeyframeAtTime:time:
	删除参数指定时间点的关键帧更多...

(bool)	- removeAllKeyframe:
	删除参数的所有关键帧更多...

(bool)	- hasKeyframeList:
	当前参数是否有关键帧列表更多...

(int64_t)	- findKeyframeTime:time:flags:
	获取指定时间点附近的关键帧更多...

(bool)	- setKeyFrameControlPoint:time:controlPointPair:
	设置关键帧控制点对更多...

(NvsControlPointPair *)	- getKeyFrameControlPoint:time:
	返回关键帧控制点对更多...

(bool)	- setKeyFrameControlPointMode:time:controlPointModePair:
	设置关键帧控制点对更多...

(NvsControlPointModePair *)	- getKeyFrameControlPointMode:time:
	返回关键帧控制点模式对更多...

(void)	- setFilterIntensity:
	设置滤镜的强度更多...

(float)	- getFilterIntensity
	获得滤镜的强度更多...

(void)	- setFilterMask:
	设置滤镜遮罩更多...

(bool)	- getFilterMask
	获得是否使用滤镜遮罩更多...

(void)	- setRegional:
	设置滤镜是否为局部滤镜更多...

(BOOL)	- getRegional
	获得滤镜是否为局部滤镜更多...

(void)	- setIgnoreBackground:
	设置局部滤镜是否消除背景更多...

(BOOL)	- getIgnoreBackground
	获得局部滤镜是否消除背景更多...

(void)	- setInverseRegion:
	设置局部滤镜是否反选区域更多...

(BOOL)	- getInverseRegion
	获得局部滤镜是否反选区域更多...

(void)	- setRegion:
	设置局部滤镜的控制范围更多...

(NSArray *)	- getRegion
	获取局部滤镜的控制范围更多...

(NvsMaskRegionInfo *)	- getRegionInfo
	获取局部滤镜的控制范围更多...

(void)	- setRegionInfo:
	设置局部滤镜的控制范围更多...

(void)	- setRegionInfoAtTime:time:
	设置某时刻局部滤镜的控制范围更多...

(void)	- setRegionalFeatherWidth:
	设置局部滤镜的羽化宽度更多...

(float)	- getRegionalFeatherWidth
	获得局部滤镜的羽化宽度更多...

(void)	- setRegionCoordinateSystemType:
	设置局部滤镜所在坐标系类型，默认为NDC坐标系更多...

(int)	- getRegionCoordinateSystemType
	获得局部滤镜所在坐标系类型更多...

(NvsParticleSystemContext *)	- getParticleSystemContext
	获得粒子特效上下文更多...

(NvsPaintingEffectContext *)	- getPaintingEffectContext
	获得手绘特效上下文更多...

(NvsARSceneManipulate *)	- getARSceneManipulate
	获得AR场景操作指针更多...

(void)	- setExprVar:varValue:
	设置表达式中定义参数的值更多...

(double)	- getExprVar:
	获得表达式中定义参数的值更多...

(void)	- clearExprVar:
	清空表达式中定义参数的值，并设置为默认值0 更多...

(void)	- clearExprVarCtx
	清空表达式中定义的全部参数的值，并设置为默认值0 更多...

属性
NvsEffectDescription *	description
	特效描述更多...

详细描述

特效

特效类是视频特效(Video effect)等不同类型特效的基类。在SDK框架中，特效是很关键的一部分，可以通过NvsEffectSdkContext类的createVideoEffect:aspectRatio:方法来添加。

警告: NvsEffect类中，所有public API都在UI线程使用！！！

函数文档

◆ clearExprVar:

- (void) clearExprVar: (NSString *) varName

清空表达式中定义参数的值，并设置为默认值0

参数

varName 表达式中定义的参数

自从: 2.16.1

◆ clearExprVarCtx

- (void) clearExprVarCtx

清空表达式中定义的全部参数的值，并设置为默认值0

参数

varName 表达式中定义的参数

自从: 2.16.1

◆ findKeyframeTime:time:flags:

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

获取指定时间点附近的关键帧

参数

fxParam	特效的数据参数
time	时间点 (单位为微秒).
flags	查找标志位，请参见KEY_FRAME_FIND_MODE.

返回: 返回离指定时间点最近的关键帧的时间位置，如果没有找到返回-1

在 NvsVideoEffectCompoundCaption 内被实现.

◆ getArbDataVal:

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

设置自定义数据参数值

参数

fxParam	特效自定义数据参数的类型
val	NvsArbitraryData数据值

返回: 返回获得的自定义数据参数值.

◆ getArbDataValAtTime:time:

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

返回自定义数据参数值

参数

fxParam	特效的自定义数据参数的类型
time	时间点

返回: 返回获得的自定义数据

参见: - setArbDataValAtTime:val:time:

◆ getARSceneManipulate

- (NvsARSceneManipulate *) getARSceneManipulate

获得AR场景操作指针

返回: 返回指向AR场景操作指针

◆ getBooleanVal:

- (BOOL) getBooleanVal: (NSString *) fxParam

获得特效参数布尔值

参数

fxParam 特效参数布尔值类型，请参见NVS_PARAM_TYPE_BOOL

返回: 返回布尔值。YES 成功获取特效参数布尔值；NO 获取参数布尔值失败。

参见: - setBooleanVal:val:

◆ getColorVal:

- (NvsEffectColor) getColorVal: (NSString *) fxParam

获得特效参数颜色值

参数

fxParam 特效参数颜色类型，请参见NVS_PARAM_TYPE_COLOR

返回: 返回自定义颜色对象

参见: - setColorVal:val:

◆ getExprVar:

- (double) getExprVar: (NSString *) varName

获得表达式中定义参数的值

参数

varName 表达式中定义的参数

返回: 返回表达式中定义参数的值

自从: 2.16.1

◆ getFilterIntensity

- (float) getFilterIntensity

获得滤镜的强度

返回: 返回滤镜的强度值

参见: - setFilterIntensity:

自从: 2.0.2

◆ getFilterMask

- (bool) getFilterMask

获得是否使用滤镜遮罩

返回: 返回是否使用了滤镜遮罩

参见: setFilterMask

自从: 2.14.1

◆ getFloatVal:

- (double) getFloatVal: (NSString *) fxParam

获得特效参数浮点值

参数

fxParam 特效参数浮点数类型，请参见NVS_PARAM_TYPE_FLOAT

返回: 返回double值

参见: - setFloatVal:val:

◆ getIgnoreBackground

- (BOOL) getIgnoreBackground

获得局部滤镜是否消除背景

返回: 返回局部滤镜是否消除背景

参见: setIgnoreBackground

自从: 2.15.1

◆ getIntVal:

- (int) getIntVal: (NSString *) fxParam

获得特效参数整数值

参数

fxParam 特效参数整数类型，请参见NVS_PARAM_TYPE_INT

返回: 返回整数值

参见: - setIntVal:val:

◆ getInverseRegion

- (BOOL) getInverseRegion

获得局部滤镜是否反选区域

返回: 返回局部滤镜是否反选区域

参见: setInverseRegion

自从: 2.15.1

◆ getKeyFrameControlPoint:time:

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

返回关键帧控制点对

参数

fxParam	特效的自定义数据参数的类型
time	时间点 (单位为微秒)

返回: 返回获得的控制点信息

参见: - setKeyFrameControlPoint:time:controlPointPair:

自从: 2.21.0

◆ getKeyFrameControlPointMode:time:

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

返回关键帧控制点模式对

参数

fxParam	特效的自定义数据参数的类型
time	时间点 (单位为微秒)

返回: 返回获得的控制点模式信息

参见: - setKeyFrameControlPointMode:time:controlPointModePair:

自从: 3.6.0

◆ getMenuVal:

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

获得特效参数菜单值

参数

fxParam 特效参数菜单类型，请参见NVS_PARAM_TYPE_MENU

返回: 返回菜单值

参见: - setMenuVal:val:

◆ getPaintingEffectContext

- (NvsPaintingEffectContext *) getPaintingEffectContext

获得手绘特效上下文

返回: 返回指向手绘特效上下文指针

◆ getParticleSystemContext

- (NvsParticleSystemContext *) getParticleSystemContext

获得粒子特效上下文

返回: 返回指向粒子特效上下文的指针

◆ getPosition2DVal:

- (NvsEffectPosition2D) getPosition2DVal: (NSString *) fxParam

获得特效参数二维坐标

参数

fxParam 特效参数二维坐标类型，请参见NVS_PARAM_TYPE_POSITION2D

返回: 返回二维坐标

参见: - setPosition2DVal:val:

◆ getPosition3DVal:

- (NvsEffectPosition3D) getPosition3DVal: (NSString *) fxParam

获得特效参数三维坐标

参数

fxParam 特效参数三维坐标类型，请参见NVS_PARAM_TYPE_POSITION3D

返回: 返回三维坐标

参见: - setPosition2DVal:val:

◆ getRegion

- (NSArray *) getRegion

获取局部滤镜的控制范围

返回: 返回局部滤镜的控制范围，点的坐标在NDC坐标系中

参见: - setRegion:

自从: 2.14.0

◆ getRegional

- (BOOL) getRegional

获得滤镜是否为局部滤镜

返回: 返回滤镜是否为局部滤镜

参见: setRegional

自从: 2.10.1

◆ getRegionalFeatherWidth

- (float) getRegionalFeatherWidth

获得局部滤镜的羽化宽度

返回: 返回局部滤镜的羽化宽度

参见: setRegionalFeatherWidth

自从: 2.10.1

◆ getRegionCoordinateSystemType

- (int) getRegionCoordinateSystemType

获得局部滤镜所在坐标系类型

返回: 返回局部滤镜所在坐标系类型

参见: setRegionCoordinateSystemType

自从: 2.16.1

◆ getRegionInfo

- (NvsMaskRegionInfo *) getRegionInfo

获取局部滤镜的控制范围

返回: region 局部滤镜的控制范围, 构成控制区域的可以是点，贝塞尔曲线或者椭圆，对应的坐标系为NDC坐标系

自从: 2.16.1

◆ getStringVal:

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

获得特效参数字符串值

参数

fxParam 特效参数字符串类型，请参见NVS_PARAM_TYPE_STRING

返回: 返回字符串指针

参见: - setStringVal:val:

◆ hasKeyframeList:

- (bool) hasKeyframeList: (NSString *) fxParam

当前参数是否有关键帧列表

参数

fxParam 特效的数据参数

返回: 返回是否有关键帧列表

在 NvsVideoEffectCompoundCaption 内被实现.

◆ removeAllKeyframe:

- (bool) removeAllKeyframe: (NSString *) fxParam

删除参数的所有关键帧

参数

fxParam 特效的数据参数

返回: 返回是否执行成功

在 NvsVideoEffectCompoundCaption 内被实现.

◆ removeKeyframeAtTime:time:

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

删除参数指定时间点的关键帧

参数

fxParam	特效的数据参数
time	时间点 (单位为微秒).

返回: 返回是否执行成功

在 NvsVideoEffectCompoundCaption 内被实现.

◆ setArbDataVal:val:

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

设置自定义数据参数值

参数

fxParam	特效自定义数据参数的类型
val	NvsArbitraryData数据值

◆ setArbDataValAtTime:val:time:

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

设置自定义数据参数值

参数

fxParam	特效的自定义数据参数的类型
val	字符串
time	时间点 (单位为微秒).

参见: - getArbDataValAtTime:time:

◆ setBooleanVal:val:

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

设置特效参数布尔值

参数

fxParam	特效参数布尔值类型，请参见NVS_PARAM_TYPE_BOOL
val	布尔值

参见: - getBooleanVal:

◆ setColorVal:val:

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

设置特效参数颜色值

参数

fxParam	特效参数颜色类型，请参见NVS_PARAM_TYPE_COLOR
val	颜色值

参见: - getColorVal:

◆ setExprVar:varValue:

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

设置表达式中定义参数的值

参数

varName	表达式中定义的参数
varValue	表达式中参数对应的值

自从: 2.16.1

◆ setFilterIntensity:

- (void) setFilterIntensity: (float) intensity

设置滤镜的强度

参数

intensity 滤镜强度值，取值范围一般为[0,1]，为0则滤镜无效果，为1则为默认效果

参见: - getFilterIntensity

自从: 2.0.2

◆ setFilterMask:

- (void) setFilterMask: (bool) useMask

设置滤镜遮罩

参数

useMask 使用滤镜遮罩，仅在有图像的区域添加滤镜效果

参见: - getFilterMask

自从: 2.14.1

◆ setFloatVal:val:

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

设置特效参数浮点值

参数

fxParam	特效参数浮点类型，请参见NVS_PARAM_TYPE_FLOAT
val	浮点值

参见: - getFloatVal:

◆ setIgnoreBackground:

- (void) setIgnoreBackground: (BOOL) isIgnoreBackground

设置局部滤镜是否消除背景

参数

regional 是否为局部滤镜消除背景，true为消除，false不是

参见: - getIgnoreBackground

自从: 2.15.1

◆ setIntVal:val:

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

设置特效参数整数值

参数

fxParam	特效参数整数类型，请参见NVS_PARAM_TYPE_INT
val	整形值

参见: - getIntVal:

◆ setInverseRegion:

- (void) setInverseRegion: (BOOL) isInverseRegion

设置局部滤镜是否反选区域

参数

regional 是否为局部滤镜反选区域，true为反选，false不是

参见: - getInverseRegion

自从: 2.15.1

◆ setKeyFrameControlPoint:time:controlPointPair:

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

设置关键帧控制点对

参数

fxParam	特效的自定义数据参数的类型
time	时间点 (单位为微秒)
controlPointPair	控制点对

参见: - getKeyFrameControlPoint:time:

自从: 2.21.0

◆ setKeyFrameControlPointMode:time:controlPointModePair:

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

设置关键帧控制点对

参数

fxParam	特效的自定义数据参数的类型
time	时间点 (单位为微秒)
controlPointModePair	控制点模式对

参见: - getKeyFrameControlPointMode:time:

自从: 3.6.0

◆ setMenuVal:val:

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

设置特效参数菜单值

参数

fxParam	特效参数菜单类型，请参见NVS_PARAM_TYPE_MENU
val	字符串

参见: - getMenuVal:

◆ setPosition2DVal:val:

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

设置特效参数二维坐标

参数

fxParam	特效参数二维坐标类型，请参见NVS_PARAM_TYPE_POSITION2D
val	二维坐标

参见: - getPosition2DVal:

◆ setPosition3DVal:val:

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

设置特效参数三维坐标

参数

fxParam	特效参数三维坐标类型，请参见NVS_PARAM_TYPE_POSITION3D
val	三维坐标

参见: - getPosition3DVal:

◆ setRegion:

- (void) setRegion: (NSArray *) region

设置局部滤镜的控制范围

参数

region 局部滤镜的控制范围, 由一系列连续的点构成，点的坐标在NDC坐标系中

自从: 2.10.1

◆ setRegional:

- (void) setRegional: (BOOL) isRegional

设置滤镜是否为局部滤镜

参数

regional 是否为局部滤镜，true为局部滤镜，false不是

参见: - getRegional

自从: 2.10.1

◆ setRegionalFeatherWidth:

- (void) setRegionalFeatherWidth: (float) featherWidth

设置局部滤镜的羽化宽度

参数

featherWidth 局部滤镜的羽化宽度

参见: - getRegionalFeatherWidth

自从: 2.10.1

◆ setRegionCoordinateSystemType:

- (void) setRegionCoordinateSystemType: (int) type

设置局部滤镜所在坐标系类型，默认为NDC坐标系

参数

coordinateSystem 局部滤镜所在坐标系

参见: - getRegionCoordinateSystemType

自从: 2.16.1

◆ setRegionInfo:

- (void) setRegionInfo: (NvsMaskRegionInfo *) info

设置局部滤镜的控制范围

参数

region 局部滤镜的控制范围, 构成控制区域的可以是点，贝塞尔曲线或者椭圆，对应的坐标系为NDC坐标系

自从: 2.16.0

◆ setRegionInfoAtTime:time:

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

设置某时刻局部滤镜的控制范围

参数

region 局部滤镜的控制范围, 构成控制区域的可以是点，贝塞尔曲线或者椭圆，对应的坐标系为NDC坐标系

自从: 2.16.0

◆ setStringVal:val:

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

设置特效参数字符串值

参数

fxParam	特效参数字符串类型，请参见NVS_PARAM_TYPE_STRING
val	字符串值

参见: - getStringVal:

属性说明

◆ description

- (NvsEffectDescription*) description

readatomicassign

特效描述

该类的文档由以下文件生成:

include/sdkcore/ios/NvsEffect.h

构造函数

属性

详细描述

函数文档

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

属性说明

◆ description