Class: NvsTimelineAnimatedSticker

NvsTimelineAnimatedSticker()

Timeline animated sticker class. Timeline animation sticker is a landscaping effect used in video editing to produce animated effects. Users can add and remove animated stickers from the timeline, as well as adjust various properties of the stickers through various APIs, such as position, size, display time, and so on. Note: The in-point and out-point units of the animated sticker on the timeline are both in microseconds.

Constructor

new NvsTimelineAnimatedSticker()

Source:

Extends

Methods

changeInPoint(newInPoint)

Change the in-point of the animated sticker on the timeline. When the new in-point does not conform to the established rules, the final return in-point may be different from the new in-point value. Such as the new in-point is less than 0, the new in-point value is greater than the timeline duration, or the new in-point is greater than the out-point.
Parameters:
Name Type Description
newInPoint The new in-point of the animated sticker on the timeline (in microseconds).
Source:
Returns:

changeOutPoint(newOutPoint)

Change the out-point of the animated sticker on the timeline. When the new out-point does not conform to the established rules, the final return out-point may be different from the new out-point value. Such as the new out-point is less than 0, the new out-point value is greater than the timeline duration, or the new out-point is less than the in-point.
Parameters:
Name Type Description
newOutPoint The out-point of the animated sticker on the timeline (in microseconds).
Source:
Returns:

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:

getAnimatedStickerPackageId()

Get animated sticker's package ID.
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:

getBoundingRectangleVertices()

Get the vertex positions of the animated sticker's original bounding in the timeline coordinate system.
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:

getHorizontalFlip()

Get the horizontal flip state of the animated sticker.
Source:
Returns:

getIgnoreBackground()

get ignore background
Overrides:
Source:
Returns:

getInPoint()

Get animated sticker's in-point on the timeline.
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:

getOpacity()

Get the sticker opacity.
Source:
Returns:

getOutPoint()

Get animated sticker's out-point on the timeline.
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:

getRotationZ()

Get the angle at which the animation sticker rotates clockwise along the Z-axis, which is perpendicular to the screen.
Source:
Returns:

getScale()

Get the scale value of the animated sticker.
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

getTranslation()

Get the translation position of the animated sticker in the timeline coordinate system.
Source:
Returns:

getVerticalFlip()

Get the vertical flip state of the animated sticker.
Source:
Returns:

getVolumeGain()

Get volume information.
Source:
Returns:

getZValue()

Get the sticker Z value.
Source:
Returns:

hasAudio()

Check whether the sticker contains audio.
Source:
Returns:

hasKeyframeList(fxParam)

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

movePosition(offset)

Change the display position of the animated sticker on the timeline (the in and out points are offset from the offset value at the same time).
Parameters:
Name Type Description
offset Offset value for in and out points changes (in microseconds).
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:

rotateAnimatedSticker(angle, anchor)

Rotate the animation sticker around the anchor point. The rotation angle set by this function is stackable.
Parameters:
Name Type Description
angle rotation angle.
anchor rotation anchor.
Source:
Returns:

rotateAnimatedSticker2(angle)

Rotate the animation sticker around center. The rotation angle set by this function is stackable.
Parameters:
Name Type Description
angle rotation angle.
Source:
Returns:

scaleAnimatedSticker(scaleFactor, anchor)

Scale animation sticker with the anchor point as the center. The scaling value set by this function is stackable.
Parameters:
Name Type Description
scaleFactor Animated sticker scaling factor.
anchor Animated sticker scale anchor.
Source:
Returns:

scaleAnimatedSticker2(scaleFactor)

Scale animation sticker on center. The scaling value set by this function is stackable.
Parameters:
Name Type Description
scaleFactor Animated sticker scaling factor.
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:

setCurrentKeyFrameTime(time)

Set the sticker's Key frame time
Parameters:
Name Type Description
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
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:

setHorizontalFlip(flip)

Set the horizontal flip of the animated sticker.
Parameters:
Name Type Description
flip Whether to flip horizontally. True means horizontal flip, and false means not.
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:

setOpacity(opacity)

Set the sticker opacity,value range [0, 1].
Parameters:
Name Type Description
opacity sticker opacity.
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:

setRotationZ(angle)

Set the angle at which the animation sticker rotates clockwise along the Z-axis, which is perpendicular to the screen.The rotation Angle set by this function does not stack.
Parameters:
Name Type Description
angle Rotation angle value.
Source:
Returns:

setScale(scale)

Set the scale value of the animated sticker. The scale value set by this function do not stack.
Parameters:
Name Type Description
scale Scaling value.
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:

setTranslation(translation)

Set the translation position of the animated sticker in the timeline coordinate system.
Parameters:
Name Type Description
translation Translation position
Source:
Returns:

setVerticalFlip(flip)

Set the vertical flip of the animated sticker.
Parameters:
Name Type Description
flip Set the vertical flip of the animated sticker.
Source:
Returns:

setVolumeGain(leftVolumeGain, rightVolumeGain)

Set the sticker volume.
Parameters:
Name Type Description
leftVolumeGain Left channel volume gain,value range [0, 1].
rightVolumeGain Right channel volume gain,value range [0, 1].
Source:
Returns:

setZValue(value)

Set the sticker Z value.The higher the Z value, the higher the sticker is.
Parameters:
Name Type Description
value Z value
Source:
Returns:

translateAnimatedSticker(translationOffset)

Tanslate animated sticker in the timeline coordinate system.The translation coordinates set by this function are stackable.
Parameters:
Name Type Description
translationOffset Animated sticker translation offset values.
Source:
Returns: