美摄Web端SDK  3.12.1
Public 成员函数 | 所有成员列表
NvsAnimatedSticker类 参考

动画贴纸类。动画贴纸是视频编辑时使用的一种美化特效，可以产生动画效果。 用户可以在时间线上添加和移除动画贴纸，也可以通过各种API调整贴纸的各种属性，如位置、大小、显示时间等等。 更多...

类 NvsAnimatedSticker 继承关系图:
NvsFx NvsProjObj NvsClipAnimatedSticker NvsTimelineAnimatedSticker NvsTrackAnimatedSticker

Public 成员函数

 constructor ()
 构造函数
 
 setTranslation (translation)
 设置转场 更多...
 
 getTranslation ()
 获取转场 更多...
 
 translateAnimatedSticker (translationOffset)
 转场动画贴纸 更多...
 
 setScale (scale)
 设置缩放 更多...
 
 getScale ()
 获取缩放 更多...
 
 scaleAnimatedSticker (scaleFactor, anchor)
 缩放动画贴纸 更多...
 
 scaleAnimatedSticker2 (scaleFactor)
 缩放动画贴纸 更多...
 
 setSeperatedScaleX (seperatedScaleX)
 设置分离式水平缩放因子 更多...
 
 setSeperatedScaleY (seperatedScaleY)
 设置分离式垂直缩放因子 更多...
 
 getSeperatedScaleX ()
 获取分离式水平缩放因子 更多...
 
 getSeperatedScaleY ()
 获取分离式垂直缩放因子 更多...
 
 seperateScaleAnimatedSticker (scaleXFactor, scaleYFactor, anchor)
 基于锚点分离式缩放贴纸 更多...
 
 seperateScaleAnimatedSticker2 (scaleXFactor, scaleYFactor)
 基于中心点分离式缩放贴纸 更多...
 
 setRotationZ (angle)
 设置Z方向旋转 更多...
 
 getRotationZ ()
 获取Z方向旋转 更多...
 
 rotateAnimatedSticker (angle, anchor)
 旋转动画贴纸 更多...
 
 rotateAnimatedSticker2 (angle)
 旋转动画贴纸 更多...
 
 setHorizontalFlip (flip)
 设置水平翻转 更多...
 
 getHorizontalFlip ()
 获取水平翻转 更多...
 
 setVerticalFlip (flip)
 设置垂直翻转 更多...
 
 getVerticalFlip ()
 获取垂直翻转 更多...
 
 getBoundingRectangleVertices ()
 获取边界矩形顶点 更多...
 
 getAnimatedStickerPackageId ()
 获取动画贴纸包ID 更多...
 
 setZValue (value)
 设置Z值 更多...
 
 getZValue ()
 获取Z值 更多...
 
 hasAudio ()
 是否是音频 更多...
 
 setVolumeGain (leftVolumeGain, rightVolumeGain)
 设置音量增益 更多...
 
 getVolumeGain ()
 获取音量增益 更多...
 
 setOpacity (opacity)
 设置不透明度 更多...
 
 getOpacity ()
 获取不透明度 更多...
 
 setCurrentKeyFrameTime (time)
 设置当前关键帧时间 更多...
 
 getAnimatedStickerPeriodAnimationPackageId ()
 获取动画贴纸周期动画样式包ID。 更多...
 
 getAnimatedStickerInAnimationPackageId ()
 设置贴纸的关键帧时间 更多...
 
 getAnimatedStickerOutAnimationPackageId ()
 获取动画贴纸出动画样式包 ID。 更多...
 
 applyAnimatedStickerPeriodAnimation (animatedStickerPeriodAnimationPackageId)
 应用动画贴纸循环动画样式。 更多...
 
 applyAnimatedStickerInAnimation (animatedStickerInAnimationPackageId)
 在动画样式中应用动画贴纸。注意：设置in-animation前请先设置loop-Animation为null，否则无效。 更多...
 
 applyAnimatedStickerOutAnimation (animatedStickerOutAnimationPackageId)
 应用动画贴纸 out-animation 样式。注意：请在设置 out-animation 之前将 loop-Animation 设置为 null，否则将不起作用。 更多...
 
 setAnimatedStickerAnimationPeriod (periodInMS)
 设置动画贴纸动画周期。 更多...
 
 getAnimatedStickerAnimationPeriod ()
 获取动画贴纸动画时期。 更多...
 
 setAnimatedStickerInAnimationDuration (inAnimationDurationInMS)
 设置动画贴纸入动画持续时间。 更多...
 
 getAnimatedStickerInAnimationDuration ()
 获取动画贴纸中的入动画持续时间。 更多...
 
 setAnimatedStickerOutAnimationDuration (outAnimationDurationInMS)
 设置动画贴纸出动画持续时间。 更多...
 
 getAnimatedStickerOutAnimationDuration ()
 获取动画贴纸出动画持续时间。 更多...
 
