animated sticker class. More...

Inheritance diagram for com.meicam.sdk.NvsAnimatedSticker:

Public Member Functions
String	getAnimatedStickerPackageId ()
	Get animated sticker's package ID. 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 timeline 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 timeline 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 timeline 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...

boolean	hasAudio ()
	Check whether the sticker contains audio. More...

void	setVolumeGain (float leftVolumeGain, float rightVolumeGain)
	Set the sticker volume. More...

NvsVolume	getVolumeGain ()
	Get volume information. 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...

boolean	setControlPoint (String fxParam, NvsControlPointPair controlPointPair)
	Set the sticker's control point pair. More...

NvsControlPointPair	getControlPoint (String fxParam)
	Get the sticker's key frame control point pair. 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...

void	setSeperatedScaleX (float scaleX)
	Set the split horizontal scaling of animated stickers. More...

float	getSeperatedScaleX ()
	Get the split horizontal scaling of animated stickers. More...

void	setSeperatedScaleY (float scaleY)
	Set the split vertical scaling of animated stickers. More...

float	getSeperatedScaleY ()
	Get the split vertical scaling of animated stickers. More...

void	enableSeparateProgressMode (boolean enable)
	Set enable the separate effect settings from progress mode. More...

boolean	isSeparateProgressModeEnabled ()
	Get whether enable the separate effect settings from progress mode. More...

Public Member Functions inherited from com.meicam.sdk.NvsFx
NvsFxDescription	getDescription ()
	Get decription of Fx. More...

void	setIntVal (String fxParam, int val)
	Set the integer parameter of NvsFx. More...

int	getIntVal (String fxParam)
	Get the integer parameter of NvsFx. More...

void	setIntValAtTime (String fxParam, int val, long time)
	Set the NvsFx's integer parameter at a specified time point. More...

int	getIntValAtTime (String fxParam, long time)
	Get the NvsFx's integer parameter at a specified time point. More...

void	setFloatVal (String fxParam, double val)
	Set the float parameter of NvsFx. More...

double	getFloatVal (String fxParam)
	Get the float parameter of NvsFx. More...

void	setFloatValAtTime (String fxParam, double val, long time)
	Set the NvsFx's float parameter at a specified time point. More...

double	getFloatValAtTime (String fxParam, long time)
	Get the NvsFx's float parameter at a specified time point. More...

void	setBooleanVal (String fxParam, boolean val)
	Set the boolean parameter of NvsFx. More...

boolean	getBooleanVal (String fxParam)
	Get the boolean parameter of NvsFx. More...

void	setBooleanValAtTime (String fxParam, boolean val, long time)
	Set the NvsFx’s boolean parameter at a specified time point. More...

boolean	getBooleanValAtTime (String fxParam, long time)
	Get the NvsFx's boolean parameter at a specified time point. More...

void	setStringVal (String fxParam, String val)
	Set the string parameter of NvsFx. More...

String	getStringVal (String fxParam)
	Get the string parameter of NvsFx. More...

void	setStringValAtTime (String fxParam, String val, long time)
	Set the NvsFx's string parameter at a specified time point. More...

String	getStringValAtTime (String fxParam, long time, int flags)
	Get the NvsFx's string parameter at a specified time point. More...

void	setColorVal (String fxParam, NvsColor val)
	Set the color parameter of NvsFx. More...

NvsColor	getColorVal (String fxParam)
	Get the color parameter of NvsFx. More...

void	setColorValAtTime (String fxParam, NvsColor val, long time)
	Set the NvsFx's color parameter at a specified time point. More...

NvsColor	getColorValAtTime (String fxParam, long time)
	Get the NvsFx's color parameter at a specified time point. More...

void	setPosition2DVal (String fxParam, NvsPosition2D val)
	Set the two dimentional coordinates parameter of NvsFx. More...

NvsPosition2D	getPosition2DVal (String fxParam)
	Get the two dimentional coordinates parameter of NvsFx. More...

void	setPosition2DValAtTime (String fxParam, NvsPosition2D val, long time)
	Set the NvsFx's two dimentional coordinates parameter at a specified time point. More...

NvsPosition2D	getPosition2DValAtTime (String fxParam, long time)
	Get the NvsFx's two dimentional coordinates parameter at a specified time point. More...

