NvsStreamingContext.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 <Foundation/Foundation.h>
#import "NvsTimeline.h"
#import "NvsAssetPackageManager.h"
#import "NvsAVFileInfo.h"
#import "NvsVideoFrameRetriever.h"
#import "NvsVideoFrameReceiver.h"
#import "NvsCustomVideoFx.h"
#import "NvsCommonDef.h"
#import "NvsCaptureAnimatedSticker.h"
#import "NvsCaptureCompoundCaption.h"
#import "NvsCaptureCaption.h"
#import "NvsCaptureAudioFx.h"
#import "NvsCaptureSceneInfo.h"
#import <CoreMedia/CMSampleBuffer.h>
 
typedef enum {
    NvsStreamingContextFlag_Support4KEdit                           = 1,        
    NvsStreamingContextFlag_Support8KEdit                           = 1 << 2,   
    NvsStreamingContextFlag_AsyncEngineState                        = 1 << 4,   
    NvsStreamingContextFlag_Support16KEdit                          = 1 << 7,   
    NvsStreamingContextFlag_EnableCaptionContextCacheLimit          = 1 << 10,  
    NvsStreamingContextFlag_DisableCapture                          = 1 << 11,  
    NvsStreamingContextFlag_PlaybackDropFrameMode                   = 1 << 12,  
    NvsStreamingContextFlag_NeedGifMotion                           = 1 << 13,  
    NvsStreamingContextFlag_DisableHardwareAudioReader              = 1 << 14,  
    NvsStreamingContextFlag_InterruptStopForInternalStop            = 1 << 18,  
    NvsStreamingContextFlag_UseFixedDefaultCaptionContextResolution = 1 << 22   
} NvsStreamingContextFlag;
 
typedef enum {
    NvsClearCacheFlag_StreamingEngine = 1,          
    NvsClearCacheFlag_IconEngine = 2,               
    NvsClearCacheFlag_WaveformEngine = 4,           
    NvsClearCacheFlag_AVFileInfo = 8,               
    NvsClearCacheFlag_CaptionFontInfo = 16          
} NvsClearCacheFlag;
 
 
typedef enum {
    NvsCompileVideoResolutionGrade360 = 0,                
    NvsCompileVideoResolutionGrade480,                    
    NvsCompileVideoResolutionGrade720,                    
    NvsCompileVideoResolutionGrade1080,                   
    NvsCompileVideoResolutionGrade2160,                   
    NvsCompileVideoResolutionGradeCustom = 256            
} NvsCompileVideoResolutionGrade;
 
typedef enum {
    NvsCompileBitrateGradeLow = 0,          
    NvsCompileBitrateGradeMedium,           
    NvsCompileBitrateGradeHigh              
} NvsCompileVideoBitrateGrade;
 
typedef enum {
    NvsStreamingEngineCompileFlag_None = 0,          
    NvsStreamingEngineCompileFlag_DisableHardwareEncoder = 1, 
    NvsStreamingEngineCompileFlag_OnlyVideo = 4,     
    NvsStreamingEngineCompileFlag_OnlyAudio = 8,      
    NvsStreamingEngineCompileFlag_BuddyHostVideoFrame = 32,      
    NvsStreamingEngineCompileFlag_TruncateAudioStream = 128,     
    NvsStreamingEngineCompileFlag_DisableAlignVideoSize = 256,   
    NvsStreamingEngineCompileFlag_IgnoreTimelineVideoSize = 2048, 
    NvsStreamingEngineCompileFlag_BuddyOriginHostVideoFrame = 8192,      
    NvsStreamingEngineCompileFlag_VariableFrameRateEnable = 16384,      
    NvsStreamingEngineCompileFlag_DontDownloadBuddyBufferForTimelineEffect = 1 << 15, 
} NvsStreamingEngineCompileFlag;
 
typedef enum {
    NvsStreamingEngineCompilePassthroughFlag_OnlyVideo = 4,         
    NvsStreamingEngineCompilePassthroughFlag_DisableTranscode = 8   
} NvsStreamingEngineCompilePassthroughFlag;
 
typedef enum {
    NvsVideoPreviewSizeModeFullSize = 0,     
    NvsVideoPreviewSizeModeLiveWindowSize    
} NvsVideoPreviewSizeMode;
 
typedef enum {
    NvsVideoCaptureResolutionGradeLow = 0,              
    NvsVideoCaptureResolutionGradeMedium,               
    NvsVideoCaptureResolutionGradeHigh,                 
    NvsVideoCaptureResolutionGradeSupperHigh,           
    NvsVideoCaptureResolutionGradeExtremelyHigh         
} NvsVideoCaptureResolutionGrade;
 
typedef enum {
    NvsStreamingEngineState_Stopped = 0,      
    NvsStreamingEngineState_CapturePreview,   
    NvsStreamingEngineState_CaptureRecording, 
    NvsStreamingEngineState_Playback,         
    NvsStreamingEngineState_Seeking,          
    NvsStreamingEngineState_Compile           
} NvsStreamingEngineState;
 
typedef enum
{
    NvsStreamingEngineCaptureFlag_GrabCapturedVideoFrame = 1,       
    NvsStreamingEngineCaptureFlag_StrictPreviewVideoSize = 8,       
    NvsStreamingEngineCaptureFlag_DontCaptureAudio = 16,            
    NvsStreamingEngineCaptureFlag_CaptureBuddyHostVideoFrame = 32,  
    NvsStreamingEngineCaptureFlag_IgnoreScreenOrientation = 64,     
    NvsStreamingEngineCaptureFlag_AutoVideoStabilization = 128,     
    NvsStreamingEngineCaptureFlag_FaceActionWithParticle = 256,     
    NvsStreamingEngineCaptureFlag_LowPipelineSize = 512,            
    NvsStreamingEngineCaptureFlag_DontAutomaticallyConfiguresApplicationAudioSession NS_ENUM_DEPRECATED_IOS(8_0, 9_0, "NvsStreamingEngineCaptureFlag_DontConfigAudioSession") = 1024, 
    NvsStreamingEngineCaptureFlag_DisableFlipOfFrontCamera = 2048,  
    NvsStreamingEngineCaptureFlag_InputAspectRatioUsed = 4096,         
    NvsStreamingEngineCaptureFlag_EnableTakePicture = 8192,         
    NvsStreamingEngineCaptureFlag_EnableHDR = 1 << 16,         
    NvsStreamingEngineCaptureFlag_DontConfigAudioSession = 1 << 17,    
} NvsStreamingEngineCaptureFlag;
 
