MeiCam SDK For iOS  3.10.0
Instance Methods | Properties | List of all members
NvsAnimatedSticker Class Reference

animated sticker class. More...

#import <NvsAnimatedSticker.h>

Inheritance diagram for NvsAnimatedSticker:
NvsFx NvsObject NvsCaptureAnimatedSticker NvsClipAnimatedSticker NvsTimelineAnimatedSticker NvsTrackAnimatedSticker

Instance Methods

(NSString *) - getAnimatedStickerPackageId
 Get animated sticker's package ID. More...
 
(void) - setScale:
 Set the scale value of the animated sticker. The scale value set by this function do not stack. More...
 
(void) - setSeperatedScaleX:
 Set the horizontal scale value of the animated sticker. The scale value set by this function do not stack. More...
 
(void) - setSeperatedScaleY:
 Set the vertical 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...
 
(float) - getSeperatedScaleX
 Get the seperated horizontal scale value of the animated sticker. More...
 
(float) - getSeperatedScaleY
 Get the seperated vertical scale value of the animated sticker. More...
 
(void) - setHorizontalFlip:
 Set the horizontal flip of the animated sticker. More...
 
(BOOL) - getHorizontalFlip
 Get the horizontal flip state of the animated sticker. More...
 
(void) - setVerticalFlip:
 Set the vertical flip of the animated sticker. More...
 
(BOOL) - getVerticalFlip
 Get the vertical flip state of the animated sticker. More...
 
(void) - setRotationZ:
 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:
 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...
 
(CGPoint) - getTransltion
 Get the translation position of the animated sticker in the timeline coordinate system. More...
 
(void) - translateAnimatedSticker:
 Tanslate animated sticker in the timeline coordinate system.The translation coordinates set by this function are stackable. More...
 
(void) - scaleAnimatedSticker:anchor:
 Scale animation sticker with the anchor point as the center. The scaling value set by this function is stackable. More...
 
(void) - rotateAnimatedSticker:anchor:
 Rotate the animation sticker around the anchor point. The rotation angle set by this function is stackable. More...
 
(void) - rotateAnimatedSticker:
 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...
 