void	setPosition3DVal (String fxParam, NvsPosition3D val)
	Set the three dimentional coordinates parameter of NvsFx. More...

NvsPosition3D	getPosition3DVal (String fxParam)
	Get the three dimentional coordinates parameter of NvsFx. More...

void	setPosition3DValAtTime (String fxParam, NvsPosition3D val, long time)
	Set the NvsFx's three dimentional coordinates parameter at a specified time point. More...

NvsPosition3D	getPosition3DValAtTime (String fxParam, long time)
	Get the NvsFx's three dimentional coordinates parameter at a specified time point. More...

void	setMenuVal (String fxParam, String val)
	Set the menu parameter of NvsFx. More...

String	getMenuVal (String fxParam)
	Get the menu parameter of NvsFx. More...

void	setMenuValAtTime (String fxParam, String val, long time)
	Set the NvsFx's menu parameter at a specified time point. More...

String	getMenuValAtTime (String fxParam, long time)
	Get the NvsFx menu parameter at a specified time point. More...

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

NvsArbitraryData	getArbDataVal (String fxParam)
	Get custom data parameter value. More...

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

NvsArbitraryData	getArbDataValAtTime (String fxParam, NvsArbitraryData val, long time)
	Get custom data parameter value at a specified time point. More...

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

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

boolean	hasKeyframeList (String fxParam)
	Check whether the parameter has key frame list or not. More...

long	findKeyframeTime (String fxParam, long time, int flags)
	Get key frame at a specified time point. 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)
	Set the intensity of the filter. More...

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

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

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

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

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

void	setIgnoreBackground (boolean isIgnoreBackground)
	Set whether the regional filter ignores background. More...

boolean	getIgnoreBackground ()
	Get whether the regional filter ignores background. More...

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

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

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

float[]	getRegion ()
	Get the region of this regional filter. More...

void	setRegionInfo (NvsMaskRegionInfo info)
	Set the mask region informations of the regional filter. More...

NvsMaskRegionInfo	getRegionInfo ()
	Get the mask region informations of the regional filter. More...

void	setRegionInfoAtTime (NvsMaskRegionInfo info, long time)
	Set the regional filter's mask region informations at a specified time point. More...

NvsMaskRegionInfo	getRegionInfoAtTime (long time)
	Get the the regional filter's mask region informations at a specified time. More...

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

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

void	setRegionalFeatherWidthAtTime (float featherWidth, long time)
	Set the regional filter's feather width at a specified time point. More...

float	getRegionalFeatherWidthAtTime (long time)
	Get the regional filter's feather width at a specified time point. More...

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

int	getRegionCoordinateSystemType ()
	Get the coordinate system type of the region. More...

NvsParticleSystemContext	getParticleSystemContext ()
	Get the particle effect context object.Please refer to NvsParticleSystemContext. More...

NvsARFaceContext	getARFaceContext ()
	Get face effect context object.Please refer to NvsARFaceContext. More...

NvsPaintingEffectContext	getPaintingEffectContext ()
	Get the particle effect context object.Please refer to NvsPaintingEffectContext. More...

NvsARSceneManipulate	getARSceneManipulate ()
	Get the AR scene operation object.Please refer to 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...

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

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

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

Object	getExprObjectVar (String varName)
	Get the value of the defined parameter in the expression. More...

void	clearExprVar (String varName)
	Clear the value of the defined parameter in the expression and set it to the default value of 0. More...

void	clearExprVarCtx ()
	Clear all parameter values defined in the expression and set them to the default value of 0. More...

Public Member Functions inherited from com.meicam.sdk.NvsObject
void	setAttachment (String key, Object value)
	Adds additional data to the NvsObject object to identify the NvsObject object or for other purpose. More...

void	setTemplateAttachment (String key, String value)
	Adds additional template data to the NvsObject object to identify the NvsObject template object. More...

Object	getAttachment (String key)
	Gets an attachment to NvsObject. More...

String	getTemplateAttachment (String key)
	Gets an template attachment to NvsObject. More...

Additional Inherited Members
Static Public Attributes inherited from com.meicam.sdk.NvsFx
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

