动画贴纸类 更多...
#import <NvsAnimatedSticker.h>
类 NvsAnimatedSticker 继承关系图:
属性 | |
| BOOL | hasAudio |
| 是否含有音频 更多... | |
| BOOL | isPanoramic |
| 是否为全景图动画贴纸,默认为否 更多... | |
| int64_t | defaultDuration |
| 动画贴纸在时间线上的默认长度（单位微秒） 更多... | |
| NSString * | animatedStickerPeriodAnimationPackageId |
| 动画贴纸循环动画样式包裹ID 更多... | |
| NSString * | animatedStickerInAnimationPackageId |
| 动画贴纸入动画样式包裹ID 更多... | |
| NSString * | animatedStickerOutAnimationPackageId |
| 动画贴纸出动画样式包裹ID 更多... | |
 属性 继承自 NvsFx | |
| NvsFxDescription * | description |
| 特效描述 更多... | |
详细描述
动画贴纸类
动画贴纸是视频编辑时使用的一种美化特效，可以产生动画效果。 用户可以在时间线(或者轨道，或者采集)上添加和移除动画贴纸，也可以通过各种API调整贴纸的各种属性，如位置、大小、显示时间等等。
注：动画贴纸在时间线(或者轨道，或者采集)上的入点和出点单位都为微秒
- 警告
- NvsAnimatedSticker类中，所有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
◆ 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
- 自从
- 1.7.0
◆ getBoundingRectangleVertices
| - (NSArray *) getBoundingRectangleVertices |
◆ getCenterAzimuthAngle
| - (float) getCenterAzimuthAngle |
获取动画贴纸中心点的方位角。只对全景图动画贴纸有效
- 返回
- 返回动画贴纸中心点的方位角，单位为角度
- 自从
- 1.6.0
◆ getCenterPolarAngle
| - (float) getCenterPolarAngle |
获取动画贴纸中心点的极角。只对全景图动画贴纸有效
- 返回
- 返回动画贴纸中心点的极角，单位为角度
- 自从
- 1.6.0
◆ getControlPoint:
| - (NvsControlPointPair*) getControlPoint: | (NSString *) | fxParam |
返回关键帧控制点对
- 参数
-
fxParam 贴纸参数的类型
- 返回
- 返回获得的控制点信息, 如果控制点为{0, 0}说明当前控制点插值方式为线性插值
- 参见
- setControlPoint: controlPointPair
- 自从
- 2.22.0
◆ getHorizontalFlip
| - (BOOL) getHorizontalFlip |
◆ getOpacity
| - (float) getOpacity |
◆ getOriginalBoundingRect
◆ getOrthoAngleRange
| - (float) getOrthoAngleRange |
获取动画贴纸与极角垂直的张角。只对全景图动画贴纸有效
- 返回
- 返回动画贴纸与极角垂直的张角，单位为角度
- 自从
- 1.7.0
◆ getPolarAngleRange
| - (float) getPolarAngleRange |
获取动画贴纸极角的张角。只对全景图动画贴纸有效
- 返回
- 返回动画贴纸极角的张角，单位为角度
- 自从
- 1.6.0
◆ getRotationZ
| - (float) getRotationZ |
◆ getScale
| - (float) getScale |
◆ getTransltion
| - (CGPoint) getTransltion |
◆ getVerticalFlip
| - (BOOL) getVerticalFlip |
◆ getVolumeGain:rightVolumeGain:
| - (void) getVolumeGain: | (float *) | leftVolumeGain | |
| rightVolumeGain: | (float *) | rightVolumeGain | |
获取音量
- 返回
- 返回获取的音量对象
- 参数
-
leftVolumeGain 输出左声道音量值 rightVolumeGain 输出右声道音量值
- 自从
- 2.0.3
◆ getZValue
| - (float) getZValue |
获取贴纸Z值
- 返回
- 返回贴纸Z值
- 自从
- 1.10.0
◆ rotateAnimatedSticker:
| - (void) rotateAnimatedSticker: | (float) | angle |
以动画贴纸中心点为锚点旋转动画贴纸，该函数设置的旋转角度可叠加
- 参数
-
angle 旋转角度
- 自从
- 1.8.1
◆ rotateAnimatedSticker:anchor:
| - (void) rotateAnimatedSticker: | (float) | angle | |
| anchor: | (CGPoint) | anchor | |
以锚点为中心旋转动画贴纸，该函数设置的旋转角度可叠加
- 参数
-
angle 旋转角度 anchor 锚点
- 自从
- 1.8.1
◆ scaleAnimatedSticker:anchor:
| - (void) scaleAnimatedSticker: | (float) | scaleFactor | |
| anchor: | (CGPoint) | anchor | |
以锚点为中心缩放动画贴纸，该函数设置的缩放值可叠加
- 参数
-
scaleFactor 动画贴纸缩放系数 anchor 动画贴纸缩放的锚点
- 自从
- 1.8.1
◆ setAnimatedStickerAnimationPeriod:
| - (void) setAnimatedStickerAnimationPeriod: | (int) | periodInMS |
◆ setAnimatedStickerInAnimationDuration:
| - (void) setAnimatedStickerInAnimationDuration: | (int) | inAnimationDurationInMS |
设置动画贴纸入动画的时长
- 参数
-
inAnimationDurationInMS 入动画的时长，注意：单位是毫秒
- 自从
- 2.21.0
◆ setAnimatedStickerOutAnimationDuration:
| - (void) setAnimatedStickerOutAnimationDuration: | (int) | outAnimationDurationInMS |
设置动画贴纸出动画的时长
- 参数
-
outAnimationDurationInMS 出动画的时长，注意：单位是毫秒
- 自从
- 2.21.0
◆ setCenterAzimuthAngle:
| - (void) setCenterAzimuthAngle: | (float) | centerAzimuthAngle |
对动画贴纸设置中心点的方位角。只对全景图动画贴纸有效
- 参数
-
centerAzimuthAngle 中心点的极角，单位为角度
- 自从
- 1.6.0
◆ setCenterPolarAngle:
| - (void) setCenterPolarAngle: | (float) | centerPolarAngle |
对动画贴纸设置中心点的极角。只对全景图动画贴纸有效
- 参数
-
centerPolarAngle 中心点的极角，单位为角度
- 自从
- 1.6.0
◆ setControlPoint:controlPointPair:
| - (bool) setControlPoint: | (NSString *) | fxParam | |
| controlPointPair: | (NvsControlPointPair *) | controlPointPair | |
设置贴纸的关键帧控制点对
- 参数
-
fxParam 贴纸参数的类型 controlPointPair 控制点对，设置控制点为{0, 0}，即当前控制点为线性插值方式，否则为曲线插值方式
- 参见
- getControlPoint
- 自从
- 2.22.0
◆ setCurrentKeyFrameTime:
| - (void) setCurrentKeyFrameTime: | (int64_t) | time |
设置贴纸的关键帧时间
- 参数
-
time 时间点
- 参见
- setCurrentKeyFrameTime
- 自从
- 2.15.0
◆ setHorizontalFlip:
| - (void) setHorizontalFlip: | (bool) | flip |
◆ setOpacity:
| - (void) setOpacity: | (float) | opacity |
◆ setPolarAngleRange:
| - (void) setPolarAngleRange: | (float) | polarAngleRange |
对动画贴纸设置极角的张角。只对全景图动画贴纸有效
- 参数
-
polarAngleRange 极角的张角，单位为角度
- 自从
- 1.6.0
◆ setRotationZ:
| - (void) setRotationZ: | (float) | angle |
◆ setScale:
| - (void) setScale: | (float) | scale |
◆ setTranslation:
| - (void) setTranslation: | (CGPoint) | translation |
设置动画贴纸在时间线坐标系下的平移坐标，该函数设置的平移坐标不叠加。请参见时间线与视图坐标
- 参数
-
translation 平移坐标
◆ setVerticalFlip:
| - (void) setVerticalFlip: | (bool) | flip |
◆ setVolumeGain:rightVolumeGain:
| - (void) setVolumeGain: | (float) | leftVolumeGain | |
| rightVolumeGain: | (float) | rightVolumeGain | |
设置贴纸音量
- 参数
-
leftVolumeGain 左声道音量增益,取值范围[0,1] rightVolumeGain 右声道音量增益,取值范围[0,1]
- 自从
- 2.0.3
◆ setZValue:
| - (void) setZValue: | (float) | value |
设置贴纸Z值。Z值越大，贴纸越处于上层
- 参数
-
value Z值
- 自从
- 1.10.0
◆ translateAnimatedSticker:
| - (void) translateAnimatedSticker: | (CGPoint) | translationOffset |
在时间线坐标系下平移动画贴纸，该函数设置的平移坐标可叠加
- 参数
-
translationOffset 动画贴纸平移的偏移值
- 自从
- 1.8.1
- 参见
- - setTranslation:
- getTranslation
属性说明
◆ animatedStickerInAnimationPackageId
|
readatomicassign |
动画贴纸入动画样式包裹ID
- 自从
- 2.21.0
◆ animatedStickerOutAnimationPackageId
|
readatomicassign |
动画贴纸出动画样式包裹ID
- 自从
- 2.21.0
◆ animatedStickerPeriodAnimationPackageId
|
readatomicassign |
动画贴纸循环动画样式包裹ID
- 自从
- 2.21.0
◆ defaultDuration
|
readatomicassign |
动画贴纸在时间线上的默认长度（单位微秒）
- 自从
- 2.1.0
◆ hasAudio
|
readatomicassign |
是否含有音频
- 自从
- 2.0.3
◆ isPanoramic
|
readatomicassign |
是否为全景图动画贴纸,默认为否
- 自从
- 1.6.0
该类的文档由以下文件生成:
- include/sdkcore/ios/NvsAnimatedSticker.h
