美摄SDK For iOS  3.7.2
构造函数 | 属性 | 所有成员列表
NvsVideoEffectAnimatedSticker类 参考

动画贴纸类 更多...

#import <NvsVideoEffectAnimatedSticker.h>

类 NvsVideoEffectAnimatedSticker 继承关系图:
NvsEffect

构造函数

(NSString *) - getAnimatedStickerPackageId
 获取动画贴纸包ID 更多...
 
(int64_t) - changeInPoint:
 改变动画贴纸在时间线上显示的入点 当设置的入点值不符合既定规则时最终返回入点值有可能与设置的入点值不同,比如新的入点值小于0,新的入点值大于时间线长度或者新的入点值大于出点值。 更多...
 
(int64_t) - changeOutPoint:
 改变动画贴纸在时间线上显示的出点 当设置的出点值不符合既定规则时最终返回出点值有可能与设置的出点值不同,比如新的出点值小于0,新的出点值大于时间线长度或者新的出点值小于入点值。 更多...
 
(void) - movePosition:
 改变动画贴纸在时间线上的显示位置(入点和出点同时偏移offset值) 更多...
 
(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:
 以动画贴纸中心点为锚点旋转动画贴纸,该函数设置的旋转角度可叠加 更多...
 
(NvsEffectRect- 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) - setOpacity:
 设置贴纸透明度 更多...
 
(float) - getOpacity
 获取透明度 更多...
 
(void) - setCurrentKeyFrameTime:
 设置贴纸的关键帧时间 更多...
 
(void) - setVideoResolution:
 设置贴纸渲染的画幅解析度 更多...
 
(bool) - applyAnimatedStickerPeriodAnimation:
 运用动画贴纸循环动画样式包 更多...
 
(bool) - applyAnimatedStickerInAnimation:
 运用动画贴纸入动画样式包。注意:如果已经应用了循环动画样式包,需要先把循环动画设置为null,否则不生效 更多...
 
(bool) - applyAnimatedStickerOutAnimation:
 运用动画贴纸出动画样式包. 注意:如果已经应用了循环动画样式包,需要先把循环动画设置为null,否则不生效 更多...
 
(void) - setAnimatedStickerAnimationPeriod:
 设置动画贴纸循环动画的周期 更多...
 
(int) - getAnimatedStickerAnimationPeriod
 获取动画贴纸循环动画的周期 更多...
 
(void) - setAnimatedStickerInAnimationDuration:
 设置动画贴纸入动画的时长 更多...
 
(int) - getAnimatedStickerInAnimationDuration
 获取动画贴纸入动画的时长 更多...
 
(void) - setAnimatedStickerOutAnimationDuration:
 设置动画贴纸出动画的时长 更多...
 
(int) - getAnimatedStickerOutAnimationDuration
 获取动画贴纸出动画的时长 更多...
 
- 构造函数 继承自 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 更多...
 

属性

BOOL isPanoramic
 是否为全景图动画贴纸,默认为否 更多...
 
int64_t inPoint
 动画贴纸在时间线上显示的入点(单位微秒) 更多...
 
int64_t outPoint
 动画贴纸在时间线上显示的出点(单位微秒) 更多...
 
int64_t defaultDuration
 动画贴纸在时间线上的默认长度(单位微秒) 更多...
 
- 属性 继承自 NvsEffect
NvsEffectDescriptiondescription
 特效描述 更多...
 

详细描述

动画贴纸类

动画贴纸是视频编辑时使用的一种美化特效,可以产生动画效果。 用户可以在时间线上添加和移除动画贴纸,也可以通过各种API调整贴纸的各种属性,如位置、大小、显示时间等等。
注:动画贴纸在时间线上的入点和出点单位都为微秒

警告
NvsVideoEffectAnimatedSticker,所有public API都在UI线程使用!!!

函数文档

◆ applyAnimatedStickerInAnimation:

- (bool) applyAnimatedStickerInAnimation: (NSString *)  animatedStickerInAnimationPackageId

运用动画贴纸入动画样式包。注意:如果已经应用了循环动画样式包,需要先把循环动画设置为null,否则不生效

参数
animatedStickerInAnimationPackageId动画贴纸入动画样式资源包ID
返回
返回boolean值。true表示成功运用,false则运用失败
警告
此接口会引发流媒体引擎状态跳转到引擎停止状态,具体情况请参见引擎变化专题
参见
getAnimatedStickerInAnimationPackageId
自从
2.21.0

◆ applyAnimatedStickerOutAnimation:

- (bool) applyAnimatedStickerOutAnimation: (NSString *)  animatedStickerOutAnimationPackageId

运用动画贴纸出动画样式包. 注意:如果已经应用了循环动画样式包,需要先把循环动画设置为null,否则不生效

参数
animatedStickerOutAnimationPackageId动画贴纸出动画样式资源包ID
返回
返回boolean值。true表示成功运用,false则运用失败
警告
此接口会引发流媒体引擎状态跳转到引擎停止状态,具体情况请参见引擎变化专题
参见
getAnimatedStickerOutAnimationPackageId
自从
2.21.0

◆ applyAnimatedStickerPeriodAnimation:

- (bool) applyAnimatedStickerPeriodAnimation: (NSString *)  animatedStickerPeriodAnimationPackageId

运用动画贴纸循环动画样式包

参数
animatedStickerPeriodAnimationPackageId动画贴纸循环动画样式资源包ID
返回
返回boolean值。true表示成功运用,false则运用失败
警告
此接口会引发流媒体引擎状态跳转到引擎停止状态,具体情况请参见引擎变化专题
参见
getAnimatedStickerAnimationPackageId
自从
2.21.0

◆ changeInPoint:

- (int64_t) changeInPoint: (int64_t)  newInPoint

改变动画贴纸在时间线上显示的入点 当设置的入点值不符合既定规则时最终返回入点值有可能与设置的入点值不同,比如新的入点值小于0,新的入点值大于时间线长度或者新的入点值大于出点值。

参数
newInPoint动画贴纸在时间线上的新入点(单位微秒)
返回
返回动画贴纸在时间线上显示的入点(单位微秒)
警告
此接口会引发流媒体引擎状态跳转到引擎停止状态,具体情况请参见引擎变化专题
参见
- changeOutPoint:
getInPoint
- movePosition:

◆ changeOutPoint:

- (int64_t) changeOutPoint: (int64_t)  newOutPoint

改变动画贴纸在时间线上显示的出点 当设置的出点值不符合既定规则时最终返回出点值有可能与设置的出点值不同,比如新的出点值小于0,新的出点值大于时间线长度或者新的出点值小于入点值。

参数
newOutPoint动画贴纸在时间线上的新的出点(单位微秒)
返回
返回动画贴纸在时间线上的显示的出点(单位微秒)
警告
此接口会引发流媒体引擎状态跳转到引擎停止状态,具体情况请参见引擎变化专题
参见
- changeInPoint:
getOutPoint
- movePosition:

◆ getAnimatedStickerAnimationPeriod

- (int) getAnimatedStickerAnimationPeriod

获取动画贴纸循环动画的周期

返回
返回动画贴纸的动画周期,注意:单位是毫秒
参见
setAnimatedStickerAnimationPeriod
自从
2.21.0

◆ getAnimatedStickerInAnimationDuration

- (int) getAnimatedStickerInAnimationDuration

获取动画贴纸入动画的时长

返回
返回动画贴纸入动画的时长,注意:单位是毫秒
参见
setAnimatedStickerInAnimationDuration
自从
2.21.0

◆ getAnimatedStickerOutAnimationDuration

- (int) getAnimatedStickerOutAnimationDuration

获取动画贴纸出动画的时长

返回
返回动画贴纸出动画的时长,注意:单位是毫秒
参见
setAnimatedStickerOutAnimationDuration
自从
2.21.0

◆ getAnimatedStickerPackageId

- (NSString *) getAnimatedStickerPackageId

获取动画贴纸包ID

返回
返回动画贴纸包ID
自从
2.20.0

◆ getBoundingRectangleVertices

- (NSArray *) getBoundingRectangleVertices

获取动画贴纸在时间线坐标系下原始包络框的顶点位置。请参见时间线与视图坐标

返回
返回List<PointF>对象,包含四个顶点位置,分别对应原始包络框的左上,左下,右下,右上顶点
自从
2.20.0

◆ getCenterAzimuthAngle

- (float) getCenterAzimuthAngle

获取动画贴纸中心点的方位角。只对全景图动画贴纸有效

返回
返回动画贴纸中心点的方位角,单位为角度
自从
2.20.0

◆ getCenterPolarAngle

- (float) getCenterPolarAngle

获取动画贴纸中心点的极角。只对全景图动画贴纸有效

返回
返回动画贴纸中心点的极角,单位为角度
自从
2.20.0

◆ getHorizontalFlip

- (BOOL) getHorizontalFlip

获取动画贴纸的水平翻转状态

返回
返回boolean值,表示水平翻转状态。true表示已翻转,false则未翻转
参见
- setHorizontalFlip:

◆ getOpacity

- (float) getOpacity

获取透明度

返回
返回获取的贴纸透明度
参见
- setOpacity:
自从
2.20.0

◆ getOriginalBoundingRect

- (NvsEffectRect) getOriginalBoundingRect

获取动画贴纸在时间线坐标系下的原始包络框。请参见时间线与视图坐标

返回
返回NvsRect对象,表示原始包络框

◆ getOrthoAngleRange

- (float) getOrthoAngleRange

获取动画贴纸与极角垂直的张角。只对全景图动画贴纸有效

返回
返回动画贴纸与极角垂直的张角,单位为角度
自从
2.20.0

◆ getPolarAngleRange

- (float) getPolarAngleRange

获取动画贴纸极角的张角。只对全景图动画贴纸有效

返回
返回动画贴纸极角的张角,单位为角度
自从
2.20.0

◆ getRotationZ

- (float) getRotationZ

获取动画贴纸沿Z轴顺时针旋转的角度值,Z轴垂直于屏幕

返回
返回旋转角度值
参见
- setRotationZ:
- rotateAnimatedSticker:

◆ getScale

- (float) getScale

获取动画贴纸的缩放值

返回
返回获取的缩放值
参见
- setScale:

◆ getTransltion

- (CGPoint) getTransltion

获取动画贴纸在时间线坐标系下的平移坐标

返回
返回PointF对象,表示获取的平移坐标
参见
- setTranslation:

◆ getVerticalFlip

- (BOOL) getVerticalFlip

获取动画贴纸的竖直翻转状态

返回
返回boolean值,表示竖直翻转状态。true表示已翻转,false则未翻转
参见
- setVerticalFlip:

◆ getZValue

- (float) getZValue

获取贴纸Z值

返回
返回贴纸Z值
自从
2.20.0

◆ movePosition:

- (void) movePosition: (int64_t)  offset

改变动画贴纸在时间线上的显示位置(入点和出点同时偏移offset值)

参数
offset入点和出点改变的偏移值(单位微秒)
警告
此接口会引发流媒体引擎状态跳转到引擎停止状态,具体情况请参见引擎变化专题
参见
- changeInPoint:
- changeOutPoint:

◆ rotateAnimatedSticker:

- (void) rotateAnimatedSticker: (float)  angle

以动画贴纸中心点为锚点旋转动画贴纸,该函数设置的旋转角度可叠加

参数
angle旋转角度
自从
2.20.0

◆ rotateAnimatedSticker:anchor:

- (void) rotateAnimatedSticker: (float)  angle
anchor: (CGPoint)  anchor 

以锚点为中心旋转动画贴纸,该函数设置的旋转角度可叠加

参数
angle旋转角度
anchor锚点
自从
2.20.0

◆ scaleAnimatedSticker:anchor:

- (void) scaleAnimatedSticker: (float)  scaleFactor
anchor: (CGPoint)  anchor 

以锚点为中心缩放动画贴纸,该函数设置的缩放值可叠加

参数
scaleFactor动画贴纸缩放系数
anchor动画贴纸缩放的锚点
自从
2.20.0

◆ setAnimatedStickerAnimationPeriod:

- (void) setAnimatedStickerAnimationPeriod: (int)  periodInMS

设置动画贴纸循环动画的周期

参数
periodInMS周期的时间,注意:单位是毫秒
参见
- getAnimatedStickerAnimationPeriod
自从
2.21.0

◆ setAnimatedStickerInAnimationDuration:

- (void) setAnimatedStickerInAnimationDuration: (int)  inAnimationDurationInMS

设置动画贴纸入动画的时长

参数
inAnimationDurationInMS入动画的时长,注意:单位是毫秒
参见
- getAnimatedStickerInAnimationDuration
自从
2.21.0

◆ setAnimatedStickerOutAnimationDuration:

- (void) setAnimatedStickerOutAnimationDuration: (int)  outAnimationDurationInMS

设置动画贴纸出动画的时长

参数
outAnimationDurationInMS出动画的时长,注意:单位是毫秒
参见
- getAnimatedStickerOutAnimationDuration
自从
2.21.0

◆ setCenterAzimuthAngle:

- (void) setCenterAzimuthAngle: (float)  centerAzimuthAngle

对动画贴纸设置中心点的方位角。只对全景图动画贴纸有效

参数
centerAzimuthAngle中心点的极角,单位为角度
自从
2.20.0

◆ setCenterPolarAngle:

- (void) setCenterPolarAngle: (float)  centerPolarAngle

对动画贴纸设置中心点的极角。只对全景图动画贴纸有效

参数
centerPolarAngle中心点的极角,单位为角度
自从
2.20.0

◆ setCurrentKeyFrameTime:

- (void) setCurrentKeyFrameTime: (int64_t)  time

设置贴纸的关键帧时间

参数
time时间点
参见
setCurrentKeyFrameTime
自从
2.20.0

◆ setHorizontalFlip:

- (void) setHorizontalFlip: (bool)  flip

设置动画贴纸的水平翻转

参数
flip是否水平翻转。true表示水平翻转,false则不翻转
参见
- getHorizontalFlip

◆ setOpacity:

- (void) setOpacity: (float)  opacity

设置贴纸透明度

参数
opacity贴纸透明度,取值范围[0,1]
参见
- getOpacity
自从
2.20.0

◆ setPolarAngleRange:

- (void) setPolarAngleRange: (float)  polarAngleRange

对动画贴纸设置极角的张角。只对全景图动画贴纸有效

参数
polarAngleRange极角的张角,单位为角度
自从
2.20.0

◆ setRotationZ:

- (void) setRotationZ: (float)  angle

设置动画贴纸沿Z轴顺时针旋转的角度值,Z轴垂直于屏幕,该函数设置的旋转角度不叠加

参数
angle旋转角度值
参见
- getRotationZ

◆ setScale:

- (void) setScale: (float)  scale

设置动画贴纸的缩放比例,该函数设置的缩放比例不叠加

参数
scale缩放比例
参见
- getScale

◆ setTranslation:

- (void) setTranslation: (CGPoint)  translation

设置动画贴纸在时间线坐标系下的平移坐标,该函数设置的平移坐标不叠加。请参见时间线与视图坐标

参数
translation平移坐标
参见
- getTransltion
- translateAnimatedSticker:

◆ setVerticalFlip:

- (void) setVerticalFlip: (bool)  flip

设置动画贴纸的竖直翻转

参数
flip是否竖直翻转。true表示竖直翻转,false则不翻转
参见
- getVerticalFlip

◆ setVideoResolution:

- (void) setVideoResolution: (NvsEffectVideoResolution *)  resolution

设置贴纸渲染的画幅解析度

参数
resolution画幅解析度
自从
2.20.0

◆ setZValue:

- (void) setZValue: (float)  value

设置贴纸Z值。Z值越大,贴纸越处于上层

参数
valueZ值
自从
2.20.0

◆ translateAnimatedSticker:

- (void) translateAnimatedSticker: (CGPoint)  translationOffset

在时间线坐标系下平移动画贴纸,该函数设置的平移坐标可叠加

参数
translationOffset动画贴纸平移的偏移值
自从
2.20.0
参见
- setTranslation:
getTranslation

属性说明

◆ defaultDuration

- (int64_t) defaultDuration
readatomicassign

动画贴纸在时间线上的默认长度(单位微秒)

自从
2.1.0

◆ inPoint

- (int64_t) inPoint
readatomicassign

动画贴纸在时间线上显示的入点(单位微秒)

◆ isPanoramic

- (BOOL) isPanoramic
readatomicassign

是否为全景图动画贴纸,默认为否

自从
1.6.0

◆ outPoint

- (int64_t) outPoint
readatomicassign

动画贴纸在时间线上显示的出点(单位微秒)


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