NvsCaptureAnimatedSticker类 参考

采集动画贴纸类 更多...

#import <NvsCaptureAnimatedSticker.h>

类 NvsCaptureAnimatedSticker 继承关系图:

构造函数
(int64_t)	- changeOffsetPoint:
	改变动画贴纸的相对偏移时间 相对偏移时间是相对于添加动画贴纸时候的采集时间。 更多...
(int64_t)	- changeDuration:
	改变动画贴纸持续时间 更多...
(void)	- setStartTime:
	设置动画贴纸的起始时间 更多...
(void)	- resetStartTime
	重置动画贴纸的起始时间 更多...
构造函数 继承自 NvsAnimatedSticker
(NSString *)	- getAnimatedStickerPackageId
	获取动画贴纸包ID 更多...
(void)	- setScale:
	设置动画贴纸的缩放比例，该函数设置的缩放比例不叠加 更多...
(float)	- getScale
	获取动画贴纸的缩放值 更多...
(void)	- setHorizontalFlip:
	设置动画贴纸的水平翻转 更多...
(BOOL)	- getHorizontalFlip
	获取动画贴纸的水平翻转状态 更多...
(void)	- setVerticalFlip:
	设置动画贴纸的竖直翻转 更多...
(BOOL)	- getVerticalFlip
	获取动画贴纸的竖直翻转状态 更多...
(void)	- setRotationZ:
	设置动画贴纸沿Z轴顺时针旋转的角度值，Z轴垂直于屏幕，该函数设置的旋转角度不叠加 更多...
(float)	- getRotationZ
	获取动画贴纸沿Z轴顺时针旋转的角度值，Z轴垂直于屏幕 更多...
(void)	- setTranslation:
	设置动画贴纸在时间线坐标系下的平移坐标，该函数设置的平移坐标不叠加。请参见时间线与视图坐标 更多...
(CGPoint)	- getTransltion
	获取动画贴纸在时间线坐标系下的平移坐标 更多...
(void)	- translateAnimatedSticker:
	在时间线坐标系下平移动画贴纸，该函数设置的平移坐标可叠加 更多...
(void)	- scaleAnimatedSticker:anchor:
	以锚点为中心缩放动画贴纸，该函数设置的缩放值可叠加 更多...
(void)	- rotateAnimatedSticker:anchor:
	以锚点为中心旋转动画贴纸，该函数设置的旋转角度可叠加 更多...
(void)	- rotateAnimatedSticker:
	以动画贴纸中心点为锚点旋转动画贴纸，该函数设置的旋转角度可叠加 更多...
(NvsRect)	- getOriginalBoundingRect
	获取动画贴纸在时间线坐标系下的原始包络框。请参见时间线与视图坐标 更多...
(NSArray *)	- getBoundingRectangleVertices
	获取动画贴纸在时间线坐标系下原始包络框的顶点位置。请参见时间线与视图坐标 更多...
(void)	- setCenterPolarAngle:
	对动画贴纸设置中心点的极角。只对全景图动画贴纸有效 更多...
(float)	- getCenterPolarAngle
	获取动画贴纸中心点的极角。只对全景图动画贴纸有效 更多...
(void)	- setCenterAzimuthAngle:
	对动画贴纸设置中心点的方位角。只对全景图动画贴纸有效 更多...
(float)	- getCenterAzimuthAngle
	获取动画贴纸中心点的方位角。只对全景图动画贴纸有效 更多...
(void)	- setPolarAngleRange:
	对动画贴纸设置极角的张角。只对全景图动画贴纸有效 更多...
(float)	- getPolarAngleRange
	获取动画贴纸极角的张角。只对全景图动画贴纸有效 更多...
(float)	- getOrthoAngleRange
	获取动画贴纸与极角垂直的张角。只对全景图动画贴纸有效 更多...
(void)	- setZValue:
	设置贴纸Z值。Z值越大，贴纸越处于上层 更多...
(float)	- getZValue
	获取贴纸Z值 更多...
(void)	- setVolumeGain:rightVolumeGain:
	设置贴纸音量 更多...
(void)	- getVolumeGain:rightVolumeGain:
	获取音量 更多...
(void)	- setOpacity:
	设置贴纸透明度 更多...
