Animated sticker class. More...

Inheritance diagram for com.meicam.effect.sdk.NvsVideoEffectAnimatedSticker:

Public Member Functions
long	getInPoint ()
	Get animated sticker's in-point. More...

long	getOutPoint ()
	Get animated sticker's out-point. More...

String	getAnimatedStickerPackageId ()
	Get animated sticker's package ID. More...

long	changeInPoint (long newInPoint)
	Change the in-point of the animated sticker 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...

long	changeOutPoint (long newOutPoint)
	Change the out-point of the animated sticker 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...

void	movePosition (long offset)
	Change the display position of the animated sticker (the in and out points are offset from the offset value at the same time). More...

void	setScale (float scale)
	Set the scale value of the animated sticker. The scale value set by this function do not stack. More...

float	getScale ()
	Get the scale value of the animated sticker. More...

void	setHorizontalFlip (boolean flip)
	Set the horizontal flip of the animated sticker. More...

boolean	getHorizontalFlip ()
	Get the horizontal flip state of the animated sticker. More...

void	setVerticalFlip (boolean flip)
	Set the vertical flip of the animated sticker. More...

boolean	getVerticalFlip ()
	Get the vertical flip state of the animated sticker. More...

void	setRotationZ (float 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...

float	getRotationZ ()
	Get the angle at which the animation sticker rotates clockwise along the Z-axis, which is perpendicular to the screen. More...

void	setTranslation (PointF translation)
	Sets the translation position of the animated sticker in the timeline coordinate system.The translation coordinate set by this function do not stack.please refer to TimeLine and View Coordinate. More...

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

void	translateAnimatedSticker (PointF translationOffset)
	Tanslate animated sticker in the video resolution coordinate system.The translation coordinates set by this function are stackable. More...

void	scaleAnimatedSticker (float scaleFactor, PointF anchor)
	Scale animation sticker with the anchor point as the center. The scaling value set by this function is stackable. More...

void	rotateAnimatedSticker (float angle, PointF anchor)
	Rotate the animation sticker around the anchor point. The rotation angle set by this function is stackable. More...

void	rotateAnimatedSticker (float angle)
	Rotate the animation sticker with the center point of the animation sticker as the anchor point.The rotation angle set by this function is stackable. More...

RectF	getOriginalBoundingRect ()
	Get the original bounding of the animated sticker in the video resolution coordinate system.please refer to TimeLine and View Coordinate. More...

List< PointF >	getBoundingRectangleVertices ()
	Get the vertex positions of the animated sticker's original bounding in the video resolution coordinate system.please refer to TimeLine and View Coordinate. More...

boolean	isPanoramic ()
	Determine whether the animated sticker is a panorama animated sticker or not. More...

void	setCenterPolarAngle (float centerPolarAngle)
	Set the polar angle of the center point on the animated sticker. Only valid for panorama animated stickers. More...

float	getCenterPolarAngle ()
	Get the polar angle of the center point of the animated sticker. It is only valid for panorama animated stickers. More...

void	setCenterAzimuthAngle (float centerAzimuthAngle)
	Set the azimuth of the center point on the animated sticker. It is only valid for panorama animated stickers. More...

float	getCenterAzimuthAngle ()
	Get the azimuth of the center point of the animated sticker. It is only valid for panorama animated stickers. More...

void	setPolarAngleRange (float polarAngleRange)
	Set animated sticker's field angle, which is coplanar with the polar angle. It is only valid for panorama animated stickers. More...

float	getPolarAngleRange ()
	Get animated sticker's field angle, which is coplanar with the polar angle. It is only valid for panorama animated stickers. More...

float	getOrthoAngleRange ()
	Get the animated sticker’s field angle which is perpendicular to the polar angle. It is only valid for panorama animated stickers. More...

void	setZValue (float value)
	Set the sticker Z value.The higher the Z value, the higher the sticker is. More...

float	getZValue ()
	Get the sticker Z value. More...

long	getDefaultDuration ()
	Get the default duration of the sticker. More...

void	setOpacity (float opacity)
	Set the sticker opacity,value range [0, 1]. More...

float	getOpacity ()
	Get the sticker opacity. More...

void	setCurrentKeyFrameTime (long time)
	Set the sticker's Key frame time. More...

void	setVideoResolution (NvsVideoResolution resolution)
	Set the sticker's video resolution. More...

String	getAnimatedStickerPeriodAnimationPackageId ()
	Gets the animated sticker period animation style package ID. More...

String	getAnimatedStickerInAnimationPackageId ()
	Gets the animated sticker in-animation style package ID. More...

String	getAnimatedStickerOutAnimationPackageId ()
	Gets the animated sticker out-animation style package ID. More...

boolean	applyAnimatedStickerPeriodAnimation (String animatedStickerPeriodAnimationPackageId)
	Applys animated sticker loop-animation style. More...

boolean	applyAnimatedStickerInAnimation (String 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...

boolean	applyAnimatedStickerOutAnimation (String 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...

void	setAnimatedStickerAnimationPeriod (int periodInMS)
	Set animated sticker Animation Period. More...

int	getAnimatedStickerAnimationPeriod ()
	Get animated sticker Animation Period. More...

void	setAnimatedStickerInAnimationDuration (int inAnimationDurationInMS)
	Set animated sticker in-animation duration. More...

int	getAnimatedStickerInAnimationDuration ()
	Get anmiated sticker in-animation duration. More...

void	setAnimatedStickerOutAnimationDuration (int outAnimationDurationInMS)
	Set animated sticker out-animation duration. More...

int	getAnimatedStickerOutAnimationDuration ()
	Get animated sticker out-animation duration. More...

Public Member Functions inherited from com.meicam.effect.sdk.NvsEffect
NvsFxDescription	getDescription ()
	Gets the description of the Effect. More...

void	setIntVal (String fxParam, int val)
	Sets the integer parameter value of the effect. More...

int	getIntVal (String fxParam)
	Gets the integer parameter value of the effect. More...

void	setIntValAtTime (String fxParam, int val, long time)
	Sets the integer parameter of NvsFx. More...

int	getIntValAtTime (String fxParam, long time)
	Gets the integer parameter of NvsFx. More...

void	setFloatVal (String fxParam, double val)
	Sets the float parameter value of the effect. More...

double	getFloatVal (String fxParam)
	Gets the float parameter value of the effect. More...

void	setFloatValAtTime (String fxParam, double val, long time)
	Sets the float parameter of NvsFx. More...

double	getFloatValAtTime (String fxParam, long time)
	Gets the float parameter of NvsFx. More...

void	setBooleanVal (String fxParam, boolean val)
	Sets the Boolean parameter value of the effect. More...

boolean	getBooleanVal (String fxParam)
	Gets the Boolean parameter value of the effect. More...

void	setBooleanValAtTime (String fxParam, boolean val, long time)
	Sets the boolean parameter of NvsFx. More...

boolean	getBooleanValAtTime (String fxParam, long time)
	Gets the boolean parameter of NvsFx. More...

void	setStringVal (String fxParam, String val)
	Sets the string parameter value of the effect. More...

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

void	setStringValAtTime (String fxParam, String val, long time)
	Sets the string parameter of NvsFx. More...

String	getStringValAtTime (String fxParam, long time)
	Gets the string parameter of NvsFx. More...

void	setColorVal (String fxParam, NvsColor val)
	Sets the color parameter value of the effect. More...

NvsColor	getColorVal (String fxParam)
	Gets the color parameter value of the effect. More...

void	setColorValAtTime (String fxParam, NvsColor val, long time)
	Sets the color parameter of NvsFx. More...

NvsColor	getColorValAtTime (String fxParam, long time)
	Gets the color parameter of NvsFx. More...

void	setPosition2DVal (String fxParam, NvsPosition2D val)
	Sets the 2D coordinates parameter value of the effect. More...

NvsPosition2D	getPosition2DVal (String fxParam)
	Gets the 2D coordinates parameter value of the effect. More...

void	setPosition2DValAtTime (String fxParam, NvsPosition2D val, long time)
	Sets the two dimentional coordinates parameter of NvsFx. More...

NvsPosition2D	getPosition2DValAtTime (String fxParam, long time)
	Gets the two dimentional coordinates parameter of NvsFx. More...

void	setPosition3DVal (String fxParam, NvsPosition3D val)
	Sets the 3D coordinates parameter value of the effect. More...

NvsPosition3D	getPosition3DVal (String fxParam)
	Gets the 3D coordinates parameter value of the effect. More...

void	setPosition3DValAtTime (String fxParam, NvsPosition3D val, long time)
	Sets the three dimentional coordinates parameter of NvsFx. More...

NvsPosition3D	getPosition3DValAtTime (String fxParam, long time)
	Gets the three dimentional coordinates parameter of NvsFx. More...

void	setMenuVal (String fxParam, String val)
	Sets the menu parameter value of the effect. More...

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

void	setMenuValAtTime (String fxParam, String val, long time)
	Sets the menu parameter of NvsFx. More...

String	getMenuValAtTime (String fxParam, long time)
	Gets the menu parameter of NvsFx. More...

void	setArbDataVal (String fxParam, NvsArbitraryData val)
	Sets custom data parameter value. More...

void	setArbDataValAtTime (String fxParam, NvsArbitraryData val, long time)
	Sets custom data parameter value. More...

boolean	removeKeyframeAtTime (String fxParam, long time)
	Remove key frame at time from key frame list. More...

boolean	removeAllKeyframe (String fxParam)
	Remove all key frame from key frame list. More...

boolean	hasKeyframeList (String fxParam)
	Check has key frame list of param. More...

long	findKeyframeTime (String fxParam, long time, int flags)
	Get key frame in list at current time. More...

boolean	setKeyFrameControlPoint (String fxParam, long time, NvsControlPointPair controlPointPair)
	Set key frame control point pair. More...

NvsControlPointPair	getKeyFrameControlPoint (String fxParam, long time)
	Get key frame control point pair. More...

boolean	setKeyFrameControlPointMode (String fxParam, long time, NvsControlPointModePair controlPointModePair)
	Set key frame control point mode pair. More...

NvsControlPointModePair	getKeyFrameControlPointMode (String fxParam, long time)
	Get key frame control point mode pair. More...

void	setFilterIntensity (float intensity)
	Sets the intensity of the filter. More...

float	getFilterIntensity ()
	Gets the intensity of the filter. More...

void	setRegional (boolean isRegional)
	Sets whether the filter is regional. More...

boolean	getRegional ()
	Gets whether the filter is regional. More...

void	setIgnoreBackground (boolean isIgnoreBackground)
	Sets whether the regional filter ignores Background. More...

boolean	getIgnoreBackground ()
	Gets whether the regional filter ignores Background. More...

void	setInverseRegion (boolean isInverseRegion)
	Sets whether the regional filter inverses region. More...

boolean	getInverseRegion ()
	Gets whether the regional filter inverses region. More...

void	setRegion (float[] region)
	Sets the region of this regional filter. More...

void	setRegionInfo (NvsMaskRegionInfo info)
	Sets the region of this regional filter. More...

void	setRegionInfoAtTime (NvsMaskRegionInfo info, long time)
	Sets the region of this regional filter at certain time. More...

void	setRegionalFeatherWidth (float featherWidth)
	Sets the feather width of this regional filter. More...

float	getRegionalFeatherWidth ()
	Gets the feather width of this regional filter. More...

void	setRegionCoordinateSystemType (int type)
	Sets the coordinate system of the region. More...

int	getRegionCoordinateSystemType ()
	Gets the coordinate system of the region. More...

void	setFilterMask (boolean useMask)
	Sets the mask of the filter. More...

boolean	getFilterMask ()
	Gets the usage of the filter's mask. More...

void	release ()
	Releases internal resources. More...

NvsParticleSystemContext	getParticleSystemContext ()

NvsPaintingEffectContext	getPaintingEffectContext ()

NvsARFaceContext	getARFaceContext ()
	Get face effect context. More...

NvsARSceneManipulate	getARSceneManipulate ()
	获得NvsARSceneManipulate接口 More...

void	setExprVar (String varName, double varValue)
	Set the value of the defined parameter in the expression. More...

double	getExprVar (String varName)
	Get the value of the defined parameter in the expression. More...

Additional Inherited Members
Static Public Attributes inherited from com.meicam.effect.sdk.NvsEffect
static final int	KEY_FRAME_FIND_MODE_INPUT_TIME_BEFORE = 1
	find key frame before current time More...

static final int	KEY_FRAME_FIND_MODE_INPUT_TIME_AFTER = 2

static final int	REGION_COORDINATE_SYSTEM_TYPE_NDC = 0
	NDC coordinate system. More...

static final int	REGION_COORDINATE_SYSTEM_TYPE_TIMELINE = 1

static final int	FACE_WARP_EFFECT_STRATEGY_CUSTOM = 0x7FFFFFFF

Protected Member Functions inherited from com.meicam.effect.sdk.NvsEffect
void	setInternalObject (long internalObject)

long	getInternalObject ()

void	finalize () throws Throwable

Detailed Description

Animated sticker class.

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.

Warning: In the NvsVideoEffectAnimatedSticker class, all public APIs are used in the UI thread! ! !

Member Function Documentation

◆ applyAnimatedStickerInAnimation()

boolean com.meicam.effect.sdk.NvsVideoEffectAnimatedSticker.applyAnimatedStickerInAnimation ( String 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

animatedStickerInAnimationPackageId animated sticker in-animation style resource package ID.

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

Warning: This interface will cause the streaming engine state to jump to the engine stop state. For details, please refer to Engine Change.

See also: getAnimatedStickerInAnimationPackageId

Since: 3.2.1

◆ applyAnimatedStickerOutAnimation()

boolean com.meicam.effect.sdk.NvsVideoEffectAnimatedSticker.applyAnimatedStickerOutAnimation ( String 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

animatedStickerOutAnimationPackageId animated sticker out-animation style resource package ID.

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

Warning: This interface will cause the streaming engine state to jump to the engine stop state. For details, please refer to Engine Change.

See also: getAnimatedStickerOutAnimationPackageId

Since: 3.2.1

◆ applyAnimatedStickerPeriodAnimation()

boolean com.meicam.effect.sdk.NvsVideoEffectAnimatedSticker.applyAnimatedStickerPeriodAnimation ( String animatedStickerPeriodAnimationPackageId )

inline

Applys animated sticker loop-animation style.

Parameters

animatedStickerPeriodAnimationPackageId animated sticker loop-animation style resource package ID.

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

Warning: This interface will cause the streaming engine state to jump to the engine stop state. For details, please refer to Engine Change.

See also: getAnimatedStickerAnimationPackageId

Since: 3.2.1

◆ changeInPoint()

long com.meicam.effect.sdk.NvsVideoEffectAnimatedSticker.changeInPoint ( long newInPoint )

inline

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

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

Returns: Return the in-point of the animated sticker on the timeline (in microseconds).

See also: changeOutPoint; getInPoint; movePosition

◆ changeOutPoint()

long com.meicam.effect.sdk.NvsVideoEffectAnimatedSticker.changeOutPoint ( long newOutPoint )

inline

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

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

Returns: Return the out-point of the animated sticker(in microseconds).

See also: changeInPoint; getOutPoint; movePosition

◆ getAnimatedStickerAnimationPeriod()

int com.meicam.effect.sdk.NvsVideoEffectAnimatedSticker.getAnimatedStickerAnimationPeriod ( )

inline

Get animated sticker Animation Period.

Returns: Return animation period in million second

See also: setAnimatedStickerAnimationPeriod

Since: 3.2.1

◆ getAnimatedStickerInAnimationDuration()

int com.meicam.effect.sdk.NvsVideoEffectAnimatedSticker.getAnimatedStickerInAnimationDuration ( )

inline

Get anmiated sticker in-animation duration.

Returns: Return in-animation duration in million second

See also: setAnimatedStickerInAnimationDuration

Since: 3.2.1

◆ getAnimatedStickerInAnimationPackageId()

String com.meicam.effect.sdk.NvsVideoEffectAnimatedSticker.getAnimatedStickerInAnimationPackageId ( )

inline

Gets the animated sticker in-animation style package ID.

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

See also: applyAnimatedStickerInAnimation

Since: 3.2.1

◆ getAnimatedStickerOutAnimationDuration()

int com.meicam.effect.sdk.NvsVideoEffectAnimatedSticker.getAnimatedStickerOutAnimationDuration ( )

inline

Get animated sticker out-animation duration.

Returns: Return out-animation duration in million second

See also: setAnimatedStickerOutAnimationDuration

Since: 3.2.1

◆ getAnimatedStickerOutAnimationPackageId()

String com.meicam.effect.sdk.NvsVideoEffectAnimatedSticker.getAnimatedStickerOutAnimationPackageId ( )

inline

Gets the animated sticker out-animation style package ID.

Returns: Returns the obtained animated sticker out-animation style resource package ID.

See also: applyAnimatedStickerOutAnimation

Since: 3.2.1

◆ getAnimatedStickerPackageId()

String com.meicam.effect.sdk.NvsVideoEffectAnimatedSticker.getAnimatedStickerPackageId ( )

inline

Get animated sticker's package ID.

Returns: Return the animated sticker's package ID.

Since: 2.20.0

◆ getAnimatedStickerPeriodAnimationPackageId()

String com.meicam.effect.sdk.NvsVideoEffectAnimatedSticker.getAnimatedStickerPeriodAnimationPackageId ( )

inline

Gets the animated sticker period animation style package ID.

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

See also: applyModularAnimatedStickerPeriodAnimation

Since: 3.2.1

◆ getBoundingRectangleVertices()

List<PointF> com.meicam.effect.sdk.NvsVideoEffectAnimatedSticker.getBoundingRectangleVertices ( )

inline

Get the vertex positions of the animated sticker's original bounding in the video resolution coordinate system.please refer to TimeLine and View Coordinate.

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

Since: 2.20.0

◆ getCenterAzimuthAngle()

float com.meicam.effect.sdk.NvsVideoEffectAnimatedSticker.getCenterAzimuthAngle ( )

inline

Get the azimuth of the center point of the animated sticker. It is only valid for panorama animated stickers.

Returns: Return the azimuth of the center point of the animated sticker, in degrees.

Since: 2.20.0

◆ getCenterPolarAngle()

float com.meicam.effect.sdk.NvsVideoEffectAnimatedSticker.getCenterPolarAngle ( )

inline

Get the polar angle of the center point of the animated sticker. It is only valid for panorama animated stickers.

Returns: Return the polar angle of the center point of the animated sticker, in degrees.

Since: 2.20.0

◆ getDefaultDuration()

long com.meicam.effect.sdk.NvsVideoEffectAnimatedSticker.getDefaultDuration ( )

inline

Get the default duration of the sticker.

Returns: Return the default duration of the sticker.

Since: 2.20.0

◆ getHorizontalFlip()

boolean com.meicam.effect.sdk.NvsVideoEffectAnimatedSticker.getHorizontalFlip ( )

inline

Get the horizontal flip state of the animated sticker.

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

See also: setHorizontalFlip

◆ getInPoint()

long com.meicam.effect.sdk.NvsVideoEffectAnimatedSticker.getInPoint ( )

inline

Get animated sticker's in-point.

Returns: Return the in-point of the animated sticker (in microseconds).

See also: getOutPoint; changeInPoint

◆ getOpacity()

float com.meicam.effect.sdk.NvsVideoEffectAnimatedSticker.getOpacity ( )

inline

Get the sticker opacity.

Returns: Return the sticker opacity.

See also: setOpacity

Since: 2.20.0

◆ getOriginalBoundingRect()

RectF com.meicam.effect.sdk.NvsVideoEffectAnimatedSticker.getOriginalBoundingRect ( )

inline

Get the original bounding of the animated sticker in the video resolution coordinate system.please refer to TimeLine and View Coordinate.

Returns: Return a RectF object representing the original bounding.

◆ getOrthoAngleRange()

float com.meicam.effect.sdk.NvsVideoEffectAnimatedSticker.getOrthoAngleRange ( )

inline

Get the animated sticker’s field angle which is perpendicular to the polar angle. It is only valid for panorama animated stickers.

Returns: Return the animated sticker’s field angle which is perpendicular to the polar angle, in degrees.

Since: 2.20.0

◆ getOutPoint()

long com.meicam.effect.sdk.NvsVideoEffectAnimatedSticker.getOutPoint ( )

inline

Get animated sticker's out-point.

Returns: Return the out-point of the animated sticker(in microseconds).

See also: getInPoint; changeOutPoint

◆ getPolarAngleRange()

float com.meicam.effect.sdk.NvsVideoEffectAnimatedSticker.getPolarAngleRange ( )

inline

Get animated sticker's field angle, which is coplanar with the polar angle. It is only valid for panorama animated stickers.

Returns: Return animated sticker's field angle coplanar with the polar corner, in degrees.

Since: 2.20.0

◆ getRotationZ()

float com.meicam.effect.sdk.NvsVideoEffectAnimatedSticker.getRotationZ ( )

inline

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

Returns: Return the rotation angle value.

See also: setRotationZ; rotateAnimatedSticker

◆ getScale()

float com.meicam.effect.sdk.NvsVideoEffectAnimatedSticker.getScale ( )

inline

Get the scale value of the animated sticker.

Returns: Return the scale value.

See also: setScale

◆ getTranslation()

PointF com.meicam.effect.sdk.NvsVideoEffectAnimatedSticker.getTranslation ( )

inline

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

Returns: Return a PointF object representing the translation position.

See also: setTranslation

◆ getVerticalFlip()

boolean com.meicam.effect.sdk.NvsVideoEffectAnimatedSticker.getVerticalFlip ( )

inline

Get the vertical flip state of the animated sticker.

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

See also: setVerticalFlip

◆ getZValue()

float com.meicam.effect.sdk.NvsVideoEffectAnimatedSticker.getZValue ( )

inline

Get the sticker Z value.

Returns: Return sticker Z value.

Since: 2.20.0

◆ isPanoramic()

boolean com.meicam.effect.sdk.NvsVideoEffectAnimatedSticker.isPanoramic ( )

inline

Determine whether the animated sticker is a panorama animated sticker or not.

Returns: Return a boolean value indicating it is a panorama animated sticker. True means panoramic, false means not.

Since: 2.20.0

◆ movePosition()

void com.meicam.effect.sdk.NvsVideoEffectAnimatedSticker.movePosition ( long offset )

inline

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

Parameters

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

See also: changeInPoint; changeOutPoint

◆ rotateAnimatedSticker() [1/2]

void com.meicam.effect.sdk.NvsVideoEffectAnimatedSticker.rotateAnimatedSticker ( float angle )

inline

Rotate the animation sticker with the center point of the animation sticker as the anchor point.The rotation angle set by this function is stackable.

Parameters

angle rotation angle

Since: 2.20.0

◆ rotateAnimatedSticker() [2/2]

void com.meicam.effect.sdk.NvsVideoEffectAnimatedSticker.rotateAnimatedSticker	(	float	angle,
		PointF	anchor
	)

inline

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

Parameters

angle	rotation angle.
anchor	rotation anchor.

Since: 2.20.0

◆ scaleAnimatedSticker()

void com.meicam.effect.sdk.NvsVideoEffectAnimatedSticker.scaleAnimatedSticker	(	float	scaleFactor,
		PointF	anchor
	)

inline

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

Parameters

scaleFactor	Animated sticker scaling factor.
anchor	Animated sticker scale anchor.

Since: 2.20.0

◆ setAnimatedStickerAnimationPeriod()

void com.meicam.effect.sdk.NvsVideoEffectAnimatedSticker.setAnimatedStickerAnimationPeriod ( int periodInMS )

inline

Set animated sticker Animation Period.

Parameters

periodInMS Animation period in million second

See also: getAnimatedStickerAnimationPeriod

Since: 3.2.1

◆ setAnimatedStickerInAnimationDuration()

void com.meicam.effect.sdk.NvsVideoEffectAnimatedSticker.setAnimatedStickerInAnimationDuration ( int inAnimationDurationInMS )

inline

Set animated sticker in-animation duration.

Parameters

inAnimationDurationInMS in-animation duration in million second

See also: getAnimatedStickerInAnimationDuration

Since: 3.2.1

◆ setAnimatedStickerOutAnimationDuration()

void com.meicam.effect.sdk.NvsVideoEffectAnimatedSticker.setAnimatedStickerOutAnimationDuration ( int outAnimationDurationInMS )

inline

Set animated sticker out-animation duration.

Parameters

outAnimationDurationInMS out-animation duration in million second

See also: getAnimatedStickerOutAnimationDuration

Since: 3.2.1

◆ setCenterAzimuthAngle()

void com.meicam.effect.sdk.NvsVideoEffectAnimatedSticker.setCenterAzimuthAngle ( float centerAzimuthAngle )

inline

Set the azimuth of the center point on the animated sticker. It is only valid for panorama animated stickers.

Parameters

centerAzimuthAngle The azimuth of the center point, in degrees.

Since: 2.20.0

◆ setCenterPolarAngle()

void com.meicam.effect.sdk.NvsVideoEffectAnimatedSticker.setCenterPolarAngle ( float centerPolarAngle )

inline

Set the polar angle of the center point on the animated sticker. Only valid for panorama animated stickers.

Parameters

centerPolarAngle The polar angle of the center point, in degrees.

Since: 2.20.0

◆ setCurrentKeyFrameTime()

void com.meicam.effect.sdk.NvsVideoEffectAnimatedSticker.setCurrentKeyFrameTime ( long time )

inline

Set the sticker's Key frame time.

Parameters

time	time point

Since: 2.20.0

◆ setHorizontalFlip()

void com.meicam.effect.sdk.NvsVideoEffectAnimatedSticker.setHorizontalFlip ( boolean flip )

inline

Set the horizontal flip of the animated sticker.

Parameters

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

See also: getHorizontalFlip

◆ setOpacity()

void com.meicam.effect.sdk.NvsVideoEffectAnimatedSticker.setOpacity ( float opacity )

inline

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

Parameters

opacity sticker opacity.

See also: getOpacity

Since: 2.20.0

◆ setPolarAngleRange()

void com.meicam.effect.sdk.NvsVideoEffectAnimatedSticker.setPolarAngleRange ( float polarAngleRange )

inline

Set animated sticker's field angle, which is coplanar with the polar angle. It is only valid for panorama animated stickers.

Parameters

polarAngleRange The field angle coplanar with the polar angle, in degrees.

Since: 2.20.0

◆ setRotationZ()

void com.meicam.effect.sdk.NvsVideoEffectAnimatedSticker.setRotationZ ( float 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

angle Rotation angle value.

See also: getRotationZ

◆ setScale()

void com.meicam.effect.sdk.NvsVideoEffectAnimatedSticker.setScale ( float scale )

inline

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

Parameters

scale Scaling value.

See also: getScale

◆ setTranslation()

void com.meicam.effect.sdk.NvsVideoEffectAnimatedSticker.setTranslation ( PointF translation )

inline

Sets the translation position of the animated sticker in the timeline coordinate system.The translation coordinate set by this function do not stack.please refer to TimeLine and View Coordinate.

Parameters

translation Translation position

See also: getTransltion; translateAnimatedSticker

◆ setVerticalFlip()

void com.meicam.effect.sdk.NvsVideoEffectAnimatedSticker.setVerticalFlip ( boolean flip )

inline

Set the vertical flip of the animated sticker.

Parameters

flip	Whether to flip vertically. True means it flip vertically, false means not.

See also: getVerticalFlip

◆ setVideoResolution()

void com.meicam.effect.sdk.NvsVideoEffectAnimatedSticker.setVideoResolution ( NvsVideoResolution resolution )

inline

Set the sticker's video resolution.

Parameters

resolution The sticker's video resolution

Since: 2.20.0

◆ setZValue()

void com.meicam.effect.sdk.NvsVideoEffectAnimatedSticker.setZValue ( float value )

inline

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

Parameters

value Z value

Since: 2.20.0

◆ translateAnimatedSticker()

void com.meicam.effect.sdk.NvsVideoEffectAnimatedSticker.translateAnimatedSticker ( PointF translationOffset )

inline

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

Parameters

translationOffset Animated sticker translation offset values.

Since: 2.20.0

See also: setTranslation; getTranslation

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

src/android/jar/com/meicam/effect/sdk/NvsVideoEffectAnimatedSticker.java

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ applyAnimatedStickerInAnimation()

◆ applyAnimatedStickerOutAnimation()

◆ applyAnimatedStickerPeriodAnimation()

◆ changeInPoint()

◆ changeOutPoint()

◆ getAnimatedStickerAnimationPeriod()

◆ getAnimatedStickerInAnimationDuration()

◆ getAnimatedStickerInAnimationPackageId()

◆ getAnimatedStickerOutAnimationDuration()

◆ getAnimatedStickerOutAnimationPackageId()

◆ getAnimatedStickerPackageId()

◆ getAnimatedStickerPeriodAnimationPackageId()

◆ getBoundingRectangleVertices()

◆ getCenterAzimuthAngle()

◆ getCenterPolarAngle()

◆ getDefaultDuration()

◆ getHorizontalFlip()

◆ getInPoint()

◆ getOpacity()

◆ getOriginalBoundingRect()

◆ getOrthoAngleRange()

◆ getOutPoint()

◆ getPolarAngleRange()

◆ getRotationZ()

◆ getScale()

◆ getTranslation()

◆ getVerticalFlip()

◆ getZValue()

◆ isPanoramic()

◆ movePosition()

◆ rotateAnimatedSticker() [1/2]

◆ rotateAnimatedSticker() [2/2]

◆ scaleAnimatedSticker()

◆ setAnimatedStickerAnimationPeriod()

◆ setAnimatedStickerInAnimationDuration()

◆ setAnimatedStickerOutAnimationDuration()

◆ setCenterAzimuthAngle()

◆ setCenterPolarAngle()

◆ setCurrentKeyFrameTime()

◆ setHorizontalFlip()

◆ setOpacity()

◆ setPolarAngleRange()

◆ setRotationZ()

◆ setScale()

◆ setTranslation()

◆ setVerticalFlip()

◆ setVideoResolution()

◆ setZValue()

◆ translateAnimatedSticker()