NvsVideoEffectCaption.h

Go to the documentation of this file.

//================================================================================
//
// (c) Copyright China Digital Video (Beijing) Limited, 2016. All rights reserved.
//
// This code and information is provided "as is" without warranty of any kind,
// either expressed or implied, including but not limited to the implied
// warranties of merchantability and/or fitness for a particular purpose.
//
//--------------------------------------------------------------------------------
//   Birth Date:    Jan 29. 2021
//   Author:        NewAuto video team
//================================================================================
#pragma once
 
#import "NvsEffect.h"
#import <CoreGraphics/CGGeometry.h>
 
typedef enum NvsVideoEffectCategory
{
    NvsVideoEffectDefaultCategory,   
    NvsVideoEffectUserCategory,      
    NvsVideoEffectThemeCategory      
} NvsVideoEffectCategory;
 
typedef enum NvsVideoEffectRoleInTheme
{
    NvsVideoEffectRoleInThemeGeneral,   
    NvsVideoEffectRoleInThemeTitle,     
    NvsVideoEffectRoleInThemeTrailer    
} NvsVideoEffectRoleInTheme;
 
typedef enum NvsVideoEffectTextAlignment
{
    NvsVideoEffectTextAlignmentLeft = 0,
    NvsVideoEffectTextAlignmentCenter,
    NvsVideoEffectTextAlignmentRight,
    NvsVideoEffectTextAlignmentTop,
    NvsVideoEffectTextAlignmentBottom,
    NvsVideoEffectTextAlignmentVCenter
} NvsVideoEffectTextAlignment;
 
typedef enum NvsVideoEffectAssetDefaultParam
{
    VIDEO_EFFECT_USE_ASSET_DEFAULT_PARAM = 0,
    VIDEO_EFFECT_NOT_USE_ASSET_DEFAULT_PARAM
} NvsVideoEffectAssetDefaultParam;
 
typedef enum
{
    NvsVideoEffectBoundingType_Text = 0,               
    NvsVideoEffectBoundingType_Text_Frame = 1,         
    NvsVideoEffectBoundingType_Frame = 2,              
    NvsVideoEffectBoundingType_Text_Origin_Frame = 3,   
    NvsVideoEffectBoundingType_Typographic_Text = 4,    
} NvsVideoEffectBoundingType;
 
typedef enum NvsVideoEffectLetterSpacingType
{
    NvsVideoEffectLetterSpacingTypePercentage = 0,
    NvsVideoEffectLetterSpacingTypeAbsolute
} NvsVideoEffectLetterSpacingType;
 
 
 
NVS_EXPORT @interface NvsVideoEffectCaption : NvsEffect
 
@property (readonly) BOOL isPanoramic;                
@property (readonly) BOOL isModular;                  
@property (nonatomic) BOOL clipAffinityEnabled;       
@property (readonly) int64_t inPoint;                 
@property (readonly) int64_t outPoint;                
@property (readonly) NvsVideoEffectRoleInTheme roleInTheme;      
@property (readonly) NvsVideoEffectCategory category;            
@property (readonly) NSString* captionStylePackageId; 
@property (readonly) NSString* modularCaptionContextPackageId;      
@property (readonly) NSString* modularCaptionRendererPackageId;     
@property (readonly) NSString* modularCaptionAnimationPackageId;    
@property (readonly) NSString* modularCaptionInAnimationPackageId;  
@property (readonly) NSString* modularCaptionOutAnimationPackageId; 
 
- (void)setVideoResolution:(NvsEffectVideoResolution)resolution;
 
- (int64_t)changeInPoint:(int64_t)newInPoint;
 
- (int64_t)changeOutPoint:(int64_t)newOutPoint;
 
- (void)movePosition:(int64_t)offset;
 
-(bool) applyCaptionStyle:(NSString*) captionStylePackageId;
 
-(bool) applyModularCaptionContext:(NSString*) captionContextPackageId;
 
-(bool) applyModularCaptionRenderer:(NSString*) captionRendererPackageId;
 
-(bool) applyModularCaptionAnimation:(NSString*) captionAnimationPackageId;
 
-(bool) applyModularCaptionInAnimation:(NSString*) captionInAnimationPackageId;
 
-(bool) applyModularCaptionOutAnimation:(NSString*) captionOutAnimationPackageId;
 
-(void) setModularCaptionAnimationPeroid:(int)periodInMS;
 
-(int) getModularCaptionAnimationPeroid;
 
-(void) setModularCaptionInAnimationDuration:(int)inAnimationDurationInMS;
 
-(int) getModularCaptionInAnimationDuration;
 
-(void) setModularCaptionOutAnimationDuration:(int)outAnimationDurationInMS;
 
-(int) getModularCaptionOutAnimationDuration;
 
-(bool) applyCaptionStyleWithAssetDefaultParam:(NSString*) captionStylePackageId isUseDefaultAssetParam:(NvsVideoEffectAssetDefaultParam)isUseDefaultAssetParam;
 
- (void)setText:(NSString *)text;
 
- (NSString *)getText;
 
- (void)setVerticalLayout:(BOOL)verticalLayout;
 
- (BOOL)getVerticalLayout;
 
