com.meicam.sdk.NvsFx类 参考

特效类 更多...

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

Public 成员函数
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 属性
关键帧查找方式
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

详细描述

特效类

特效类是视频特效(Video Fx)，音频特效(Audio Fx)，音频转场(Audio Transition)，视频转场(Video Transition)等不同类型特效的基类。 在SDK框架中，特效是很关键的一部分，派生自NvsFx的每种不同类型的特效，或通过片段实例，或时间线实例，或轨道实例来添加，移除和获取。 同时，特效类中提供了不同的API接口来设置和获取特效参数类型。

警告

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

成员函数说明

clearExprVar()

void com.meicam.sdk.NvsFx.clearExprVar ( String  varName )

inline

清空表达式中定义参数的值，并设置为默认值0

参数

varName

表达式中定义的参数

自从

2.16.1

clearExprVarCtx()

void com.meicam.sdk.NvsFx.clearExprVarCtx ( )

inline

清空表达式中定义的全部参数的值，并设置为默认值0

自从

2.16.1

findKeyframeTime()

long com.meicam.sdk.NvsFx.findKeyframeTime ( String  fxParam, long  time, int  flags  )

inline

获取指定时间点附近的关键帧

参数

fxParam	特效的数据参数
time	时间点 (单位为微秒).
flags	查找标志位，请参见KEY_FRAME_FIND_MODE.

返回

返回离指定时间点最近的关键帧的时间位置，如果没有找到返回-1

被 com.meicam.sdk.NvsCompoundCaption 重载.

getArbDataVal()

NvsArbitraryData com.meicam.sdk.NvsFx.getArbDataVal ( String  fxParam )

inline

返回自定义数据参数值

参数

fxParam

特效的自定义数据参数的类型

返回

返回获得的自定义数据

参见

setArbDataVal

getArbDataValAtTime()

NvsArbitraryData com.meicam.sdk.NvsFx.getArbDataValAtTime ( String  fxParam, NvsArbitraryData  val, long  time  )

inline

返回自定义数据参数值

参数

fxParam	特效的自定义数据参数的类型
time	时间点

返回

返回获得的自定义数据

参见

setArbDataValAtTime

getARFaceContext()

NvsARFaceContext com.meicam.sdk.NvsFx.getARFaceContext ( )

inline

获得人脸特效上下文对象。请参见NvsARFaceContext

返回

返回人脸特效上下文对象

getARSceneManipulate()

NvsARSceneManipulate com.meicam.sdk.NvsFx.getARSceneManipulate ( )

inline

获得AR场景操作对象。请参见NvsARSceneManipulate

返回

返回AR场景操作对象

getBooleanVal()

boolean com.meicam.sdk.NvsFx.getBooleanVal ( String  fxParam )

inline

获得特效的布尔值参数值

参数

fxParam

特效的布尔值参数的类型。请参见PARAM_TYPE_BOOL

返回

返回获得的布尔值

参见

setBooleanVal

getBooleanValAtTime()

boolean com.meicam.sdk.NvsFx.getBooleanValAtTime ( String  fxParam, long  time  )

inline

获得特效的布尔值参数值

参数

fxParam	特效的布尔值参数的类型。请参见PARAM_TYPE_BOOL
time	时间点 (单位为微秒).

返回

返回获得的布尔值

参见

setBooleanValAtTime

getColorVal()

NvsColor com.meicam.sdk.NvsFx.getColorVal ( String  fxParam )

inline

获得特效颜色值参数值

参数

fxParam

特效的颜色参数的类型。请参见PARAM_TYPE_COLOR

返回

返回获得的自定义颜色NvsColor对象

参见

setColorVal

getColorValAtTime()

NvsColor com.meicam.sdk.NvsFx.getColorValAtTime ( String  fxParam, long  time  )

inline

获得特效颜色值参数值

参数

fxParam	特效的颜色参数的类型。请参见PARAM_TYPE_COLOR
time	时间点 (单位为微秒).

返回

返回获得的自定义颜色NvsColor对象

参见

setColorValAtTime

getDescription()

NvsFxDescription com.meicam.sdk.NvsFx.getDescription ( )

inline

获取特效的描述

返回

返回特效的描述对象

getExprObjectVar()

Object com.meicam.sdk.NvsFx.getExprObjectVar ( String  varName )

inline

获得表达式中定义参数的值

参数

varName

表达式中定义的参数

返回

返回表达式中定义参数的值

参见

setExprStringVar

自从

3.5.2

getExprStringVar()

String com.meicam.sdk.NvsFx.getExprStringVar ( String  varName )

inline

获得表达式中定义参数的值

参数

varName

表达式中定义的参数

返回

返回表达式中定义参数的值

参见

setExprStringVar

自从

2.16.1

getExprVar()

double com.meicam.sdk.NvsFx.getExprVar ( String  varName )

inline

获得表达式中定义参数的值

参数

varName

表达式中定义的参数

返回

返回表达式中定义参数的值

参见

setExprVar

自从

2.16.1

getFilterIntensity()

float com.meicam.sdk.NvsFx.getFilterIntensity ( )

inline

获得滤镜的强度

返回

返回滤镜的强度值

参见

setFilterIntensity

自从

2.0.2

getFilterMask()

boolean com.meicam.sdk.NvsFx.getFilterMask ( )

inline

获得是否使用滤镜遮罩

返回

返回是否使用了滤镜遮罩

参见

setFilterMask

自从

2.14.1

getFloatVal()

double com.meicam.sdk.NvsFx.getFloatVal ( String  fxParam )

inline

获得特效浮点数参数值

参数

fxParam

特效的浮点数参数的类型。请参见PARAM_TYPE_FLOAT

返回

返回获得的double值

参见

setFloatVal

getFloatValAtTime()

double com.meicam.sdk.NvsFx.getFloatValAtTime ( String  fxParam, long  time  )

inline

获得指定时间点上特效浮点数参数值

参数

fxParam	特效的浮点数参数的类型。请参见PARAM_TYPE_FLOAT
time	时间点 (单位为微秒).

返回

返回获得的double值

参见

setFloatValAtTime

getIgnoreBackground()

boolean com.meicam.sdk.NvsFx.getIgnoreBackground ( )

inline

获得局部滤镜是否消除背景

返回

返回局部滤镜是否消除背景

参见

setIgnoreBackground

自从

2.15.1

getIntVal()

int com.meicam.sdk.NvsFx.getIntVal ( String  fxParam )

inline

获得特效的整数参数值

参数

fxParam

特效的整数参数的类型。请参见PARAM_TYPE_INT

返回

返回获得的整数值

参见

setIntVal

getIntValAtTime()

int com.meicam.sdk.NvsFx.getIntValAtTime ( String  fxParam, long  time  )

inline

获得指定时间点上特效的整数参数值

参数

fxParam	特效的整数参数的类型。请参见PARAM_TYPE_INT
time	时间点 (单位为微秒).

返回

返回获得的整数值

参见

setIntValAtTime

getInverseRegion()

boolean com.meicam.sdk.NvsFx.getInverseRegion ( )

inline

获得局部滤镜是否反选区域

返回

返回局部滤镜是否反选区域

参见

setInverseRegion

自从

2.15.1

getKeyFrameControlPoint()

NvsControlPointPair com.meicam.sdk.NvsFx.getKeyFrameControlPoint ( String  fxParam, long  time  )

inline

返回关键帧控制点对

参数

fxParam	特效的自定义数据参数的类型
time	时间点 (单位为微秒)

返回

返回获得的控制点信息。

参见

setKeyFrameControlPoint

自从

2.21.0

getKeyFrameControlPointMode()

NvsControlPointModePair com.meicam.sdk.NvsFx.getKeyFrameControlPointMode ( String  fxParam, long  time  )

inline

返回关键帧控制点模式对

参数

