美摄SDK For Android  3.14.0
Public 成员函数 | 所有成员列表
com.meicam.sdk.NvsCaptureAnimatedSticker类 参考

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

类 com.meicam.sdk.NvsCaptureAnimatedSticker 继承关系图:
com.meicam.sdk.NvsAnimatedSticker com.meicam.sdk.NvsFx com.meicam.sdk.NvsObject

Public 成员函数

long getOffsetPoint ()
 获取动画贴纸的偏移时间 更多...
 
long getDuration ()
 获取动画贴纸的持续时间 更多...
 
long changeOffsetPoint (long newOffset)
 改变动画贴纸的相对偏移时间 相对偏移时间是相对于添加动画贴纸时候的采集时间。 更多...
 
long changeDuration (long newOutPoint)
 改变动画贴纸持续时间 更多...
 
void setStartTime (long startTime)
 设置动画贴纸的起始时间 更多...
 
void resetStartTime ()
 重置动画贴纸的起始时间 更多...
 
- Public 成员函数 继承自 com.meicam.sdk.NvsAnimatedSticker
String getAnimatedStickerPackageId ()
 获取动画贴纸包ID 更多...
 
void setScale (float scale)
 设置动画贴纸的缩放比例,该函数设置的缩放比例不叠加 更多...
 
float getScale ()
 获取动画贴纸的缩放值 更多...
 
void setHorizontalFlip (boolean flip)
 设置动画贴纸的水平翻转 更多...
 
boolean getHorizontalFlip ()
 获取动画贴纸的水平翻转状态 更多...
 
void setVerticalFlip (boolean flip)
 设置动画贴纸的竖直翻转 更多...
 
boolean getVerticalFlip ()
 获取动画贴纸的竖直翻转状态 更多...
 
void setRotationZ (float angle)
 设置动画贴纸沿Z轴顺时针旋转的角度值,Z轴垂直于屏幕,该函数设置的旋转角度不叠加 更多...
 
float getRotationZ ()
 获取动画贴纸沿Z轴顺时针旋转的角度值,Z轴垂直于屏幕 更多...
 
void setTranslation (PointF translation)
 设置动画贴纸在时间线坐标系下的平移坐标,该函数设置的平移坐标不叠加。请参见时间线与视图坐标 更多...
 
PointF getTranslation ()
 获取动画贴纸在时间线坐标系下的平移坐标 更多...
 
void translateAnimatedSticker (PointF translationOffset)
 在时间线坐标系下平移动画贴纸,该函数设置的平移坐标可叠加 更多...
 
void scaleAnimatedSticker (float scaleFactor, PointF anchor)
 以锚点为中心缩放动画贴纸,该函数设置的缩放值可叠加 更多...
 
void rotateAnimatedSticker (float angle, PointF anchor)
 以锚点为中心旋转动画贴纸,该函数设置的旋转角度可叠加 更多...
 
void rotateAnimatedSticker (float angle)
 以动画贴纸中心点为锚点旋转动画贴纸,该函数设置的旋转角度可叠加 更多...
 
RectF getOriginalBoundingRect ()
 获取动画贴纸在时间线坐标系下的原始包络框。请参见时间线与视图坐标 更多...
 
List< PointF > getBoundingRectangleVertices ()
 获取动画贴纸在时间线坐标系下原始包络框的顶点位置。请参见时间线与视图坐标 更多...
 
boolean isPanoramic ()
 判断当前动画贴纸是否为全景图动画贴纸 更多...
 
void setCenterPolarAngle (float centerPolarAngle)
 对动画贴纸设置中心点的极角。只对全景图动画贴纸有效 更多...
 
float getCenterPolarAngle ()
 获取动画贴纸中心点的极角。只对全景图动画贴纸有效 更多...
 
void setCenterAzimuthAngle (float centerAzimuthAngle)
 对动画贴纸设置中心点的方位角。只对全景图动画贴纸有效 更多...
 
