The captured video effect. More...

#import <NvsCaptureVideoFx.h>

Inheritance diagram for NvsCaptureVideoFx:

Instance Methods
(CGPoint)	- mapPointFromImageCoordToParticleSystemCoord:withHeight:withPtImage:
	Converts the captured screen coordinates to the particle system coordinates. More...

(int64_t)	- changeOffsetPoint:
	Changes the offset of the fx. The offset time is the fx time relative to the time when the caption was added. More...

(int64_t)	- changeDuration:
	Changes the duration of the fx. More...

(void)	- setStartTime:
	Set start time of the fx. More...

(void)	- resetStartTime
	Reset start time of the fx. More...

Instance Methods inherited from NvsFx
(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
NvsCaptureVideoFxType	captureVideoFxType
	The type of the captured video effect. More...

NSString *	bultinCaptureVideoFxName
	The name of the build-in captured video effect. If it is not a build-in capture video effect, return nil. More...

NSString *	captureVideoFxPackageId
	The ID of the package captured video effect. If it is not a package video effect, return nil. More...

unsigned int	index
	The index of the video effect. More...

int64_t	offsetPoint
	Get caption's offset time. More...

int64_t	duration
	Get the duration of the caption (in microseconds). More...

Properties inherited from NvsFx
NvsFxDescription *	description
	Special effect description. More...

Detailed Description

The captured video effect.

The captured video effect is an effect that it is applied when videos capture. After obtaining a Streaming Context, users can add or remove multiple captured video effects in built-in, package, and beauty modes.

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

Method Documentation

◆ changeDuration:

- (int64_t) changeDuration: (int64_t) newOutPoint

Changes the duration of the fx.

Parameters

newOutPoint The new expected duration of the fx on the timeline (in microseconds).

Returns: Returns the out-point of the fx on the timeline (in microseconds).

Since: 3.4.0

◆ changeOffsetPoint:

- (int64_t) changeOffsetPoint: (int64_t) newOffset

Changes the offset of the fx. The offset time is the fx time relative to the time when the caption was added.

Parameters

newInPoint The new offset of the fx (in microseconds).

Returns: Returns the offset of the fx (in microseconds).

Since: 3.4.0

◆ mapPointFromImageCoordToParticleSystemCoord:withHeight:withPtImage:

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

Converts the captured screen coordinates to the particle system coordinates.

Parameters

imageWidth	Image width
imageHeight	Image height
ptImage	the timeline coordinates

Returns: Returns the transformed particle system coordinates(CGPoint).If ImageWidth or ImageHeight is less than 1, then ptImage is returned directly.

Since: 2.3.1

◆ resetStartTime

- (void) resetStartTime

Reset start time of the fx.

Since: 3.4.0

◆ setStartTime:

- (void) setStartTime: (int64_t) startTime

Set start time of the fx.

Parameters

startTime The start time(in microseconds).

Since: 3.4.0

Property Documentation

◆ bultinCaptureVideoFxName

- (NSString*) bultinCaptureVideoFxName

readatomicassign

The name of the build-in captured video effect. If it is not a build-in capture video effect, return nil.

◆ captureVideoFxPackageId

- (NSString*) captureVideoFxPackageId

readatomicassign

The ID of the package captured video effect. If it is not a package video effect, return nil.

◆ captureVideoFxType

- (NvsCaptureVideoFxType) captureVideoFxType

readatomicassign

The type of the captured video effect.

◆ duration

- (int64_t) duration

readatomicassign

Get the duration of the caption (in microseconds).

Since: 3.4.0

◆ index

- (unsigned int) index

readatomicassign

The index of the video effect.

◆ offsetPoint

- (int64_t) offsetPoint

readatomicassign

Get caption's offset time.

Since: 3.4.0

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

include/sdkcore/ios/NvsCaptureVideoFx.h

Instance Methods

Properties

Detailed Description

Method Documentation

◆ changeDuration:

◆ changeOffsetPoint:

◆ mapPointFromImageCoordToParticleSystemCoord:withHeight:withPtImage:

◆ resetStartTime

◆ setStartTime:

Property Documentation

◆ bultinCaptureVideoFxName

◆ captureVideoFxPackageId

◆ captureVideoFxType

◆ duration

◆ index

◆ offsetPoint