com.meicam.sdk.NvsTimelineVideoFx类 参考

时间线视频特效 时间线视频特效是作用于时间线实例上的视频特效。 时间线视频特效分为內建特效、包裹特效和自定义特效三种类型。 內建特效是集成在sdk内部的，不需要授权即可直接使用。包裹特效是将特效资源整合成了特效包，每个特效包都有其一一对应的授权文件，并且要先安装再使用，具体情况请参见素材包安装 自定义特效是用户通过编写代码实现的特效 时间线视频特效包含特效入点和出点，通过入点和出点我们可以指定特效作用于时间线的位置和长度，入点要小于出点，单位为微秒。 时间线视频特效允许叠加，渲染顺序通过预设Z值控制。 更多...

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

Public 成员函数
int	getTimelineVideoFxType ()
	获取时间线视频特效类型 更多...
String	getBuiltinTimelineVideoFxName ()
	获取内建时间线视频特效名字 更多...
String	getTimelineVideoFxPackageId ()
	获取时间线视频特效资源包ID 更多...
long	getInPoint ()
	时间线视频特效在时间线上的入点 更多...
long	getOutPoint ()
	时间线视频特效在时间线上的出点 更多...
long	changeInPoint (long newInPoint)
	改变时间线视频特效在时间线上的入点 当设置的入点值不符合既定规则时最终返回入点值有可能与设置的入点值不同，比如新的入点值小于0，新的入点值大于时间线长度或者新的入点值大于出点值。 更多...
long	changeOutPoint (long newOutPoint)
	改变时间线视频特效在时间线上的出点 当设置的出点值不符合既定规则时最终返回出点值有可能与设置的出点值不同，比如新的出点值小于0，新的出点值大于时间线长度或者新的出点值小于入点值。 更多...
void	movePosition (long offset)
	改变时间线视频特效在时间线上的位置(入点和出点同时偏移offset值) 更多...
void	setZValue (float value)
	设置时间线视频特效Z值 Z值决定了特效的渲染顺序，Z值越大，特效越处于上层 更多...
float	getZValue ()
	获取时间线视频特效Z值 更多...
PointF	mapPointFromCanonicalToParticleSystem (PointF ptCononical)
	将时间线坐标转换为粒子系统坐标 更多...
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 属性
时间线视频特效类型
static final int	TIMELINE_VIDEOFX_TYPE_BUILTIN = 0
	内建视频特效类型 更多...
static final int	TIMELINE_VIDEOFX_TYPE_PACKAGE = 1
	包裹视频特效类型 更多...
static final int	TIMELINE_VIDEOFX_TYPE_CUSTOM = 2
静态 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

详细描述

时间线视频特效 时间线视频特效是作用于时间线实例上的视频特效。 时间线视频特效分为內建特效、包裹特效和自定义特效三种类型。 內建特效是集成在sdk内部的，不需要授权即可直接使用。包裹特效是将特效资源整合成了特效包，每个特效包都有其一一对应的授权文件，并且要先安装再使用，具体情况请参见素材包安装 自定义特效是用户通过编写代码实现的特效 时间线视频特效包含特效入点和出点，通过入点和出点我们可以指定特效作用于时间线的位置和长度，入点要小于出点，单位为微秒。 时间线视频特效允许叠加，渲染顺序通过预设Z值控制。

警告

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

成员函数说明

changeInPoint()

long com.meicam.sdk.NvsTimelineVideoFx.changeInPoint ( long  newInPoint )

inline

改变时间线视频特效在时间线上的入点 当设置的入点值不符合既定规则时最终返回入点值有可能与设置的入点值不同，比如新的入点值小于0，新的入点值大于时间线长度或者新的入点值大于出点值。

参数

newInPoint

时间线特效在时间线上的新的入点（单位微秒）

返回

返回时间线视频特效在时间线上最终的入点值（单位微秒

警告

此接口会引发流媒体引擎状态跳转到引擎停止状态，具体情况请参见引擎变化专题

参见

changeOutPoint

movePosition

changeOutPoint()