float getCenterAzimuthAngle ()
 获取动画贴纸中心点的方位角。只对全景图动画贴纸有效 更多...
 
void setPolarAngleRange (float polarAngleRange)
 对动画贴纸设置极角的张角。只对全景图动画贴纸有效 更多...
 
float getPolarAngleRange ()
 获取动画贴纸极角的张角。只对全景图动画贴纸有效 更多...
 
float getOrthoAngleRange ()
 获取动画贴纸与极角垂直的张角。只对全景图动画贴纸有效 更多...
 
void setZValue (float value)
 设置贴纸Z值。Z值越大,贴纸越处于上层 更多...
 
float getZValue ()
 获取贴纸Z值 更多...
 
boolean hasAudio ()
 查询贴纸是否含有音频 更多...
 
void setVolumeGain (float leftVolumeGain, float rightVolumeGain)
 设置贴纸音量 更多...
 
NvsVolume getVolumeGain ()
 获取音量 更多...
 
long getDefaultDuration ()
 获取贴纸默认长度 更多...
 
void setOpacity (float opacity)
 设置贴纸透明度 更多...
 
float getOpacity ()
 获取透明度 更多...
 
void setCurrentKeyFrameTime (long time)
 设置贴纸的关键帧时间 更多...
 
boolean setControlPoint (String fxParam, NvsControlPointPair controlPointPair)
 设置贴纸的关键帧控制点对 更多...
 
NvsControlPointPair getControlPoint (String fxParam)
 返回关键帧控制点对 更多...
 
String getAnimatedStickerPeriodAnimationPackageId ()
 获得动画贴纸循环动画样式包裹ID 更多...
 
String getAnimatedStickerInAnimationPackageId ()
 获得动画贴纸入动画样式包裹ID 更多...
 
String getAnimatedStickerOutAnimationPackageId ()
 获得动画贴纸出动画样式包裹ID 更多...
 
boolean applyAnimatedStickerPeriodAnimation (String animatedStickerPeriodAnimationPackageId)
 运用动画贴纸循环动画样式包 更多...
 
boolean applyAnimatedStickerInAnimation (String animatedStickerInAnimationPackageId)
 运用动画贴纸入动画样式包。注意:如果已经应用了循环动画样式包,需要先把循环动画设置为null,否则不生效 更多...
 
boolean applyAnimatedStickerOutAnimation (String animatedStickerOutAnimationPackageId)
 运用贴纸动画出动画样式包. 注意:如果已经应用了循环动画样式包,需要先把循环动画设置为null,否则不生效 更多...
 
void setAnimatedStickerAnimationPeriod (int periodInMS)
 设置动画贴纸循环动画的周期 更多...
 
int getAnimatedStickerAnimationPeriod ()
 获取动画贴纸循环动画的周期 更多...
 
void setAnimatedStickerInAnimationDuration (int inAnimationDurationInMS)
 设置动画贴纸入动画的时长 更多...
 
int getAnimatedStickerInAnimationDuration ()
 获取动画贴纸入动画的时长 更多...
 
void setAnimatedStickerOutAnimationDuration (int outAnimationDurationInMS)
 设置动画贴纸出动画的时长 更多...
 
int getAnimatedStickerOutAnimationDuration ()
 获取动画贴纸出动画的时长 更多...
 
void setSeperatedScaleX (float scaleX)
 设置动画贴纸的分离式水平缩放比例。 更多...
 
float getSeperatedScaleX ()
 获取动画贴纸的分离式水平缩放比例。 更多...
 
void setSeperatedScaleY (float scaleY)
 设置动画贴纸的分离式垂直缩放比例。 更多...
 
float getSeperatedScaleY ()
 获取动画贴纸的分离式垂直缩放比例。 更多...
 
void enableSeparateProgressMode (boolean enable)
 设置开启将特效参数与进程分离模式。 更多...
 
boolean isSeparateProgressModeEnabled ()
 获取是否开启将特效参数与进程分离模式。 更多...
 