(NvsRect- getOriginalBoundingRect
 Get the original bounding of the animated sticker in the timeline coordinate system.please refer to TimeLine and View Coordinate. More...
 
(NSArray *) - 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...
 
(void) - setCenterPolarAngle:
 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:
 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:
 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:
 Set the sticker Z value.The higher the Z value, the higher the sticker is. More...
 
(float) - getZValue
 Get the sticker Z value. More...
 
(void) - setVolumeGain:rightVolumeGain:
 Set the sticker volume. More...
 
(void) - getVolumeGain:rightVolumeGain:
 Get volume information. More...
 
(void) - setOpacity:
 Set the sticker opacity,value range [0, 1]. More...
 
(float) - getOpacity
 Get the sticker opacity. More...
 
(void) - setCurrentKeyFrameTime:
 Set the sticker's Key frame time. More...
 
(bool) - setControlPoint:controlPointPair:
 Set the sticker's control point pair. More...
 
(NvsControlPointPair *) - getControlPoint:
 Get the sticker's key frame control point pair. More...
 
(bool) - applyAnimatedStickerPeriodAnimation:
 Applys animated sticker loop-animation style. More...
 
(bool) - applyAnimatedStickerInAnimation:
 Applys animated sticker in-animation style. Notes:please set loop-Animation to null before you set in-animation, otherwise it will NOT works. More...
 
(bool) - applyAnimatedStickerOutAnimation:
 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:
 Set animated sticker Animation Period. More...
 
(int) - getAnimatedStickerAnimationPeriod
 Get animated sticker Animation Period. More...
 
(void) - setAnimatedStickerInAnimationDuration:
 Set animated sticker in-animation duration. More...
 
(int) - getAnimatedStickerInAnimationDuration
 Get animated sticker in-animation duration. More...
 
(void) - setAnimatedStickerOutAnimationDuration:
 Set animated sticker out-animation duration. More...
 
(int) - getAnimatedStickerOutAnimationDuration
 Get animated sticker out-animation duration. More...
 
(void) - enableSeparateProgressMode:
 Set enable the separate effect settings from progress mode. More...
 
(bool) - isSeparateProgressModeEnabled
 Get whether enable the separate effect settings from progress mode. More...
 
- Instance Methods inherited from NvsFx
(void) - setIntVal:val:
 Set the integer parameter of NvsFx. More...
 
(int) - getIntVal:
 Get the integer parameter of NvsFx. More...
 
(void) - setIntValAtTime:val:time:
 Set the NvsFx's integer parameter at a specified time point. More...
 
(int) - getIntValAtTime:time:
 Get the NvsFx's integer parameter at a specified time point. More...
 
(void) - setFloatVal:val:
 Set the float parameter of NvsFx. More...
 
(double) - getFloatVal:
 Get the float parameter of NvsFx. More...
 
(void) - setFloatValAtTime:val:time:
 Set the NvsFx's float parameter at a specified time point. More...
 
(double) - getFloatValAtTime:time:
 Get the NvsFx's float parameter at a specified time point. More...
 
(void) - setBooleanVal:val:
 Set the BOOL parameter of NvsFx. More...
 
(BOOL) - getBooleanVal:
 Get the BOOL parameter of NvsFx. More...
 
(void) - setBooleanValAtTime:val:time:
 Set the NvsFx’s BOOL parameter at a specified time point. More...
 
(BOOL) - getBooleanValAtTime:time:
 Get the NvsFx's BOOL parameter at a specified time point. More...
 
(void) - setStringVal:val:
 Set the string parameter of NvsFx. More...
 
(NSString *) - getStringVal:
 Get the string parameter of NvsFx. More...
 
(void) - setStringValAtTime:val:time:
 Set the NvsFx's string parameter at a specified time point. More...
 
(NSString *) - getStringValAtTime:time:
 Get the NvsFx's string parameter at a specified time point. More...
 
(void) - setColorVal:val:
 Set the color parameter of NvsFx. More...
 
(NvsColor- getColorVal:
 Get the color parameter of NvsFx. More...
 
(void) - setColorValAtTime:val:time:
 Set the NvsFx's color parameter at a specified time point. More...
 
(NvsColor- getColorValAtTime:time:
 Get the NvsFx's color parameter at a specified time point. More...
 
(void) - setPosition2DVal:val:
 Set the two dimentional coordinates parameter of NvsFx. More...
 
(NvsPosition2D- getPosition2DVal:
 Get the two dimentional coordinates parameter of NvsFx. More...
 
(void) - setPosition2DValAtTime:val:time:
 Set the NvsFx's two dimentional coordinates parameter at a specified time point. More...
 
(NvsPosition2D- getPosition2DValAtTime:time:
 Get the NvsFx's two dimentional coordinates parameter at a specified time point. More...
 
(void) - setPosition3DVal:val:
 Set the three dimentional coordinates parameter of NvsFx. More...
 
(NvsPosition3D- getPosition3DVal:
 Get the three dimentional coordinates parameter of NvsFx. More...
 
(void) - setPosition3DValAtTime:val:time:
 Set the NvsFx's three dimentional coordinates parameter at a specified time point. More...
 
(NvsPosition3D- getPosition3DValAtTime:time:
 Get the NvsFx's three dimentional coordinates parameter at a specified time point. More...
 
(void) - setMenuVal:val:
 Set the menu parameter of NvsFx. More...
 
(NSString *) - getMenuVal:
 Get the menu parameter of NvsFx. More...
 
(void) - setMenuValAtTime:val:time:
 Set the NvsFx's menu parameter at a specified time point. More...
 
(NSString *) - getMenuValAtTime:time:
 Get the NvsFx menu parameter at a specified time point. More...
 
(void) - setArbDataVal:val:
 Set custom data parameter value. More...
 
(NvsArbitraryData *) - getArbDataVal:
 Get custom data parameter value. More...
 
(void) - setArbDataValAtTime:val:time:
 Sets custom data parameter value. More...
 
(NvsArbitraryData *) - getArbDataValAtTime:time:
 Get custom data parameter value at a specified time point. More...
 
(bool) - removeKeyframeAtTime:time:
 Remove key frame at a specified time point from key frame list. More...
 
(bool) - removeAllKeyframe:
 Remove all key frames from key frame list. More...
 
(bool) - hasKeyframeList:
 Check whether the parameter has key frame list or not. More...
 
(int64_t) - findKeyframeTime:time:flags:
 Get key frame at a specified time point. More...
 
(bool) - setKeyFrameControlPoint:time:controlPointPair:
 Set key frame control point pair. More...
 
(NvsControlPointPair *) - getKeyFrameControlPoint:time:
 Get key frame control point pair. More...
 
(bool) - setKeyFrameControlPointMode:time:controlPointModePair:
 Set key frame control point mode pair. More...
 
(NvsControlPointModePair *) - getKeyFrameControlPointMode:time:
 Get key frame control point mode pair. More...
 
(void) - setFilterIntensity:
 Set the intensity of the filter. More...
 
(float) - getFilterIntensity
 Get the intensity of the filter. More...
 
(void) - setFilterMask:
 Set the mask of the filter. More...
 
(bool) - getFilterMask
 Get the usage of the filter's mask. More...
 
(void) - setRegional:
 Set whether the filter is regional. More...
 
(BOOL) - getRegional
 Get whether the filter is regional. More...
 
(void) - setIgnoreBackground:
 Set whether the regional filter ignores background. More...
 
(BOOL) - getIgnoreBackground
 Get whether the regional filter ignores background. More...
 
(void) - setInverseRegion:
 Set whether the regional filter inverses region. More...
 
(BOOL) - getInverseRegion
 Get whether the regional filter inverses region. More...
 
(NSArray *) - getRegion
 Get the region of this regional filter. More...
 
(void) - setRegion:
 Set the region of this regional filter. More...
 
(NvsMaskRegionInfo *) - getRegionInfo
 Get the mask region informations of the regional filter. More...
 
(void) - setRegionInfo:
 Set the mask region informations of the regional filter. More...
 
(void) - setRegionInfoAtTime:time:
 Set the regional filter's mask region informations at a specified time point. More...
 
(NvsMaskRegionInfo *) - getRegionInfoAtTime:
 Get the the regional filter's mask region informations at a specified time. More...
 
(void) - setRegionalFeatherWidth:
 Set the feather width of the regional filter. More...
 
(float) - getRegionalFeatherWidth
 Get the feather width of the regional filter. More...
 
(void) - setRegionalFeatherWidthAtTime:time:
 Set the regional filter's feather width at a specified time point. More...
 
(float) - getRegionalFeatherWidthAtTime:
 Get the regional filter's feather width at a specified time point. More...
 
(void) - setRegionCoordinateSystemType:
 Set the coordinate system of the region. More...
 
(int) - getRegionCoordinateSystemType
 Get the coordinate system of the region. More...
 
(NvsParticleSystemContext *) - getParticleSystemContext
 Get the particle effect context pointer.Please refer to NvsParticleSystemContext. More...
 
(NvsARFaceContext *) - getARFaceContext
 Get face effect context pointer.Please refer to NvsARFaceContext. More...
 
(NvsPaintingEffectContext *) - getPaintingEffectContext
 Get the particle effect context pointer.Please refer to NvsPaintingEffectContext. More...
 
(NvsARSceneManipulate *) - getARSceneManipulate
 Get the AR scene operation pointer.Please refer to NvsARSceneManipulate. More...
 
(void) - setExprVar:varValue:
 Set the value of the defined parameter in the expression. More...
 
(double) - getExprVar:
 Get the value of the defined parameter in the expression. More...
 
(void) - setColorExprVar:varValue:
 Set the color value of the defined parameter in the expression. More...
 
(NvsColor- getColorExprVar:
 Get the color value of the defined parameter in the expression. More...
 
(void) - clearExprVar:
 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...
 
- Instance Methods inherited from NvsObject
(void) - setAttachment:forKey:
 Adds an attachment to the NvsObject object to identify the object of the NvsObject or for other purposes. More...
 
(void) - setTemplateAttachment:forKey:
 Adds additional template data to the NvsObject object to identify the NvsObject template object. More...
 
(NSObject *) - getAttachment:
 Gets attached attachments. More...
 
(NSString *) - getTemplateAttachment:
 Gets an template attachment to NvsObject. More...
 

Properties

BOOL hasAudio
 Whether it contains audio. More...
 
BOOL isPanoramic
 Whether It's a panorama animated sticker,Default is no. More...
 
int64_t defaultDuration
 The default duration of the animated sticker on the timeline (in microseconds). More...
 
NSString * animatedStickerPeriodAnimationPackageId
 The package ID of the animated sticker loop-animation style. More...
 
NSString * animatedStickerInAnimationPackageId
 The package ID of the animated sticker in-animation style. More...
 
NSString * animatedStickerOutAnimationPackageId
 The package ID of the animated sticker out-animation style. More...
 
- Properties inherited from NvsFx
NvsFxDescriptiondescription
 Special effect description. More...
 

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! ! !

Method Documentation

◆ applyAnimatedStickerInAnimation:

- (bool) applyAnimatedStickerInAnimation: (NSString *)  animatedStickerInAnimationPackageId

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

Parameters
animatedStickerInAnimationPackageIdAnimated 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:

- (bool) applyAnimatedStickerOutAnimation: (NSString *)  animatedStickerOutAnimationPackageId

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

Parameters
AnimatedStickerOutAnimationPackageIdAnimated 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:

- (bool) applyAnimatedStickerPeriodAnimation: (NSString *)  animatedStickerPeriodAnimationPackageId

Applys animated sticker loop-animation style.

Parameters
animatedStickerPeriodAnimationPackageIdanimated 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) enableSeparateProgressMode: (bool)  enable

Set enable the separate effect settings from progress mode.

Parameters
enablewhether enable or not.
See also
- isSeparateProgressModeEnabled
Since
3.8.1

◆ getAnimatedStickerAnimationPeriod

- (int) getAnimatedStickerAnimationPeriod

Get animated sticker Animation Period.

Returns
Return animation period in million second
See also
setAnimatedStickerAnimationPeriod
Since
2.21.0

◆ getAnimatedStickerInAnimationDuration

- (int) getAnimatedStickerInAnimationDuration

Get animated sticker in-animation duration.

Returns
Return in-animation duration in million second
See also
setAnimatedStickerInAnimationDuration
Since
2.21.0

◆ getAnimatedStickerOutAnimationDuration

- (int) getAnimatedStickerOutAnimationDuration

Get animated sticker out-animation duration.

Returns
Return out-animation duration in million second
See also
setAnimatedStickerOutAnimationDuration
Since
2.21.0

◆ getAnimatedStickerPackageId

- (NSString *) getAnimatedStickerPackageId

Get animated sticker's package ID.

Returns
Return the animated sticker's package ID.
Since
1.7.0

◆ getBoundingRectangleVertices

- (NSArray *) getBoundingRectangleVertices

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) getCenterAzimuthAngle

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) getCenterPolarAngle

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*) getControlPoint: (NSString *)  fxParam

Get the sticker's key frame control point pair.

Parameters
fxParamThe 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: controlPointPair
Since
2.22.0

◆ getHorizontalFlip

- (BOOL) getHorizontalFlip

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) getOpacity

Get the sticker opacity.

Returns
Return the sticker opacity.
See also
- setOpacity:
Since
2.14.0

◆ getOriginalBoundingRect

- (NvsRect) getOriginalBoundingRect

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) getOrthoAngleRange

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) getPolarAngleRange

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) getRotationZ

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) getScale

