Animated sticker class.Animation sticker is a landscaping effect used in video editing to produce animated effects. Users can add and adjust various properties of the stickers through various APIs, such as position, size, display time, and so on. More...

Inheritance diagram for NveAnimatedSticker:

Public Member Functions
	constructor ()
	constructor

	setTranslation (translation)
	Sets the translation position of the animated sticker in the resolution coordinate system.The translation coordinate set by this function do not stack. More...

	getTranslation ()
	Get the translation position of the animated sticker in the resolution coordinate system. More...

	translateAnimatedSticker (translationOffset)
	Tanslate animated sticker in the resolution 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 resolution 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's Key frame time. 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 NveEffectInstance
	constructor ()
	The constructor of NveEffectInstance.

	release ()
	Release the instance of effect You must call release() if you won't use this effect instance object anymore, otherwise there will be severe internal resources leak!

	setIntVal (fxParam, val)
	Set the integer parameter value of the effect. More...

	getIntVal (fxParam)
	Get the integer parameter value of the effect. More...

	setFloatVal (fxParam, val)
	Set the float parameter value of the effect. More...

	getFloatVal (fxParam)
	Get the float parameter value of the effect. More...

	setBooleanVal (fxParam, val)
	Set the boolean parameter value of the effect. More...

	getBooleanVal (fxParam)
	Get the boolean parameter value of the effect. More...

	setMenuVal (fxParam, val)
	Set the menu parameter value of the effect. More...

	getMenuVal (fxParam)
	Get the menu parameter value of the effect. More...

	setStringVal (fxParam, val)
	Set the string parameter value of the effect. More...

	getStringVal (fxParam)
	Get the string parameter value of the effect. More...

	setColorVal (fxParam, val)
	Set the color parameter value of the effect. More...

	getColorVal (fxParam)
	Get the color parameter value of the effect. More...

	setFilterIntensity (intensity)
	Set the intensity of the filter. More...

	getFilterIntensity ()
	Get the intensity of the filter. More...

	getARSceneManipulate ()
	Get the manipulate of ARScene. More...

	getInPoint ()
	Get in-point of effect. More...

	getOutPoint ()
	Get out point of effect. More...

	changeInPoint (newInPoint)
	Changes in-point of effect. More...

	changeOutPoint (newOutPoint)
	Changes out-point of effect. More...

Detailed Description

Animated sticker class.Animation sticker is a landscaping effect used in video editing to produce animated effects. Users can add and 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 are both in microseconds.

See also: NveEffectInstance

Member Function Documentation

◆ applyAnimatedStickerInAnimation()

NveAnimatedSticker::applyAnimatedStickerInAnimation ( animatedStickerInAnimationPackageId )

inline

Applys animated sticker in-animation style. Notes：please set loop-Animation to null before you set in-animation, otherwise it will NOT works.

Parameters

{String} animatedStickerPeriodAnimationPackageId animated sticker in-animation style resource package ID.

Returns: {Boolean} Returns boolean value. Returns boolean value. True means a successful application, false means a failure.

◆ applyAnimatedStickerOutAnimation()

NveAnimatedSticker::applyAnimatedStickerOutAnimation ( animatedStickerOutAnimationPackageId )

inline

Applys animated sticker out-animation style.Notes：please set loop-Animation to null before you set out-animation, otherwise it will NOT works.

Parameters

{String} animatedStickerPeriodAnimationPackageId animated sticker out-animation style resource package ID.

Returns: {Boolean} Returns boolean value. True means a successful application, false means a failure.

◆ applyAnimatedStickerPeriodAnimation()

NveAnimatedSticker::applyAnimatedStickerPeriodAnimation ( animatedStickerPeriodAnimationPackageId )

inline

Applys animated sticker loop-animation style.

Parameters

{String} animatedStickerPeriodAnimationPackageId animated sticker loop-animation style resource package ID.

Returns: {Boolean} Returns boolean value. True means a successful application, false means a failure.

◆ getAnimatedStickerAnimationPeriod()

NveAnimatedSticker::getAnimatedStickerAnimationPeriod ( )

