MeiCam SDK For iOS  3.1.2
Instance Methods | Properties | List of all members
NvsTimelineAnimatedSticker Class Reference

Timeline animated sticker class. More...

#import <NvsTimelineAnimatedSticker.h>

Inheritance diagram for NvsTimelineAnimatedSticker:
NvsAnimatedSticker NvsFx NvsObject

Instance Methods

(int64_t) - changeInPoint:
 Change the in-point of the animated sticker on the timeline. 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...
 
(int64_t) - changeOutPoint:
 Change the out-point of the animated sticker on the timeline. 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:
 Change 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...
 
- Instance Methods inherited from NvsAnimatedSticker
(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...
 
(float) - getScale
 Get the 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...
 
- 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...
 
(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) - 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 clipAffinityEnabled
 Whether to turn on the affinity with clip.If it is turned on, the operation of the clip will affect the sticker. Default mode is on. More...
 
int64_t inPoint
 The in point of the animated sticker on the timeline (in microseconds). More...
 
int64_t outPoint
 The out point of the animated sticker on the timeline (in microseconds). More...
 
- Properties inherited from NvsAnimatedSticker
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

Timeline animated sticker class.

Timeline 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 NvsTimelineAnimatedSticker class, all public APIs are used in the UI thread! ! !

Method Documentation

◆ changeInPoint:

- (int64_t) changeInPoint: (int64_t)  newInPoint

Change the in-point of the animated sticker on the timeline. 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
newInPointThe new in-point of the animated sticker on the timeline (in microseconds).
Returns
Return 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:

◆ changeOutPoint:

- (int64_t) changeOutPoint: (int64_t)  newOutPoint

Change the out-point of the animated sticker on the timeline. 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
newOutPointThe out-point of the animated sticker on the timeline (in microseconds).
Returns
Return 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:

◆ movePosition:

- (void) movePosition: (int64_t)  offset

Change 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
offsetOffset 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:

Property Documentation

◆ clipAffinityEnabled

- (BOOL) clipAffinityEnabled
readwritenonatomicassign

Whether to turn on the affinity with clip.If it is turned on, the operation of the clip will affect the sticker. Default mode is on.

Since
1.7.1

◆ inPoint

- (int64_t) inPoint
readatomicassign

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

◆ outPoint

- (int64_t) outPoint
readatomicassign

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


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