Get the scale value of the animated sticker.

Returns
Return the scale value.
See also
- setScale:

◆ getSeperatedScaleX

- (float) getSeperatedScaleX

Get the seperated horizontal scale value of the animated sticker.

Returns
Return the horizontal scale value.
Since
3.7.3

◆ getSeperatedScaleY

- (float) getSeperatedScaleY

Get the seperated vertical scale value of the animated sticker.

Returns
Return the vertical scale value.
Since
3.7.3

◆ getTransltion

- (CGPoint) getTransltion

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

- (BOOL) getVerticalFlip

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:rightVolumeGain:

- (void) getVolumeGain: (float *)  leftVolumeGain
rightVolumeGain: (float *)  rightVolumeGain 

Get volume information.

Parameters
leftVolumeGainOutputs the volume value of the left channel
rightVolumeGainOutputs the volume value of the right channel
See also
- setVolumeGain:rightVolumeGain:
Since
2.0.3

◆ getZValue

- (float) getZValue

Get the sticker Z value.

Returns
Return sticker Z value.
Since
1.10.0

◆ isSeparateProgressModeEnabled

- (bool) isSeparateProgressModeEnabled

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:

- (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.

Parameters
anglerotation angle
Since
1.8.1

◆ rotateAnimatedSticker:anchor:

- (void) rotateAnimatedSticker: (float)  angle
anchor: (CGPoint)  anchor 

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

Parameters
anglerotation angle.
anchorrotation anchor.
Since
1.8.1

◆ scaleAnimatedSticker:anchor:

- (void) scaleAnimatedSticker: (float)  scaleFactor
anchor: (CGPoint)  anchor 

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

Parameters
scaleFactorAnimated sticker scaling factor.
anchorAnimated sticker scale anchor.
Since
1.8.1

◆ setAnimatedStickerAnimationPeriod:

- (void) setAnimatedStickerAnimationPeriod: (int)  periodInMS

Set animated sticker Animation Period.

Parameters
periodInMSAnimation period in million second
See also
- getAnimatedStickerAnimationPeriod
Since
2.21.0

◆ setAnimatedStickerInAnimationDuration:

- (void) setAnimatedStickerInAnimationDuration: (int)  inAnimationDurationInMS

Set animated sticker in-animation duration.

Parameters
inAnimationDurationInMSin-animation duration in million second
See also
- getAnimatedStickerInAnimationDuration
Since
2.21.0

◆ setAnimatedStickerOutAnimationDuration:

- (void) setAnimatedStickerOutAnimationDuration: (int)  outAnimationDurationInMS

Set animated sticker out-animation duration.

Parameters
outAnimationDurationInMSout-animation duration in million second
See also
- getAnimatedStickerOutAnimationDuration
Since
2.21.0

◆ setCenterAzimuthAngle:

- (void) setCenterAzimuthAngle: (float)  centerAzimuthAngle

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

Parameters
centerAzimuthAngleThe azimuth of the center point, in degrees.
Since
1.6.0

◆ setCenterPolarAngle:

- (void) setCenterPolarAngle: (float)  centerPolarAngle

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

Parameters
centerPolarAngleThe polar angle of the center point, in degrees.
Since
1.6.0

◆ setControlPoint:controlPointPair:

- (bool) setControlPoint: (NSString *)  fxParam
controlPointPair: (NvsControlPointPair *)  controlPointPair 

Set the sticker's control point pair.

Parameters
fxParamThe type of data parameter for the sticker.
controlPointPaircontrol 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) setCurrentKeyFrameTime: (int64_t)  time