- Public 成员函数 继承自 com.meicam.sdk.NvsFx
NvsFxDescription getDescription ()
 获取特效的描述 更多...
 
void setIntVal (String fxParam, int val)
 设置特效的整数参数值 更多...
 
int getIntVal (String fxParam)
 获得特效的整数参数值 更多...
 
void setIntValAtTime (String fxParam, int val, long time)
 设置指定时间点上特效的整数参数值 更多...
 
int getIntValAtTime (String fxParam, long time)
 获得指定时间点上特效的整数参数值 更多...
 
void setFloatVal (String fxParam, double val)
 设置特效的浮点数参数值 更多...
 
double getFloatVal (String fxParam)
 获得特效浮点数参数值 更多...
 
void setFloatValAtTime (String fxParam, double val, long time)
 设置指定时间点上特效的浮点数参数值 更多...
 
double getFloatValAtTime (String fxParam, long time)
 获得指定时间点上特效浮点数参数值 更多...
 
void setBooleanVal (String fxParam, boolean val)
 设置特效布尔值参数值 更多...
 
boolean getBooleanVal (String fxParam)
 获得特效的布尔值参数值 更多...
 
void setBooleanValAtTime (String fxParam, boolean val, long time)
 设置指点时间点上特效布尔值参数值 更多...
 
boolean getBooleanValAtTime (String fxParam, long time)
 获得特效的布尔值参数值 更多...
 
void setStringVal (String fxParam, String val)
 设置特效字符串参数值 更多...
 
String getStringVal (String fxParam)
 获得特效字符串参数值 更多...
 
void setStringValAtTime (String fxParam, String val, long time)
 设置指定时间点上特效字符串参数值 更多...
 
String getStringValAtTime (String fxParam, long time, int flags)
 获得指定时间点上特效字符串参数值 更多...
 
void setColorVal (String fxParam, NvsColor val)
 设置特效颜色值参数值 更多...
 
NvsColor getColorVal (String fxParam)
 获得特效颜色值参数值 更多...
 
void setColorValAtTime (String fxParam, NvsColor val, long time)
 设置特效颜色值参数值 更多...
 
NvsColor getColorValAtTime (String fxParam, long time)
 获得特效颜色值参数值 更多...
 
void setPosition2DVal (String fxParam, NvsPosition2D val)
 设置特效二维坐标参数值 更多...
 
NvsPosition2D getPosition2DVal (String fxParam)
 获得特效二维坐标参数值 更多...
 
void setPosition2DValAtTime (String fxParam, NvsPosition2D val, long time)
 设置特效二维坐标参数值 更多...
 
NvsPosition2D getPosition2DValAtTime (String fxParam, long time)
 获得特效二维坐标参数值 更多...
 
void setPosition3DVal (String fxParam, NvsPosition3D val)
 设置特效三维坐标参数值 更多...
 
NvsPosition3D getPosition3DVal (String fxParam)
 获得特效三维坐标参数值 更多...
 
void setPosition3DValAtTime (String fxParam, NvsPosition3D val, long time)
 设置特效三维坐标参数值 更多...
 
NvsPosition3D getPosition3DValAtTime (String fxParam, long time)
 获得特效三维坐标参数值 更多...
 
void setMenuVal (String fxParam, String val)
 设置特效菜单参数值 更多...
 
String getMenuVal (String fxParam)
 获得特效菜单参数值 更多...
 
void setMenuValAtTime (String fxParam, String val, long time)
 设置特效菜单参数值 更多...
 
String getMenuValAtTime (String fxParam, long time)
 获得特效菜单参数值 更多...
 
void setArbDataVal (String fxParam, NvsArbitraryData val)
 设置自定义数据参数值 更多...
 
NvsArbitraryData getArbDataVal (String fxParam)
 返回自定义数据参数值 更多...
 
void setArbDataValAtTime (String fxParam, NvsArbitraryData val, long time)
 设置自定义数据参数值 更多...
 
