NvsTimelineVideoFx类 参考

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

类 NvsTimelineVideoFx 继承关系图:

Public 成员函数
	constructor ()
	构造函数
	getTimelineVideoFxType ()
	获取时间线视频特效类型 更多...
	getBuiltinTimelineVideoFxName ()
	获取内置时间线视频特效名字 更多...
	getTimelineVideoFxPackageId ()
	获取时间线视频特效包ID 更多...
	getInPoint ()
	获取入点 更多...
	getOutPoint ()
	获取出点 更多...
	changeInPoint (newInPoint)
	改变入点 更多...
	changeOutPoint (newOutPoint)
	改变出点 更多...
	movePosition (offset)
	移动位置 更多...
	setZValue (value)
	设置Z值,Z 值决定了特效的渲染顺序。 Z值越高，效果越好。 更多...
	getZValue ()
	获取Z值 更多...
	mapPointFromCanonicalToParticleSystem (ptCanonical)
	将点从规范映射到粒子系统 更多...
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)
	根据键，获取模板属性值 更多...

详细描述

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

参见

NvsFx

成员函数说明

changeInPoint()

NvsTimelineVideoFx::changeInPoint (   newInPoint )

inline

改变入点

参数

{Number}

newInPoint 新的入点

返回

{Number} 返回时间线视频效果在时间线上的最终入点值（以微秒为单位）。

changeOutPoint()

NvsTimelineVideoFx::changeOutPoint (   newOutPoint )

inline

改变出点

参数

{Number}

newOutPoint 新的出点

返回

{Number} 返回时间线视频效果在时间线上的最终出点值（以微秒为单位）。

getBuiltinTimelineVideoFxName()

NvsTimelineVideoFx::getBuiltinTimelineVideoFxName ( )

inline

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

返回

{String} 返回内置时间线视频效果的名称。当它不是内置效果时，它将返回 null。

getInPoint()

NvsTimelineVideoFx::getInPoint ( )

inline

获取入点

返回

{Number} 时间线视频效果在时间线上的入点（以微秒为单位）。

getOutPoint()

NvsTimelineVideoFx::getOutPoint ( )

inline

获取出点

返回

{Number} 时间线视频效果在时间线上的出点（以微秒为单位）。

getTimelineVideoFxPackageId()

NvsTimelineVideoFx::getTimelineVideoFxPackageId ( )

inline

获取时间线视频特效包ID

返回

{String} 返回时间线视频效果资源包ID。不是打包效果的时候会返回null。

getTimelineVideoFxType()

NvsTimelineVideoFx::getTimelineVideoFxType ( )

inline

获取时间线视频特效类型

返回

{String} 返回时间线视频效果类型。请参阅[时间线视频效果类型]。 (TIMELINE_VIDEOFX_TYPE)。

getZValue()

NvsTimelineVideoFx::getZValue ( )

inline

获取Z值

返回

{Number} 返回视频特效 Z 值。

mapPointFromCanonicalToParticleSystem()

NvsTimelineVideoFx::mapPointFromCanonicalToParticleSystem (   ptCanonical )

inline

将点从规范映射到粒子系统

参数

{PointF}

ptCanonical 时间轴坐标。

返回

{PointF} 返回变换后的粒子系统坐标，PointF 对象。

movePosition()

NvsTimelineVideoFx::movePosition (   offset )

inline

移动位置

参数

{Number}

offset 偏移量

返回

{void}

setZValue()

NvsTimelineVideoFx::setZValue (   value )

inline

设置Z值,Z 值决定了特效的渲染顺序。 Z值越高，效果越好。

参数

{Number}

value Z值

返回

{void}

---

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

• src/js/NvStreamingSdk.js