fxParam	特效的自定义数据参数的类型
time	时间点 (单位为微秒)

返回

返回获得的控制点模式信息。

参见

setKeyFrameControlPointMode

自从

3.6.0

getMenuVal()

String com.meicam.sdk.NvsFx.getMenuVal ( String  fxParam )

inline

获得特效菜单参数值

参数

fxParam

特效的菜单参数的类型。请参见PARAM_TYPE_MENU

返回

返回获得的菜单

参见

setMenuVal

getMenuValAtTime()

String com.meicam.sdk.NvsFx.getMenuValAtTime ( String  fxParam, long  time  )

inline

获得特效菜单参数值

参数

fxParam	特效的菜单参数的类型。请参见PARAM_TYPE_MENU
time	时间点 (单位为微秒).

返回

返回获得的菜单

参见

setMenuValAtTime

getPaintingEffectContext()

NvsPaintingEffectContext com.meicam.sdk.NvsFx.getPaintingEffectContext ( )

inline

获得手绘特效上下文对象。请参见NvsPaintingEffectContext

返回

返回手绘特效上下文对象

自从

2.2.0

getParticleSystemContext()

NvsParticleSystemContext com.meicam.sdk.NvsFx.getParticleSystemContext ( )

inline

获得粒子特效上下文对象。请参见NvsParticleSystemContext

返回

返回粒子特效上下文的对象

getPosition2DVal()

NvsPosition2D com.meicam.sdk.NvsFx.getPosition2DVal ( String  fxParam )

inline

获得特效二维坐标参数值

参数

fxParam

特效的二维坐标参数的类型。请参见PARAM_TYPE_POSITION2D

返回

返回获得的二维坐标NvPosition2D对象

参见

setPosition2DVal

getPosition3DVal

getPosition2DValAtTime()

NvsPosition2D com.meicam.sdk.NvsFx.getPosition2DValAtTime ( String  fxParam, long  time  )

inline

获得特效二维坐标参数值

参数

fxParam	特效的二维坐标参数的类型。请参见PARAM_TYPE_POSITION2D
time	时间点 (单位为微秒).

返回

返回获得的二维坐标NvPosition2D对象

参见

setPosition2DValAtTime

getPosition3DValAtTime

getPosition3DVal()

NvsPosition3D com.meicam.sdk.NvsFx.getPosition3DVal ( String  fxParam )

inline

获得特效三维坐标参数值

参数

fxParam

特效的三维坐标参数的类型。请参见PARAM_TYPE_POSITION3D

返回

返回获得的三维坐标NvsPosition3D对象

参见

setPosition3DVal

getPosition2DVal

getPosition3DValAtTime()

NvsPosition3D com.meicam.sdk.NvsFx.getPosition3DValAtTime ( String  fxParam, long  time  )

inline

获得特效三维坐标参数值

参数

fxParam	特效的三维坐标参数的类型。请参见PARAM_TYPE_POSITION3D
time	时间点 (单位为微秒).

返回

返回获得的三维坐标NvsPosition3D对象

参见

setPosition3DValAtTime

getPosition2DValAtTime

getRegion()

float [] com.meicam.sdk.NvsFx.getRegion ( )

inline

获取局部滤镜的控制范围

返回

获取局部滤镜的控制范围, 由一系列连续的点构成，点的坐标在NDC坐标系中。

参见

setRegion

自从

2.16.1

getRegional()

boolean com.meicam.sdk.NvsFx.getRegional ( )

inline

获得滤镜是否为局部滤镜

返回

返回滤镜是否为局部滤镜

参见

setRegional

自从

2.10.1

getRegionalFeatherWidth()

float com.meicam.sdk.NvsFx.getRegionalFeatherWidth ( )

inline

获得局部滤镜的羽化宽度

返回

返回局部滤镜的羽化宽度

参见

setRegionalFeatherWidth

自从

2.10.1

getRegionalFeatherWidthAtTime()

float com.meicam.sdk.NvsFx.getRegionalFeatherWidthAtTime ( long  time )

