Timeline animated sticker is sticker with animated effect. More...

Inheritance diagram for com.meicam.sdk.NvsTimelineAnimatedSticker:

Public Member Functions
void	setClipAffinityEnabled (boolean enable)
	Sets whether the affinity between the animated sticker and the clip is on. More...

boolean	getClipAffinityEnabled ()
	Gets whether the affinity between the animated sticker and the clip is on. More...

long	getInPoint ()
	Gets animated sticker's in-point on the timeline. More...

long	getOutPoint ()
	Gets animated sticker's out-point on the timeline. More...

String	getAnimatedStickerPackageId ()
	Gets animated sticker's package Id. More...

long	changeInPoint (long newInPoint)
	Changes the in-point of the animated sticker on the timeline. More...

long	changeOutPoint (long newOutPoint)
	Changes the out-point of the animated sticker on the timeline. More...

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

void	setScale (float scale)
	Sets the zoom value of the animated sticker. More...

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

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

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

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

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

void	setRotationZ (float angle)
	Sets the rotation angle of the animated sticker. More...

float	getRotationZ ()
	Gets the rotation angle value of the animated sticker. More...

void	setTranslation (PointF translation)
	Sets the translation of the animated sticker. More...

PointF	getTranslation ()
	Gets the translation position of the animated sticker. More...

void	translateAnimatedSticker (PointF translationOffset)
	Tanslates animated sticker. More...

void	scaleAnimatedSticker (float scaleFactor, PointF anchor)
	Scales animated sticker. More...

void	rotateAnimatedSticker (float angle, PointF anchor)
	Rotates animated sticker. More...

void	rotateAnimatedSticker (float angle)
	Rotates animated stickers with an animated sticker center point as an anchor. More...

RectF	getOriginalBoundingRect ()
	Gets the original enclosing rectangle of the animated sticker. More...

List< PointF >	getBoundingRectangleVertices ()
	Gets the vertex position of the original enclosing rectangle of the animated sticker after transformation. More...

boolean	isPanoramic ()
	Determines whether the current animated sticker is a panorama animated sticker. More...

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

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

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

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

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

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

float	getOrthoAngleRange ()
	Gets 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)
	Sets the sticker Z value. More...

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

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

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

NvsVolume	getVolumeGain ()
	Gets volume information. More...

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

NvsParticleSystemContext	getParticleSystemContext ()

NvsARFaceContext	getARFaceContext ()

NvsPaintingEffectContext	getPaintingEffectContext ()

NvsARSceneManipulate	getARSceneManipulate ()
	获得NvsARSceneManipulate接口 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...

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

Additional Inherited Members
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

Timeline animated sticker is sticker with animated effect.

Timeline animation sticker is a kind of landscaping effect used in video editing. Overlaying stickers on the video will produce special effects. When editing a video, users can add and remove animated stickers through the Timeline. If the added sticker position is not what users want, users can also adjust the stickers' position.
Note: The in-point and out-point units of the animated sticker on the timeline are both in microseconds.

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

Member Function Documentation

long com.meicam.sdk.NvsTimelineAnimatedSticker.changeInPoint ( long newInPoint )

inline

Changes the in-point of the animated sticker on the timeline.

Parameters

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

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

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: changeOutPoint; getInPoint; movePosition

long com.meicam.sdk.NvsTimelineAnimatedSticker.changeOutPoint ( long newOutPoint )

inline

Changes the out-point of the animated sticker on the timeline.

Parameters

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

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

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: changeInPoint; getOutPoint; movePosition

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

inline

Gets animated sticker's package Id.

Returns: Returns the obtained animated sticker's package Id.

Since: 1.7.0

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

inline

Gets the vertex position of the original enclosing rectangle of the animated sticker after transformation.

Returns: Returns a List<PointF> object containing four vertex positions, which in turn correspond to the top left, bottom left, bottom right, and top right vertices of the original bounding rectangle.

Since: 1.4.0

float com.meicam.sdk.NvsTimelineAnimatedSticker.getCenterAzimuthAngle ( )

inline

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

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

Since: 1.6.0

float com.meicam.sdk.NvsTimelineAnimatedSticker.getCenterPolarAngle ( )

inline

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

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

Since: 1.6.0

boolean com.meicam.sdk.NvsTimelineAnimatedSticker.getClipAffinityEnabled ( )

inline

Gets whether the affinity between the animated sticker and the clip is on.

Returns: Returns whether the affinity between the animated sticker and the clip is turned on.

Since: 1.7.1

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

inline

Gets the default duration of the sticker.

Returns: Returns sticker default duration.

Since: 2.1.0

boolean com.meicam.sdk.NvsTimelineAnimatedSticker.getHorizontalFlip ( )

inline

Gets the horizontal flip state of the animated sticker.

Returns: Returns a boolean value indicating a horizontal flip state. True means it flips, false means it doesn't flip.

See also: setHorizontalFlip

long com.meicam.sdk.NvsTimelineAnimatedSticker.getInPoint ( )

inline

Gets animated sticker's in-point on the timeline.

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

See also: getOutPoint; changeInPoint

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

inline

Gets the original enclosing rectangle of the animated sticker.

Returns: Returns a RectF object representing the original enclosing rectangle that was obtained.