inline

Get animated sticker Animation Period.

Returns: {Number} Return animation period in millisecond

◆ getAnimatedStickerInAnimationDuration()

NveAnimatedSticker::getAnimatedStickerInAnimationDuration ( )

inline

Get animated sticker in-animation duration.

Returns: {Number} Get animated sticker in-animation duration.

◆ getAnimatedStickerInAnimationPackageId()

NveAnimatedSticker::getAnimatedStickerInAnimationPackageId ( )

inline

Set the sticker's Key frame time.

Returns: {String} Returns the obtained modular sticker in-animation style resource package ID.

◆ getAnimatedStickerOutAnimationDuration()

NveAnimatedSticker::getAnimatedStickerOutAnimationDuration ( )

inline

Get animated sticker out-animation duration.

Returns: {Number} Return out-animation duration in millisecond

◆ getAnimatedStickerOutAnimationPackageId()

NveAnimatedSticker::getAnimatedStickerOutAnimationPackageId ( )

inline

Set the sticker's Key frame time.

Returns: {String} Returns the obtained modular sticker in-animation style resource package ID.

◆ getAnimatedStickerPackageId()

NveAnimatedSticker::getAnimatedStickerPackageId ( )

inline

Get animated sticker's package ID.

Returns: {String} Return the animated sticker's package ID.

◆ getAnimatedStickerPeriodAnimationPackageId()

NveAnimatedSticker::getAnimatedStickerPeriodAnimationPackageId ( )

inline

Gets the animated sticker period animation style package ID.

Returns: {String} Returns the obtained modular sticker period animation style resource package ID.

◆ getBoundingRectangleVertices()

NveAnimatedSticker::getBoundingRectangleVertices ( )

inline

Get the vertex positions of the animated sticker's original bounding in the resolution coordinate system.

Returns: {NveVectorVal<NvePointF>} Return a NveVectorVal<NvePointF> object containing four vertex positions corresponding to the top left, bottom left, bottom right, and top right vertices of the original bounding.

See also: NveVectorVal

◆ getHorizontalFlip()

NveAnimatedSticker::getHorizontalFlip ( )

inline

Get the horizontal flip state of the animated sticker.

Returns: {Boolean} Return a boolean value indicating a horizontal flip state. True means it flips, false means not.

◆ getOpacity()

NveAnimatedSticker::getOpacity ( )

inline

Get the sticker opacity.

Returns: {Number} Return the sticker opacity.

◆ getRotationZ()

NveAnimatedSticker::getRotationZ ( )

inline

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

Returns: {Number} Return the rotation angle value.

◆ getScale()

NveAnimatedSticker::getScale ( )

inline

Get the scale value of the animated sticker.

Returns: {Number} the scale value.

See also: setScale

◆ getSeperatedScaleX()

NveAnimatedSticker::getSeperatedScaleX ( )

inline

Get separated horizontal scaling factor for animated sticker.

Returns: {Number} Returns animated sticker separated horizontal scaling factor.

◆ getSeperatedScaleY()

NveAnimatedSticker::getSeperatedScaleY ( )

inline

Get separated vertical scaling factor for animated sticker.

Returns: {Number} Returns animated sticker separated vertical scaling factor.

◆ getTranslation()

NveAnimatedSticker::getTranslation ( )

inline

Get the translation position of the animated sticker in the resolution coordinate system.

Returns: {NvePointF} The translation position.

See also: setTranslation

◆ getVerticalFlip()

NveAnimatedSticker::getVerticalFlip ( )

inline

Get the vertical flip state of the animated sticker.

Returns: {Boolean} Return a boolean value indicating a vertical flip state. True means it flips, false means not.

◆ getVolumeGain()

NveAnimatedSticker::getVolumeGain ( )

inline

Set the sticker volume.

Get volume information.

Returns: {NveVolume} Return the volume object.

◆ getZValue()

NveAnimatedSticker::getZValue ( )

inline

Get the sticker Z value.

Returns: {Number} Return sticker Z value.

◆ hasAudio()

NveAnimatedSticker::hasAudio ( )

inline

