NvsCaption.h

Go to the documentation of this file.

//================================================================================
//
// (c) Copyright Meishe Co. Ltd, 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:        Meishe video team
//================================================================================
#pragma once
 
#import "NvsFx.h"
#import <CoreGraphics/CGGeometry.h>
#import "NvsTimelineCompoundCaption.h"
#import "NvsCaptionSpan.h"
#import "NvsCaptionTextLayout.h"
 
NVS_EXPORT @interface NvsCaption : NvsFx
 
@property (readonly) BOOL isPanoramic;                
@property (readonly) BOOL isModular;                  
@property (readonly) NvsRoleInTheme roleInTheme;      
@property (readonly) NvsCategory 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; 
 
-(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:(NvsAssetDefaultParam)isUseDefaultAssetParam;
 
- (void)setText:(NSString *)text;
 
- (NSString *)getText;
 
- (void)setVerticalLayout:(BOOL)verticalLayout;
 
- (BOOL)getVerticalLayout;
 
- (void)setTextAlignment:(NvsTextAlignment)textAlign;
 
- (NvsTextAlignment)getTextAlignment;
 
- (void)setTextVerticalAlignment:(NvsTextAlignment)textVerticalAlign;
 
- (NvsTextAlignment)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;
 
- (NvsLetterSpacingType)getLetterSpacingType;
 
- (void)setLetterSpacingType:(NvsLetterSpacingType)letterSpacingType;
 
- (float)getLineSpacing;
 
- (void)setLineSpacing:(float)lineSpacing;
 
 
- (void)setTextColor:(const NvsColor *)textColor;
 
- (void)resetTextColorState;
 
- (NvsColor)getTextColor;
 
- (void)setDrawOutline:(BOOL)drawOutline;
 
- (BOOL)getDrawOutline;
 
- (void)setOutlineColor:(const NvsColor *)outlineColor;
 
- (NvsColor)getOutlineColor;
 
- (void)resetOutlineColorState;
 
- (void)setOutlineWidth:(float)outlineWidth;
 
- (float)getOutlineWidth;
 
- (void)setDrawShadow:(BOOL)drawShadow;
 
- (BOOL)getDrawShadow;
 
- (void)setShadowColor:(const NvsColor *)shadowColor;
 
- (NvsColor)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:(NvsRect)rc;
 
- (NvsRect)getTextBoundingRect;
 
- (NSArray *)getBoundingRectangleVertices;
 
- (NSArray *)getCaptionBoundingVertices:(NvsBoundingType)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 NvsColor *)backgroundColor;
 
- (NvsColor)getBackgroundColor;
 
- (void)setBackgroundRadius:(float)radius;
 
- (float)getBackgroundRadius;
 
 
-(void)setBoundaryPaddingRatio:(float)ratio;
 
-(float)getBoundaryPaddingRatio;
 
- (void)setSecondaryColor:(const NvsColor *)color;
 
- (NvsColor)getSecondaryColor;
 
- (void)setSecondaryOutlineColor:(const NvsColor *)color;
 
- (NvsColor)getSecondaryOutlineColor;
 
- (void)setCurrentKeyFrameTime:(int64_t)time;
 
- (bool)setControlPoint:(NSString *)fxParam controlPointPair:(NvsControlPointPair *)controlPointPair;
 
- (NvsControlPointPair*)getControlPoint:(NSString*)fxParam;
 
- (BOOL)isFrameCaption;
 
- (void)setTextSpanList:(NSArray<NvsCaptionSpan *>*)storyboardCaptionSpanList;
 
- (NSArray<NvsCaptionSpan *>*)getTextSpanList;
 
- (NvsCaptionTextLayout *)getTextLayout;
 
- (int)getComplexRenderLayerCount;
 
- (BOOL)hasOutlineLayerInComplexRender:(int)layerIndex;
 
- (NvsColor)getComplexRenderLayerOutlineColor:(int)layerIndex;
 
- (BOOL)setComplexRenderLayerOutlineColor:(int)layerIndex color:(NvsColor)color;
 
- (float)getComplexRenderLayerOutlineWidth:(int)layerIndex;
 
- (BOOL)setComplexRenderLayerOutlineWidth:(int)layerIndex width:(float)width;
 
- (float)getComplexRenderLayerOpacity:(int)layerIndex;
 
- (BOOL)setComplexRenderLayerOpacity:(int)layerIndex opacity:(float)opacity;
 
 
@end