- Public 成员函数 继承自 NvsFx
 constructor ()
 特效类。构造器
 
 getDescription ()
 获取特效的描述。返回 NvsFxDescription 对象 更多...
 
 setIntVal (fxParam, val)
 设置整数值 更多...
 
 getIntVal (fxParam)
 获取整数值 更多...
 
 setIntValAtTime (fxParam, val, time)
 在某个时间设置整数值 更多...
 
 getIntValAtTime (fxParam, time)
 在某个时间获取整数值 更多...
 
 setFloatVal (fxParam, val)
 设置浮点值 更多...
 
 getFloatVal (fxParam)
 获取浮点值 更多...
 
 setFloatValAtTime (fxParam, val, time)
 在某个时间设置浮点值 更多...
 
 getFloatValAtTime (fxParam, time)
 在某个时间获取浮点值 更多...
 
 setBooleanVal (fxParam, val)
 设置布尔值 更多...
 
 getBooleanVal (fxParam)
 获取布尔值 更多...
 
 setBooleanValAtTime (fxParam, val, time)
 在某个时间设置布尔值 更多...
 
 getBooleanValAtTime (fxParam, time)
 在某个时间获取布尔值 更多...
 
 setMenuVal (fxParam, val)
 设置菜单值 更多...
 
 getMenuVal (fxParam)
 设置菜单值 更多...
 
 setMenuValAtTime (fxParam, val, time)
 在某个时间设置菜单值 更多...
 
 getMenuValAtTime (fxParam, time)
 在某个时间获取菜单值 更多...
 
 setStringVal (fxParam, val)
 设置字符串值 更多...
 
 getStringVal (fxParam)
 获取字符串值 更多...
 
 setStringValAtTime (fxParam, val, time)
 在某个时间点设置字符串值 更多...
 
 getStringValAtTime (fxParam, time)
 在某个时间获取字符串值 更多...
 
 setColorVal (fxParam, val)
 设置颜色值 更多...
 
 getColorVal (fxParam)
 设置颜色值 更多...
 
 setColorValAtTime (fxParam, val, time)
 在某个时间设置颜色 更多...
 
 getColorValAtTime (fxParam, time)
 在某个时间点获取颜色值 更多...
 
 removeKeyframeAtTime (fxParam, time)
 在某个时间删除关键帧 更多...
 
 removeAllKeyframe (fxParam)
 删除所有关键帧 更多...
 
 hasKeyframeList (fxParam)
 是否有关键帧列表 更多...
 
 findKeyframeTime (fxParam, time, flags)
 在某个时间查询关键帧 更多...
 
 setParamKeyframes (fxParam, keyframes)
 设置关键帧参数 更多...
 
 getParamKeyframes (fxParam)
 获取关键帧参数 更多...
 
 setParamKeyframeAtTime (fxParam, time, keyframe)
 在某个时间设置关键帧参数 更多...
 
 getParamKeyframeAtTime (fxParam, time)
 在某个时间获取关键帧参数 更多...
 
 getIntpFxParamValsAtTime (fxParam, time)
 在某个时间获取关键帧参数 更多...
 
 setFilterIntensity (intensity)
 设置滤镜强度 更多...
 
 getFilterIntensity ()
 获取滤镜强度 更多...
 
 setRegional (isRegional)
 设置区域 更多...
 
 getRegional ()
 获取区域范围 更多...
 
 setIgnoreBackground (isIgnoreBackground)
 设置忽略背景 更多...
 
 getIgnoreBackground ()
 获取忽略背景 更多...
 
 setInverseRegion (isInverseRegion)
 设置反转区域 更多...
 
 getInverseRegion ()
 获取反转区域 更多...
 
 setRegion (region)
 设置区域 更多...
 
 setRegionAtTime (region, time)
 在某个时间设置区域 更多...
 
 setEllipseRegion (center, a, b, angle)
 设置椭圆区域 更多...
 
 setEllipseRegionAtTime (center, a, b, angle, time)
 在某个时间点设置椭圆区域 更多...
 
 getRegionInfos ()
 获取特效区域信息 更多...
 
 getRegionInfosAtTime (time)
 获取特效在某个时间点的区域信息 更多...
 
 setRegionalFeatherWidth (featherWidth)
 设置区域羽化宽度 更多...
 
 getRegionalFeatherWidth ()
 获取区域羽化宽度 更多...
 
 getParticleSystemContext ()
 获取粒子特效上下文 更多...
 
 getARSceneManipulate ()
 获取ARScene操作 更多...
 
 setExprVar (varName, varValue)
 设置表达式变量 更多...
 
 getExprVar (varName)
 获取表达式变量 更多...
 
 setExprObjectVar (varName, varValue)
 设置对象(例如:颜色)表达式变量 更多...
 
 getExprObjectVar (varName)
 获取对象(例如:颜色)表达式变量 更多...
 
 clearExprVar ()
 清除Expr值 更多...
 
 clearExprVarCtx ()
 清空表达式中定义的全部参数的值，并设置为默认值0 更多...
 
 setArbitraryVal (fxParam, val)
 设置特效不定类型的值 更多...
 
 getArbitraryVal (fxParam)
 获取特效不定类型的值 更多...
 
 setArbitraryValAtTime (fxParam, val, time)
 
 getArbitraryValAtTime (fxParam, time)
 获取特效某时间点不定类型的值 更多...
 
 setRegionInfos (regionInfos)
 设置多个区域信息 更多...
 
 setRegionInfosAtTime (regionInfos, time)
 设置某个时间点的多个区域信息 更多...
 
