NvsTimeline.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:    Dec 29. 2016
//   Author:        Meishe video team
//================================================================================
#pragma once
 
#import "NvsCommonDef.h"
#import "NvsObject.h"
#import "NvsLiveWindow.h"
#import "NvsCustomVideoFx.h"
#import "NvsTimelineCompoundCaption.h"
#import "NvsTimelineGraphCompositor.h"
 
@class NvsVideoTrack;
@class NvsAudioTrack;
@class NvsTimelineCaption;
@class NvsTimelineAnimatedSticker;
@class NvsTimelineVideoFx;
@class NvsClip;
@class NvsCaption;
 
typedef enum {
    NvsTimelineWatermarkPosition_TopRight = 0,        
    NvsTimelineWatermarkPosition_TopLeft = 1,         
    NvsTimelineWatermarkPosition_BottomLeft = 2,      
    NvsTimelineWatermarkPosition_BottomRight = 3      
} NvsTimelineWatermarkPosition;
 
NVS_EXPORT @interface NvsPlaybackRateControlRegion : NSObject
 
    @property (nonatomic, assign) int64_t startTime;
    @property (nonatomic, assign) int64_t endTime;
    @property (nonatomic, assign) float playbackRate;
    @property (nonatomic, assign) float audioGain;
 
@end
 
NVS_EXPORT @interface NvsCaptionBoundingVerticesInfo : NSObject
 
@property (nonatomic, strong) NvsCaption* caption;
@property (nonatomic, strong) NSArray<NSValue*>* values; // CGPoint
 
@end
 
NVS_EXPORT @interface NvsClipBoundingVerticesInfo : NSObject
 
@property (nonatomic, strong) NvsClip* clip;
@property (nonatomic, strong) NSArray<NSValue*>* values; // CGPoint
 
@end
 
 
 
NVS_EXPORT @interface NvsTimeline : NvsObject
 
@property (readonly) NvsVideoResolution videoRes;           
 
@property (readonly) NvsAudioResolution audioRes;           
 
@property (readonly) NvsRational videoFps;                  
 
@property (readonly) int64_t duration;                      
 
@property (nonatomic) int64_t audioFadeOutDuration;         
 
-(int)getCreationFlags;
 
- (NvsVideoTrack *)appendVideoTrack;
 
- (NvsAudioTrack *)appendAudioTrack;
 
- (NvsVideoTrack *)insertVideoTrack:(unsigned int)clipIndex;
 
- (NvsAudioTrack *)insertAudioTrack:(unsigned int)clipIndex;
 
- (BOOL)removeVideoTrack:(unsigned int)trackIndex;
 
- (BOOL)removeAudioTrack:(unsigned int)trackIndex;
 
- (unsigned int)videoTrackCount;
 
- (unsigned int)audioTrackCount;
 
- (NvsVideoTrack *)getVideoTrackByIndex:(unsigned int)trackIndex;
 
- (NvsAudioTrack *)getAudioTrackByIndex:(unsigned int)trackIndex;
 
- (BOOL)changeVideoSize:(int)videoWidth videoHeight:(int)videoHeight;
 
- (BOOL)changeVideoBitDepth:(NvsVideoResolutionBitDepth)newBitDepth;
 
 
- (void)setCaptionBoundingRectInActualMode:(BOOL)isActualBoundingRect;
 
- (void)enableRenderOrderByZValue:(BOOL)enable;
 
- (BOOL)isRenderOrderByZValueEnabled;
 
- (NvsTimelineCaption *)getFirstCaption;
 
- (NvsTimelineCaption *)getLastCaption;
 
- (NvsTimelineCaption *)getPrevCaption:(NvsTimelineCaption *)caption;
 
- (NvsTimelineCaption *)getNextCaption:(NvsTimelineCaption *)caption;
 
- (NSArray *)getCaptionsByTimelinePosition:(int64_t)timelinePos;
 