Static Public Attributes inherited from com.meicam.sdk.NvsObject
static final String	TEMPLATE_KEY_REPLACE_ID = "MSTemplate-ReplaceId"

static final String	TEMPLATE_KEY_FOOTAGE_CAN_REPLACE = "MSTemplate-FootageCanReplace"

static final String	TEMPLATE_KEY_FOOTAGE_ID = "MSTemplate-FootageId"

static final String	TEMPLATE_KEY_FOOTAGE_NAME = "MSTemplate-FootageName"

static final String	TEMPLATE_KEY_FOOTAGE_M3U8_NAME = "MSTemplate-FootageM3U8Name"

static final String	TEMPLATE_KEY_FOOTAGE_TAGS = "MSTemplate-FootageTags"

static final String	TEMPLATE_KEY_FOOTAGE_TYPE = "MSTemplate-FootageType"

static final String	TEMPLATE_KEY_FOOTAGE_NEED_REVERSE = "MSTemplate-FootageNeedReverse"

static final String	TEMPLATE_KEY_CLIP_RAW_WIDTH = "MSTemplate-ClipRawWidth"

static final String	TEMPLATE_KEY_CLIP_RAW_HEIGHT = "MSTemplate-ClipRawHeight"

static final String	TEMPLATE_KEY_VOLUME_TYPE = "MSTemplate-VolumeType"

static final String	TEMPLATE_KEY_FX_GROUP = "MSTemplate-FxGroup"

static final String	TEMPLATE_KEY_BEST_SEEK_TIME = "MSTemplate-BestSeekTime"

static final String	TEMPLATE_KEY_MASK_TYPE = "MSTemplate-MaskType"

static final String	TEMPLATE_VALUE_MASK_TYPE_LINE = "MSTemplate-MaskType-Line"

static final String	TEMPLATE_VALUE_MASK_TYPE_MIRROR = "MSTemplate-MaskType-Mirror"

static final String	TEMPLATE_VALUE_MASK_TYPE_CIRCLE = "MSTemplate-MaskType-Circle"

static final String	TEMPLATE_VALUE_MASK_TYPE_RECT = "MSTemplate-MaskType-Rect"

static final String	TEMPLATE_VALUE_MASK_TYPE_HEART = "MSTemplate-MaskType-Heart"

static final String	TEMPLATE_VALUE_MASK_TYPE_STAR = "MSTemplate-MaskType-Star"

static final String	TEMPLATE_KEY_TRANS_TYPE_CUT = "MSTemplate-TransType-Cut"

static final String	TEMPLATE_KEY_CURVE_SPEED_TYPE = "MSTemplate-CurveSpeedType"

static final String	TEMPLATE_VALUE_CURVE_SPEED_TYPE_CUSTOM = "MSTemplate-CurveSpeedType-Custom"

static final String	TEMPLATE_VALUE_CURVE_SPEED_TYPE_MONTAGE = "MSTemplate-CurveSpeedType-Montage"

static final String	TEMPLATE_VALUE_CURVE_SPEED_TYPE_HERO = "MSTemplate-CurveSpeedType-Hero"

static final String	TEMPLATE_VALUE_CURVE_SPEED_TYPE_BULLET = "MSTemplate-CurveSpeedType-bullet"

static final String	TEMPLATE_VALUE_CURVE_SPEED_TYPE_PLUS = "MSTemplate-CurveSpeedType-Plus"

static final String	TEMPLATE_VALUE_CURVE_SPEED_TYPE_IN = "MSTemplate-CurveSpeedType-In"

static final String	TEMPLATE_VALUE_CURVE_SPEED_TYPE_OUT = "MSTemplate-CurveSpeedType-Out"

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

long	getInternalObject ()

Protected Attributes inherited from com.meicam.sdk.NvsObject
long	m_internalObject = 0

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(or video track, or capture), 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 NvsAnimatedSticker class, all public APIs are used in the UI thread! ! !

Member Function Documentation

◆ applyAnimatedStickerInAnimation()

boolean com.meicam.sdk.NvsAnimatedSticker.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: 2.21.0

◆ applyAnimatedStickerOutAnimation()

boolean com.meicam.sdk.NvsAnimatedSticker.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: 2.21.0

◆ applyAnimatedStickerPeriodAnimation()