Check whether the sticker contains audio.

Returns: {Boolean} Return whether the sticker contains audio.

◆ rotateAnimatedSticker()

NveAnimatedSticker::rotateAnimatedSticker	(	angle,
		anchor
	)

inline

Scale animation sticker with the anchor point as the center. The scaling value set by this function is stackable.

Parameters

{Number}	angle Rotation angle.
{NvePointF}	anchor Rotation anchor.

Returns: {void}

◆ rotateAnimatedSticker2()

NveAnimatedSticker::rotateAnimatedSticker2 ( angle )

inline

Rotate the animation sticker around center. The rotation angle set by this function is stackable.

Parameters

{Number} angle rotation angle.

Returns: {void}

◆ scaleAnimatedSticker()

NveAnimatedSticker::scaleAnimatedSticker	(	scaleFactor,
		anchor
	)

inline

Scale animation sticker with the anchor point as the center. The scaling value set by this function is stackable.

Parameters

{Number}	scaleFactor Animated sticker scaling factor.
{NvePointF}	anchor Animated sticker scale anchor.

See also: setScale; scaleAnimatedSticker2

◆ scaleAnimatedSticker2()

NveAnimatedSticker::scaleAnimatedSticker2 ( scaleFactor )

inline

Scale animation sticker on center. The scaling value set by this function is stackable.

Parameters

{Number} scaleFactor Animated sticker scaling factor.

See also: scaleAnimatedSticker

◆ seperateScaleAnimatedSticker()

NveAnimatedSticker::seperateScaleAnimatedSticker	(	scaleXFactor,
		scaleYFactor,
		anchor
	)

inline

Separate scale animated sticker based on anchor point.

Parameters

{Number}	scaleXFactor Seperated horizontal scaling factor.
{Number}	scaleYFactor Seperated vertical scaling factor.
{NvePointF}	anchor Animated sticker scale anchor.

Returns: {void}

◆ seperateScaleAnimatedSticker2()

NveAnimatedSticker::seperateScaleAnimatedSticker2	(	scaleXFactor,
		scaleYFactor
	)

inline

Seperate scale animated sticker based on center point.

Parameters

{Number}	scaleXFactor Seperated horizontal scaling factor.
{Number}	scaleYFactor Seperated vertical scaling factor.

Returns: {void}

◆ setAnimatedStickerAnimationPeriod()

NveAnimatedSticker::setAnimatedStickerAnimationPeriod ( periodInMS )

inline

Set animated sticker Animation Period.

Parameters

{Number} periodInMS Animation period in millisecond

Returns: {void}

◆ setAnimatedStickerInAnimationDuration()

NveAnimatedSticker::setAnimatedStickerInAnimationDuration ( inAnimationDurationInMS )

inline

Set animated sticker in-animation duration.

Parameters

{Number} inAnimationDurationInMS in-animation duration in millisecond

Returns: {void}

◆ setAnimatedStickerOutAnimationDuration()

NveAnimatedSticker::setAnimatedStickerOutAnimationDuration ( outAnimationDurationInMS )

inline

Set animated sticker out-animation duration.

Parameters

{Number} outAnimationDurationInMS out-animation duration in millisecond

Returns: {void}

◆ setCurrentKeyFrameTime()

NveAnimatedSticker::setCurrentKeyFrameTime ( time )

inline

Set the sticker's Key frame time.

Parameters

{Number} time time point

Returns: {void}

◆ setHorizontalFlip()

NveAnimatedSticker::setHorizontalFlip ( flip )

inline

Set the horizontal flip of the animated sticker.

Parameters

{Boolean} flip Whether to flip horizontally. True means horizontal flip, and false means not.

Returns: {void}

◆ setOpacity()

NveAnimatedSticker::setOpacity ( opacity )

inline

Set the sticker opacity,value range [0, 1].

Parameters

{Number} opacity sticker opacity.

Returns: {void}

◆ setRotationZ()

NveAnimatedSticker::setRotationZ ( angle )

inline

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

{Number} angle Rotation angle value.

Returns: {void}

◆ setScale()

NveAnimatedSticker::setScale ( scale )

inline

Set the scale value of the animated sticker. The scale value set by this function do not stack.

Parameters

{Number} scale the scale value.

See also: getScale

◆ setSeperatedScaleX()

NveAnimatedSticker::setSeperatedScaleX ( seperatedScaleX )

inline

Set seperated horizontal scaling factor for animated sticker.

Parameters

{Number} seperatedScaleX Seperated horizontal scaling factor.

Returns: {void}

◆ setSeperatedScaleY()

NveAnimatedSticker::setSeperatedScaleY ( seperatedScaleY )

inline

Set separated vertical scaling factor for animated sticker.

Parameters

{Number} seperatedScaleY Seperated vertical scaling factor.

Returns: {void}

◆ setTranslation()

NveAnimatedSticker::setTranslation ( translation )

inline

Sets the translation position of the animated sticker in the resolution coordinate system.The translation coordinate set by this function do not stack.

Parameters

{NvePointF} translation Translation position

See also: getTranslation

◆ setVerticalFlip()

NveAnimatedSticker::setVerticalFlip ( flip )

inline

Set the vertical flip of the animated sticker.

Parameters

{Boolean} flip Whether to flip vertically. True means it flip vertically, false means not.

Returns: {void} Set the vertical flip of the animated sticker.

◆ setVolumeGain()

NveAnimatedSticker::setVolumeGain	(	leftVolumeGain,
		rightVolumeGain
	)

inline

Set the sticker volume.

Parameters

{Number}	leftVolumeGain Left channel volume gain,value range [0, 1].
{Number}	rightVolumeGain Right channel volume gain,value range [0, 1].

Returns: {void}

◆ setZValue()

NveAnimatedSticker::setZValue ( value )

inline

Set the sticker Z value.The higher the Z value, the higher the sticker is.

Parameters

{Number} value Z value

Returns: {} Set the sticker Z value.The higher the Z value, the higher the sticker is.

◆ translateAnimatedSticker()

NveAnimatedSticker::translateAnimatedSticker ( translationOffset )

inline

Tanslate animated sticker in the resolution coordinate system.The translation coordinates set by this function are stackable.

Parameters

{NvePointF} translationOffset translation offset.

See also: setTranslation

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

src/js/NvEffectSdk.js

Public Member Functions

Detailed Description

Member Function Documentation

◆ applyAnimatedStickerInAnimation()

◆ applyAnimatedStickerOutAnimation()

◆ applyAnimatedStickerPeriodAnimation()

◆ getAnimatedStickerAnimationPeriod()

◆ getAnimatedStickerInAnimationDuration()

◆ getAnimatedStickerInAnimationPackageId()

◆ getAnimatedStickerOutAnimationDuration()

◆ getAnimatedStickerOutAnimationPackageId()

◆ getAnimatedStickerPackageId()

◆ getAnimatedStickerPeriodAnimationPackageId()

◆ getBoundingRectangleVertices()

◆ getHorizontalFlip()

◆ getOpacity()

◆ getRotationZ()

◆ getScale()

◆ getSeperatedScaleX()

◆ getSeperatedScaleY()

◆ getTranslation()

◆ getVerticalFlip()

◆ getVolumeGain()

◆ getZValue()

◆ hasAudio()

◆ rotateAnimatedSticker()

◆ rotateAnimatedSticker2()

◆ scaleAnimatedSticker()

◆ scaleAnimatedSticker2()

◆ seperateScaleAnimatedSticker()

◆ seperateScaleAnimatedSticker2()

◆ setAnimatedStickerAnimationPeriod()

◆ setAnimatedStickerInAnimationDuration()

◆ setAnimatedStickerOutAnimationDuration()

◆ setCurrentKeyFrameTime()

◆ setHorizontalFlip()

◆ setOpacity()

◆ setRotationZ()

◆ setScale()

◆ setSeperatedScaleX()

◆ setSeperatedScaleY()

◆ setTranslation()

◆ setVerticalFlip()

◆ setVolumeGain()

◆ setZValue()

◆ translateAnimatedSticker()