- Public 成员函数 继承自 NvsProjObj
 constructor ()
 
 setInternalObject (obj)
 设置内置对象 更多...
 
 getInternalObject ()
 获取内置对象 更多...
 
 setTemplateAttachment (key, value)
 设置模板附件 更多...
 
 getTemplateAttachment (key)
 根据键，获取模板属性值 更多...
 

详细描述

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

注解
动画贴纸在时间线上的入点和出点单位都为微秒。
参见
NvsFx

成员函数说明

◆ applyAnimatedStickerInAnimation()

NvsAnimatedSticker::applyAnimatedStickerInAnimation (   animatedStickerInAnimationPackageId)
inline

在动画样式中应用动画贴纸。注意：设置in-animation前请先设置loop-Animation为null，否则无效。

参数
{String}animatedStickerPeriodAnimationPackageId 动画贴纸动画风格资源包ID。
返回
{Boolean} Returns boolean value. 返回布尔值。 true 表示申请成功，false 表示失败。

◆ applyAnimatedStickerOutAnimation()

NvsAnimatedSticker::applyAnimatedStickerOutAnimation (   animatedStickerOutAnimationPackageId)
inline

应用动画贴纸 out-animation 样式。注意：请在设置 out-animation 之前将 loop-Animation 设置为 null，否则将不起作用。

参数
{String}animatedStickerPeriodAnimationPackageId 动画贴纸-动画样式资源包ID。
返回
{Boolean} Returns boolean value. true 表示申请成功，false 表示失败。

◆ applyAnimatedStickerPeriodAnimation()

NvsAnimatedSticker::applyAnimatedStickerPeriodAnimation (   animatedStickerPeriodAnimationPackageId)
inline

应用动画贴纸循环动画样式。

参数
{String}animatedStickerPeriodAnimationPackageId 动画贴纸循环-动画样式资源包ID。
返回
{Boolean} Returns boolean value. true 表示应用成功，false 表示失败。

◆ getAnimatedStickerAnimationPeriod()

NvsAnimatedSticker::getAnimatedStickerAnimationPeriod ( )
inline

获取动画贴纸动画时期。

返回
{Number} 以毫秒为单位返回动画周期

◆ getAnimatedStickerInAnimationDuration()

NvsAnimatedSticker::getAnimatedStickerInAnimationDuration ( )
inline

获取动画贴纸中的入动画持续时间。

返回
{Number} 获取动画贴纸中的入动画持续时间。

◆ getAnimatedStickerInAnimationPackageId()

NvsAnimatedSticker::getAnimatedStickerInAnimationPackageId ( )
inline

设置贴纸的关键帧时间

返回
{String} 返回获取到的模块化贴纸入动画风格资源包ID。