typedef enum
{
    BufferImageRotation_0 = 0,
    BufferImageRotation_90 = 1,
    BufferImageRotation_180 = 2,
    BufferImageRotation_270 = 3,
} BufferImageRotation;
 
typedef enum
{
    VideoStabilizationFlag_Off = 0,          
    VideoStabilizationFlag_Auto = 1,         
    VideoStabilizationFlag_Standard = 2,     
    VideoStabilizationFlag_Super = 3,        
} VideoStabilizationFlag;
 
typedef enum
{
    NvsStreamingEngineRecordingFlag_VideoIntraFrameOnly = 2,  
    NvsStreamingEngineRecordingFlag_OnlyRecordVideo = 16,     
    NvsStreamingEngineRecordingFlag_IgnoreVideoRotation = 32,  
    NvsStreamingEngineRecordingFlag_WithoutFxUseStreamingWriter = 256,  
    NvsStreamingEngineRecordingFlag_FlipHorizontally = 512  
} NvsStreamingEngineRecordingFlag;
 
typedef enum
{
    NvsCameraFlashMode_FlashOff = 1,  
    NvsCameraFlashMode_FlashOn = 2,   
    NvsCameraFlashMode_FlashAuto = 4,  
    NvsCameraFlashMode_Torch = 8  
} NvsCameraFlashMode;
 
typedef enum {
    NvsStreamingEngineSeekFlag_ShowCaptionPoster = 2,          
    NvsStreamingEngineSeekFlag_ShowAnimatedStickerPoster = 4,  
    NvsStreamingEngineSeekFlag_BuddyHostVideoFrame = 16,        
    NvsStreamingEngineSeekFlag_NotConnectToLivewindow = 128,        
    NvsStreamingEngineSeekFlag_BuddyOriginHostVideoFrame = 256,          
    NvsStreamingEngineSeekFlag_DontDownloadBuddyBufferForTimelineEffect = 1024, 
    NvsStreamingEngineSeekFlag_AllowFastScrubbing NS_ENUM_DEPRECATED_IOS(8_0, 9_0, "NvsStreamingEngineSeekFlag_AllowFastScrubbing") = 2048, 
} NvsStreamingEngineSeekFlag;
 
typedef enum {
    NvsStreamingEnginePlaybackFlag_LowPipelineSize = 8,                 
    NvsStreamingEnginePlaybackFlag_DisableFixedPrerollTime = 16,        
    NvsStreamingEnginePlaybackFlag_BuddyHostVideoFrame = 32,            
    NvsStreamingEnginePlaybackFlag_AutoCacheAllCafFrames = 128,         
    NvsStreamingEnginePlaybackFlag_SpeedCompMode = 512,           
    NvsStreamingEnginePlaybackFlag_BuddyOriginHostVideoFrame = 2048,    
    NvsStreamingEnginePlaybackFlag_VariableFrameRateEnable = 4096,    
    NvsStreamingEnginePlaybackFlag_DisableDropFrameMode = 16384, 
    NvsStreamingEnginePlaybackFlag_DontDownloadBuddyBufferForTimelineEffect = 1 << 17, 
} NvsStreamingEnginePlaybackFlag;
 
typedef enum {
    NvsStreamingEngineStopFlag_Async = 2    
} NvsStreamingEngineStopFlag;
 
typedef enum {
    NvsHumanDetectionFeature_FaceLandmark = 1,
    NvsHumanDetectionFeature_FaceAction = 2,
    NvsHumanDetectionFeature_AvatarExpression = 4,
    NvsHumanDetectionFeature_VideoMode = 8,
    NvsHumanDetectionFeature_ImageMode = 16,
    NvsHumanDetectionFeature_MultiThread = 32,
    NvsHumanDetectionFeature_SingleThread = 64,
    NvsHumanDetectionFeature_Extra = 128,
    NvsHumanDetectionFeature_Background = 256,
    NvsHumanDetectionFeature_HandLandmark = 512,
    NvsHumanDetectionFeature_HandAction = 1024,
    NvsHumanDetectionFeature_HandBone = 2048,
    NvsHumanDetectionFeature_EyeballLandmark = 4096,
    NvsHumanDetectionFeature_MultiDetect = 8192,
    NvsHumanDetectionFeature_SegmentationSky = 16384,
    NvsHumanDetectionFeature_SemiImageMode = 32768,
    NvsHumanDetectionFeature_HalfBody = 65536,
    NvsHumanDetectionFeature_FaceAttri = 131072,
    NvsHumanDetectionFeature_FaceAttriShape = 262144
} NvsHumanDetectionFeatureFlag;
 
#define HUMAN_DETECTION_OPTIONS_FACE_DETECT_THREAD_NUM            @"Face Detect Thread Num"       
#define HUMAN_DETECTION_OPTIONS_FACE_LANDMARK_THREAD_NUM          @"Face Landmark Thread Num"     
#define HUMAN_DETECTION_OPTIONS_FACE_TRACK_THREAD_NUM             @"Face Track Thread Num"        
#define HUMAN_DETECTION_OPTIONS_SKY_SEGMENTATION_THREAD_NUM       @"Sky Segmentation Thread Num"  
 
 
typedef enum {
    NvsHumanDetectionDataType_FakeFace = 0,
    NvsHumanDetectionDataType_Makeup,   // deprecated
    NvsHumanDetectionDataType_SkinColor,
    NvsHumanDetectionDataType_PE106,
    NvsHumanDetectionDataType_PE240,
    NvsHumanDetectionDataType_CustomAvatar,
    NvsHumanDetectionDataType_Makeup2,  // deprecated, replaced by NvsHumanDetectionDataType_FaceCommon
    NvsHumanDetectionDataType_FaceCommon,
    NvsHumanDetectionDataType_AdvancedBeauty,
} NvsHumanDetectionDataTypeFlag;
 