inline

获得指定时间点局部滤镜的羽化宽度

参数

time

时间点

返回

返回指定时间点局部滤镜的羽化宽度

参见

setRegionalFeatherWidthAtTime

自从

2.16.1

getRegionCoordinateSystemType()

int com.meicam.sdk.NvsFx.getRegionCoordinateSystemType ( )

inline

获得局部滤镜所在坐标系类型

返回

返回局部滤镜所在坐标系类型

参见

setRegionCoordinateSystemType

自从

2.16.1

getRegionInfo()

NvsMaskRegionInfo com.meicam.sdk.NvsFx.getRegionInfo ( )

inline

获取局部滤镜的蒙版区域信息

返回

返回局部滤镜的蒙版区域信息

参见

setRegionInfo

自从

2.16.0

getRegionInfoAtTime()

NvsMaskRegionInfo com.meicam.sdk.NvsFx.getRegionInfoAtTime ( long  time )

inline

获取指定时间点局部滤镜的模板区域信息

返回

返回指定时间点滤镜的模板区域信息

参见

setRegionInfoAtTime

自从

2.16.0

getStringVal()

String com.meicam.sdk.NvsFx.getStringVal ( String  fxParam )

inline

获得特效字符串参数值

参数

fxParam

特效的字符串参数的类型。请参见PARAM_TYPE_STRING

返回

返回获得的字符串

参见

setStringVal

getStringValAtTime()

String com.meicam.sdk.NvsFx.getStringValAtTime ( String  fxParam, long  time, int  flags  )

inline

获得指定时间点上特效字符串参数值

参数

fxParam	特效的字符串参数的类型。请参见PARAM_TYPE_STRING
time	时间点 (单位为微秒).

返回

返回获得的字符串

参见

setStringValAtTime

hasKeyframeList()

boolean com.meicam.sdk.NvsFx.hasKeyframeList ( String  fxParam )

inline

当前参数是否有关键帧列表

参数

fxParam

特效的数据参数

返回

返回是否有关键帧列表

被 com.meicam.sdk.NvsCompoundCaption 重载.

removeAllKeyframe()

boolean com.meicam.sdk.NvsFx.removeAllKeyframe ( String  fxParam )

inline

删除参数的所有关键帧

参数

fxParam

特效的数据参数

返回

返回是否执行成功

被 com.meicam.sdk.NvsCompoundCaption 重载.

removeKeyframeAtTime()

boolean com.meicam.sdk.NvsFx.removeKeyframeAtTime ( String  fxParam, long  time  )

inline

删除参数指定时间点的关键帧

参数

fxParam	特效的数据参数
time	时间点 (单位为微秒).

返回

返回是否执行成功

被 com.meicam.sdk.NvsCompoundCaption 重载.

setArbDataVal()

void com.meicam.sdk.NvsFx.setArbDataVal ( String  fxParam, NvsArbitraryData  val  )

inline

设置自定义数据参数值

参数

fxParam	特效的自定义数据参数的类型
val	字符串

参见

getArbDataVal

setArbDataValAtTime()

void com.meicam.sdk.NvsFx.setArbDataValAtTime ( String  fxParam, NvsArbitraryData  val, long  time  )

inline

设置自定义数据参数值

参数

fxParam	特效的自定义数据参数的类型
val	字符串
time	时间点 (单位为微秒).

参见

getArbDataValAtTime

setBooleanVal()

void com.meicam.sdk.NvsFx.setBooleanVal ( String  fxParam, boolean  val  )

inline

设置特效布尔值参数值

参数

fxParam	特效的布尔值参数的类型。请参见PARAM_TYPE_BOOL
val	布尔值

参见

getBooleanVal

setBooleanValAtTime()

void com.meicam.sdk.NvsFx.setBooleanValAtTime ( String  fxParam, boolean  val, long  time  )

inline

设置指点时间点上特效布尔值参数值

参数