- (void)setTextAlignment:(NvsVideoEffectTextAlignment)textAlign;
 
- (NvsVideoEffectTextAlignment)getTextAlignment;
 
- (void)setTextVerticalAlignment:(NvsVideoEffectTextAlignment)textVerticalAlign;
 
- (NvsVideoEffectTextAlignment)getTextVerticalAlignment;
 
- (void)setBold:(BOOL)bold;
 
- (BOOL)getBold;
 
- (void)setWeight:(int)weight;
 
- (int)getWeight;
 
- (void)setItalic:(BOOL)italic;
 
- (BOOL)getItalic;
 
- (void)setUnderline:(BOOL)underline;
 
- (BOOL)getUnderline;
 
- (float)getLetterSpacing;
 
- (void)setLetterSpacing:(float)letterSpacing;
 
- (NvsVideoEffectLetterSpacingType)getLetterSpacingType;
 
- (void)setLetterSpacingType:(NvsVideoEffectLetterSpacingType)letterSpacingType;
 
- (float)getLineSpacing;
 
- (void)setLineSpacing:(float)lineSpacing;
 
 
- (void)setTextColor:(const NvsEffectColor *)textColor;
 
- (NvsEffectColor)getTextColor;
 
- (void)setDrawOutline:(BOOL)drawOutline;
 
- (BOOL)getDrawOutline;
 
- (void)setOutlineColor:(const NvsEffectColor *)outlineColor;
 
- (NvsEffectColor)getOutlineColor;
 
- (void)setOutlineWidth:(float)outlineWidth;
 
- (float)getOutlineWidth;
 
- (void)setDrawShadow:(BOOL)drawShadow;
 
- (BOOL)getDrawShadow;
 
- (void)setShadowColor:(const NvsEffectColor *)shadowColor;
 
- (NvsEffectColor)getShadowColor;
 
- (void)setShadowOffset:(CGPoint)shadowOffset;
 
- (CGPoint)getShadowOffset;
 
- (void)setShadowFeather:(float)feather;
 
- (float)getShadowFeather;
 
- (void)setFontSize:(float)fontSize;
 
- (float)getFontSize;
 
- (void)setFrameCaptionMaxFontSize:(float)maxFontSize;
 
- (void)setFontWithFilePath:(NSString *)filePath;
 
- (NSString *)getFontFilePath;
 
- (NSString *)getFontFamily;
 
- (void)setFontFamily:(NSString *)family;
 
- (void)setCaptionTranslation:(CGPoint)translation;
 
- (CGPoint)getCaptionTranslation;
 
- (void)translateCaption:(CGPoint)translationOffset;
 
- (void)setAnchorPoint:(CGPoint)anchor;
 
- (CGPoint)getAnchorPoint;
 
- (void)setScaleX:(float)scale;
 
- (float)getScaleX;
 
- (void)setScaleY:(float)scale;
 
- (float)getScaleY;
 
- (void)scaleCaption:(float)scaleFactor anchor:(CGPoint)anchor;
 
- (void)setRotationZ:(float)angle;
 
- (float)getRotationZ;
 
- (void)rotateCaption:(float)angle anchor:(CGPoint)anchor;
 
- (void)rotateCaption:(float)angle;
 
- (void)setTextFrameOriginRect:(NvsEffectRect)rc;
 
- (NvsEffectRect)getTextBoundingRect:(BOOL)actualBoundingRect;
 
- (NSArray *)getCaptionBoundingVertices:(NvsVideoEffectBoundingType)boundingType;
 
- (void)setCenterPolarAngle:(float)centerPolarAngle;
 
- (float)getCenterPolarAngle;
 
- (float)getTextCenterPolarAngle;
 
- (void)setCenterAzimuthAngle:(float)centerAzimuthAngle;
 
- (float)getCenterAzimuthAngle;
 
- (float)getTextCenterAzimuthAngle;
 
- (void)setPolarAngleRange:(float)polarAngleRange;
 
- (float)getPolarAngleRange;
 
- (float)getTextPolarAngleRange;
 
- (float)getOrthoAngleRange;
 
- (float)getTextOrthoAngleRange;
 
- (void)setPanoramicScaleX:(float)scaleX;
 
- (float)getPanoramicScaleX;
 
- (void)setPanoramicScaleY:(float)scaleY;
 
- (float)getPanoramicScaleY;
 
- (void)setPanoramicRotation:(float)rotationAngle;
 
- (float)getPanoramicRotation;
 
- (void)setZValue:(float)value;
 
- (float)getZValue;
 
- (void)setRecordingUserOperation:(BOOL)recordingUserOperation;
 
- (void)setOpacity:(float)opacity;
 
- (float)getOpacity;
 
- (void)setBackgroundColor:(const NvsEffectColor *)backgroundColor;
 
- (NvsEffectColor)getBackgroundColor;
 
- (void)setBackgroundRadius:(float)radius;
 
- (float)getBackgroundRadius;
 
- (void)setSecondaryColor:(const NvsEffectColor *)color;
 
- (NvsEffectColor)getSecondaryColor;
 
- (void)setCurrentKeyFrameTime:(int64_t)time;
 
- (BOOL)isFrameCaption;
 
@end