- (NvsTimelineCaption *)addCaption:(NSString *)captionText inPoint:(int64_t)inPoint duration:(int64_t)duration captionStylePackageId:(NSString *)captionStylePackageId;
 
- (NvsTimelineCaption *)addPanoramicCaption:(NSString *)captionText inPoint:(int64_t)inPoint duration:(int64_t)duration captionStylePackageId:(NSString *)captionStylePackageId;
 
- (NvsTimelineCaption *)addModularCaption:(NSString *)captionText inPoint:(int64_t)inPoint duration:(int64_t)duration;
 
- (NvsTimelineCaption *)removeCaption:(NvsTimelineCaption *)caption;
 
- (NvsTimelineCompoundCaption *)getFirstCompoundCaption;
 
- (NvsTimelineCompoundCaption *)getLastCompoundCaption;
 
- (NvsTimelineCompoundCaption *)getPrevCompoundCaption:(NvsTimelineCompoundCaption *)caption;
 
- (NvsTimelineCompoundCaption *)getNextCompoundCaption:(NvsTimelineCompoundCaption *)caption;
 
- (NSArray<NvsTimelineCompoundCaption*> *)getCompoundCaptionsByTimelinePosition:(int64_t)timelinePos;
 
- (NvsTimelineCompoundCaption *)addCompoundCaption:(int64_t)inPoint
                                          duration:(int64_t)duration
                          compoundCaptionPackageId:(NSString *)compoundCaptionPackageId;
 
- (NvsTimelineCompoundCaption *)addPanoramicCompoundCaption:(int64_t)inPoint
                                          duration:(int64_t)duration
                          compoundCaptionPackageId:(NSString *)compoundCaptionPackageId;
 
- (NvsTimelineCompoundCaption *)removeCompoundCaption:(NvsTimelineCompoundCaption *)caption;
 
- (NvsTimelineAnimatedSticker *)getFirstAnimatedSticker;
 
- (NvsTimelineAnimatedSticker *)getLastAnimatedSticker;
 
- (NvsTimelineAnimatedSticker *)getPrevAnimatedSticker:(NvsTimelineAnimatedSticker *)animatedSticker;
 
- (NvsTimelineAnimatedSticker *)getNextAnimatedSticker:(NvsTimelineAnimatedSticker *)animatedSticker;
 
- (NSArray *)getAnimatedStickersByTimelinePosition:(int64_t)timelinePos;
 
- (NvsTimelineAnimatedSticker *)addAnimatedSticker:(int64_t)inPoint duration:(int64_t)duration animatedStickerPackageId:(NSString *)animatedStickerPackageId;
 
- (NvsTimelineAnimatedSticker *)addPanoramicAnimatedSticker:(int64_t)inPoint duration:(int64_t)duration animatedStickerPackageId:(NSString *)animatedStickerPackageId;
 
- (NvsTimelineAnimatedSticker *)addCustomAnimatedSticker:(int64_t)inPoint duration:(int64_t)duration animatedStickerPackageId:(NSString *)animatedStickerPackageId customImagePath:(NSString *)customImagePath;
 
- (NvsTimelineAnimatedSticker *)addCustomPanoramicAnimatedSticker:(int64_t)inPoint duration:(int64_t)duration animatedStickerPackageId:(NSString *)animatedStickerPackageId customImagePath:(NSString *)customImagePath;
 
- (NvsTimelineAnimatedSticker *)removeAnimatedSticker:(NvsTimelineAnimatedSticker *)animatedSticker;
 
- (NvsTimelineVideoFx *)getFirstTimelineVideoFx;
 
- (NvsTimelineVideoFx *)getLastTimelineVideoFx;
 
- (NvsTimelineVideoFx *)getPrevTimelineVideoFx:(NvsTimelineVideoFx *)videoFx;
 
- (NvsTimelineVideoFx *)getNextTimelineVideoFx:(NvsTimelineVideoFx *)videoFx;
 
- (NSArray *)getTimelineVideoFxByTimelinePosition:(int64_t)timelinePos;
 