fxParam	特效的布尔值参数的类型。请参见PARAM_TYPE_BOOL
val	布尔值
time	时间点 (单位为微秒).

参见

getBooleanValAtTime

setColorVal()

void com.meicam.sdk.NvsFx.setColorVal ( String  fxParam, NvsColor  val  )

inline

设置特效颜色值参数值

参数

fxParam	特效的颜色参数的类型。请参见PARAM_TYPE_COLOR
val	NvsColor自定义颜色对象

参见

getColorVal

setColorValAtTime()

void com.meicam.sdk.NvsFx.setColorValAtTime ( String  fxParam, NvsColor  val, long  time  )

inline

设置特效颜色值参数值

参数

fxParam	特效的颜色参数的类型。请参见PARAM_TYPE_COLOR
val	NvsColor自定义颜色对象
time	时间点 (单位为微秒).

参见

getColorValAtTime

setExprObjectVar()

void com.meicam.sdk.NvsFx.setExprObjectVar ( String  varName, Object  varValue  )

inline

设置表达式中定义参数的值

参数

varName	表达式中定义的参数
varValue	表达式中参数对应的值

参见

getExprStringVar

自从

3.5.2

setExprStringVar()

void com.meicam.sdk.NvsFx.setExprStringVar ( String  varName, String  varValue  )

inline

设置表达式中定义参数的值

参数

varName	表达式中定义的参数
varValue	表达式中参数对应的值

参见

getExprStringVar

自从

2.16.1

setExprVar()

void com.meicam.sdk.NvsFx.setExprVar ( String  varName, double  varValue  )

inline

设置表达式中定义参数的值

参数

varName	表达式中定义的参数
varValue	表达式中参数对应的值

参见

getExprVar

自从

2.16.1

setFilterIntensity()

void com.meicam.sdk.NvsFx.setFilterIntensity ( float  intensity )

inline

设置滤镜的强度

参数

intensity

滤镜强度值，取值范围一般为[0,1]，为0则滤镜无效果，为1则为默认效果

参见

getFilterIntensity

自从

2.0.2

setFilterMask()

void com.meicam.sdk.NvsFx.setFilterMask ( boolean  useMask )

inline

设置滤镜遮罩

参数

useMask

是否使用遮罩。如果使用遮罩，仅在有遮罩的区域添加滤镜效果。

参见

getFilterMask

自从

2.14.1

setFloatVal()

void com.meicam.sdk.NvsFx.setFloatVal ( String  fxParam, double  val  )

inline

设置特效的浮点数参数值

参数

fxParam	特效的浮点数参数的类型。请参见PARAM_TYPE_FLOAT
val	浮点值

参见

getFloatVal

setFloatValAtTime()

void com.meicam.sdk.NvsFx.setFloatValAtTime ( String  fxParam, double  val, long  time  )

inline

设置指定时间点上特效的浮点数参数值

参数

fxParam	特效的浮点数参数的类型。请参见PARAM_TYPE_FLOAT
val	浮点值
time	时间点 (单位为微秒).

参见

getFloatValAtTime

setIgnoreBackground()

void com.meicam.sdk.NvsFx.setIgnoreBackground ( boolean  isIgnoreBackground )

inline

设置局部滤镜是否消除背景

参数

IgnoreBackground

是否为局部滤镜消除背景，true为消除，false不是

参见

getIgnoreBackground

自从

2.15.1

setIntVal()

void com.meicam.sdk.NvsFx.setIntVal ( String  fxParam, int  val  )

inline

设置特效的整数参数值

参数

fxParam	特效的整数参数的类型。请参见PARAM_TYPE_INT
val	整数

参见

getIntVal

setIntValAtTime()

void com.meicam.sdk.NvsFx.setIntValAtTime ( String  fxParam, int  val, long  time  )

inline

设置指定时间点上特效的整数参数值

参数

fxParam	特效的整数参数的类型。请参见PARAM_TYPE_INT
val	整数
time	时间点 (单位为微秒).

参见