boolean com.meicam.sdk.NvsAnimatedSticker.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: 2.21.0

◆ enableSeparateProgressMode()

void com.meicam.sdk.NvsAnimatedSticker.enableSeparateProgressMode ( boolean enable )

inline

Set enable the separate effect settings from progress mode.

Parameters

enable whether enable or not.

See also: isSeparateProgressModeEnabled

Since: 3.8.1

◆ getAnimatedStickerAnimationPeriod()

int com.meicam.sdk.NvsAnimatedSticker.getAnimatedStickerAnimationPeriod ( )

inline

Get animated sticker Animation Period.

Returns: Return animation period in million second

See also: setAnimatedStickerAnimationPeriod

Since: 2.21.0

◆ getAnimatedStickerInAnimationDuration()

int com.meicam.sdk.NvsAnimatedSticker.getAnimatedStickerInAnimationDuration ( )

inline

Get anmiated sticker in-animation duration.

Returns: Return in-animation duration in million second

See also: setAnimatedStickerInAnimationDuration

Since: 2.21.0

◆ getAnimatedStickerInAnimationPackageId()

String com.meicam.sdk.NvsAnimatedSticker.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: 2.21.0

◆ getAnimatedStickerOutAnimationDuration()

int com.meicam.sdk.NvsAnimatedSticker.getAnimatedStickerOutAnimationDuration ( )

inline

Get animated sticker out-animation duration.

Returns: Return out-animation duration in million second

See also: setAnimatedStickerOutAnimationDuration

Since: 2.21.0

◆ getAnimatedStickerOutAnimationPackageId()

String com.meicam.sdk.NvsAnimatedSticker.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: 2.21.0

◆ getAnimatedStickerPackageId()

String com.meicam.sdk.NvsAnimatedSticker.getAnimatedStickerPackageId ( )

inline

Get animated sticker's package ID.

Returns: Return the animated sticker's package ID.

Since: 1.7.0

◆ getAnimatedStickerPeriodAnimationPackageId()

String com.meicam.sdk.NvsAnimatedSticker.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: 2.21.0

◆ getBoundingRectangleVertices()

List<PointF> com.meicam.sdk.NvsAnimatedSticker.getBoundingRectangleVertices ( )

inline

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

◆ getCenterAzimuthAngle()

float com.meicam.sdk.NvsAnimatedSticker.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: 1.6.0

◆ getCenterPolarAngle()

float com.meicam.sdk.NvsAnimatedSticker.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: 1.6.0

◆ getControlPoint()

NvsControlPointPair com.meicam.sdk.NvsAnimatedSticker.getControlPoint ( String fxParam )

inline

Get the sticker's key frame control point pair.

Parameters

fxParam The type of data parameter for the sticker.

Returns: return control point data.If the control point is {0, 0},the current control point interpolation method is linear interpolation.NvsControlPointPair对象

See also: setControlPoint

Since: 2.22.0

◆ getDefaultDuration()

long com.meicam.sdk.NvsAnimatedSticker.getDefaultDuration ( )

inline

Get the default duration of the sticker.

Returns: Return the default duration of the sticker.

Since: 2.1.0

◆ getHorizontalFlip()

boolean com.meicam.sdk.NvsAnimatedSticker.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

◆ getOpacity()

float com.meicam.sdk.NvsAnimatedSticker.getOpacity ( )

inline

Get the sticker opacity.

Returns: Return the sticker opacity.

See also: setOpacity

Since: 2.14.0

◆ getOriginalBoundingRect()

RectF com.meicam.sdk.NvsAnimatedSticker.getOriginalBoundingRect ( )

inline

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

Returns: Return a RectF object representing the original bounding.

◆ getOrthoAngleRange()

float com.meicam.sdk.NvsAnimatedSticker.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: 1.7.0

◆ getPolarAngleRange()

float com.meicam.sdk.NvsAnimatedSticker.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: 1.6.0

◆ getRotationZ()

float com.meicam.sdk.NvsAnimatedSticker.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.sdk.NvsAnimatedSticker.getScale ( )

inline

Get the scale value of the animated sticker.

Returns: Return the scale value.

See also: setScale

◆ getSeperatedScaleX()

float com.meicam.sdk.NvsAnimatedSticker.getSeperatedScaleX ( )

