Class: NvsTimelineVideoFx

NvsTimelineVideoFx()

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

Constructor

new NvsTimelineVideoFx()

Source:

Extends

Methods

changeInPoint(newInPoint)

改变入点
Parameters:
Name Type Description
newInPoint 新的入点
Source:
Returns:

changeOutPoint(newOutPoint)

改变出点
Parameters:
Name Type Description
newOutPoint 新的出点
Source:
Returns:

clearExprVar()

清除Expr值
Overrides:
Source:
Returns:

clearExprVarCtx()

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

findKeyframeTime(fxParam, time, flags)

在某个时间查询关键帧
Parameters:
Name Type Description
fxParam 特效参数
time 时间点
flags 标识
Overrides:
Source:
Returns:

getARSceneManipulate()

获取ARScene操作
Overrides:
Source:
Returns:

getBooleanVal(fxParam)

获取布尔值
Parameters:
Name Type Description
fxParam 特效参数
Overrides:
Source:
Returns:

getBooleanValAtTime(fxParam, time)

在某个时间获取布尔值
Parameters:
Name Type Description
fxParam 特效参数
time 时间
Overrides:
Source:
Returns:

getBuiltinTimelineVideoFxName()

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

getColorVal(fxParam)

获取颜色值
Parameters:
Name Type Description
fxParam 特效参数
Overrides:
Source:
Returns:

getColorValAtTime(fxParam, time)

在某个时间点获取颜色值
Parameters:
Name Type Description
fxParam 特效参数
time 时间点
Overrides:
Source:
Returns:

getDescription()

获取描述信息
Overrides:
Source:
Returns:

getExprVar(varName)

获取Expr值
Parameters:
Name Type Description
varName 变量名字
Overrides:
Source:
Returns:

getFilterIntensity()

获取滤镜强度
Overrides:
Source:
Returns:

getFloatVal(fxParam)

获取浮点值
Parameters:
Name Type Description
fxParam 特效参数
Overrides:
Source:
Returns:

getFloatValAtTime(fxParam, time)

在某个时间获取浮点值
Parameters:
Name Type Description
fxParam 特效参数
time 时间
Overrides:
Source:
Returns:

getIgnoreBackground()

获取忽略背景
Overrides:
Source:
Returns:

getInPoint()

获取入点
Source:
Returns:

getInternalObject() → {Num}

获取内置对象
Overrides:
Source:
Returns:
Type
Num

getIntVal(fxParam)

获取整数值
Parameters:
Name Type Description
fxParam 特效参数
Overrides:
Source:
Returns:

getIntValAtTime(fxParam, time)

在某个时间获取整数值
Parameters:
Name Type Description
fxParam 特效参数
time 时间
Overrides:
Source:
Returns:

getInverseRegion()

获取反转区域
Overrides:
Source:
Returns:

getMenuVal(fxParam)

获取菜单值
Parameters:
Name Type Description
fxParam 特效参数
Overrides:
Source:
Returns:

getMenuValAtTime(fxParam, time)

在某个时间获取菜单值
Parameters:
Name Type Description
fxParam 特效参数
time 时间点
Overrides:
Source:
Returns:

getOutPoint()

获取出点
Source:
Returns:

getParticleSystemContext()

获取粒子系统上下文
Overrides:
Source:
Returns:

getRegional()

获取区域范围
Overrides:
Source:
Returns:

getRegionalFeatherWidth()

获取区域羽化宽度
Overrides:
Source:
Returns:

getRegionInfos()

获取区域信息
Overrides:
Source:
Returns:

getRegionInfosAtTime(time)

在某个时间点获取区域信息
Parameters:
Name Type Description
time 时间点
Overrides:
Source:
Returns:

getStringVal(fxParam)

获取字符串值
Parameters:
Name Type Description
fxParam 特效参数
Overrides:
Source:
Returns:

getStringValAtTime(fxParam, time)

在某个时间获取字符串值
Parameters:
Name Type Description
fxParam 特效参数
time 时间点
Overrides:
Source:
Returns:

getTemplateAttachment(key) → {Num}

根据键，获取模板属性值
Parameters:
Name Type Description
key 键
Overrides:
Source:
Returns:
Type
Num

getTimelineVideoFxPackageId()

获取时间线视频特效包ID
Source:
Returns:

getTimelineVideoFxType()

获取时间线视频特效类型
Source:
Returns:

getZValue()

获取Z值
Source:
Returns:

hasKeyframeList(fxParam)

是否有关键帧列表
Parameters:
Name Type Description
fxParam 特效参数
Overrides:
Source:
Returns:

mapPointFromCanonicalToParticleSystem(ptCanonical)

将点从规范映射到粒子系统
Parameters:
Name Type Description
ptCanonical
Source:
Returns:

movePosition(offset)

移动位置
Parameters:
Name Type Description
offset 偏移量
Source:
Returns:

removeAllKeyframe(fxParam)

删除所有关键帧
Parameters:
Name Type Description
fxParam 特效参数
Overrides:
Source:
Returns:

removeKeyframeAtTime(fxParam, time)

在某个时间删除关键帧
Parameters:
Name Type Description
fxParam 特效参数
time 时间点
Overrides:
Source:
Returns:

setBooleanVal(fxParam, val)

设置布尔值
Parameters:
Name Type Description
fxParam 特效参数
val 具体值
Overrides:
Source:
Returns:

setBooleanValAtTime(fxParam, val, time)

在某个时间设置布尔值
Parameters:
Name Type Description
fxParam 特效参数
val 具体值
time 时间
Overrides:
Source:
Returns:

setColorVal(fxParam, val)

设置颜色值
Parameters:
Name Type Description
fxParam 特效参数
val 颜色值
Overrides:
Source:
Returns:

setColorValAtTime(fxParam, val, time)

在某个时间设置颜色
Parameters:
Name Type Description
fxParam 特效参数
val 颜色值
time 时间点
Overrides:
Source:
Returns:

setEllipseRegion(center, a, b, angle)

设置椭圆区域
Parameters:
Name Type Description
center 居中
a 长半轴
b 短半轴
angle 角度
Overrides:
Source:
Returns:

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

在某个时间点设置椭圆区域
Parameters:
Name Type Description
center 居中
a 长半轴
b 短半轴
angle 角度
time 时间
Overrides:
Source:
Returns:

setExprVar(varName, varValue)

设置Expr变量
Parameters:
Name Type Description
varName 变量名字
varValue 变量值
Overrides:
Source:
Returns:

setFilterIntensity(intensity)

设置滤镜强度
Parameters:
Name Type Description
intensity 强度值
Overrides:
Source:
Returns:

setFloatVal(fxParam, val)

设置浮点值
Parameters:
Name Type Description
fxParam 特效参数
val 值
Overrides:
Source:
Returns:

setFloatValAtTime(fxParam, val, time)

在某个时间设置浮点值
Parameters:
Name Type Description
fxParam 特效参数值
val 值
time 时间点
Overrides:
Source:
Returns:

setIgnoreBackground(isIgnoreBackground)

设置忽略背景
Parameters:
Name Type Description
isIgnoreBackground 是否忽略背景
Overrides:
Source:
Returns:

setInternalObject(obj) → {Num}

设置内置对象
Parameters:
Name Type Description
obj
Overrides:
Source:
Returns:
Type
Num

setIntVal(fxParam, val)

设置整数值
Parameters:
Name Type Description
fxParam 特效参数
val 值
Overrides:
Source:
Returns:

setIntValAtTime(fxParam, val, time)

在某个时间设置整数值
Parameters:
Name Type Description
fxParam 特效参数
val 值
time 时间
Overrides:
Source:
Returns:

setInverseRegion(isInverseRegion)

设置反转区域
Parameters:
Name Type Description
isInverseRegion 是否反转区域
Overrides:
Source:
Returns:

setMenuVal(fxParam, val)

设置菜单值
Parameters:
Name Type Description
fxParam 特效参数
val 菜单值
Overrides:
Source:
Returns:

setMenuValAtTime(fxParam, val, time)

在某个时间设置菜单值
Parameters:
Name Type Description
fxParam 特效参数
val 值
time 时间点
Overrides:
Source:
Returns:

setRegion(region)

设置区域
Parameters:
Name Type Description
region 区域对象
Overrides:
Source:
Returns:

setRegional(isRegional)

设置区域
Parameters:
Name Type Description
isRegional 是区域的
Overrides:
Source:
Returns:

setRegionalFeatherWidth(featherWidth)

设置区域羽化宽度
Parameters:
Name Type Description
featherWidth 宽度值
Overrides:
Source:
Returns:

setRegionAtTime(region, time)

在某个时间设置区域
Parameters:
Name Type Description
region 区域对象
time 时间点
Overrides:
Source:
Returns:

setStringVal(fxParam, val)

设置字符串值
Parameters:
Name Type Description
fxParam 特效参数
val 字符串值
Overrides:
Source:
Returns:

setStringValAtTime(fxParam, val, time)

在某个时间点设置字符串值
Parameters:
Name Type Description
fxParam 特效参数
val 字符串值
time 时间点
Overrides:
Source:
Returns:

setTemplateAttachment(key, value) → {Num}

设置模板附件
Parameters:
Name Type Description
key 键
value 值
Overrides:
Source:
Returns:
Type
Num

setZValue(value)

设置Z值
Parameters:
Name Type Description
value Z值
Source:
Returns: