NvsTrackAnimatedSticker Class Reference

Track animated sticker. More...

Inheritance diagram for NvsTrackAnimatedSticker:

Public Member Functions
	constructor ()
	getInPoint ()
	Get animated sticker's in-point on the track. More...
	getOutPoint ()
	Get animated sticker's out-point on the track. More...
	changeInPoint (newInPoint)
	Change the in-point of the animated sticker on the track. 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. More...
	changeOutPoint (newOutPoint)
	Change the out-point of the animated sticker on the track. 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. More...
	movePosition (offset)
	Change the display position of the animated sticker on the track (the in and out points are offset from the offset value at the same time). More...
Public Member Functions inherited from NvsAnimatedSticker
	constructor ()
	constructor
	setTranslation (translation)
	Sets the translation position of the animated sticker in the timeline coordinate system.The translation coordinate set by this function do not stack. More...
	getTranslation ()
	Get the translation position of the animated sticker in the timeline coordinate system. More...
	translateAnimatedSticker (translationOffset)
	Tanslate animated sticker in the timeline coordinate system.The translation coordinates set by this function are stackable. More...
	setScale (scale)
	Set the scale value of the animated sticker. The scale value set by this function do not stack. More...
	getScale ()
	Get the scale value of the animated sticker. More...
	scaleAnimatedSticker (scaleFactor, anchor)
	Scale animation sticker with the anchor point as the center. The scaling value set by this function is stackable. More...
	scaleAnimatedSticker2 (scaleFactor)
	Scale animation sticker on center. The scaling value set by this function is stackable. More...
	setSeperatedScaleX (seperatedScaleX)
	Set seperated horizontal scaling factor for animated sticker. More...
	setSeperatedScaleY (seperatedScaleY)
	Set separated vertical scaling factor for animated sticker. More...
	getSeperatedScaleX ()
	Get separated horizontal scaling factor for animated sticker. More...
	getSeperatedScaleY ()
	Get separated vertical scaling factor for animated sticker. More...
	seperateScaleAnimatedSticker (scaleXFactor, scaleYFactor, anchor)
	Separate scale animated sticker based on anchor point. More...
	seperateScaleAnimatedSticker2 (scaleXFactor, scaleYFactor)
	Seperate scale animated sticker based on center point. More...
	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. More...
	getRotationZ ()
	Get the angle at which the animation sticker rotates clockwise along the Z-axis, which is perpendicular to the screen. More...
	rotateAnimatedSticker (angle, anchor)
	Scale animation sticker with the anchor point as the center. The scaling value set by this function is stackable. More...
	rotateAnimatedSticker2 (angle)
	Rotate the animation sticker around center. The rotation angle set by this function is stackable. More...
	setHorizontalFlip (flip)
	Set the horizontal flip of the animated sticker. More...
	getHorizontalFlip ()
	Get the horizontal flip state of the animated sticker. More...
	setVerticalFlip (flip)
	Set the vertical flip of the animated sticker. More...
	getVerticalFlip ()
	Get the vertical flip state of the animated sticker. More...
	getBoundingRectangleVertices ()
	Get the vertex positions of the animated sticker's original bounding in the timeline coordinate system. More...
	getAnimatedStickerPackageId ()
	Get animated sticker's package ID. More...
	setZValue (value)
	Set the sticker Z value.The higher the Z value, the higher the sticker is. More...
	getZValue ()
	Get the sticker Z value. More...
	hasAudio ()
	Check whether the sticker contains audio. More...
	setVolumeGain (leftVolumeGain, rightVolumeGain)
	Set the sticker volume. More...
	getVolumeGain ()
	Set the sticker volume. More...
	setOpacity (opacity)
	Set the sticker opacity,value range [0, 1]. More...
	getOpacity ()
	Get the sticker opacity. More...
	setCurrentKeyFrameTime (time)
	Set the sticker current time values as key frame. More...
	getAnimatedStickerPeriodAnimationPackageId ()
	Gets the animated sticker period animation style package ID. More...
	getAnimatedStickerInAnimationPackageId ()
	Set the sticker's Key frame time. More...
	getAnimatedStickerOutAnimationPackageId ()
	Set the sticker's Key frame time. More...
	applyAnimatedStickerPeriodAnimation (animatedStickerPeriodAnimationPackageId)
	Applys animated sticker loop-animation style. More...
	applyAnimatedStickerInAnimation (animatedStickerInAnimationPackageId)
	Applys animated sticker in-animation style. Notes：please set loop-Animation to null before you set in-animation, otherwise it will NOT works. More...
	applyAnimatedStickerOutAnimation (animatedStickerOutAnimationPackageId)
	Applys animated sticker out-animation style.Notes：please set loop-Animation to null before you set out-animation, otherwise it will NOT works. More...
	setAnimatedStickerAnimationPeriod (periodInMS)
	Set animated sticker Animation Period. More...
	getAnimatedStickerAnimationPeriod ()
	Get animated sticker Animation Period. More...
	setAnimatedStickerInAnimationDuration (inAnimationDurationInMS)
	Set animated sticker in-animation duration. More...
	getAnimatedStickerInAnimationDuration ()
	Get animated sticker in-animation duration. More...
	setAnimatedStickerOutAnimationDuration (outAnimationDurationInMS)
	Set animated sticker out-animation duration. More...
	getAnimatedStickerOutAnimationDuration ()
	Get animated sticker out-animation duration. More...
