NvsCompoundCaption.h

Go to the documentation of this file.

//================================================================================
//
// (c) Copyright Meishe Co. Ltd, 2018. 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:    Dec 18. 2020
//   Author:        Meishe video team
//================================================================================
#pragma once
 
#import "NvsFx.h"
#import <CoreGraphics/CGGeometry.h>
 
typedef enum
{
    NvsBoundingType_Text = 0,               
    NvsBoundingType_Text_Frame = 1,         
    NvsBoundingType_Frame = 2,              
    NvsBoundingType_Text_Origin_Frame = 3,  
    NvsBoundingType_Typographic_Text = 4,   
} NvsBoundingType;
 
NVS_EXPORT @interface NvsCompoundCaption : NvsFx
 
@property (readonly) NSString* captionStylePackageId; 
 
@property (readonly) NSInteger captionCount;
 
- (void)setText:(NSInteger)captionIndex
           text:(NSString *)text;
 
- (NSString *)getText:(NSInteger)captionIndex;
 
- (void)setFontFamily:(NSInteger)captionIndex
               family:(NSString *)family;
 
- (NSString *)getFontFamily:(NSInteger)captionIndex;
 
- (void)setTextColor:(NSInteger)captionIndex
           textColor:(const NvsColor *)textColor;
 
- (NvsColor)getTextColor:(NSInteger)captionIndex;
 
- (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)rotateCaptionAroundCenter:(float)angle
                     boundingType:(NvsBoundingType)boundingType;
 
- (NSArray *)getCaptionBoundingVertices:(NSInteger)captionIndex
                           boundingType:(NvsBoundingType)boundingType;
 
- (NSArray *)getCompoundBoundingVertices:(NvsBoundingType)boundingType;
 
- (void)setZValue:(float)value;
 
- (float)getZValue;
 
- (void)setOpacity:(float)opacity;
 
- (float)getOpacity;
 
- (void)setDrawOutline:(BOOL)drawOutline captionIndex:(int)captionIndex;
 
- (BOOL)getDrawOutline:(int)captionIndex;
 
- (void)setOutlineColor:(NvsColor)outlineColor captionIndex:(int)captionIndex;
 
-(NvsColor)getOutlineColor:(int)captionIndex;
 
- (void)setOutlineWidth:(float)outlineWidth captionIndex:(int)captionIndex;
 
- (float)getOutlineWidth:(int)captionIndex;
 
- (void)setBackgroundColor:(NvsColor)backgroundColor captionIndex:(int)captionIndex;
 
- (NvsColor)getBackgroundColor:(int)captionIndex;
 
- (void)setBold:(BOOL)bold captionIndex:(int)captionIndex;
 
- (BOOL)getBold:(int)captionIndex;
 
- (void)setWeight:(int)weight captionIndex:(int)captionIndex;
 
- (int)getWeight:(int)captionIndex;
 
- (void)setItalic:(BOOL)italic captionIndex:(int)captionIndex;
 
- (BOOL)getItalic:(int)captionIndex;
 
- (void)setCurrentKeyFrameTime:(int64_t)time;
 
- (bool)setControlPoint:(NSString *)fxParam controlPointPair:(NvsControlPointPair *)controlPointPair;
 
- (NvsControlPointPair*)getControlPoint:(NSString*)fxParam;
 
- (bool)removeKeyframeAtTime:(NSString *)fxParam time:(int64_t)time;
 
- (bool)removeAllKeyframe:(NSString *)fxParam;
 
- (bool)hasKeyframeList:(NSString *)fxParam;
 
- (int64_t)findKeyframeTime:(NSString *)fxParam time:(int64_t)time flags:(int)flags;
 
//
// Panoramic caption specific methods
//
@property (readonly) BOOL isPanoramic;          
 
-(void)setCenterPolarAngle:(float)centerPolarAngle;
 
-(float)getCenterPolarAngle:(int)captionIndex;
 
-(void)setPolarAngleRange:(float)polarAngleRange;
 
-(float)getPolarAngleRange:(int)captionIndex;
 
-(void)setCenterAzimuthAngle:(float)centerAzimuthAngle;
 
-(float)getCenterAzimuthAngle:(int)captionIndex;
 
-(float)getOrthoAngleRange:(int)captionIndex;
 
-(void)setPanoramicScaleX:(float)scaleX;
 
-(float)getPanoramicScaleX;
 
-(void)setPanoramicScaleY:(float)scaleY;
 
-(float)getPanoramicScaleY;
 
-(void)setPanoramicRotation:(float)rotationAngle;
 
-(float)getPanoramicRotation;
 
- (BOOL)isFrameCaption:(unsigned int)captionIndex;
@end