(float)	- getOpacity
	获取透明度 更多...
(void)	- setCurrentKeyFrameTime:
	设置贴纸的关键帧时间 更多...
(bool)	- setControlPoint:controlPointPair:
	设置贴纸的关键帧控制点对 更多...
(NvsControlPointPair *)	- getControlPoint:
	返回关键帧控制点对 更多...
(bool)	- applyAnimatedStickerPeriodAnimation:
	运用动画贴纸循环动画样式包 更多...
(bool)	- applyAnimatedStickerInAnimation:
	运用动画贴纸入动画样式包。注意：如果已经应用了循环动画样式包，需要先把循环动画设置为null，否则不生效 更多...
(bool)	- applyAnimatedStickerOutAnimation:
	运用动画贴纸出动画样式包. 注意：如果已经应用了循环动画样式包，需要先把循环动画设置为null，否则不生效 更多...
(void)	- setAnimatedStickerAnimationPeriod:
	设置动画贴纸循环动画的周期 更多...
(int)	- getAnimatedStickerAnimationPeriod
	获取动画贴纸循环动画的周期 更多...
(void)	- setAnimatedStickerInAnimationDuration:
	设置动画贴纸入动画的时长 更多...
(int)	- getAnimatedStickerInAnimationDuration
	获取动画贴纸入动画的时长 更多...
(void)	- setAnimatedStickerOutAnimationDuration:
	设置动画贴纸出动画的时长 更多...
(int)	- getAnimatedStickerOutAnimationDuration
	获取动画贴纸出动画的时长 更多...
构造函数 继承自 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的模板资源附件 更多...

属性
int64_t	offsetPoint
	动画贴纸偏移时间（单位微秒） 更多...
int64_t	duration
	动画贴纸持续时间（单位微秒） 更多...
属性 继承自 NvsAnimatedSticker
BOOL	hasAudio
	是否含有音频 更多...
BOOL	isPanoramic
	是否为全景图动画贴纸,默认为否 更多...
int64_t	defaultDuration
	动画贴纸在时间线上的默认长度（单位微秒） 更多...
NSString *	animatedStickerPeriodAnimationPackageId
	动画贴纸循环动画样式包裹ID 更多...
NSString *	animatedStickerInAnimationPackageId
	动画贴纸入动画样式包裹ID 更多...
NSString *	animatedStickerOutAnimationPackageId
	动画贴纸出动画样式包裹ID 更多...
属性 继承自 NvsFx
NvsFxDescription *	description
	特效描述 更多...

详细描述

采集动画贴纸类

动画贴纸添加后，起始时间为当前的拍摄的位置和给定的偏移时间开始加载动画贴纸。结束时间为添加时候的时间位置，偏移时间和持续时间之和。 通过各种API调整贴纸的各种属性，如位置、大小、显示时间等等。
注：动画贴纸的偏移时间和持续时间单位都为微秒
注1：动画贴纸的默认开始时间为添加时刻的采集时间，如果在StartCapturePreview调用之前添加的，起始时间都为0

警告

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

自从

2.21.0

函数文档

changeDuration:

- (int64_t) changeDuration:

(int64_t)

newOutPoint

改变动画贴纸持续时间

参数

newOutPoint

动画贴纸新的期望持续时间（单位微秒）

返回

返回动画贴纸新的持续时间（单位微秒）

changeOffsetPoint:

- (int64_t) changeOffsetPoint:

(int64_t)

newOffset

改变动画贴纸的相对偏移时间 相对偏移时间是相对于添加动画贴纸时候的采集时间。

参数

newOffset

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

返回

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

参见

changeDuration

offsetPoint

resetStartTime

- (void) resetStartTime

重置动画贴纸的起始时间

setStartTime:

- (void) setStartTime:

(int64_t)

startTime

设置动画贴纸的起始时间

参数

startTime

起始时间

自从

3.4.0

属性说明

duration

- (int64_t) duration

readatomicassign

动画贴纸持续时间（单位微秒）

自从

2.21.0

offsetPoint

- (int64_t) offsetPoint

readatomicassign

动画贴纸偏移时间（单位微秒）

自从

2.21.0

---

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

• include/sdkcore/ios/NvsCaptureAnimatedSticker.h