float com.meicam.sdk.NvsTimelineAnimatedSticker.getOrthoAngleRange ( )

inline

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

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

Since: 1.7.0

long com.meicam.sdk.NvsTimelineAnimatedSticker.getOutPoint ( )

inline

Gets animated sticker's out-point on the timeline.

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

See also: getInPoint; changeOutPoint

float com.meicam.sdk.NvsTimelineAnimatedSticker.getPolarAngleRange ( )

inline

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

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

Since: 1.6.0

float com.meicam.sdk.NvsTimelineAnimatedSticker.getRotationZ ( )

inline

Gets the rotation angle value of the animated sticker.

Returns: Returns the obtained rotation angle value.

See also: setRotationZ

float com.meicam.sdk.NvsTimelineAnimatedSticker.getScale ( )

inline

Gets the scale value of the animated sticker.

Returns: Returns the obtained zoom value.

See also: setScale

PointF com.meicam.sdk.NvsTimelineAnimatedSticker.getTranslation ( )

inline

Gets the translation position of the animated sticker.

Returns: Returns a PointF object representing the translation position.

See also: setTranslation

boolean com.meicam.sdk.NvsTimelineAnimatedSticker.getVerticalFlip ( )

inline

Gets the vertical flip state of the animated sticker.

Returns: Returns a boolean value indicating a vertical flip state. True means it flips, false means it doesn't flips.

See also: setVerticalFlip

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

inline

Gets volume information.

Returns: Returns the volume object.

See also: setVolumeGain

Since: 2.0.3

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

inline

Gets the sticker Z value.

Returns: Returns sticker Z value.

Since: 1.10.0

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

inline

Checks whether the sticker contains audio.

Returns: Returns whether the sticker contains audio.

Since: 2.0.3

boolean com.meicam.sdk.NvsTimelineAnimatedSticker.isPanoramic ( )

inline

Determines whether the current animated sticker is a panorama animated sticker.

Returns: A return value of true indicates it is a panorama animated sticker.

Since: 1.6.0

void com.meicam.sdk.NvsTimelineAnimatedSticker.movePosition ( long offset )

inline

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

Parameters

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

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: changeInPoint; changeOutPoint

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

inline

Rotates animated sticker.

Parameters

angle	Animated sticker rotation angle.
anchor	Animated sticker rotation anchor.

Since: 1.8.1

void com.meicam.sdk.NvsTimelineAnimatedSticker.rotateAnimatedSticker ( float angle )

inline

Rotates animated stickers with an animated sticker center point as an anchor.

Parameters

angle Animated sticker rotation angle

Since: 1.8.1

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

inline

Scales animated sticker.

Parameters

scaleFactor	Animated sticker scaling factor.
anchor	Animated sticker zoom anchor.

Since: 1.8.1

void com.meicam.sdk.NvsTimelineAnimatedSticker.setCenterAzimuthAngle ( float centerAzimuthAngle )

inline

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

Parameters

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

Since: 1.6.0

void com.meicam.sdk.NvsTimelineAnimatedSticker.setCenterPolarAngle ( float centerPolarAngle )

inline

Sets 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

void com.meicam.sdk.NvsTimelineAnimatedSticker.setClipAffinityEnabled ( boolean enable )

inline

Sets whether the affinity between the animated sticker and the clip is on.

Parameters

enable Whether to enable the affinity between the animation sticker and the clip. If it is turned on, the operation of the clip will affect the sticker. Default mode is on.

Since: 1.7.1

void com.meicam.sdk.NvsTimelineAnimatedSticker.setHorizontalFlip ( boolean flip )

inline

Sets the horizontal flip of the animated sticker.

Parameters

flip	Whether to flip horizontally. True means horizontal flip, and false means it doesn't flip.

See also: getHorizontalFlip

void com.meicam.sdk.NvsTimelineAnimatedSticker.setPolarAngleRange ( float polarAngleRange )

inline

Sets 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

void com.meicam.sdk.NvsTimelineAnimatedSticker.setRotationZ ( float angle )

inline

Sets the rotation angle of the animated sticker.

Parameters

angle Rotation angle value.

See also: getRotationZ

void com.meicam.sdk.NvsTimelineAnimatedSticker.setScale ( float scale )

inline

Sets the zoom value of the animated sticker.

Parameters

scale Scaling value.

See also: getScale

void com.meicam.sdk.NvsTimelineAnimatedSticker.setTranslation ( PointF translation )

inline

Sets the translation of the animated sticker.

Parameters

translation Translation position

See also: getTransltion; translateAnimatedSticker

void com.meicam.sdk.NvsTimelineAnimatedSticker.setVerticalFlip ( boolean flip )

inline

Sets the vertical flip of the animated sticker.

Parameters

flip	Whether to flip vertically. True means it flip vertically, false means it doesn't flip.

See also: getVerticalFlip

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

inline

Sets the sticker volume.

Parameters

leftVolumeGain	Left channel volume gain.
rightVolumeGain	Right channel volume gain.

See also: getVolumeGain

Since: 2.0.3

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

inline

Sets the sticker Z value.

Parameters

value Z value

Since: 1.10.0

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

inline

Tanslates animated sticker.

Parameters

translationOffset Animated sticker tanslates horizontal and vertical 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/NvsTimelineAnimatedSticker.java

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation