NvsCaptureVideoFx类 参考

采集视频特效 更多...

#import <NvsCaptureVideoFx.h>

类 NvsCaptureVideoFx 继承关系图:

构造函数
(CGPoint)	- mapPointFromImageCoordToParticleSystemCoord:withHeight:withPtImage:
	将采集画面坐标转换为粒子系统坐标 更多...
(int64_t)	- changeOffsetPoint:
	改变特效的相对偏移时间 更多...
(int64_t)	- changeDuration:
	改变特效持续时间 更多...
(void)	- setStartTime:
	设置特效的起始时间 更多...
(void)	- resetStartTime
	重置特效的起始时间 更多...
构造函数 继承自 NvsFx
(void)	- setIntVal:val:
	设置特效的整数参数值 更多...
(int)	- getIntVal:
	获得特效的整数参数值 更多...
(void)	- setIntValAtTime:val:time:
	设置指定时间点上特效的整数参数值 更多...
(int)	- getIntValAtTime:time:
	获得指定时间点上特效的整数参数值 更多...
(void)	- setFloatVal:val:
	设置特效的浮点数参数值 更多...
(double)	- getFloatVal:
	获得特效浮点数参数值 更多...
(void)	- setFloatValAtTime:val:time:
	设置指定时间点上特效的浮点数参数值 更多...
(double)	- getFloatValAtTime:time:
	获得指定时间点上特效浮点数参数值 更多...
(void)	- setBooleanVal:val:
	设置特效布尔值参数值 更多...
(BOOL)	- getBooleanVal:
	获得特效的布尔值参数值 更多...
(void)	- setBooleanValAtTime:val:time:
	设置指点时间点上特效布尔值参数值 更多...
(BOOL)	- getBooleanValAtTime:time:
	获得特效的布尔值参数值 更多...
(void)	- setStringVal:val:
	设置特效字符串参数值 更多...
(NSString *)	- getStringVal:
	获得特效字符串参数值 更多...
(void)	- setStringValAtTime:val:time:
	设置指定时间点上特效字符串参数值 更多...
(NSString *)	- getStringValAtTime:time:
	获得指定时间点上特效字符串参数值 更多...
(void)	- setColorVal:val:
	设置特效颜色值参数值 更多...
(NvsColor)	- getColorVal:
	获得特效颜色值参数值 更多...
(void)	- setColorValAtTime:val:time:
	设置特效颜色值参数值 更多...
(NvsColor)	- getColorValAtTime:time:
	获得特效颜色值参数值 更多...
(void)	- setPosition2DVal:val:
	设置特效二维坐标参数值 更多...
(NvsPosition2D)	- getPosition2DVal:
	获得特效二维坐标参数值 更多...
(void)	- setPosition2DValAtTime:val:time:
	设置特效二维坐标参数值 更多...
(NvsPosition2D)	- getPosition2DValAtTime:time:
	获得特效二维坐标参数值 更多...
(void)	- setPosition3DVal:val:
	设置特效三维坐标参数值 更多...
(NvsPosition3D)	- getPosition3DVal:
	获得特效三维坐标参数值 更多...
(void)	- setPosition3DValAtTime:val:time:
	设置特效三维坐标参数值 更多...
(NvsPosition3D)	- getPosition3DValAtTime:time:
	获得特效三维坐标参数值 更多...
(void)	- setMenuVal:val:
	设置特效菜单参数值 更多...
(NSString *)	- getMenuVal:
	获得特效菜单参数值 更多...
(void)	- setMenuValAtTime:val:time:
	设置特效菜单参数值 更多...
(NSString *)	- getMenuValAtTime:time:
	获得特效菜单参数值 更多...
