Class: NvsVideoFx

NvsVideoFx()

Video effects. The video effect is a special effect on the video clip, which can change the overall or partial color, brightness, transparency, etc. of the video image, so that the video can show a special effect. On Video Clip, users can add, remove, and get multiple video effects.

Constructor

new NvsVideoFx()

Source:

Extends

Methods

clearExprVar()

clear Expr value
Overrides:
Source:
Returns:

clearExprVarCtx()

clear all Expr value
Overrides:
Source:
Returns:

findKeyframeTime(fxParam, time, flags)

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

getARSceneManipulate()

get ARScene operation
Overrides:
Source:
Returns:

getBooleanVal(fxParam)

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

getBooleanValAtTime(fxParam, time)

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

getBuiltinVideoFxName()

Get built-in video effect's name.
Source:
Returns:

getColorVal(fxParam)

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

getColorValAtTime(fxParam, time)

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

getDescription()

get description information
Overrides:
Source:
Returns:

getExprVar(varName)

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

getFilterIntensity()

get filter intensity
Overrides:
Source:
Returns:

getFloatVal(fxParam)

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

getFloatValAtTime(fxParam, time)

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

getIgnoreBackground()

get ignore background
Overrides:
Source:
Returns:

getIndex()

Get video effect's index.
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
Overrides:
Source:
Returns:

getIntValAtTime(fxParam, time)

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

getInverseRegion()

get region in reverse
Overrides:
Source:
Returns:

getMenuVal(fxParam)

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

getMenuValAtTime(fxParam, time)

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

getParticleSystemContext()

get particle system context
Overrides:
Source:
Returns:

getRegional()

get regional
Overrides:
Source:
Returns:

getRegionalFeatherWidth()

get regional feather width
Overrides:
Source:
Returns:

getRegionInfos()

get region
Overrides:
Source:
Returns:

getRegionInfosAtTime(time)

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

getStringVal(fxParam)

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

getStringValAtTime(fxParam, time)

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

getTemplateAttachment(key) → {Num}

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

getVideoFxPackageId()

Get the video effect's resource package ID.
Source:
Returns:

getVideoFxType()

Get video effect's type.
Source:
Returns:

hasKeyframeList(fxParam)

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

mapPointFromCanonicalToParticleSystem(ptCanonical)

mapping point from canonical to particle system
Parameters:
Name Type Description
ptCanonical
Source:
Returns:

removeAllKeyframe(fxParam)

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

removeKeyframeAtTime(fxParam, time)

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

setBooleanVal(fxParam, val)

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

setBooleanValAtTime(fxParam, val, time)

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

setColorVal(fxParam, val)

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

setColorValAtTime(fxParam, val, time)

set color value at certain time
Parameters:
Name Type Description
fxParam name of parameter
val value
time time
Overrides:
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
Overrides:
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
Overrides:
Source:
Returns:

setExprVar(varName, varValue)

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

setFilterIntensity(intensity)

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

setFloatVal(fxParam, val)

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

setFloatValAtTime(fxParam, val, time)

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

setIgnoreBackground(isIgnoreBackground)

set ignore background
Parameters:
Name Type Description
isIgnoreBackground ignore background or not
Overrides:
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
Overrides:
Source:
Returns:

setIntValAtTime(fxParam, val, time)

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

setInverseRegion(isInverseRegion)

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

setMenuVal(fxParam, val)

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

setMenuValAtTime(fxParam, val, time)

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

setRegion(region)

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

setRegional(isRegional)

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

setRegionalFeatherWidth(featherWidth)

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

setRegionAtTime(region, time)

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

setStringVal(fxParam, val)

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

setStringValAtTime(fxParam, val, time)

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

setTemplateAttachment(key, value)

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