Class: NvsFx

NvsFx()

Special effects. Special effects are the base classes of different types of special effects such as video FX, audio FX, audio transition and video transition. In the SDK framework, special effects are a key part. Each different type of special effects derived from nvsfx can be added, removed and obtained through clip instances, timeline instances or track instances. At the same time, different API interfaces are provided in the special effect class to set and obtain the special effect parameter types.

Constructor

new NvsFx()

Source:

Extends

Methods

clearExprVar()

clear Expr value
Source:
Returns:

clearExprVarCtx()

clear all Expr value
Source:
Returns:

findKeyframeTime(fxParam, time, flags)

find key frame at certain time
Parameters:
Name Type Description
fxParam name of parameter
time time
flags flags
Source:
Returns:

getARSceneManipulate()

get ARScene operation
Source:
Returns:

getBooleanVal(fxParam)

get boolean value
Parameters:
Name Type Description
fxParam name of parameter
Source:
Returns:

getBooleanValAtTime(fxParam, time)

get boolean value at certain time
Parameters:
Name Type Description
fxParam name of parameter
time time
Source:
Returns:

getColorVal(fxParam)

get color value
Parameters:
Name Type Description
fxParam name of parameter
Source:
Returns:

getColorValAtTime(fxParam, time)

get color value at certain time
Parameters:
Name Type Description
fxParam name of parameter
time time
Source:
Returns:

getDescription()

get description information
Source:
Returns:

getExprVar(varName)

get Expr value
Parameters:
Name Type Description
varName variable name
Source:
Returns:

getFilterIntensity()

get filter intensity
Source:
Returns:

getFloatVal(fxParam)

get float value
Parameters:
Name Type Description
fxParam name of parameter
Source:
Returns:

getFloatValAtTime(fxParam, time)

get float value at certain time
Parameters:
Name Type Description
fxParam name of parameter
time time
Source:
Returns:

getIgnoreBackground()

get ignore background
Source:
Returns:

getInternalObject() → {Num}

get internal object
Overrides:
Source:
Returns:
Type
Num

getIntVal(fxParam)

get integer value
Parameters:
Name Type Description
fxParam name of parameter
Source:
Returns:

getIntValAtTime(fxParam, time)

get integer value at certain time
Parameters:
Name Type Description
fxParam name of parameter
time time
Source:
Returns:

getInverseRegion()

get region in reverse
Source:
Returns:

getMenuVal(fxParam)

get menu value
Parameters:
Name Type Description
fxParam name of parameter
Source:
Returns:

getMenuValAtTime(fxParam, time)

get menu value at certain time
Parameters:
Name Type Description
fxParam name of parameter
time time
Source:
Returns:

getParticleSystemContext()

get particle system context
Source:
Returns:

getRegional()

get regional
Source:
Returns:

getRegionalFeatherWidth()

get regional feather width
Source:
Returns:

getRegionInfos()

get region
Source:
Returns:

getRegionInfosAtTime(time)

get region information at certain time
Parameters:
Name Type Description
time time
Source:
Returns:

getStringVal(fxParam)

get character string
Parameters:
Name Type Description
fxParam name of parameter
Source:
Returns:

getStringValAtTime(fxParam, time)

get string value at certain time
Parameters:
Name Type Description
fxParam name of parameter
time time
Source:
Returns:

getTemplateAttachment(key) → {Num}

get template attachment according key
Parameters:
Name Type Description
key key
Overrides:
Source:
Returns:
Type
Num

hasKeyframeList(fxParam)

has key frame list or not
Parameters:
Name Type Description
fxParam name of parameter
Source:
Returns:

removeAllKeyframe(fxParam)

remove all key frame
Parameters:
Name Type Description
fxParam name of parameter
Source:
Returns:

removeKeyframeAtTime(fxParam, time)

remove key frame at certain time
Parameters:
Name Type Description
fxParam name of parameter
time time
Source:
Returns:

setBooleanVal(fxParam, val)

set boolean value
Parameters:
Name Type Description
fxParam name of parameter
val value
Source:
Returns:

setBooleanValAtTime(fxParam, val, time)

set boolean value at certain time
Parameters:
Name Type Description
fxParam name of parameter
val value
time time
Source:
Returns:

setColorVal(fxParam, val)

set color value
Parameters:
Name Type Description
fxParam name of parameter
val value
Source:
Returns:

setColorValAtTime(fxParam, val, time)

set color value at certain time
Parameters:
Name Type Description
fxParam name of parameter
val value
time time
Source:
Returns:

setEllipseRegion(center, a, b, angle)

set ellipse region
Parameters:
Name Type Description
center center point
a Long semiaxis of ellipse
b short semiaxis of ellipse
angle angle
Source:
Returns:

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

set ellipse region at certain time
Parameters:
Name Type Description
center center point
a Long semiaxis of ellipse
b short semiaxis of ellipse
angle angle
time time
Source:
Returns:

setExprVar(varName, varValue)

set Expr value
Parameters:
Name Type Description
varName variable name
varValue variable value
Source:
Returns:

setFilterIntensity(intensity)

set filter intensity
Parameters:
Name Type Description
intensity intensity
Source:
Returns:

setFloatVal(fxParam, val)

set float value
Parameters:
Name Type Description
fxParam name of parameter
val value
Source:
Returns:

setFloatValAtTime(fxParam, val, time)

set float value at certain time
Parameters:
Name Type Description
fxParam name of parameter
val value
time time
Source:
Returns:

setIgnoreBackground(isIgnoreBackground)

set ignore background
Parameters:
Name Type Description
isIgnoreBackground ignore background or not
Source:
Returns:

setInternalObject(obj)

set internal object
Parameters:
Name Type Description
obj internal object
Overrides:
Source:
Returns:

setIntVal(fxParam, val)

set integer value
Parameters:
Name Type Description
fxParam name of parameter
val value
Source:
Returns:

setIntValAtTime(fxParam, val, time)

set integer value at certain time
Parameters:
Name Type Description
fxParam name of parameter
val value
time time
Source:
Returns:

setInverseRegion(isInverseRegion)

set region in reverse
Parameters:
Name Type Description
isInverseRegion inverse region or not
Source:
Returns:

setMenuVal(fxParam, val)

set menu value
Parameters:
Name Type Description
fxParam name of parameter
val value
Source:
Returns:

setMenuValAtTime(fxParam, val, time)

set menu value at certain time
Parameters:
Name Type Description
fxParam name of parameter
val value
time time
Source:
Returns:

setRegion(region)

set region
Parameters:
Name Type Description
region region
Source:
Returns:

setRegional(isRegional)

set regional
Parameters:
Name Type Description
isRegional regional or not
Source:
Returns:

setRegionalFeatherWidth(featherWidth)

set region feather width
Parameters:
Name Type Description
featherWidth feather width
Source:
Returns:

setRegionAtTime(region, time)

set region at certain time
Parameters:
Name Type Description
region region
time time
Source:
Returns:

setStringVal(fxParam, val)

set string value
Parameters:
Name Type Description
fxParam name of parameter
val value
Source:
Returns:

setStringValAtTime(fxParam, val, time)

set character string at certain time
Parameters:
Name Type Description
fxParam name of parameter
val value
time time
Source:
Returns:

setTemplateAttachment(key, value)

get template attachment
Parameters:
Name Type Description
key key
value value
Overrides:
Source:
Returns: