MeiCam SDK For iOS  3.10.0
NvsVideoEffectAnimatedSticker.h
Go to the documentation of this file.
1 //================================================================================
2 //
3 // (c) Copyright China Digital Video (Beijing) Limited, 2016. All rights reserved.
4 //
5 // This code and information is provided "as is" without warranty of any kind,
6 // either expressed or implied, including but not limited to the implied
7 // warranties of merchantability and/or fitness for a particular purpose.
8 //
9 //--------------------------------------------------------------------------------
10 // Birth Date: Jan 15. 2021
11 // Author: NewAuto video team
12 //================================================================================
13 #pragma once
14 
15 #import "NvsEffect.h"
16 #import <CoreGraphics/CGGeometry.h>
17 
35 
36 
37 @property (readonly) BOOL isPanoramic;
38 @property (readonly) int64_t inPoint;
39 @property (readonly) int64_t outPoint;
40 @property (readonly) int64_t defaultDuration;
41 
42 
52 - (NSString *)getAnimatedStickerPackageId;
53 
72 - (int64_t)changeInPoint:(int64_t)newInPoint;
73 
92 - (int64_t)changeOutPoint:(int64_t)newOutPoint;
93 
106 - (void)movePosition:(int64_t)offset;
107 
117 - (void)setScale:(float)scale;
118 
128 - (float)getScale;
129 
139 - (void)setHorizontalFlip:(bool)flip;
140 
150 - (BOOL)getHorizontalFlip;
151 
161 - (void)setVerticalFlip:(bool)flip;
162 
172 - (BOOL)getVerticalFlip;
173 
183 - (void)setRotationZ:(float)angle;
184 
195 - (float)getRotationZ;
196 
207 - (void)setTranslation:(CGPoint)translation;
208 
218 - (CGPoint)getTransltion;
219 
231 - (void)translateAnimatedSticker:(CGPoint)translationOffset;
232 
244 - (void)scaleAnimatedSticker:(float)scaleFactor anchor:(CGPoint)anchor;
245 
257 - (void)rotateAnimatedSticker:(float)angle anchor:(CGPoint)anchor;
258 
268 - (void)rotateAnimatedSticker:(float)angle;
269 
279 
289 - (NSArray *)getBoundingRectangleVertices;
290 
300 - (void)setCenterPolarAngle:(float)centerPolarAngle;
301 
311 - (float)getCenterPolarAngle;
312 
322 - (void)setCenterAzimuthAngle:(float)centerAzimuthAngle;
323 
333 - (float)getCenterAzimuthAngle;
334 
344 - (void)setPolarAngleRange:(float)polarAngleRange;
345 
355 - (float)getPolarAngleRange;
356 
366 - (float)getOrthoAngleRange;
367 
377 - (void)setZValue:(float)value;
378 
388 - (float)getZValue;
389 
400 - (void)setOpacity:(float)opacity;
401 
412 - (float)getOpacity;
413 
424 - (void)setCurrentKeyFrameTime:(int64_t)time;
425 
435 - (void)setVideoResolution:(NvsEffectVideoResolution*)resolution;
436 
451 - (bool)applyAnimatedStickerPeriodAnimation:(NSString*) animatedStickerPeriodAnimationPackageId;
452 
467 - (bool)applyAnimatedStickerInAnimation:(NSString*) animatedStickerInAnimationPackageId;
468 
483 - (bool)applyAnimatedStickerOutAnimation:(NSString*) animatedStickerOutAnimationPackageId;
484 
495 - (void)setAnimatedStickerAnimationPeriod:(int)periodInMS;
496 
508 
519 - (void)setAnimatedStickerInAnimationDuration:(int)inAnimationDurationInMS;
520 
532 
543 - (void)setAnimatedStickerOutAnimationDuration:(int)outAnimationDurationInMS;
544 
556 
557 @end
558 
-[NvsVideoEffectAnimatedSticker getZValue]
float getZValue()
Get the sticker Z value.
NvsVideoEffectAnimatedSticker
Animated sticker class.
Definition: NvsVideoEffectAnimatedSticker.h:35
-[NvsVideoEffectAnimatedSticker getAnimatedStickerAnimationPeriod]
int getAnimatedStickerAnimationPeriod()
Get animated sticker Animation Period.
-[NvsVideoEffectAnimatedSticker getVerticalFlip]
BOOL getVerticalFlip()
Get the vertical flip state of the animated sticker.
NvsEffectRect
Rectangle.
Definition: NvsEffectCommonDef.h:120
-[NvsVideoEffectAnimatedSticker getAnimatedStickerPackageId]
NSString * getAnimatedStickerPackageId()
Get animated sticker's package ID.
NvsVideoEffectAnimatedSticker::isPanoramic
BOOL isPanoramic
Whether It's a panorama animated sticker,Default is no.
Definition: NvsVideoEffectAnimatedSticker.h:37
NvsVideoEffectAnimatedSticker::defaultDuration
int64_t defaultDuration
The default duration of the animated sticker on the timeline (in microseconds).
Definition: NvsVideoEffectAnimatedSticker.h:40
-[NvsVideoEffectAnimatedSticker getOrthoAngleRange]
float getOrthoAngleRange()
Get the animated sticker’s field angle which is perpendicular to the polar angle. It is only valid fo...
-[NvsVideoEffectAnimatedSticker getCenterPolarAngle]
float getCenterPolarAngle()
Get the polar angle of the center point of the animated sticker. It is only valid for panorama animat...
-[NvsVideoEffectAnimatedSticker getBoundingRectangleVertices]
NSArray * getBoundingRectangleVertices()
Get the vertex positions of the animated sticker's original bounding in the timeline coordinate syste...
NvsVideoEffectAnimatedSticker::inPoint
int64_t inPoint
The in point of the animated sticker on the timeline (in microseconds).
Definition: NvsVideoEffectAnimatedSticker.h:38
-[NvsVideoEffectAnimatedSticker getOriginalBoundingRect]
NvsEffectRect getOriginalBoundingRect()
Get the original bounding of the animated sticker in the timeline coordinate system....
-[NvsVideoEffectAnimatedSticker getScale]
float getScale()
Get the scale value of the animated sticker.
-[NvsVideoEffectAnimatedSticker getPolarAngleRange]
float getPolarAngleRange()
Get animated sticker's field angle, which is coplanar with the polar angle. It is only valid for pano...
NvsVideoEffectAnimatedSticker::outPoint
int64_t outPoint
The out point of the animated sticker on the timeline (in microseconds).
Definition: NvsVideoEffectAnimatedSticker.h:39
-[NvsVideoEffectAnimatedSticker getRotationZ]
float getRotationZ()
Get the angle at which the animation sticker rotates clockwise along the Z-axis, which is perpendicul...
NVS_EXPORT
#define NVS_EXPORT
Definition: NvsCommonDef.h:20
NvsEffect
Special effects.
Definition: NvsEffect.h:46
-[NvsVideoEffectAnimatedSticker getOpacity]
float getOpacity()
Get the sticker opacity.
NvsEffectVideoResolution
Video resolution.
Definition: NvsEffectCommonDef.h:39
-[NvsVideoEffectAnimatedSticker getAnimatedStickerOutAnimationDuration]
int getAnimatedStickerOutAnimationDuration()
Get animated sticker out-animation duration.
-[NvsVideoEffectAnimatedSticker getAnimatedStickerInAnimationDuration]
int getAnimatedStickerInAnimationDuration()
Get animated sticker in-animation duration.
-[NvsVideoEffectAnimatedSticker getTransltion]
CGPoint getTransltion()
Get the translation position of the animated sticker in the timeline coordinate system.
-[NvsVideoEffectAnimatedSticker getHorizontalFlip]
BOOL getHorizontalFlip()
Get the horizontal flip state of the animated sticker.
-[NvsVideoEffectAnimatedSticker getCenterAzimuthAngle]
float getCenterAzimuthAngle()
Get the azimuth of the center point of the animated sticker. It is only valid for panorama animated s...
NvsEffect.h