getIntValAtTime

setInverseRegion()

void com.meicam.sdk.NvsFx.setInverseRegion ( boolean  isInverseRegion )

inline

设置局部滤镜是否反选区域

参数

isInverseRegion

是否为局部滤镜反选区域，true为反选，false不是

参见

getInverseRegion

自从

2.15.1

setKeyFrameControlPoint()

boolean com.meicam.sdk.NvsFx.setKeyFrameControlPoint ( String  fxParam, long  time, NvsControlPointPair  controlPointPair  )

inline

设置关键帧控制点对

参数

fxParam	特效的自定义数据参数的类型
time	时间点 (单位为微秒)
controlPointPair	控制点对

参见

getKeyFrameControlPoint

自从

2.21.0

setKeyFrameControlPointMode()

boolean com.meicam.sdk.NvsFx.setKeyFrameControlPointMode ( String  fxParam, long  time, NvsControlPointModePair  controlPointModePair  )

inline

设置关键帧控制点模式对

参数

fxParam	特效的自定义数据参数的类型
time	时间点 (单位为微秒)
controlPointModePair	控制点模式对

参见

getKeyFrameControlPointMode

自从

3.6.0

setMenuVal()

void com.meicam.sdk.NvsFx.setMenuVal ( String  fxParam, String  val  )

inline

设置特效菜单参数值

参数

fxParam	特效的菜单参数的类型。请参见PARAM_TYPE_MENU
val	字符串

参见

getMenuVal

setMenuValAtTime()

void com.meicam.sdk.NvsFx.setMenuValAtTime ( String  fxParam, String  val, long  time  )

inline

设置特效菜单参数值

参数

fxParam	特效的菜单参数的类型。请参见PARAM_TYPE_MENU
val	字符串
time	时间点 (单位为微秒).

参见

getMenuValAtTime

setPosition2DVal()

void com.meicam.sdk.NvsFx.setPosition2DVal ( String  fxParam, NvsPosition2D  val  )

inline

设置特效二维坐标参数值

参数

fxParam	特效的二维坐标参数的类型。请参见PARAM_TYPE_POSITION2D
val	二维坐标NvsPosition2D对象

参见

getPosition2DVal

setPosition3DVal

setPosition2DValAtTime()

void com.meicam.sdk.NvsFx.setPosition2DValAtTime ( String  fxParam, NvsPosition2D  val, long  time  )

inline

设置特效二维坐标参数值

参数

fxParam	特效的二维坐标参数的类型。请参见PARAM_TYPE_POSITION2D
val	二维坐标NvsPosition2D对象
time	时间点 (单位为微秒).

参见

getPosition2DValAtTime

setPosition3DValAtTime

setPosition3DVal()

void com.meicam.sdk.NvsFx.setPosition3DVal ( String  fxParam, NvsPosition3D  val  )

inline

设置特效三维坐标参数值

参数

fxParam	特效的三维坐标参数的类型。请参见PARAM_TYPE_POSITION3D
val	三维坐标NvsPosition3D对象

参见

getPosition3DVal

setPosition2DVal

setPosition3DValAtTime()

void com.meicam.sdk.NvsFx.setPosition3DValAtTime ( String  fxParam, NvsPosition3D  val, long  time  )

inline

设置特效三维坐标参数值

参数

fxParam	特效的三维坐标参数的类型。请参见PARAM_TYPE_POSITION3D
val	三维坐标NvsPosition3D对象
time	时间点 (单位为微秒).

参见

getPosition3DValAtTime

setPosition2DValAtTime

setRegion()

void com.meicam.sdk.NvsFx.setRegion ( float[]  region )

inline

设置局部滤镜的控制范围

参数

region

局部滤镜的控制范围, 由一系列连续的点构成，点的坐标在NDC坐标系中

参见

getRegion

自从

2.10.1

setRegional()

void com.meicam.sdk.NvsFx.setRegional ( boolean  isRegional )

inline

设置滤镜是否为局部滤镜