typedef enum {
    NvsStreamingEngineHarwareErrorType_Video_Encoder_Setup_Error = 0,
    NvsStreamingEngineHarwareErrorType_Video_Encoding_Error,
    NvsStreamingEngineHarwareErrorType_Video_Decoder_Setup_Error,
    NvsStreamingEngineHarwareErrorType_Video_Decoding_Error
} NvsStreamingEngineHarwareErrorType;
 
typedef enum {
    NvsStreamingEngineMediaErrorType_Unknown_Error = -1,
    NvsStreamingEngineMediaErrorType_Video_Encoder_Setup_Error = 0,
    NvsStreamingEngineMediaErrorType_Video_Encoding_Error,
    NvsStreamingEngineMediaErrorType_Video_Decoder_Setup_Error,
    NvsStreamingEngineMediaErrorType_Video_Decoding_Error
} NvsStreamingEngineMediaErrorType;
 
typedef enum {
    NvsStreamingEngineCompileErrorType_No_Error = 0,
    NvsStreamingEngineCompileErrorType_Cancelation = 1,
    NvsStreamingEngineCompileErrorType_Video_Encoder_Setup_Error = 2,
    NvsStreamingEngineCompileErrorType_Video_Encoding_Error = 3,
    NvsStreamingEngineCompileErrorType_Video_Decoding_Error = 4,
    NvsStreamingEngineCompileErrorType_Muxing_Error = 5,
} NvsStreamingEngineCompileErrorType;
 
typedef enum {
    NvsStreamingEngineCaptureDeviceErrorCode_Unknown = 1,
    NvsStreamingEngineCaptureDeviceErrorCode_ServerDied = 2,
    NvsStreamingEngineCaptureDeviceErrorCode_FailToStart = 3,
    NvsStreamingEngineCaptureDeviceErrorCode_FailToConnect = 4
} NvsStreamingEngineCaptureDeviceErrorCode;
 
typedef enum {
    NvsCreateTimelineType_LongestDurationConsiderAllTracks = 1, 
    NvsCreateTimelineType_SyncAudioVideoTransOnVideoTrack = 2,  
    NvsCreateTimelineType_UseMipmap = 4,                        
    NvsCreateTimelineType_VariantImageSize = 8,                 
    NvsCreateTimelineType_DontAddDefaultVideoTransition = 16,   
    NvsCreateTimelineType_Orphan = 128,                         
    NvsCreateTimelineType_OriginalSizeUsedForRawFilter = 2048   
} NvsCreateTimelineTypeFlag;
 
typedef enum {
    NvsHDRCapabilityFlagSupportedByImporter = 1,        
    NvsHDRCapabilityFlagSupportedByEditing = 2,         
    NvsHDRCapabilityFlagSupportedByExporter = 4,        
    NvsHDRCapabilityFlagSupportedByLivewindow = 8,      
    NvsHDRCapabilityFlagSupportedByCamera = 0x10,          
}NvsHDRCapabilityFlag;
 
typedef enum
{
    NvsStreamingEnginePlaybackExceptionType_MediaFileError = 0
}NvsStreamingEnginePlaybackExceptionType;
 
typedef enum{
    NvsDebugLevelNone = 0,
    NvsDebugLevelError,
    NvsDebugLevelWarning,
    NvsDebugLevelDebug,
    NvsDebugLevelVerbose,
    NvsDebugLevelMax
} NvsDebugLevel;
 
#define NVS_RECORD_BITRATE                      @"bitrate"          
#define NVS_RECORD_GOP_SIZE                     @"gopsize"            
#define NVS_RECORD_VIDEO_ENCODEC_NAME           @"video encoder name"              
#define NVS_RECORD_HDR_VIDEO_COLOR_TRANSFER     @"encorder color transfer"         
 
 
#define NVS_COMPILE_BITRATE                          @"bitrate"                        
#define NVS_COMPILE_GOP_SIZE                         @"gopsize"                        
#define NVS_COMPILE_AUDIO_BITRATE                    @"audio bitrate"                  
#define NVS_COMPILE_LOSSLESS_AUDIO                   @"lossless audio"                 
#define NVS_COMPILE_OPTIMIZE_FOR_NETWORK_USE         @"optimize-for-network-use"       
#define NVS_COMPILE_VIDEO_ENCODEC_NAME               @"video encoder name"             
#define NVS_COMPILE_AUDIO_ENCODEC_NAME               @"audio encoder name"             
#define NVS_COMPILE_VIDEO_FPS                        @"fps"                            
#define NVS_COMPILE_DONT_USE_VIDEO_TOOLBOX           @"dont-use-video-toolbox"         
#define NVS_COMPILE_DISABLE_ENCODING_SPEED_PRIORITY  @"disable encoding speed priority"    
#define NVS_COMPILE_HDR_VIDEO_COLOR_TRANSFER         @"encorder color transfer"        
#define NVS_COMPILE_ENABLE_BREAKPOINT_CONTINUATION   @"enable breakpoint continuation" 
#define NVS_COMPILE_CACHE_FILE_PATH                  @"cache file path"                
#define NVS_COMPILE_CACHE_FILE_DURATION              @"cache file duration"            
#define NVS_COMPILE_CACHE_FILE_SIZE                  @"cache file size"                
#define NVS_COMPILE_SOFTWARE_ENCODER_CRF             @"software encorder crf"          
#define NVS_COMPILE_SOFTWARE_ENCODER_CRF_BITRATE_MAX @"software encorder crf bitrate max" 
#define NVS_COMPILE_SOFTWARE_ENCODER_MODE            @"software encorder mode"         
 
#define NVS_COMPILE_CREATION_TIME                    @"creation time" 
#define NVS_COMPILE_METADATADESCRIPTION              @"metadata description"         
#define NVS_COMPILE_AUDIO_SAMPLE_RATE                @"audio sample rate"          
#define NVS_COMPILE_AUDIO_CHANNELS_MODE              @"audio channels mode"          
#define NVS_COMPILE_FILE_META_DATA                   @"file metadata"          
#define NVS_COMPILE_GIF_STATS_MODE                   @"gif stats mode"          
 
 
typedef enum {
    NvsAVFileinfoExtra_None = 0,          
    NvsAVFileinfoExtra_AVPixelFormat      
} NvsAVFileinfoExtraFlag;
 
typedef enum {
    NvsCameraDeviceType_None,                     
    NvsCameraDeviceType_WideAngle,                
    NvsCameraDeviceType_Telephoto,                
    NvsCameraDeviceType_TrueDepth,                
    NvsCameraDeviceType_WideAngleAndTelephoto,    
    NvsCameraDeviceType_UltraWideCamera,          
    NvsCameraDeviceType_SpecailDevice             
} NvsCameraDeviceType;
 
@class NvsCaptureDeviceCapability;
@class NvsCaptureVideoFx;
@class NvsFxDescription;
@class NvsMediaError;
 
@protocol NvsStreamingContextDelegate <NSObject>
@optional
 
 
- (void)didCaptureDeviceCapsReady:(unsigned int)captureDeviceIndex;
 
- (void)didCaptureDevicePreviewResolutionReady:(unsigned int)captureDeviceIndex;
 
- (void)didCaptureDevicePreviewStarted:(unsigned int)captureDeviceIndex;
 
- (void)didCaptureDeviceError:(unsigned int)captureDeviceIndex errorCode:(int32_t)errorCode;
 
- (void)didCaptureDeviceStopped:(unsigned int)captureDeviceIndex;
 
- (void)didCaptureDeviceAutoFocusComplete:(unsigned int)captureDeviceIndex succeeded:(BOOL)succeeded;
 
- (void)didCaptureRecordingStarted:(unsigned int)captureDeviceIndex;
 
- (void)didCaptureRecordingFirstVideoFrameReached:(unsigned int)captureDeviceIndex timeStamp:(int64_t)timestamp;
 
- (void)didCaptureRecordingDurationUpdated:(int)captureDeviceIndex duration:(int64_t)duration;
 
- (void)didCaptureRecordingFinished:(unsigned int)captureDeviceIndex;
 
- (void)didCaptureRecordingError:(unsigned int)captureDeviceIndex;
 
- (void)didPlaybackPreloadingCompletion:(NvsTimeline *)timeline;
 
- (void)didPlaybackTimelinePosition:(NvsTimeline *)timeline position:(int64_t)position;
 
- (void)didPlaybackDelayed:(NvsTimeline *)timeline delayTime:(int64_t)time isVideo:(bool)flag;
 
- (void)didPlaybackStopped:(NvsTimeline *)timeline;
 
- (void)didPlaybackEOF:(NvsTimeline *)timeline;
 
- (void)didCompileProgress:(NvsTimeline *)timeline progress:(int)progress;
 
- (void)didCompileFloatProgress:(NvsTimeline *)timeline progress:(float)progress;
 
- (void)didCompileFinished:(NvsTimeline *)timeline;
 
- (void)didCompileCompleted:(NvsTimeline *)timeline isCanceled:(BOOL)isCanceled;
 
- (void)didCompileCompleted:(NvsTimeline *)timeline isHardwareEncoding:(BOOL)isHardwareEncoding errorType:(int)errorType errorString:(NSString*)errorString flags:(int)flags;
 
- (void)didCompileFailed:(NvsTimeline *)timeline;
 
- (void)didCompileSliceCompleted:(NvsTimeline *)timeline filePath:(NSString*)filePath isVideo:(BOOL)isVideo index:(int)index;
 
- (void)didStreamingEngineStateChanged:(NvsStreamingEngineState)state;
 
- (void)didFirstVideoFramePresented:(NvsTimeline *)timeline;
 
- (void)didTimestampOutOfRange:(NvsTimeline *)timeline;
 
- (void)didSeekingTimelinePosition:(NvsTimeline *)timeline position:(int64_t)position;
 
- (void)captureVideoFrameGrabbedArrived:(NvsVideoFrameInfo*)sampleBufferInfo;
 
- (void)onAudioSampleArrived:(NvsAudioSampleBuffers*)audioSample;
 
- (void)capturePreviewAudioSampleArrived:(NvsAudioSampleBuffers*)audioSample;
 
- (void)capturePictureArrived:(NvsVideoFrameInfo*)sampleBufferInfo;
 
- (void)onPlaybackException:(NvsTimeline *)timeline exceptionType:(NvsStreamingEnginePlaybackExceptionType)exceptionType exceptionString:(NSString *)exceptionString;
 
- (void)onHardwareError:(NvsStreamingEngineHarwareErrorType)errorType stringInfo:(NSString*)stringInfo;
- (void)onMediaError:(NvsMediaError*)error;
- (void)didVUMeterValue:(NvsTimeline *)timeline leftValue:(float)left rightValue:(float)right timestamp:(int64_t)time;
 
- (void)onAudioSampleArrived:(NvsTimeline *)timeline audioSample:(NvsAudioSampleBuffers*)audioSample;
 
@end
 
@protocol NvsImageGrabberDelegate <NSObject>
@optional
 
- (void)onImageGrabbedArrived:(UIImage*)image timestamp:(int64_t)time;
 
- (void)onImageGrabbedArrived:(NvsTimeline *)timeline image:(UIImage*)image timestamp:(int64_t)time;
 
@end
 
@protocol NvsStreamingContextDebugLogDelegate <NSObject>
@optional
 
- (void)onDebugLogArrived:(int)level logStr:(NSString*)logStr;
@end
 
@protocol NvsStreamingContextWebDelegate <NSObject>
@optional
- (void)onWebRequestWaitStatusChange:(BOOL)isVideo waiting:(BOOL)waiting;
 
@end
 
NVS_EXPORT @interface NvsTemplateFootageInfo : NSObject
 
@property(nonatomic, strong) NSString *footageId;
@property(nonatomic, strong) NSString *filePath;
@property(nonatomic, strong) NSString *reverseFilePath;
 
@end
 
NVS_EXPORT @interface NvsStreamingContext : NSObject
 
@property (nonatomic, weak) id<NvsStreamingContextDelegate> delegate;
@property (nonatomic, weak) id<NvsStreamingContextWebDelegate> webDelegate;
@property (readonly) NvsAssetPackageManager *assetPackageManager;       
@property (nonatomic) float compileVideoBitrateMultiplier;              
@property (nonatomic) float recordVideoBitrateMultiplier;               
@property (nonatomic) BOOL defaultCaptionFade;                          
@property (nonatomic, weak) id<NvsImageGrabberDelegate> imageGrabberDelegate;
 
@property (nonatomic) NSMutableDictionary *compileConfigurations;
 
+ (void)getSdkVersion:(int *)majorVersion minorVersion:(int *)minorVersion revisionNumber:(int *)revisionNumber;
 
+ (void)setDebugLevel:(NvsDebugLevel)debugLevel;
 
+ (void)setSaveDebugMessagesToFile:(BOOL)saveDebugMessagesToFile;
 
+ (void)setDebugMessagesToStdOut:(BOOL)debugMessagesToStdOut;
 
+ (void)setDebugLogDelegate:(id<NvsStreamingContextDebugLogDelegate>)debugLogDelegate;
+ (BOOL)verifySdkLicenseFile:(NSString *)sdkLicenseFilePath;
 
+ (NvsStreamingContext *)sharedInstance;
 
+ (NvsStreamingContext *)sharedInstanceWithFlags:(NvsStreamingContextFlag)flags;
 
+ (void)destroyInstance;
 
+ (int)hasARModule;
 
+ (BOOL)initHumanDetection:(NSString *)modelFilePath
           licenseFilePath:(NSString *)licenseFilePath
                  features:(int)features;
 
+ (BOOL)initHumanDetection:(NSString *)modelFilePath
           licenseFilePath:(NSString *)licenseFilePath
                  features:(int)features
                   options:(NSMutableDictionary *)options;
 
+ (BOOL)initHumanDetectionExt:(NSString *)modelFilePath
              licenseFilePath:(NSString *)licenseFilePath
                     features:(int)features;
 
+ (BOOL)initHumanDetectionExt:(NSString *)modelFilePath
              licenseFilePath:(NSString *)licenseFilePath
                     features:(int)features
                      options:(NSMutableDictionary *)options;
 
+ (BOOL)setupHumanDetectionData:(int)dataType
           dataFilePath:(NSString *)dataFilePath;
 
+ (void)closeHumanDetection;
 
- (BOOL)preloadEffectResources;
 
+ (NSString *)getLogFileDirectory;
 
- (EAGLSharegroup *)getEAGLSharegroup;
 
- (float)detectEngineRenderFramePerSecond;
 
- (NvsAVFileInfo *)getAVFileInfo:(NSString *)avFilePath;
 
- (NvsAVFileInfo *)getAVFileInfoExtra:(NSString *)avFilePath extraFlag:(int) extraFlag;
 
 
- (NvsAVFileInfo *)getAVFileInfo:(NSString *)avFilePath extraFlag:(int) extraFlag withError:(NSMutableString*)errString;
 
 
- (int)detectVideoFileKeyframeInterval:(NSString *)videoFilePath;
 
- (BOOL)setDefaultThemeEndingLogoImageFilePath:(NSString *)logoImageFilePath;
 
- (NSString *)getDefaultThemeEndingLogoImageFilePath;
 
- (BOOL)setThemeEndingEnabled:(BOOL)enable;
 
- (int)getEngineHDRCaps;
 
- (void)setAudioVUMeterEnabled:(BOOL)enable;
 
- (void)setEnableAudioSampleNotify:(BOOL)enable;
 
- (NSString*)registerFontByFilePath:(NSString *)fontFilePath;
 
- (NSArray*)getFontInfoByFilePath:(NSString *)fontFilePath;
 
- (void)setColorGainForSDRToHDR:(float)gain;
 
- (float)getColorGainForSDRToHDR;
 
- (BOOL)exportTemplateInfo:(NSString *)templateUuid timeline:(NvsTimeline *)timeline requestedAspectRatio:(int)requestedAspectRatio;
 
- (BOOL)generateTemplatePackage:(NSString *)templateUuid innerAssetDir:(NSString *)innerAssetDir templateOutputDir:(NSString *)templateOutputDir;
 
- (void)setTemplate:(NSString *)templateUuid customResourceDir:(NSString *)customResourceDir;
 
- (BOOL)exportProjectInfo:(NSString *)projectUuid timeline:(NvsTimeline *)timeline requestedAspectRatio:(int)requestedAspectRatio;
 
- (BOOL)generateProjectPackage:(NSString *)projectUuid innerAssetDir:(NSString *)innerAssetDir projectOutputDir:(NSString *)projectOutputDir;
 
- (NvsTimeline *)createTimeline:(NvsVideoResolution *)videoEditRes videoFps:(NvsRational *)videoFps audioEditRes:(NvsAudioResolution *)audioEditRes;
 
- (NvsTimeline *)createTimeline:(NvsVideoResolution *)videoEditRes videoFps:(NvsRational *)videoFps audioEditRes:(NvsAudioResolution *)audioEditRes flags:(int)flags;
 
- (NvsTimeline *)createTimeline:(NvsVideoResolution *)videoEditRes videoFps:(NvsRational *)videoFps audioEditRes:(NvsAudioResolution *)audioEditRes bitDepth:(NvsVideoResolutionBitDepth)depth flags:(int)flags;
 
- (NvsTimeline *)createTimelineEx:(NvsVideoResolution *)videoEditRes videoFps:(NvsRational *)videoFps audioEditRes:(NvsAudioResolution *)audioEditRes flags:(int)flags;
 
- (NvsTimeline *)createTimeline:(NSString *)templateId templateFootages:(NSArray <NvsTemplateFootageInfo*>*)templateFootages;
 
- (NvsTimeline *)createTimeline:(NSString *)templateId templateFootages:(NSArray <NvsTemplateFootageInfo*>*)templateFootages flags:(int)flags;
 
 
- (NvsTimeline *)createTimeline:(NSString *)templateId templateFootages:(NSArray <NvsTemplateFootageInfo*>*)templateFootages flags:(int)flags videoFps:(NvsRational *)videoFps audioEditRes:(NvsAudioResolution *)audioEditRes;
 
- (NvsTimeline *)loadProject:(NSString *)projectId resourceDir:(NSString*)resourceDir;
 
- (BOOL)removeTimeline:(NvsTimeline *)timeline;
 
- (NvsStreamingEngineState)getStreamingEngineState;
 
- (int64_t)getTimelineCurrentPosition:(NvsTimeline *)timeline;
 
- (BOOL)compileTimeline:(NvsTimeline *)timeline startTime:(int64_t)startTime endTime:(int64_t)endTime outputFilePath:(NSString *)outputFilePath videoResolutionGrade:(NvsCompileVideoResolutionGrade)videoResolutionGrade videoBitrateGrade:(NvsCompileVideoBitrateGrade)videoBitrateGrade flags:(int)flags;
 
- (BOOL)compileTimeline:(NvsTimeline *)timeline startTime:(int64_t)startTime endTime:(int64_t)endTime outputFilePath:(NSString *)outputFilePath videoResolutionGrade:(NvsCompileVideoResolutionGrade)videoResolutionGrade videoBitrateGrade:(NvsCompileVideoBitrateGrade)videoBitrateGrade compileConfigurations:(NSMutableDictionary *)compileConfigurations flags:(int)flags;
 
- (BOOL)compilePassthroughTimeline:(NvsTimeline *)timeline
                    outputFilePath:(NSString *)outputFilePath
             compileConfigurations:(NSMutableDictionary *)configurations flags:(int)flags;
 
- (BOOL)pauseCompiling;
 
- (BOOL)resumeCompiling;
 
- (BOOL)isCompilingPaused;
 
- (BOOL)pausePlayback;
 
- (BOOL)resumePlayback;
 
- (BOOL)isPlaybackPaused;
 
- (void)setCustomCompileVideoHeight:(unsigned int)videoHeight;
 
- (unsigned int)getCustomCompileVideoHeight;
 
- (BOOL)connectTimeline:(NvsTimeline *)timeline withLiveWindow:(NvsLiveWindow *)liveWindow;
 
- (BOOL)connectTimeline:(NvsTimeline *)timeline withVideoFrameReceiver:(NvsVideoFrameReceiver *)receiver;
 
- (void)setTimeline:(NvsTimeline *)timeline scaleForSeek:(double)secondsPerPixel API_DEPRECATED("",macos(10.3, 10.11), ios(7.0, 8.0));
 
- (BOOL)seekTimeline:(NvsTimeline *)timeline timestamp:(int64_t)timestamp videoSizeMode:(NvsVideoPreviewSizeMode)videoSizeMode flags:(int)flags;
 
- (BOOL)seekTimeline:(NvsTimeline *)timeline timestamp:(int64_t)timestamp proxyScale:(const NvsRational *)proxyScale flags:(int)flags;
 
- (UIImage *)grabImageFromTimeline:(NvsTimeline *)timeline
                         timestamp:(int64_t)timestamp
                        proxyScale:(const NvsRational *)proxyScale;
 
 
- (UIImage *)grabImageFromTimeline:(NvsTimeline *)timeline timestamp:(int64_t)timestamp proxyScale:(const NvsRational *)proxyScale flags:(int)flags;
 
- (BOOL)grabImageFromTimelineAsync:(NvsTimeline *)timeline
                              timestamp:(int64_t)timestamp
                             proxyScale:(const NvsRational *)proxyScale
                                  flags:(int)flags;
 
- (BOOL)playbackTimeline:(NvsTimeline *)timeline startTime:(int64_t)startTime endTime:(int64_t)endTime videoSizeMode:(NvsVideoPreviewSizeMode)videoSizeMode preload:(BOOL)preload flags:(int)flags;
 
- (BOOL)playbackTimeline:(NvsTimeline *)timeline startTime:(int64_t)startTime endTime:(int64_t)endTime proxyScale:(const NvsRational *)proxyScale preload:(BOOL)preload flags:(int)flags;
 
- (void)stop;
 
- (void)stop:(int)flags;
 
- (void)clearCachedResources:(BOOL)asynchronous;
 
- (void)clearCachedResources:(BOOL)asynchronous flags:(int)flags;
 
- (unsigned int)captureDeviceCount;
 
- (NvsCameraDeviceType)getCaptureDeviceType:(unsigned int)captureIndex;
 
- (BOOL)isCaptureDeviceBackFacing:(unsigned int)catpureDeviceIndex;
 
- (NvsCaptureDeviceCapability *)getCaptureDeviceCapability:(unsigned int)catpureDeviceIndex;
 
- (BOOL)connectCapturePreviewWithLiveWindow:(NvsLiveWindow *)liveWindow;
 
- (BOOL)connectCapturePreviewWithVideoFrameReceiver:(NvsVideoFrameReceiver *)receiver;
 
-(void)setUserWatermarkForCapture:(NSString *)watermarkFilePath
                     displayWidth:(int)displayWidth
                    displayHeight:(int)displayHeight
                          opacity:(float)opacity
                         position:(NvsTimelineWatermarkPosition)position
                          marginX:(int)marginX
                          marginY:(int)marginY;
 
-(void)removeUserWatermarkForCapture;
 
- (BOOL)startCapturePreview:(unsigned int)captureDeviceIndex
              videoResGrade:(NvsVideoCaptureResolutionGrade)videoResGrade
                      flags:(int)flags
                aspectRatio:(const NvsRational *)aspectRatio;
 
- (BOOL)startBufferCapturePreview:(unsigned int)width
                                                height:(unsigned int)height
  fps:(const NvsRational *)fps
  rotation:(int)rotation
  flipHorizontally:(BOOL)flipHorizontally;
 
- (BOOL)sendBufferToCapturePreview:(const NvsVideoFrameInfo *)data;
 