inline

Get the split horizontal scaling of animated stickers.

Returns: Return Detached horizontal scaling.

See also: setSeperatedScaleX

Since: 3.7.3

◆ getSeperatedScaleY()

float com.meicam.sdk.NvsAnimatedSticker.getSeperatedScaleY ( )

inline

Get the split vertical scaling of animated stickers.

Returns: Return Detached vertical scaling.

See also: setSeperatedScaleY

Since: 3.7.3

◆ getTranslation()

PointF com.meicam.sdk.NvsAnimatedSticker.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.sdk.NvsAnimatedSticker.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

◆ getVolumeGain()

NvsVolume com.meicam.sdk.NvsAnimatedSticker.getVolumeGain ( )

inline

Get volume information.

Returns: Return the volume object.

See also: setVolumeGain

Since: 2.0.3

◆ getZValue()

float com.meicam.sdk.NvsAnimatedSticker.getZValue ( )

inline

Get the sticker Z value.

Returns: Return sticker Z value.

Since: 1.10.0

◆ hasAudio()

boolean com.meicam.sdk.NvsAnimatedSticker.hasAudio ( )

inline

Check whether the sticker contains audio.

Returns: Return whether the sticker contains audio.

Since: 2.0.3

◆ isPanoramic()

boolean com.meicam.sdk.NvsAnimatedSticker.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: 1.6.0

◆ isSeparateProgressModeEnabled()

boolean com.meicam.sdk.NvsAnimatedSticker.isSeparateProgressModeEnabled ( )

inline

Get whether enable the separate effect settings from progress mode.

Returns: Return whether enable the separate effect settings from progress mode.

See also: enableSeparateProgressMode

Since: 3.8.1

◆ rotateAnimatedSticker() [1/2]

void com.meicam.sdk.NvsAnimatedSticker.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: 1.8.1

◆ rotateAnimatedSticker() [2/2]

void com.meicam.sdk.NvsAnimatedSticker.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: 1.8.1

◆ scaleAnimatedSticker()

void com.meicam.sdk.NvsAnimatedSticker.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: 1.8.1

◆ setAnimatedStickerAnimationPeriod()

void com.meicam.sdk.NvsAnimatedSticker.setAnimatedStickerAnimationPeriod ( int periodInMS )

inline

Set animated sticker Animation Period.

Parameters

periodInMS Animation period in million second

See also: getAnimatedStickerAnimationPeriod

Since: 2.21.0

◆ setAnimatedStickerInAnimationDuration()

void com.meicam.sdk.NvsAnimatedSticker.setAnimatedStickerInAnimationDuration ( int inAnimationDurationInMS )

inline

Set animated sticker in-animation duration.

Parameters

inAnimationDurationInMS in-animation duration in million second

See also: getAnimatedStickerInAnimationDuration

Since: 2.21.0

◆ setAnimatedStickerOutAnimationDuration()

void com.meicam.sdk.NvsAnimatedSticker.setAnimatedStickerOutAnimationDuration ( int outAnimationDurationInMS )

inline

Set animated sticker out-animation duration.

Parameters

outAnimationDurationInMS out-animation duration in million second

See also: getAnimatedStickerOutAnimationDuration

Since: 2.21.0

◆ setCenterAzimuthAngle()

void com.meicam.sdk.NvsAnimatedSticker.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: 1.6.0

◆ setCenterPolarAngle()

void com.meicam.sdk.NvsAnimatedSticker.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: 1.6.0

◆ setControlPoint()

boolean com.meicam.sdk.NvsAnimatedSticker.setControlPoint	(	String	fxParam,
		NvsControlPointPair	controlPointPair
	)

inline

Set the sticker's control point pair.

Parameters

fxParam	The type of data parameter for the sticker.
controlPointPair	control point pair.Set the control point to {0, 0}, that is, the current control point is linear interpolation, otherwise it is curve interpolation.

See also: getControlPoint

Since: 2.22.0

◆ setCurrentKeyFrameTime()

void com.meicam.sdk.NvsAnimatedSticker.setCurrentKeyFrameTime ( long time )

inline

Set the sticker's Key frame time.

Parameters

time	time point

See also: setCurrentKeyFrameTime

Since: 2.15.0