NvsArbitraryData getArbDataValAtTime (String fxParam, NvsArbitraryData val, long time)
 返回自定义数据参数值 更多...
 
boolean removeKeyframeAtTime (String fxParam, long time)
 删除参数指定时间点的关键帧 更多...
 
boolean removeAllKeyframe (String fxParam)
 删除参数的所有关键帧 更多...
 
boolean hasKeyframeList (String fxParam)
 当前参数是否有关键帧列表 更多...
 
long findKeyframeTime (String fxParam, long time, int flags)
 获取指定时间点附近的关键帧 更多...
 
boolean setKeyFrameControlPoint (String fxParam, long time, NvsControlPointPair controlPointPair)
 设置关键帧控制点对 更多...
 
NvsControlPointPair getKeyFrameControlPoint (String fxParam, long time)
 返回关键帧控制点对 更多...
 
boolean setKeyFrameControlPointMode (String fxParam, long time, NvsControlPointModePair controlPointModePair)
 设置关键帧控制点模式对 更多...
 
NvsControlPointModePair getKeyFrameControlPointMode (String fxParam, long time)
 返回关键帧控制点模式对 更多...
 
void setFilterIntensity (float intensity)
 设置滤镜的强度 更多...
 
float getFilterIntensity ()
 获得滤镜的强度 更多...
 
void setFilterMask (boolean useMask)
 设置滤镜遮罩 更多...
 
boolean getFilterMask ()
 获得是否使用滤镜遮罩 更多...
 
void setRegional (boolean isRegional)
 设置滤镜是否为局部滤镜 更多...
 
boolean getRegional ()
 获得滤镜是否为局部滤镜 更多...
 
void setIgnoreBackground (boolean isIgnoreBackground)
 设置局部滤镜是否消除背景 更多...
 
boolean getIgnoreBackground ()
 获得局部滤镜是否消除背景 更多...
 
void setInverseRegion (boolean isInverseRegion)
 设置局部滤镜是否反选区域 更多...
 
boolean getInverseRegion ()
 获得局部滤镜是否反选区域 更多...
 
void setRegion (float[] region)
 设置局部滤镜的控制范围 更多...
 
float[] getRegion ()
 获取局部滤镜的控制范围 更多...
 
void setRegionInfo (NvsMaskRegionInfo info)
 设置局部滤镜的蒙版区域信息 更多...
 
NvsMaskRegionInfo getRegionInfo ()
 获取局部滤镜的蒙版区域信息 更多...
 
void setRegionInfoAtTime (NvsMaskRegionInfo info, long time)
 设置指定时间点局部滤镜的蒙版区域信息 更多...
 
NvsMaskRegionInfo getRegionInfoAtTime (long time)
 获取指定时间点局部滤镜的模板区域信息 更多...
 
void setRegionalFeatherWidth (float featherWidth)
 设置局部滤镜的羽化宽度 更多...
 
float getRegionalFeatherWidth ()
 获得局部滤镜的羽化宽度 更多...
 
void setRegionalFeatherWidthAtTime (float featherWidth, long time)
 设置指定时间点局部滤镜的羽化宽度 更多...
 
float getRegionalFeatherWidthAtTime (long time)
 获得指定时间点局部滤镜的羽化宽度 更多...
 
void setRegionCoordinateSystemType (int type)
 设置局部滤镜所在坐标系类型,默认为NDC坐标系 更多...
 
int getRegionCoordinateSystemType ()
 获得局部滤镜所在坐标系类型 更多...
 
NvsParticleSystemContext getParticleSystemContext ()
 获得粒子特效上下文对象。请参见NvsParticleSystemContext 更多...
 
NvsARFaceContext getARFaceContext ()
 获得人脸特效上下文对象。请参见NvsARFaceContext 更多...
 
NvsPaintingEffectContext getPaintingEffectContext ()
 获得手绘特效上下文对象。请参见NvsPaintingEffectContext 更多...
 