◆ getAnimatedStickerOutAnimationDuration()

NvsAnimatedSticker::getAnimatedStickerOutAnimationDuration ( )
inline

获取动画贴纸出动画持续时间。

返回
{Number} 以毫秒为单位返回出动画持续时间

◆ getAnimatedStickerOutAnimationPackageId()

NvsAnimatedSticker::getAnimatedStickerOutAnimationPackageId ( )
inline

获取动画贴纸出动画样式包 ID。

返回
{String} 返回获得的动画贴纸动画风格的资源包ID。

◆ getAnimatedStickerPackageId()

NvsAnimatedSticker::getAnimatedStickerPackageId ( )
inline

获取动画贴纸包ID

返回
{String} 返回动画贴纸的包 ID。

◆ getAnimatedStickerPeriodAnimationPackageId()

NvsAnimatedSticker::getAnimatedStickerPeriodAnimationPackageId ( )
inline

获取动画贴纸周期动画样式包ID。

返回
{String} 返回获取到的模块化贴纸周期动画风格资源包ID。

◆ getBoundingRectangleVertices()

NvsAnimatedSticker::getBoundingRectangleVertices ( )
inline

获取边界矩形顶点

返回
{NvsVectorVal<NvsPointF>} 返回一个 NvsVectorVal<NvsPointF> 对象，其中包含四个顶点位置，对应于原始边界的左上角、左下角、右下角和右上角顶点。
参见
NvsVectorVal

◆ getHorizontalFlip()

NvsAnimatedSticker::getHorizontalFlip ( )
inline

获取水平翻转

返回
{Boolean} 返回一个布尔值，指示水平翻转状态。 true 表示翻转，false 表示不翻转。

◆ getOpacity()

NvsAnimatedSticker::getOpacity ( )
inline

获取不透明度

返回
{Number} 返回贴纸不透明度。

◆ getRotationZ()

NvsAnimatedSticker::getRotationZ ( )
inline

获取Z方向旋转

返回
{Number} 返回旋转角度值。

◆ getScale()

NvsAnimatedSticker::getScale ( )
inline

获取缩放

返回
{Number} 返回比例值。

◆ getSeperatedScaleX()

NvsAnimatedSticker::getSeperatedScaleX ( )
inline

获取分离式水平缩放因子

返回
{Number} 返回分离式水平缩放因子

◆ getSeperatedScaleY()

NvsAnimatedSticker::getSeperatedScaleY ( )
inline

获取分离式垂直缩放因子

返回
{Number} 返回分离式垂直缩放因子

◆ getTranslation()

NvsAnimatedSticker::getTranslation ( )
inline

获取转场

返回
{PointF} 返回一个表示平移位置的 PointF 对象。
参见
PointF

◆ getVerticalFlip()

NvsAnimatedSticker::getVerticalFlip ( )
inline

获取垂直翻转

返回
{Boolean} 返回一个布尔值，指示垂直翻转状态。 true 表示翻转，false 表示不翻转。

◆ getVolumeGain()

NvsAnimatedSticker::getVolumeGain ( )
inline

获取音量增益

返回
{NvsVolume} 返回音量增益对象。

◆ getZValue()

NvsAnimatedSticker::getZValue ( )
inline

获取Z值

返回
{Number} 返回贴纸 Z 值。

◆ hasAudio()

NvsAnimatedSticker::hasAudio ( )
inline

是否是音频

返回
{Boolean} 返回贴纸是否包含音频。

◆ rotateAnimatedSticker()

NvsAnimatedSticker::rotateAnimatedSticker (   angle,
  anchor 
)
inline

旋转动画贴纸

参数
{Number}angle 角度
{PointF}anchor 锚点
返回
{void}

◆ rotateAnimatedSticker2()

NvsAnimatedSticker::rotateAnimatedSticker2 (   angle)
inline

旋转动画贴纸

参数
{Number}angle 旋转角度。
返回
{void}

◆ scaleAnimatedSticker()

NvsAnimatedSticker::scaleAnimatedSticker (   scaleFactor,
  anchor 
)
inline

缩放动画贴纸

参数
{Number}scaleFactor 缩放因子
{PointF}anchor 锚点
返回
{void}

◆ scaleAnimatedSticker2()

NvsAnimatedSticker::scaleAnimatedSticker2 (   scaleFactor)
inline

缩放动画贴纸