- (BOOL)sendAudioSamplesToCapturePreview:(CMSampleBufferRef)data;
 
- (BOOL)startCapturePreviewForLiveStreaming:(unsigned int)captureDeviceIndex
                              videoResGrade:(NvsVideoCaptureResolutionGrade)videoResGrade
                                      flags:(int)flags
                                aspectRatio:(const NvsRational *)aspectRatio
                      liveStreamingEndPoint:(NSString *)liveStreamingEndPoint;
- (NvsSize)getCapturePreviewVideoSize:(unsigned int)catpureDeviceIndex;
 
- (NvsColor)sampleColorFromCapturedVideoFrame:(CGRect)sampleRect;
 
- (void)startAutoFocus:(CGPoint)focusPointOfInterest;
 
- (void)cancelAutoFocus;
 
- (void)startContinuousFocus;
 
- (void)startAutoExposure:(CGPoint)pointOfInterest;
 
- (void)setZoomFactor:(float)zoomFactor;
 
- (float)getZoomFactor;
 
- (void)toggleFlash:(BOOL)on;
 
- (BOOL)isFlashOn;
 
- (void)toggleFlashMode:(NvsCameraFlashMode)mode;
 
- (NvsCameraFlashMode)getFlashMode;
 
- (VideoStabilizationFlag)getVideoStabilization;
 
- (void)setVideoStabilization:(VideoStabilizationFlag)flags;
 
- (void)setExposureBias:(float)exposureBias;
 
- (float)getExposureBias;
 
- (NvsCaptureVideoFx *)appendBuiltinCaptureVideoFx:(NSString *)videoFxName;
 
- (NvsCaptureVideoFx *)insertBuiltinCaptureVideoFx:(NSString *)videoFxName withInsertPosition:(unsigned int)insertPosition;
 
- (NvsCaptureVideoFx *)appendPackagedCaptureVideoFx:(NSString *)videoFxPackageId;
 
- (NvsCaptureVideoFx *)insertPackagedCaptureVideoFx:(NSString *)videoFxPackageId withInsertPosition:(unsigned int)insertPosition;
 
- (NvsCaptureVideoFx *)appendCustomCaptureVideoFx:(id<NvsCustomVideoFxRenderer>)customVideoFxRender;
 
- (NvsCaptureVideoFx *)insertCustomCaptureVideoFx:(id<NvsCustomVideoFxRenderer>)customVideoFxRender withInsertPosition:(int)insertPosition;
 
- (NvsCaptureVideoFx *)appendBeautyCaptureVideoFx;
 
- (NvsCaptureVideoFx *)insertBeautyCaptureVideoFx:(unsigned int)insertPosition;
 
- (BOOL)removeCaptureVideoFx:(unsigned int)captureVideoFxIndex;
 
- (void)removeAllCaptureVideoFx;
 
- (unsigned int)getCaptureVideoFxCount;
 
- (NvsCaptureVideoFx *)getCaptureVideoFxByIndex:(unsigned int)captureVideoFxIndex;
 
- (NvsCaptureAudioFx *)appendBuiltinCaptureAudioFx:(NSString *)audioFxName;
 
- (NvsCaptureAudioFx *)insertBuiltinCaptureAudioFx:(NSString *)audioFxName withInsertPosition:(unsigned int)insertPosition;
 
- (BOOL)removeCaptureAudioFx:(unsigned int)captureAudioFxIndex;
 
- (void)removeAllCaptureAudioFx;
 
- (unsigned int)getCaptureAudioFxCount;
 
- (NvsCaptureAudioFx *)getCaptureAudioFxByIndex:(unsigned int)captureAudioFxIndex;
 
- (NvsCaptureAnimatedSticker *)appendCaptureAnimatedSticker:(int64_t)offsetTime duration:(int64_t)duration animatedStickerPackageId:(NSString *)animatedStickerPackageId;
 
- (NvsCaptureAnimatedSticker *)insertCaptureAnimatedSticker:(int64_t)offsetTime duration:(int64_t)duration animatedStickerPackageId:(NSString *)animatedStickerPackageId insertPosition:(unsigned int)insertPosition;
 
- (NvsCaptureAnimatedSticker *)addCustomCaptureAnimatedSticker:(int64_t)inPoint duration:(int64_t)duration animatedStickerPackageId:(NSString *)animatedStickerPackageId customImagePath:(NSString *)customImagePath;
 
- (NvsCaptureAnimatedSticker *)insertCustomCaptureAnimatedSticker:(int64_t)offsetTime duration:(int64_t)duration animatedStickerPackageId:(NSString *)animatedStickerPackageId customImagePath:(NSString *)customImagePath insertPosition:(unsigned int)insertPosition;
 
- (BOOL)removeCaptureAnimatedSticker:(unsigned int)captureAnimagedStickerIndex;
 
- (void)removeAllCaptureAnimatedSticker;
 
- (unsigned int)getCaptureAnimatedStickerCount;
 
- (NvsCaptureAnimatedSticker *)getCaptureAnimatedStickerByIndex:(unsigned int)captureStikcerIndex;
 
- (NvsCaptureCompoundCaption *)appendCaptureCompoundCaption:(int64_t)offsetTime duration:(int64_t)duration compoundCaptionPackageId:(NSString *)compoundCaptionPackageId;
 
- (NvsCaptureCompoundCaption *)insertCaptureCompoundCaption:(int64_t)offsetTime duration:(int64_t)duration compoundCaptionPackageId:(NSString *)compoundCaptionPackageId insertPosition:(unsigned int)insertPosition;
 
-(BOOL)removeCaptureCompoundCaption:(unsigned int)captureCompoundCaptionIndex;
 
- (void)removeAllCaptureCompoundCaption;
 
- (unsigned int)getCaptureCompoundCaptionCount;
 
- (NvsCaptureCompoundCaption *)getCaptureCompoundCaptionByIndex:(unsigned int)captureCaptionIndex;
 