NvsARSceneManipulate getARSceneManipulate ()
 获得AR场景操作对象。请参见NvsARSceneManipulate 更多...
 
void setExprVar (String varName, double varValue)
 设置表达式中定义参数的值 更多...
 
double getExprVar (String varName)
 获得表达式中定义参数的值 更多...
 
void setExprStringVar (String varName, String varValue)
 设置表达式中定义参数的值 更多...
 
String getExprStringVar (String varName)
 获得表达式中定义参数的值 更多...
 
void setExprObjectVar (String varName, Object varValue)
 设置表达式中定义参数的值 更多...
 
Object getExprObjectVar (String varName)
 获得表达式中定义参数的值 更多...
 
void clearExprVar (String varName)
 清空表达式中定义参数的值,并设置为默认值0 更多...
 
void clearExprVarCtx ()
 清空表达式中定义的全部参数的值,并设置为默认值0 更多...
 
- Public 成员函数 继承自 com.meicam.sdk.NvsObject
void setAttachment (String key, Object value)
 为NvsObject对象添加附加的数据,用来标识NvsObject的对象或者其他用途 更多...
 
void setTemplateAttachment (String key, String value)
 为NvsObject对象添加模板资源的附加数据,用来标识NvsObject的模板数据 更多...
 
Object getAttachment (String key)
 获取NvsObject的附件 更多...
 
String getTemplateAttachment (String key)
 获取NvsObject的模板资源附件 更多...
 

额外继承的成员函数

- 静态 Public 属性 继承自 com.meicam.sdk.NvsFx
static final int KEY_FRAME_FIND_MODE_INPUT_TIME_BEFORE = 1
 查找当前时间点之前的关键帧 更多...
 
static final int KEY_FRAME_FIND_MODE_INPUT_TIME_AFTER = 2
 
static final int REGION_COORDINATE_SYSTEM_TYPE_NDC = 0
 NDC坐标系 更多...
 
static final int REGION_COORDINATE_SYSTEM_TYPE_TIMELINE = 1
 
static final int FACE_WARP_EFFECT_STRATEGY_CUSTOM = 0x7FFFFFFF
 
- 静态 Public 属性 继承自 com.meicam.sdk.NvsObject
static final String TEMPLATE_KEY_REPLACE_ID = "MSTemplate-ReplaceId"
 
static final String TEMPLATE_KEY_FOOTAGE_CAN_REPLACE = "MSTemplate-FootageCanReplace"
 
static final String TEMPLATE_KEY_FOOTAGE_ID = "MSTemplate-FootageId"
 
static final String TEMPLATE_KEY_FOOTAGE_NAME = "MSTemplate-FootageName"
 
static final String TEMPLATE_KEY_FOOTAGE_M3U8_NAME = "MSTemplate-FootageM3U8Name"
 
static final String TEMPLATE_KEY_FOOTAGE_TAGS = "MSTemplate-FootageTags"
 
static final String TEMPLATE_KEY_FOOTAGE_TYPE = "MSTemplate-FootageType"
 
static final String TEMPLATE_KEY_FOOTAGE_NEED_REVERSE = "MSTemplate-FootageNeedReverse"
 
static final String TEMPLATE_KEY_CLIP_RAW_WIDTH = "MSTemplate-ClipRawWidth"
 
static final String TEMPLATE_KEY_CLIP_RAW_HEIGHT = "MSTemplate-ClipRawHeight"
 
static final String TEMPLATE_KEY_VOLUME_TYPE = "MSTemplate-VolumeType"
 
static final String TEMPLATE_KEY_FX_GROUP = "MSTemplate-FxGroup"
 
static final String TEMPLATE_KEY_BEST_SEEK_TIME = "MSTemplate-BestSeekTime"
 
static final String TEMPLATE_KEY_MASK_TYPE = "MSTemplate-MaskType"
 
static final String TEMPLATE_VALUE_MASK_TYPE_LINE = "MSTemplate-MaskType-Line"
 
static final String TEMPLATE_VALUE_MASK_TYPE_MIRROR = "MSTemplate-MaskType-Mirror"
 
static final String TEMPLATE_VALUE_MASK_TYPE_CIRCLE = "MSTemplate-MaskType-Circle"
 
static final String TEMPLATE_VALUE_MASK_TYPE_RECT = "MSTemplate-MaskType-Rect"
 
static final String TEMPLATE_VALUE_MASK_TYPE_HEART = "MSTemplate-MaskType-Heart"
 
static final String TEMPLATE_VALUE_MASK_TYPE_STAR = "MSTemplate-MaskType-Star"
 
static final String TEMPLATE_KEY_TRANS_TYPE_CUT = "MSTemplate-TransType-Cut"
 
static final String TEMPLATE_KEY_CURVE_SPEED_TYPE = "MSTemplate-CurveSpeedType"
 
static final String TEMPLATE_VALUE_CURVE_SPEED_TYPE_CUSTOM = "MSTemplate-CurveSpeedType-Custom"
 
static final String TEMPLATE_VALUE_CURVE_SPEED_TYPE_MONTAGE = "MSTemplate-CurveSpeedType-Montage"
 
static final String TEMPLATE_VALUE_CURVE_SPEED_TYPE_HERO = "MSTemplate-CurveSpeedType-Hero"
 
static final String TEMPLATE_VALUE_CURVE_SPEED_TYPE_BULLET = "MSTemplate-CurveSpeedType-bullet"
 
static final String TEMPLATE_VALUE_CURVE_SPEED_TYPE_PLUS = "MSTemplate-CurveSpeedType-Plus"
 
static final String TEMPLATE_VALUE_CURVE_SPEED_TYPE_IN = "MSTemplate-CurveSpeedType-In"
 
static final String TEMPLATE_VALUE_CURVE_SPEED_TYPE_OUT = "MSTemplate-CurveSpeedType-Out"
 
- Protected 成员函数 继承自 com.meicam.sdk.NvsObject
void setInternalObject (long internalObject)
 
long getInternalObject ()
 
- Protected 属性 继承自 com.meicam.sdk.NvsObject
long m_internalObject = 0
 

详细描述

采集动画贴纸类

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

警告
NvsCaptureAnimatedSticker类中,所有public API都在UI线程使用!!!
自从
2.21.0

成员函数说明

◆ changeDuration()

long com.meicam.sdk.NvsCaptureAnimatedSticker.changeDuration ( long  newOutPoint)
inline

改变动画贴纸持续时间

参数
newOutPoint动画贴纸新的期望持续时间(单位微秒)
返回
返回动画贴纸新的持续时间(单位微秒)

◆ changeOffsetPoint()

long com.meicam.sdk.NvsCaptureAnimatedSticker.changeOffsetPoint ( long  newOffset)
inline

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

参数
newOffset新的相对偏移时间(单位微秒)
返回
返回新的相对偏移时间(单位微秒)
参见
changeDuration
getOffsetPoint

◆ getDuration()

long com.meicam.sdk.NvsCaptureAnimatedSticker.getDuration ( )
inline

获取动画贴纸的持续时间

返回
动画贴纸持续时间(单位微秒)
参见
getOffsetPoint
changeDuration

◆ getOffsetPoint()

long com.meicam.sdk.NvsCaptureAnimatedSticker.getOffsetPoint ( )
inline

获取动画贴纸的偏移时间

返回
动画贴纸偏移时间(单位微秒)
参见
getDuration
changeOffsetPoint

◆ resetStartTime()

void com.meicam.sdk.NvsCaptureAnimatedSticker.resetStartTime ( )
inline

重置动画贴纸的起始时间

◆ setStartTime()

void com.meicam.sdk.NvsCaptureAnimatedSticker.setStartTime ( long  startTime)
inline

设置动画贴纸的起始时间

自从
3.4.0

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