Public Member Functions inherited from NvsFx
	constructor ()
	NvsFx constructor.
	getDescription ()
	Get description of Fx.Return the NvsFxDescription object. More...
	setIntVal (fxParam, val)
	Set the integer parameter of NvsFx.The type of the NvsFx's integer parameter. More...
	getIntVal (fxParam)
	Get the integer parameter of NvsFx.Return the integer value. More...
	setIntValAtTime (fxParam, val, time)
	Set the NvsFx's integer parameter at a specified time point. More...
	getIntValAtTime (fxParam, time)
	Get the NvsFx's integer parameter at a specified time point.Return the integer value. More...
	setFloatVal (fxParam, val)
	set float value More...
	getFloatVal (fxParam)
	get float value More...
	setFloatValAtTime (fxParam, val, time)
	Set the NvsFx's float parameter at a specified time point. More...
	getFloatValAtTime (fxParam, time)
	Get the NvsFx's float parameter at a specified time point.Return the double value. More...
	setBooleanVal (fxParam, val)
	Set the boolean parameter of NvsFx. More...
	getBooleanVal (fxParam)
	Get the boolean parameter of NvsFx.Return the boolean value. More...
	setBooleanValAtTime (fxParam, val, time)
	Set the NvsFx’s boolean parameter at a specified time point. More...
	getBooleanValAtTime (fxParam, time)
	Get the NvsFx's boolean parameter at a specified time point. More...
	setMenuVal (fxParam, val)
	Set the menu parameter of NvsFx. More...
	getMenuVal (fxParam)
	Get the menu parameter of NvsFx.Return the menu value of NvsFx. More...
	setMenuValAtTime (fxParam, val, time)
	Set the NvsFx's menu parameter at a specified time point. More...
	getMenuValAtTime (fxParam, time)
	Get the NvsFx menu parameter at a specified time point.Return the menu value of NvsFx. More...
	setStringVal (fxParam, val)
	Set the string parameter of NvsFx. More...
	getStringVal (fxParam)
	Get the string parameter of NvsFx.Return the string value. More...
	setStringValAtTime (fxParam, val, time)
	Set the NvsFx's string parameter at a specified time point. More...
	getStringValAtTime (fxParam, time)
	Get the NvsFx's string parameter at a specified time point.Return the string value. More...
	setColorVal (fxParam, val)
	Set the color parameter of NvsFx. More...
	getColorVal (fxParam)
	Get the color parameter of NvsFx. More...
	setColorValAtTime (fxParam, val, time)
	Set the NvsFx's color parameter at a specified time point. More...
	getColorValAtTime (fxParam, time)
	get color value at certain time More...
	removeKeyframeAtTime (fxParam, time)
	remove Remove key frame at a specified time point from key frame list. More...
	removeAllKeyframe (fxParam)
	remove Remove all key frames from key frame list. More...
	hasKeyframeList (fxParam)
	Check whether the parameter has key frame list or not. More...
	findKeyframeTime (fxParam, time, flags)
	Get key frame at a specified time point. More...
	setParamKeyframes (fxParam, keyframes)
	Set key frame parameters. More...
	getParamKeyframes (fxParam)
	Get key frame parameters. More...
	setParamKeyframeAtTime (fxParam, time, keyframe)
	Set key frame at a specified time point. More...
	getParamKeyframeAtTime (fxParam, time)
	Get key frame at a specified time point. More...
	getIntpFxParamValsAtTime (fxParam, time)
	Get key frame at a specified time point. More...
	setFilterIntensity (intensity)
	Set the intensity of the filter. More...
	getFilterIntensity ()
	Get the intensity of the filter. More...
	setRegional (isRegional)
	Set whether the filter is regional. More...
	getRegional ()
	Get whether the filter is regional. More...
	setIgnoreBackground (isIgnoreBackground)
	Set whether the regional filter ignores background. More...
	getIgnoreBackground ()
	Get whether the regional filter ignores background. More...
	setInverseRegion (isInverseRegion)
	Set whether the regional filter inverses region. More...
	getInverseRegion ()
	Get whether the regional filter inverses region. More...
	setRegion (region)
	Set the region of this regional filter. More...
	setRegionAtTime (region, time)
	set region at certain time More...
	setEllipseRegion (center, a, b, angle)
	set ellipse region More...
	setEllipseRegionAtTime (center, a, b, angle, time)
	set ellipse region at certain time More...
	getRegionInfos ()
	Get the mask region informations of the regional filter. More...
	getRegionInfosAtTime (time)
	Get the mask region informations of the regional filter at a specified time. More...
	setRegionalFeatherWidth (featherWidth)
	Set the feather width of the regional filter. More...
	getRegionalFeatherWidth ()
	Get the feather width of the regional filter. More...
	getParticleSystemContext ()
	Get the particle effect context object. More...
	getARSceneManipulate ()
	Get the manipulate of ARScene. More...
	setExprVar (varName, varValue)
	Set the value of the defined parameter in the expression. More...
	getExprVar (varName)
	Get the value of the defined parameter in the expression. More...
	setExprObjectVar (varName, varValue)
	Set the object(e.g. color) value of the defined parameter in the expression. More...
	getExprObjectVar (varName)
	Get the object(e.g. color) value of the defined parameter in the expression. More...
	clearExprVar ()
	Clear the value of the defined parameter in the expression and set it to the default value of 0. More...
	clearExprVarCtx ()
	Clear all parameter values defined in the expression and set them to the default value of 0. More...
	setArbitraryVal (fxParam, val)
	Set arbitrary value of fx. More...
	getArbitraryVal (fxParam)
	Get the arbitrary value of fx. More...
	setArbitraryValAtTime (fxParam, val, time)
	Set arbitrary value of fx at time. More...
	getArbitraryValAtTime (fxParam, time)
	Get arbitrary value of fx at time. More...
	setRegionInfos (regionInfos)
	Set region infos of fx. More...
	setRegionInfosAtTime (regionInfos, time)
	Set region infos of fx at time. More...