- (NvsTimelineVideoFx *)addBuiltinTimelineVideoFx:(int64_t)inPoint duration:(int64_t)duration videoFxName:(NSString *)videoFxName;
 
- (NvsTimelineVideoFx *)addPackagedTimelineVideoFx:(int64_t)inPoint duration:(int64_t)duration videoFxPackageId:(NSString *)videoFxPackageId;
 
- (NvsTimelineVideoFx *)addCustomTimelineVideoFx:(int64_t)inPoint
                                        duration:(int64_t)duration
                             customVideoFxRender:(id<NvsCustomVideoFxRenderer>)customVideoFxRender;
 
- (NvsTimelineVideoFx *)removeTimelineVideoFx:(NvsTimelineVideoFx *)videoFx;
 
- (NSString *)getCurrentThemeId;
 
- (BOOL)applyTheme:(NSString *)themeId;
 
- (void)removeCurrentTheme;
 
- (void)setThemeTitleCaptionText:(NSString *)text;
 
- (void)setThemeTrailerCaptionText:(NSString *)text;
 
- (void)setThemeMusicVolumeGain:(float)leftVolumeGain rightVolumeGain:(float)rightVolumeGain;
 
- (void)getThemeMusicVolumeGain:(float *)leftVolumeGain rightVolumeGain:(float *)rightVolumeGain;
 
- (bool)addWatermark:(NSString*)watermarkFilePath displayWidth:(int)displayWidth displayHeight:(int)displayHeight opacity:(float)opacity position:(int)position marginX:(int)marginX marginY:(int)marginY;
 
- (void)deleteWatermark;
 
- (bool)setWatermarkOpacity:(float)opacity;
 
- (bool)setTimelineEndingLogo:(NSString*)logoFilePath displayWidth:(unsigned int)displayWidth displayHeight:(unsigned int)displayHeight centerX:(int)centerX centerY:(int)centerY;
 
- (void)removeTimelineEndingLogo;
 
- (void)setPlaybackRateControl:(NSArray *) arrayPlaybackRateControlRegion;
 
- (NSArray *)getPlaybackRateControl;
 
- (BOOL)moveVideoTrackIndex:(unsigned int)srcTrackIndex dstTrackIndex:(unsigned int)dstTrackIndex;
 
- (NvsTimelineGraphCompositor *)getFirstTimelineGraphCompositor;
 
- (NvsTimelineGraphCompositor *)getLastTimelineGraphCompositor;
 
- (NvsTimelineGraphCompositor *)getPrevTimelineGraphCompositor:(NvsTimelineGraphCompositor*)graphCompositor;
 
- (NvsTimelineGraphCompositor *)getNextTimelineGraphCompositor:(NvsTimelineGraphCompositor*)graphCompositor;
 
- (NvsTimelineGraphCompositor *)getTimelineGraphCompositorByTimelinePosition:(int64_t)timelinePos;
 
- (NvsTimelineGraphCompositor *)addTimelineGraphCompositor:(int64_t)inPoint duration:(int64_t)duration graphDescStr:(NSString *)graphDescStr;
 
- (NvsTimelineGraphCompositor *)addTimelineGraphCompositor:(int64_t)inPoint duration:(int64_t)duration graphDescStr:(NSString *)graphDescStr buddyTrackIndex:(int)buddyTrackIndex;
 
 
- (NvsTimelineGraphCompositor *)removeTimelineGraphCompositor:(NvsTimelineGraphCompositor*)graphCompositor;
 
- (unsigned int)creationFlags;
 
- (bool)applyThemeTemplate:(NSString *)templateId;
 
- (NSArray<NvsCaptionBoundingVerticesInfo*>*)getCaptionsBoundingVerticesRecursively:(NvsBoundingType)boundingType timelinePosition:(int64_t)timelinePosition;
 
- (NSArray<NvsClipBoundingVerticesInfo*>*)getVideoClipBoundingVerticesRecursively:(int64_t)timelinePosition;
 
@end