参数

regional

是否为局部滤镜，true为局部滤镜，false不是

参见

getRegional

自从

2.10.1

setRegionalFeatherWidth()

void com.meicam.sdk.NvsFx.setRegionalFeatherWidth ( float  featherWidth )

inline

设置局部滤镜的羽化宽度

参数

featherWidth

局部滤镜的羽化宽度

参见

getRegionalFeatherWidth

自从

2.10.1

setRegionalFeatherWidthAtTime()

void com.meicam.sdk.NvsFx.setRegionalFeatherWidthAtTime ( float  featherWidth, long  time  )

inline

设置指定时间点局部滤镜的羽化宽度

参数

featherWidth	局部滤镜的羽化宽度
time	时间点

参见

getRegionalFeatherWidthAtTime

自从

2.16.1

setRegionCoordinateSystemType()

void com.meicam.sdk.NvsFx.setRegionCoordinateSystemType ( int  type )

inline

设置局部滤镜所在坐标系类型，默认为NDC坐标系

参数

coordinateSystem

局部滤镜所在坐标系，默认是NDC坐标系

参见

getRegionCoordinateSystemType

自从

2.16.1

setRegionInfo()

void com.meicam.sdk.NvsFx.setRegionInfo ( NvsMaskRegionInfo  info )

inline

设置局部滤镜的蒙版区域信息

参数

info	局部滤镜的蒙版区域信息, 构成控制区域的可以是点，贝塞尔曲线或者椭圆，对应的坐标系为NDC坐标系

参见

getRegionInfo

自从

2.16.0

setRegionInfoAtTime()

void com.meicam.sdk.NvsFx.setRegionInfoAtTime ( NvsMaskRegionInfo  info, long  time  )

inline

设置指定时间点局部滤镜的蒙版区域信息

参数

region	蒙版区域信息, 构成控制区域的可以是点，贝塞尔曲线或者椭圆，对应的坐标系为NDC坐标系
time	时间点

参见

getRegionInfoAtTime

自从

2.16.0

setStringVal()

void com.meicam.sdk.NvsFx.setStringVal ( String  fxParam, String  val  )

inline

设置特效字符串参数值

参数

fxParam	特效的字符串参数的类型。请参见PARAM_TYPE_STRING
val	字符串

参见

getStringVal

setStringValAtTime()

void com.meicam.sdk.NvsFx.setStringValAtTime ( String  fxParam, String  val, long  time  )

inline

设置指定时间点上特效字符串参数值

参数

fxParam	特效的字符串参数的类型。请参见PARAM_TYPE_STRING
val	字符串
time	时间点 (单位为微秒).

参见

getStringValAtTime

类成员变量说明

FACE_WARP_EFFECT_STRATEGY_CUSTOM

final int com.meicam.sdk.NvsFx.FACE_WARP_EFFECT_STRATEGY_CUSTOM = 0x7FFFFFFF

static

人脸变形特效自定义策略

KEY_FRAME_FIND_MODE_INPUT_TIME_AFTER

final int com.meicam.sdk.NvsFx.KEY_FRAME_FIND_MODE_INPUT_TIME_AFTER = 2

static

查找当前时间点之后的关键帧

KEY_FRAME_FIND_MODE_INPUT_TIME_BEFORE

final int com.meicam.sdk.NvsFx.KEY_FRAME_FIND_MODE_INPUT_TIME_BEFORE = 1

static

查找当前时间点之前的关键帧

REGION_COORDINATE_SYSTEM_TYPE_NDC

final int com.meicam.sdk.NvsFx.REGION_COORDINATE_SYSTEM_TYPE_NDC = 0

static

NDC坐标系

REGION_COORDINATE_SYSTEM_TYPE_TIMELINE

final int com.meicam.sdk.NvsFx.REGION_COORDINATE_SYSTEM_TYPE_TIMELINE = 1

static

timeline坐标系

---

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

• src/android/jar/com/meicam/sdk/NvsFx.java