NvsFx类 参考

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

类 NvsFx 继承关系图:

Public 成员函数
	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)
	根据键，获取模板属性值 更多...

详细描述

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

参见

NvsProjObj

成员函数说明

clearExprVar()

NvsFx::clearExprVar ( )

inline

清除Expr值

返回

{}

clearExprVarCtx()

NvsFx::clearExprVarCtx ( )

inline

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

返回

{}

findKeyframeTime()

NvsFx::findKeyframeTime (   fxParam,   time,   flags  )

inline

在某个时间查询关键帧

参数

{String}	fxParam 特效参数
{Number}	time 时间点
{Number}	flags 标识

返回

{Number} 返回指定时间点附近的关键帧时间点，如果该时间点附近没有关键帧，则返回 - 1

getArbitraryVal()

NvsFx::getArbitraryVal (   fxParam )

inline

获取特效不定类型的值

参数

{String}

fxParam 特效参数名称

返回

{NvsRegionInfo} NvsRegionInfo类型的值

参见

NvsRegionInfo

getArbitraryValAtTime()

NvsFx::getArbitraryValAtTime (   fxParam,   time  )

inline

获取特效某时间点不定类型的值

参数

{String}	fxParam 特效参数名称
{Number}	time 时间点

返回

{NvsRegionInfo} NvsRegionInfo类型的值

参见

NvsRegionInfo

getARSceneManipulate()

NvsFx::getARSceneManipulate ( )

inline

获取ARScene操作

返回

{NvsARSceneManipulate} 返回 AR 场景操作对象。

getBooleanVal()

NvsFx::getBooleanVal (   fxParam )

inline

获取布尔值

参数

{String}

fxParam 特效参数

返回

{Boolean} 返回布尔值。

getBooleanValAtTime()

NvsFx::getBooleanValAtTime (   fxParam,   time  )

inline

在某个时间获取布尔值

参数

{String}	fxParam 特效参数
{Number}	time 时间

返回

{Boolean} 返回布尔值。

getColorVal()

NvsFx::getColorVal (   fxParam )

inline

设置颜色值

参数

{String}

fxParam 特效参数

返回

{NvsColor} 返回自定义颜色对象[NvsColor]。

参见

NvsColor

getColorValAtTime()

NvsFx::getColorValAtTime (   fxParam,   time  )

inline

在某个时间点获取颜色值

参数

{String}	fxParam 特效参数
{Number}	time 时间点

返回

{NvsColor} 返回自定义颜色对象[NvsColor]。

getDescription()

NvsFx::getDescription ( )

inline

获取特效的描述。返回 NvsFxDescription 对象

返回

{NvsFxDescription}

参见

NvsFxDescription

getExprObjectVar()

NvsFx::getExprObjectVar (   varName )

inline

获取对象(例如:颜色)表达式变量

参数

{String}

varName 变量名字

返回

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

getExprVar()

NvsFx::getExprVar (   varName )

inline

获取表达式变量

参数

{String}

varName 变量名字

返回

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

getFilterIntensity()

NvsFx::getFilterIntensity ( )

inline

获取滤镜强度

返回

{Number} 返回滤镜的强度值

getFloatVal()

NvsFx::getFloatVal (   fxParam )

inline

获取浮点值

参数

{String}

fxParam 特效参数

返回

{Number} 返回double值

getFloatValAtTime()

NvsFx::getFloatValAtTime (   fxParam,   time  )

inline

在某个时间获取浮点值

参数

{String}	fxParam 特效参数
{Number}	time 时间

返回

{Number} 返回double值

getIgnoreBackground()

NvsFx::getIgnoreBackground ( )

inline

获取忽略背景

返回

{Boolean} 返回区域过滤器是否忽略背景。

getIntpFxParamValsAtTime()

NvsFx::getIntpFxParamValsAtTime (   fxParam,   time  )

inline

在某个时间获取关键帧参数

参数

{String}	fxParam 特效参数
{Number}	time 时间点

返回

{NvsVectorVal}

参见

NvsVectorVal

getIntVal()

NvsFx::getIntVal (   fxParam )

inline

获取整数值

参数

{String}

fxParam 特效参数

返回

{Number} 返回整数值。

getIntValAtTime()

NvsFx::getIntValAtTime (   fxParam,   time  )

inline

在某个时间获取整数值

参数

{String}	fxParam 特效参数
{Number}	time 时间

返回

{Number} 返回整数值。

getInverseRegion()

NvsFx::getInverseRegion ( )

inline

获取反转区域

返回

{Boolean} 返回区域过滤器是否与区域相反。

getMenuVal()

NvsFx::getMenuVal (   fxParam )

inline

设置菜单值

参数

{String}

fxParam 特效参数

返回

{String} 返回 NvsFx 的菜单值。

getMenuValAtTime()

NvsFx::getMenuValAtTime (   fxParam,   time  )

inline

在某个时间获取菜单值

参数

{String}	fxParam 特效参数
{Number}	time 时间点

返回

{String} 返回 NvsFx 的菜单值。

getParamKeyframeAtTime()

NvsFx::getParamKeyframeAtTime (   fxParam,   time  )

inline

在某个时间获取关键帧参数

参数

{String}	fxParam The type of custom data parameter for the effect.
{Number}	time 时间点

返回

{void}

getParamKeyframes()

NvsFx::getParamKeyframes (   fxParam )

inline

获取关键帧参数

参数

{String}

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

返回

{NvsVectorVal}

参见

NvsVectorVal

getParticleSystemContext()

NvsFx::getParticleSystemContext ( )

inline

获取粒子特效上下文

返回

{NvsParticleSystemContext} 返回一个粒子特效上下文对象。

getRegional()

NvsFx::getRegional ( )

inline

获取区域范围

返回

{Boolean} Return whether the filter is regional or not.

getRegionalFeatherWidth()

NvsFx::getRegionalFeatherWidth ( )

inline

获取区域羽化宽度

返回

{Number} 返回区域过滤器的羽化宽度。

getRegionInfos()

NvsFx::getRegionInfos ( )

inline

获取特效区域信息

返回

{NvsVectorVal<NvsRegionInfo>} 返回特效遮罩区域信息集合。每一个区域信息对象结构可以包含NDC坐标系中的一系列点或椭圆信息。

参见

NvsRegionInfo

getRegionInfosAtTime()

NvsFx::getRegionInfosAtTime (   time )

inline

获取特效在某个时间点的区域信息

参数

{Number}

time 时间点

返回

{NvsVectorVal<NvsRegionInfo>} 返回特效遮罩区域信息集合。每一个区域信息对象结构可以包含NDC坐标系中的一系列点或椭圆信息。

getStringVal()

NvsFx::getStringVal (   fxParam )

inline

获取字符串值

参数

{String}

fxParam 特效参数

返回

{String} 返回字符串。

getStringValAtTime()

NvsFx::getStringValAtTime (   fxParam,   time  )

inline

在某个时间获取字符串值

参数

{String}	fxParam 特效参数
{Number}	time 时间点

返回

{String} 返回字符串。

hasKeyframeList()

NvsFx::hasKeyframeList (   fxParam )

inline

是否有关键帧列表

参数

{String}

fxParam 特效参数

返回

{Boolean} 返回是否存在。

removeAllKeyframe()

NvsFx::removeAllKeyframe (   fxParam )

inline

删除所有关键帧

参数

{String}

fxParam 特效参数

返回

{Boolean} 返回成功或失败

removeKeyframeAtTime()

NvsFx::removeKeyframeAtTime (   fxParam,   time  )

inline

在某个时间删除关键帧

参数

{String}	fxParam 特效参数
{Number}	time 时间点

返回

{Boolean} 返回成功或失败

setArbitraryVal()

NvsFx::setArbitraryVal (   fxParam,   val  )

inline

设置特效不定类型的值

参数

{String}	fxParam 特效参数名称
{NvsRegionInfo}	val 目前只支持NvsRegionInfo类型的值

参见

NvsRegionInfo

setArbitraryValAtTime()

NvsFx::setArbitraryValAtTime (   fxParam,   val,   time  )

inline

setBooleanVal()

NvsFx::setBooleanVal (   fxParam,   val  )

inline

设置布尔值

参数

{String}	fxParam 特效参数
{Boolean}	val 布尔值

返回

{void}

setBooleanValAtTime()

NvsFx::setBooleanValAtTime (   fxParam,   val,   time  )

inline

在某个时间设置布尔值

参数

{String}	fxParam 特效参数
{Boolean}	val 具体值具体值
{Number}	time 时间

返回

{void}

setColorVal()

NvsFx::setColorVal (   fxParam,   val  )

inline

设置颜色值

参数

{String}	fxParam 特效参数
{NvsColor}	val 颜色值

返回

{void}

参见

NvsColor

setColorValAtTime()

NvsFx::setColorValAtTime (   fxParam,   val,   time  )

inline

在某个时间设置颜色

参数

{String}	fxParam 特效参数
{NvsColor}	val 颜色值
{Number}	time 时间点

返回

{void}

setEllipseRegion()

NvsFx::setEllipseRegion (   center,   a,   b,   angle  )

inline

设置椭圆区域

参数

{NvsPointF}	center 居中
{Number}	a 长半轴
{Number}	b 短半轴
{Number}	angle 角度

返回

{void}

setEllipseRegionAtTime()

NvsFx::setEllipseRegionAtTime (   center,   a,   b,   angle,   time  )

inline

在某个时间点设置椭圆区域

参数

{NvsPointF}	center 居中
{Number}	a 长半轴
{Number}	b 短半轴
{Number}	angle 角度
{Number}	time 时间

返回

{void}

setExprObjectVar()

NvsFx::setExprObjectVar (   varName,   varValue  )

inline

设置对象(例如:颜色)表达式变量

参数

{String}	varName 变量名字
{Number}	varValue 变量值

返回

{void}

setExprVar()

NvsFx::setExprVar (   varName,   varValue  )

inline

设置表达式变量

参数

{String}	varName 变量名字
{Number}	varValue 变量值

返回

{void}

setFilterIntensity()

NvsFx::setFilterIntensity (   intensity )

inline

设置滤镜强度

参数

{Number}

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

setFloatVal()

NvsFx::setFloatVal (   fxParam,   val  )

inline

设置浮点值

参数

{String}	fxParam 特效参数
{Number}	val 值

返回

{void}

setFloatValAtTime()

NvsFx::setFloatValAtTime (   fxParam,   val,   time  )

inline

在某个时间设置浮点值

参数

{String}	fxParam 特效参数值
{Number}	val 值
{Number}	time 时间点

返回

{void}

setIgnoreBackground()

NvsFx::setIgnoreBackground (   isIgnoreBackground )

inline

设置忽略背景

参数

{Boolean}

isIgnoreBackground 是否忽略背景

返回

{void}

setIntVal()

NvsFx::setIntVal (   fxParam,   val  )

inline

设置整数值

参数

{String}	fxParam 特效参数
{Number}	val 值

返回

{void}

setIntValAtTime()

NvsFx::setIntValAtTime (   fxParam,   val,   time  )

inline

在某个时间设置整数值

参数

{String}	fxParam 特效参数
{Number}	val 值
{Number}	time 时间

返回

{void}

setInverseRegion()

NvsFx::setInverseRegion (   isInverseRegion )

inline

设置反转区域

参数

{Boolean}

isInverseRegion 是否反转区域

返回

{void}

setMenuVal()

NvsFx::setMenuVal (   fxParam,   val  )

inline

设置菜单值

参数

{String}	fxParam 特效参数
{String}	val 菜单值

返回

{void}

setMenuValAtTime()

NvsFx::setMenuValAtTime (   fxParam,   val,   time  )

inline

在某个时间设置菜单值

参数

{String}	fxParam 特效参数
{String}	val 值
{Number}	time 时间点

返回

{String}

setParamKeyframeAtTime()

NvsFx::setParamKeyframeAtTime (   fxParam,   time,   keyframe  )

inline

在某个时间设置关键帧参数

参数

{String}	fxParam The type of custom data parameter for the effect.
{Number}	time 时间点
{NvsVectorVal}	keyframe

返回

{Boolean} 是否设置成功

setParamKeyframes()

NvsFx::setParamKeyframes (   fxParam,   keyframes  )

inline

设置关键帧参数

参数

{String}	fxParam 特效的自定义数据参数的类型。
{NvsVectorVal}	keyframes 关键帧

返回

{Boolean}

setRegion()

NvsFx::setRegion (   region )

inline

设置区域

参数

{Number[]}

region 区域对象

返回

{void}

setRegional()

NvsFx::setRegional (   isRegional )

inline

设置区域

参数

{Boolean}

isRegional 过滤器是否是区域性的。 true 表示区域性，false 表示相反。

返回

{void}

setRegionalFeatherWidth()

NvsFx::setRegionalFeatherWidth (   featherWidth )

inline

设置区域羽化宽度

参数

{Number}

featherWidth 宽度值

返回

{}

setRegionAtTime()

NvsFx::setRegionAtTime (   region,   time  )

inline

在某个时间设置区域

参数

{Number[]}	region 区域对象
{Number}	time 时间点

返回

{void}

setRegionInfos()

NvsFx::setRegionInfos (   regionInfos )

inline

设置多个区域信息

参数

{NvsVectorVal<NvsRegionInfo>}

regionInfos NvsRegionInfo对象数组

参见

NvsRegionInfo

setRegionInfosAtTime()

NvsFx::setRegionInfosAtTime (   regionInfos,   time  )

inline

设置某个时间点的多个区域信息

参数

{NvsVectorVal<NvsRegionInfo>}	regionInfos NvsRegionInfo对象数组
{Number}	time 时间点

参见

NvsRegionInfo

setStringVal()

NvsFx::setStringVal (   fxParam,   val  )

inline

设置字符串值

参数

{String}	fxParam 特效参数
{String}	val 字符串值

返回

{void}

setStringValAtTime()

NvsFx::setStringValAtTime (   fxParam,   val,   time  )

inline

在某个时间点设置字符串值

参数

{String}	fxParam 特效参数
{String}	val 字符串值
{Number}	time 时间点

返回

{void}

---

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

• src/js/NvStreamingSdk.js