Public Member Functions inherited from NvsProjObj
	constructor ()
	setInternalObject (obj)
	set internal object More...
	getInternalObject ()
	get internal object More...
	setTemplateAttachment (key, value)
	Adds additional template data to the NvsObject object to identify the NvsObject template object. More...
	getTemplateAttachment (key)
	Gets an template attachment to NvsObject. More...

Detailed Description

Track animated sticker.

Member Function Documentation

changeInPoint()

NvsTrackAnimatedSticker::changeInPoint (   newInPoint )

inline

Change the in-point of the animated sticker on the track. 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

{Number}

newInPoint The new in-point of the animated sticker on the track (in microseconds).

Returns

{Number} Return the in-point of the animated sticker on the track (in microseconds).

changeOutPoint()

NvsTrackAnimatedSticker::changeOutPoint (   newOutPoint )

inline

Change the out-point of the animated sticker on the track. 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

{Number}

newOutPoint The out-point of the animated sticker on the track (in microseconds).

Returns

{Number} Return the out-point of the animated sticker on the track (in microseconds).

constructor()

NvsTrackAnimatedSticker::constructor ( )

inline

@constructor

getInPoint()

NvsTrackAnimatedSticker::getInPoint ( )

inline

Get animated sticker's in-point on the track.

Returns

{Number} Return the in-point of the animated sticker on the track (in microseconds).

getOutPoint()

NvsTrackAnimatedSticker::getOutPoint ( )

inline

Get animated sticker's out-point on the track.

Returns

{Number} Return the out-point of the animated sticker on the track (in microseconds).

movePosition()

NvsTrackAnimatedSticker::movePosition (   offset )

inline

Change the display position of the animated sticker on the track (the in and out points are offset from the offset value at the same time).

Parameters

{Number}

offset Offset value for in and out points changes (in microseconds).

---

The documentation for this class was generated from the following file:

• src/js/NvStreamingSdk.js