参数
{Number}scaleFactor 缩放因子
返回
{void}

◆ seperateScaleAnimatedSticker()

NvsAnimatedSticker::seperateScaleAnimatedSticker (   scaleXFactor,
  scaleYFactor,
  anchor 
)
inline

基于锚点分离式缩放贴纸

参数
{Number}scaleXFactor 分离式水平缩放因子
{Number}scaleYFactor 分离式垂直缩放因子
{PointF}anchor 缩放锚点
返回
{void}

◆ seperateScaleAnimatedSticker2()

NvsAnimatedSticker::seperateScaleAnimatedSticker2 (   scaleXFactor,
  scaleYFactor 
)
inline

基于中心点分离式缩放贴纸

参数
{Number}scaleXFactor 分离式水平缩放因子
{Number}scaleYFactor 分离式垂直缩放因子
返回
{void}

◆ setAnimatedStickerAnimationPeriod()

NvsAnimatedSticker::setAnimatedStickerAnimationPeriod (   periodInMS)
inline

设置动画贴纸动画周期。

参数
{Number}periodInMS 动画周期（毫秒）
返回
{void}

◆ setAnimatedStickerInAnimationDuration()

NvsAnimatedSticker::setAnimatedStickerInAnimationDuration (   inAnimationDurationInMS)
inline

设置动画贴纸入动画持续时间。

参数
{Number}inAnimationDurationInMS 入动画持续时间（以毫秒为单位）
返回
{void}

◆ setAnimatedStickerOutAnimationDuration()

NvsAnimatedSticker::setAnimatedStickerOutAnimationDuration (   outAnimationDurationInMS)
inline

设置动画贴纸出动画持续时间。

参数
{Number}outAnimationDurationInMS 以毫秒为单位的出动画持续时间
返回
{void}

◆ setCurrentKeyFrameTime()

NvsAnimatedSticker::setCurrentKeyFrameTime (   time)
inline

设置当前关键帧时间

参数
{Number}time 时间
返回
{void}

◆ setHorizontalFlip()

NvsAnimatedSticker::setHorizontalFlip (   flip)
inline

设置水平翻转

参数
{Boolean}flip 翻转
返回
{void}

◆ setOpacity()

NvsAnimatedSticker::setOpacity (   opacity)
inline

设置不透明度

参数
{Number}opacity 不透明度值
返回
{void}

◆ setRotationZ()

NvsAnimatedSticker::setRotationZ (   angle)
inline

设置Z方向旋转

参数
{Number}angle 角度
返回
{void}

◆ setScale()

NvsAnimatedSticker::setScale (   scale)
inline

设置缩放

参数
{Number}scale 缩放值
返回
{void}

◆ setSeperatedScaleX()

NvsAnimatedSticker::setSeperatedScaleX (   seperatedScaleX)
inline

设置分离式水平缩放因子

参数
{Number}seperatedScaleX 分离式水平缩放因子
返回
{void}

◆ setSeperatedScaleY()

NvsAnimatedSticker::setSeperatedScaleY (   seperatedScaleY)
inline

设置分离式垂直缩放因子

参数
{Number}seperatedScaleY 分离式垂直缩放因子
返回
{void}

◆ setTranslation()

NvsAnimatedSticker::setTranslation (   translation)
inline

设置转场

参数
{PointF}translation 转场
返回
{void}
参见
PointF

◆ setVerticalFlip()

NvsAnimatedSticker::setVerticalFlip (   flip)
inline

设置垂直翻转

参数
{Boolean}flip 翻转
返回
{void} 设置动画贴纸的垂直翻转。。

◆ setVolumeGain()

NvsAnimatedSticker::setVolumeGain (   leftVolumeGain,
  rightVolumeGain 
)
inline

设置音量增益

参数
{Number}leftVolumeGain 左音量增益
{Number}rightVolumeGain 右音量增益
返回
{void}

◆ setZValue()

NvsAnimatedSticker::setZValue (   value)
inline

设置Z值

参数
{Number}value Z值大小
返回
{} 设置贴纸Z值。Z值越高，贴纸越高。

◆ translateAnimatedSticker()

NvsAnimatedSticker::translateAnimatedSticker (   translationOffset)
inline

转场动画贴纸

参数
{PointF}translationOffset 转场偏移量
返回
{void}
参见
PointF
该类的文档由以下文件生成:
制作者 doxygen 1.9.1