◆ setHorizontalFlip()

void com.meicam.sdk.NvsAnimatedSticker.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.sdk.NvsAnimatedSticker.setOpacity ( float opacity )

inline

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

Parameters

opacity sticker opacity.

See also: getOpacity

Since: 2.14.0

◆ setPolarAngleRange()

void com.meicam.sdk.NvsAnimatedSticker.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: 1.6.0

◆ setRotationZ()

void com.meicam.sdk.NvsAnimatedSticker.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.sdk.NvsAnimatedSticker.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

◆ setSeperatedScaleX()

void com.meicam.sdk.NvsAnimatedSticker.setSeperatedScaleX ( float scaleX )

inline

Set the split horizontal scaling of animated stickers.

Parameters

scaleX Detached horizontal scaling.

See also: getSeperatedScaleX

Since: 3.7.3

◆ setSeperatedScaleY()

void com.meicam.sdk.NvsAnimatedSticker.setSeperatedScaleY ( float scaleY )

inline

Set the split vertical scaling of animated stickers.

Parameters

scaleY Detached vertical scaling.

See also: getSeperatedScaleY

Since: 3.7.3

◆ setTranslation()

void com.meicam.sdk.NvsAnimatedSticker.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.sdk.NvsAnimatedSticker.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

◆ setVolumeGain()

void com.meicam.sdk.NvsAnimatedSticker.setVolumeGain	(	float	leftVolumeGain,
		float	rightVolumeGain
	)

inline

Set the sticker volume.

Parameters

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

See also: getVolumeGain

Since: 2.0.3

◆ setZValue()

void com.meicam.sdk.NvsAnimatedSticker.setZValue ( float value )

inline

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

Parameters

value Z value

Since: 1.10.0

◆ translateAnimatedSticker()

void com.meicam.sdk.NvsAnimatedSticker.translateAnimatedSticker ( PointF translationOffset )

inline

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

Parameters

translationOffset Animated sticker translation offset values.

Since: 1.8.1

See also: setTranslation; getTranslation

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

src/android/jar/com/meicam/sdk/NvsAnimatedSticker.java

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ applyAnimatedStickerInAnimation()

◆ applyAnimatedStickerOutAnimation()

◆ applyAnimatedStickerPeriodAnimation()

◆ enableSeparateProgressMode()

◆ getAnimatedStickerAnimationPeriod()

◆ getAnimatedStickerInAnimationDuration()

◆ getAnimatedStickerInAnimationPackageId()

◆ getAnimatedStickerOutAnimationDuration()

◆ getAnimatedStickerOutAnimationPackageId()

◆ getAnimatedStickerPackageId()

◆ getAnimatedStickerPeriodAnimationPackageId()

◆ getBoundingRectangleVertices()

◆ getCenterAzimuthAngle()

◆ getCenterPolarAngle()

◆ getControlPoint()

◆ getDefaultDuration()

◆ getHorizontalFlip()

◆ getOpacity()

◆ getOriginalBoundingRect()

◆ getOrthoAngleRange()

◆ getPolarAngleRange()

◆ getRotationZ()

◆ getScale()

◆ getSeperatedScaleX()

◆ getSeperatedScaleY()

◆ getTranslation()

◆ getVerticalFlip()

◆ getVolumeGain()

◆ getZValue()

◆ hasAudio()

◆ isPanoramic()

◆ isSeparateProgressModeEnabled()

◆ rotateAnimatedSticker() [1/2]

◆ rotateAnimatedSticker() [2/2]

◆ scaleAnimatedSticker()

◆ setAnimatedStickerAnimationPeriod()

◆ setAnimatedStickerInAnimationDuration()

◆ setAnimatedStickerOutAnimationDuration()

◆ setCenterAzimuthAngle()

◆ setCenterPolarAngle()

◆ setControlPoint()

◆ setCurrentKeyFrameTime()

◆ setHorizontalFlip()

◆ setOpacity()

◆ setPolarAngleRange()

◆ setRotationZ()

◆ setScale()

◆ setSeperatedScaleX()

◆ setSeperatedScaleY()

◆ setTranslation()

◆ setVerticalFlip()

◆ setVolumeGain()

◆ setZValue()

◆ translateAnimatedSticker()