(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
	获得局部滤镜是否反选区域 更多...
(NSArray *)	- getRegion
	获取局部滤镜的控制范围 更多...
(void)	- setRegion:
	设置局部滤镜的控制范围 更多...
(NvsMaskRegionInfo *)	- getRegionInfo
	获取局部滤镜的蒙版区域信息 更多...
(void)	- setRegionInfo:
	设置局部滤镜的蒙版区域信息 更多...
(void)	- setRegionInfoAtTime:time:
	设置指定时间点局部滤镜的蒙版区域信息 更多...
(NvsMaskRegionInfo *)	- getRegionInfoAtTime:
	获取指定时间点局部滤镜的模板区域信息 更多...
(void)	- setRegionalFeatherWidth:
	设置局部滤镜的羽化宽度 更多...
(float)	- getRegionalFeatherWidth
	获得局部滤镜的羽化宽度 更多...
(void)	- setRegionalFeatherWidthAtTime:time:
	设置指定时间点局部滤镜的羽化宽度 更多...
(float)	- getRegionalFeatherWidthAtTime:
	获得指定时间点局部滤镜的羽化宽度 更多...
(void)	- setRegionCoordinateSystemType:
	设置局部滤镜所在坐标系类型，默认为NDC坐标系 更多...
(int)	- getRegionCoordinateSystemType
	获得局部滤镜所在坐标系类型 更多...
(NvsParticleSystemContext *)	- getParticleSystemContext
	获得粒子特效上下文指针。请参见NvsParticleSystemContext 更多...
(NvsARFaceContext *)	- getARFaceContext
	获得人脸特效上下文指针。请参见NvsARFaceContext 更多...
(NvsPaintingEffectContext *)	- getPaintingEffectContext
	获得手绘特效上下文指针。请参见NvsPaintingEffectContext 更多...
(NvsARSceneManipulate *)	- getARSceneManipulate
	获得AR场景操作指针。请参见NvsARSceneManipulate 更多...
(void)	- setExprVar:varValue:
	设置表达式中定义参数的值 更多...
(double)	- getExprVar:
	获得表达式中定义参数的值 更多...
(void)	- setColorExprVar:varValue:
	设置颜色类型表达式中定义参数的值 更多...
(NvsColor)	- getColorExprVar:
	获得颜色表达式中定义参数的值 更多...
(void)	- clearExprVar:
	清空表达式中定义参数的值，并设置为默认值0 更多...
(void)	- clearExprVarCtx
	清空表达式中定义的全部参数的值，并设置为默认值0 更多...
构造函数 继承自 NvsObject
(void)	- setAttachment:forKey:
	给NvsObject对象添加附件，用来标识NvsObject的对象或者用于其他用途 更多...
(void)	- setTemplateAttachment:forKey:
	为NvsObject对象添加模板资源的附加数据，用来标识NvsObject的模板数据 更多...
(NSObject *)	- getAttachment:
	获取已经添加的附件 更多...
(NSString *)	- getTemplateAttachment:
	获取NvsObject的模板资源附件 更多...

属性
NvsCaptureVideoFxType	captureVideoFxType
	采集视频特效类型 更多...
NSString *	bultinCaptureVideoFxName
	内嵌采集视频特效名字。如果不是内嵌采集视频特效返回nil 更多...
NSString *	captureVideoFxPackageId
	采集视频特效资源包ID。如果不是资源包采集视频特效返回nil 更多...
unsigned int	index
	视频特效索引 更多...
int64_t	offsetPoint
	特效偏移时间（单位微秒） 更多...
int64_t	duration
	特效的持续时间（单位微秒） 更多...
属性 继承自 NvsFx
NvsFxDescription *	description
	特效描述 更多...

详细描述

采集视频特效

采集视频特效是一种应用在视频采集时的特效。获取流媒体上下文(Streaming Context)实例后，可按内建方式，包裹方式，美颜方式来添加或移除多个采集视频特效。

警告

NvsCaptureVideoFx类中，所有public API都在UI线程使用！！！

函数文档

changeDuration:

- (int64_t) changeDuration:

(int64_t)

newOutPoint

改变特效持续时间

参数

newOutPoint

特效新的期望持续时间（单位微秒）

返回

返回特效新的持续时间（单位微秒）

自从

3.4.0

changeOffsetPoint:

- (int64_t) changeOffsetPoint:

(int64_t)

newOffset

改变特效的相对偏移时间

参数

newInPoint

新的相对偏移时间（单位微秒）

返回

返回新的相对偏移时间（单位微秒）

自从

3.4.0

mapPointFromImageCoordToParticleSystemCoord:withHeight:withPtImage:

- (CGPoint) mapPointFromImageCoordToParticleSystemCoord:		(int)	imageWidth
withHeight:		(int)	imageHeight
withPtImage:		(CGPoint)	ptImage

将采集画面坐标转换为粒子系统坐标

参数

imageWidth	采集画面宽度
imageHeight	采集画面高度
ptImage	时间线坐标

返回

返回转换后的粒子系统坐标CGPoint。如果imageWidth或者imageHeight小于1，则直接返回ptImage。

自从

2.3.1

resetStartTime

- (void) resetStartTime

重置特效的起始时间

自从

3.4.0

setStartTime:

- (void) setStartTime:

(int64_t)

startTime

设置特效的起始时间

参数

startTime

起始时间

自从

3.4.0

属性说明

bultinCaptureVideoFxName

- (NSString*) bultinCaptureVideoFxName

readatomicassign

内嵌采集视频特效名字。如果不是内嵌采集视频特效返回nil

captureVideoFxPackageId

- (NSString*) captureVideoFxPackageId

readatomicassign

采集视频特效资源包ID。如果不是资源包采集视频特效返回nil

captureVideoFxType

- (NvsCaptureVideoFxType) captureVideoFxType

readatomicassign

采集视频特效类型

duration

- (int64_t) duration

readatomicassign

特效的持续时间（单位微秒）

自从

3.4.0

index

- (unsigned int) index

readatomicassign

视频特效索引

offsetPoint

- (int64_t) offsetPoint

readatomicassign

特效偏移时间（单位微秒）

自从

3.4.0

---

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

• include/sdkcore/ios/NvsCaptureVideoFx.h