Set the sticker's Key frame time.

Parameters
timetime point
See also
setCurrentKeyFrameTime
Since
2.15.0

◆ setHorizontalFlip:

- (void) setHorizontalFlip: (bool)  flip

Set the horizontal flip of the animated sticker.

Parameters
flipWhether to flip horizontally. True means horizontal flip, and false means not.
See also
- getHorizontalFlip

◆ setOpacity:

- (void) setOpacity: (float)  opacity

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

Parameters
opacitysticker opacity.
See also
- getOpacity
Since
2.14.0

◆ setPolarAngleRange:

- (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.

Parameters
polarAngleRangeThe field angle coplanar with the polar angle, in degrees.
Since
1.6.0

◆ setRotationZ:

- (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.

Parameters
angleRotation angle value.
See also
- getRotationZ

◆ setScale:

- (void) setScale: (float)  scale

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

Parameters
scaleScaling value.
See also
- getScale

◆ setSeperatedScaleX:

- (void) setSeperatedScaleX: (float)  scaleX

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

Parameters
scalehorizontal Scaling value.
Returns
Since
3.7.3

◆ setSeperatedScaleY:

- (void) setSeperatedScaleY: (float)  scaleY

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

Parameters
scalevertical Scaling value.
Since
3.7.3

◆ setTranslation:

- (void) setTranslation: (CGPoint)  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.

Parameters
translationTranslation position
See also
- getTransltion
- translateAnimatedSticker:

◆ setVerticalFlip:

- (void) setVerticalFlip: (bool)  flip

Set the vertical flip of the animated sticker.

Parameters
flipWhether to flip vertically. True means it flip vertically, false means not.
See also
- getVerticalFlip

◆ setVolumeGain:rightVolumeGain:

- (void) setVolumeGain: (float)  leftVolumeGain
rightVolumeGain: (float)  rightVolumeGain 

Set the sticker volume.

Parameters
leftVolumeGainLeft channel volume gain,value range [0, 1].
rightVolumeGainRight channel volume gain,value range [0, 1].
See also
- getVolumeGain:rightVolumeGain:
Since
2.0.3

◆ setZValue:

- (void) setZValue: (float)  value

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

Parameters
valueZ value
Since
1.10.0

◆ translateAnimatedSticker:

- (void) translateAnimatedSticker: (CGPoint)  translationOffset

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

Parameters
translationOffsetAnimated sticker translation offset values.
Since
1.8.1
See also
- setTranslation:
getTranslation

Property Documentation

◆ animatedStickerInAnimationPackageId

- (NSString*) animatedStickerInAnimationPackageId
readatomicassign

The package ID of the animated sticker in-animation style.

Since
2.21.0

◆ animatedStickerOutAnimationPackageId

- (NSString*) animatedStickerOutAnimationPackageId
readatomicassign

The package ID of the animated sticker out-animation style.

Since
2.21.0

◆ animatedStickerPeriodAnimationPackageId

- (NSString*) animatedStickerPeriodAnimationPackageId
readatomicassign

The package ID of the animated sticker loop-animation style.

Since
2.21.0

◆ defaultDuration

- (int64_t) defaultDuration
readatomicassign

The default duration of the animated sticker on the timeline (in microseconds).

Since
2.1.0

◆ hasAudio

- (BOOL) hasAudio
readatomicassign

Whether it contains audio.

Since
2.0.3

◆ isPanoramic

- (BOOL) isPanoramic
readatomicassign

Whether It's a panorama animated sticker,Default is no.

Since
1.6.0

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