- (NvsCaptureCaption *)appendCaptureCaption:(NSString *)captionText offsetTime:(int64_t)offsetTime duration:(int64_t)duration captionStylePackageId:(NSString *)captionStylePackageId;
 
- (NvsCaptureCaption *)insertCaptureCaption:(NSString *)captionText offsetTime:(int64_t)offsetTime duration:(int64_t)duration captionStylePackageId:(NSString *)captionStylePackageId insertPosition:(unsigned int)insertPosition;
 
- (NvsCaptureCaption *)appendCaptureModularCaption:(NSString *)captionText offsetTime:(int64_t)offsetTime duration:(int64_t)duration;
 
- (NvsCaptureCaption *)insertCaptureModularCaption:(NSString *)captionText offsetTime:(int64_t)offsetTime duration:(int64_t)duration insertPosition:(unsigned int)insertPosition;
 
- (BOOL)removeCaptureCaption:(unsigned int)captureCaptionIndex;
 
- (void)removeAllCaptureCaption;
 
- (unsigned int)getCaptureCaptionCount;
 
- (NvsCaptureCaption *)getCaptureCaptionByIndex:(unsigned int)captureCaptionIndex;
 
- (BOOL)applyCaptureScene:(NSString *)captureSceneId;
 
- (BOOL)applyCaptureScene:(NSString *)captureSceneId captureSceneInfo:(NvsCaptureSceneInfo*)info;
 
- (NSString *)getCurrentCaptureSceneId;
 
- (void)removeCurrentCaptureScene;
 
- (BOOL)startRecording:(NSString *)outputFilePath;
 
- (BOOL)startRecording:(NSString *)outputFilePath withFlags:(int)flags;
 
- (BOOL)startRecording:(NSString *)outputFilePath withFlags:(int)flags withRecordConfigurations:(NSMutableDictionary *)withRecordConfigurations;
 
- (BOOL)startRecordingWithFx:(NSString *)outputFilePath;
 
- (BOOL)startRecordingWithFx:(NSString *)outputFilePath withFlags:(int)flags;
 
- (BOOL)startRecordingWithFx:(NSString *)outputFilePath withFlags:(int)flags withRecordConfigurations:(NSMutableDictionary *)withRecordConfigurations;
 
- (void)setAudioSampleInfoForCallback:(NvsCapturedAudioSampleInfo*)info;
 
- (void)stopRecording;
 
- (BOOL)pauseRecording;
 
- (BOOL)resumeRecording;
 
- (BOOL)isRecordingPaused;
 
- (BOOL)takePicture:(int)flags;
 
- (NSArray *)getAllBuiltinVideoFxNames;
 
- (NSArray *)getAllBuiltinAudioFxNames;
 
- (NSArray *)getAllBuiltinVideoTransitionNames;
 
- (NSArray *)getAllBuiltinCaptureVideoFxNames;
 
- (NSString *)getBeautyVideoFxName;
 
- (NSString *)getDefaultVideoTransitionName;
 
- (void)setDefaultAudioTransitionName:(NSString *)name;
 
- (NvsFxDescription *)getVideoFxDescription:(NSString *)fxName;
 
- (NvsFxDescription *)getAudioFxDescription:(NSString *)fxName;
 
- (NvsVideoFrameRetriever *)createVideoFrameRetriever:(NSString *)videoFilePath;
 
- (NvsStreamingContext *)createAuxiliaryStreamingContext:(int)flags;
 
- (void)destoryAuxiliaryStreamingContext:(NvsStreamingContext*)auxContext;
 
- (void)setAudioOutputDeviceVolume:(float)volume;
 
+ (BOOL)functionalityAuthorised:(NSString *)sdkFunctionName;
 
+ (void)setSpecialCameraDeviceType:(NSString*)specialCameraType;
 
+ (void)setEnableFindExtraDeviceType:(BOOL)enable;
 
+ (void)setMaxCafCacheMemorySize:(int)maxMemorySize;
 
- (void)setCaptureFps:(int)fps;
 
- (void)setImageReaderCount:(int)count API_DEPRECATED("Use +setMaxImageReaderCount:", macos(10.3, 10.11), ios(7.0, 8.0));
 
- (void)setDefaultImageClipDuration:(int64_t)defaultImageClipDuration;
 
+ (void)setMaxImageReaderCount:(int)count;
 
+ (void)setFxPluginBundlePathList:(NSArray *)list;
 
+ (void)setMaxAudioReaderCount:(int)count;
 
+ (void)setMaxReaderCount:(int)count;
+ (void)setMaxVideoDecodeErrorCount:(int)count;
+ (void)setMaxSoftReaderCount:(int)count;
 
+ (void)setMaxIconReaderCount:(int)count;
 
+ (void)setStreamingPoolSizeInByte:(int)maxMemorySize;
 
+ (void)setWebAssetSliceSize:(int)sliceSize;
 
+ (void)setMaxEditCaptionCachedContextCount:(int)count;
 
+ (void)setMaxCompileCaptionCachedContextCount:(int)count;
 
- (long)calcDurationAfterCurvesVariableSpeed:(NSString*)curvesString;
 
- (BOOL)isBlackFrame:(UIImage *)image;
 
- (BOOL)getAECEnabled;
 
- (void)setAECEnabled:(BOOL)enable;
 
@end
 
NVS_EXPORT @interface NvsCaptureDeviceCapability : NSObject
 
@property (readonly) BOOL supportAutoFocus;                     
@property (readonly) BOOL supportContinuousFocus;               
@property (readonly) BOOL supportAutoExposure;                  
@property (readonly) BOOL supportZoom;                          
@property (readonly) float maxZoomFactor;                       
@property (readonly) BOOL supportFlash;                         
@property (readonly) BOOL supportVideoStabilization;            
@property (readonly) BOOL supportExposureBias;                  
@property (readonly) float minExposureBias;                     
@property (readonly) float maxExposureBias;                     
 
@end
 
NVS_EXPORT @interface NvsMediaError : NSObject
 
@property(atomic) NvsStreamingEngineMediaErrorType errorType;            
@property(atomic) BOOL isHardwareError;                                  
@property(atomic) NSString* errorInfo;                                   
 
@end