long com.meicam.sdk.NvsTimelineVideoFx.changeOutPoint ( long  newOutPoint )

inline

改变时间线视频特效在时间线上的出点 当设置的出点值不符合既定规则时最终返回出点值有可能与设置的出点值不同，比如新的出点值小于0，新的出点值大于时间线长度或者新的出点值小于入点值。

参数

newOutPoint

时间线视频特效在时间线上的新的出点（单位微秒）

返回

返回时间线视频特效在时间线最终的出点值（单位微秒）

警告

此接口会引发流媒体引擎状态跳转到引擎停止状态，具体情况请参见引擎变化专题

参见

changeInPoint

movePosition

getBuiltinTimelineVideoFxName()

String com.meicam.sdk.NvsTimelineVideoFx.getBuiltinTimelineVideoFxName ( )

inline

获取内建时间线视频特效名字

返回

返回内建时间线视频特效名字。如果不是内建时间线视频特效返回空字符串

自从

1.7.0

getInPoint()

long com.meicam.sdk.NvsTimelineVideoFx.getInPoint ( )

inline

时间线视频特效在时间线上的入点

返回

时间线视频特效在时间线上的入点（单位微秒）

参见

getOutPoint

changeInPoint

getOutPoint()

long com.meicam.sdk.NvsTimelineVideoFx.getOutPoint ( )

inline

时间线视频特效在时间线上的出点

返回

时间线视频特效在时间线上的出点（单位微秒）

参见

getInPoint

changeOutPoint

getTimelineVideoFxPackageId()

String com.meicam.sdk.NvsTimelineVideoFx.getTimelineVideoFxPackageId ( )

inline

获取时间线视频特效资源包ID

返回

返回时间线视频特效资源包ID。如果不是资源包时间线视频特效返回空字符串

自从

1.7.0

getTimelineVideoFxType()

int com.meicam.sdk.NvsTimelineVideoFx.getTimelineVideoFxType ( )

inline

获取时间线视频特效类型

返回

返回时间线视频特效类型。请参见时间线视频特效类型

自从

1.7.0

getZValue()

float com.meicam.sdk.NvsTimelineVideoFx.getZValue ( )

inline

获取时间线视频特效Z值

返回

返回时间线视频特效Z值

自从

2.17.0

mapPointFromCanonicalToParticleSystem()

PointF com.meicam.sdk.NvsTimelineVideoFx.mapPointFromCanonicalToParticleSystem ( PointF  ptCononical )

inline

将时间线坐标转换为粒子系统坐标

参数

ptCononical

时间线坐标

返回

返回转换后的粒子系统坐标PointF对象

自从

1.16.0

movePosition()

void com.meicam.sdk.NvsTimelineVideoFx.movePosition ( long  offset )

inline

改变时间线视频特效在时间线上的位置(入点和出点同时偏移offset值)

参数

offset

入点和出点改变的偏移值（单位微秒）

警告

此接口会引发流媒体引擎状态跳转到引擎停止状态，具体情况请参见引擎变化专题

参见

changeInPoint

changeOutPoint

setZValue()

void com.meicam.sdk.NvsTimelineVideoFx.setZValue ( float  value )

inline

设置时间线视频特效Z值 Z值决定了特效的渲染顺序，Z值越大，特效越处于上层

参数

value

z值

自从

2.17.0

类成员变量说明

TIMELINE_VIDEOFX_TYPE_BUILTIN

final int com.meicam.sdk.NvsTimelineVideoFx.TIMELINE_VIDEOFX_TYPE_BUILTIN = 0

static

内建视频特效类型

TIMELINE_VIDEOFX_TYPE_CUSTOM

final int com.meicam.sdk.NvsTimelineVideoFx.TIMELINE_VIDEOFX_TYPE_CUSTOM = 2

static

自定义视频特效类型

TIMELINE_VIDEOFX_TYPE_PACKAGE

final int com.meicam.sdk.NvsTimelineVideoFx.TIMELINE_VIDEOFX_TYPE_PACKAGE = 1

static

包裹视频特效类型

---

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

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