NvsStreamingContext.h File Reference

#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>

Go to the source code of this file.

Classes
protocol	<NvsStreamingContextDelegate>
protocol	<NvsImageGrabberDelegate>
class	NvsTemplateFootageInfo
	information of template footage More...
class	NvsStreamingContext
	Streaming context. More...
class	NvsCaptureDeviceCapability
	Description of capture device capability. More...

Macros
Configuration of recording video
#define	NVS_RECORD_BITRATE   @"bitrate"
	Record bitrate，type: int, such as 3000000 for 3M biterate. More...
#define	NVS_RECORD_GOP_SIZE   @"gopsize"
	Record GOP size, type: int, default is 30. More...
#define	NVS_RECORD_VIDEO_ENCODEC_NAME   @"video encoder name"
	Assigned video encoding format, hevc(h.256) is supported, default is h.264. More...
#define	NVS_RECORD_HDR_VIDEO_COLOR_TRANSFER   @"encorder color transfer"
Configuration of Compilation Timeline
#define	NVS_COMPILE_BITRATE   @"bitrate"
	Compile bitrate，type: int, such as 3000000 for 3M biterate. More...
#define	NVS_COMPILE_GOP_SIZE   @"gopsize"
	Compile GOP size, type: int, default is 30. More...
#define	NVS_COMPILE_AUDIO_BITRATE   @"audio bitrate"
	Compile audio bitrate, type: int, such as 128000 for 128k bitrate. More...
#define	NVS_COMPILE_LOSSLESS_AUDIO   @"lossless audio"
	Whether to compile lossless audio, type: boolean. More...
#define	NVS_COMPILE_OPTIMIZE_FOR_NETWORK_USE   @"optimize-for-network-use"
	Whether to prepose the index table, type: boolean. More...
#define	NVS_COMPILE_VIDEO_ENCODEC_NAME   @"video encoder name"
	Assigned video encoding format, hevc(h.256) is supported, default is h.264. More...
#define	NVS_COMPILE_AUDIO_ENCODEC_NAME   @"audio encoder name"
	Assigned audio encoding format, "amr-wb" and "mp3" are supported, default is "aac". More...
#define	NVS_COMPILE_VIDEO_FPS   @"fps"
	frames per second when compiling, type: NSData, such as NvsRational videoFps = {30, 1},[NSData dataWithBytes:&videoFps length:sizeof(NvsRational)] forKey:NVS_COMPILE_VIDEO_FPS] More...
#define	NVS_COMPILE_DONT_USE_VIDEO_TOOLBOX   @"dont-use-video-toolbox"
	Whether to use video toolbox, type: boolean. More...
#define	NVS_COMPILE_HDR_VIDEO_COLOR_TRANSFER   @"encorder color transfer"
	Set color transfer for HDR to encode, curve: string, default is "none", can support "st2084" and "hlg",. More...
#define	NVS_COMPILE_ENABLE_BREAKPOINT_CONTINUATION   @"enable breakpoint continuation"
	Set whether enable breakpoint continuation. More...
#define	NVS_COMPILE_CACHE_FILE_PATH   @"cache file path"
	Breakpoint continuation cache file path. More...
#define	NVS_COMPILE_CACHE_FILE_DURATION   @"cache file duration"
	Breakpoint continuation cache file duration. More...
#define	NVS_COMPILE_SOFTWARE_ENCODER_CRF   @"software encorder crf"
	Preset crf parameters for software encoder, type: int, range is [1, 99], less is better，default is 23. More...
#define	NVS_COMPILE_SOFTWARE_ENCODER_CRF_BITRATE_MAX   @"software encorder crf bitrate max"
	Preset maximum bitrate for software encoder in crf mode, type: int. More...
#define	NVS_COMPILE_SOFTWARE_ENCODER_MODE   @"software encorder mode"
	Software encoder mode, type: string, support “abr”、“crf”，default is crf. More...
#define	NVS_COMPILE_CREATION_TIME   @"creation time"
	Set creation time for this file. Foramt:"YYYY-MM-DDTHH:MM:SS",eg:2010-12-24T12:00:00(use location time) More...
#define	NVS_COMPILE_METADATADESCRIPTION   @"metadata description"
	Corresponding AVMetadataCommonKeyDescription, sets the metadata description of the video files. More...
#define	NVS_COMPILE_AUDIO_SAMPLE_RATE   @"audio sample rate"
	Set the audio sampling rate, currently supporting a minimum of 16K and a maximum of 128K. More...
#define	NVS_COMPILE_AUDIO_CHANNELS_MODE   @"audio channels mode"
	Set up audio channels, currently supporting "mixtomono", with default and timeline settings consistent. More...
#define	NVS_COMPILE_FILE_META_DATA   @"file metadata"
	Set meta data, for example:"creation-time=xxxxx;location=17.641347+160.931648;". More...
#define	NVS_COMPILE_GIF_STATS_MODE   @"gif stats mode"

Enumerations
enum	NvsStreamingContextFlag {   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 }
	Streaming context creation flag. More...
enum	NvsClearCacheFlag {   NvsClearCacheFlag_StreamingEngine = 1, NvsClearCacheFlag_IconEngine = 2, NvsClearCacheFlag_WaveformEngine = 4, NvsClearCacheFlag_AVFileInfo = 8,   NvsClearCacheFlag_CaptionFontInfo = 16 }
	Clear cache flags. More...
enum	NvsCompileVideoResolutionGrade {   NvsCompileVideoResolutionGrade360 = 0, NvsCompileVideoResolutionGrade480, NvsCompileVideoResolutionGrade720, NvsCompileVideoResolutionGrade1080,   NvsCompileVideoResolutionGrade2160, NvsCompileVideoResolutionGradeCustom = 256 }
	Resolution level for compiling video (define video resolution at time of createTimeline. Automatically defining rendering video width in according to output video height). More...
enum	NvsCompileVideoBitrateGrade { NvsCompileBitrateGradeLow = 0, NvsCompileBitrateGradeMedium, NvsCompileBitrateGradeHigh }
	The bitrate level of compiling the video file. More...
enum	NvsStreamingEngineCompileFlag {   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 }
	Flag of compiling video. More...
enum	NvsVideoPreviewSizeMode { NvsVideoPreviewSizeModeFullSize = 0, NvsVideoPreviewSizeModeLiveWindowSize }
	Mode of preview video. More...
enum	NvsVideoCaptureResolutionGrade {   NvsVideoCaptureResolutionGradeLow = 0, NvsVideoCaptureResolutionGradeMedium, NvsVideoCaptureResolutionGradeHigh, NvsVideoCaptureResolutionGradeSupperHigh,   NvsVideoCaptureResolutionGradeExtremelyHigh }
	Resolution level for capturing video. More...
enum	NvsStreamingEngineState {   NvsStreamingEngineState_Stopped = 0, NvsStreamingEngineState_CapturePreview, NvsStreamingEngineState_CaptureRecording, NvsStreamingEngineState_Playback,   NvsStreamingEngineState_Seeking, NvsStreamingEngineState_Compile }
	Streaming engine status. More...
enum	NvsStreamingEngineCaptureFlag {   NvsStreamingEngineCaptureFlag_GrabCapturedVideoFrame = 1, NvsStreamingEngineCaptureFlag_StrictPreviewVideoSize = 8, NvsStreamingEngineCaptureFlag_DontCaptureAudio = 16, NvsStreamingEngineCaptureFlag_CaptureBuddyHostVideoFrame = 32,   NvsStreamingEngineCaptureFlag_IgnoreScreenOrientation = 64, NvsStreamingEngineCaptureFlag_AutoVideoStabilization = 128, NvsStreamingEngineCaptureFlag_FaceActionWithParticle = 256, NvsStreamingEngineCaptureFlag_LowPipelineSize = 512,   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 }
	Flag of capturing. More...
enum	BufferImageRotation { BufferImageRotation_0 = 0, BufferImageRotation_90 = 1, BufferImageRotation_180 = 2, BufferImageRotation_270 = 3 }
	Enters the image rotation angle of the buffer. More...
enum	VideoStabilizationFlag { VideoStabilizationFlag_Off = 0, VideoStabilizationFlag_Auto = 1, VideoStabilizationFlag_Standard = 2, VideoStabilizationFlag_Super = 3 }
	Stabilization flag. More...
enum	NvsStreamingEngineRecordingFlag {   NvsStreamingEngineRecordingFlag_VideoIntraFrameOnly = 2, NvsStreamingEngineRecordingFlag_OnlyRecordVideo = 16, NvsStreamingEngineRecordingFlag_IgnoreVideoRotation = 32, NvsStreamingEngineRecordingFlag_WithoutFxUseStreamingWriter = 256,   NvsStreamingEngineRecordingFlag_FlipHorizontally = 512 }
	Flag of Recording. More...
enum	NvsCameraFlashMode { NvsCameraFlashMode_FlashOff = 1, NvsCameraFlashMode_FlashOn = 2, NvsCameraFlashMode_FlashAuto = 4, NvsCameraFlashMode_Torch = 8 }
	Camera flash mode. More...
enum	NvsStreamingEngineSeekFlag {   NvsStreamingEngineSeekFlag_ShowCaptionPoster = 2, NvsStreamingEngineSeekFlag_ShowAnimatedStickerPoster = 4, NvsStreamingEngineSeekFlag_BuddyHostVideoFrame = 16, NvsStreamingEngineSeekFlag_NotConnectToLivewindow = 128,   NvsStreamingEngineSeekFlag_BuddyOriginHostVideoFrame = 256 }
	Flag of seeking engine. More...
enum	NvsStreamingEnginePlaybackFlag {   NvsStreamingEnginePlaybackFlag_LowPipelineSize = 8, NvsStreamingEnginePlaybackFlag_DisableFixedPrerollTime = 16, NvsStreamingEnginePlaybackFlag_BuddyHostVideoFrame = 32, NvsStreamingEnginePlaybackFlag_AutoCacheAllCafFrames = 128,   NvsStreamingEnginePlaybackFlag_SpeedCompMode = 512, NvsStreamingEnginePlaybackFlag_BuddyOriginHostVideoFrame = 2048, NvsStreamingEnginePlaybackFlag_VariableFrameRateEnable = 4096, NvsStreamingEnginePlaybackFlag_DisableDropFrameMode = 16384 }
	Flag of playing engine. More...
enum	NvsStreamingEngineStopFlag { NvsStreamingEngineStopFlag_Async = 2 }
	Flag of stoppoing engine stopp. More...
enum	NvsHumanDetectionFeatureFlag {   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 }
	Flag of human detection. More...
enum	NvsHumanDetectionDataTypeFlag {   NvsHumanDetectionDataType_FakeFace = 0, NvsHumanDetectionDataType_Makeup, NvsHumanDetectionDataType_SkinColor, NvsHumanDetectionDataType_PE106,   NvsHumanDetectionDataType_PE240, NvsHumanDetectionDataType_CustomAvatar, NvsHumanDetectionDataType_Makeup2 }
	Type of human detection data package. More...
enum	NvsStreamingEngineHarwareErrorType { NvsStreamingEngineHarwareErrorType_Video_Encoder_Setup_Error = 0, NvsStreamingEngineHarwareErrorType_Video_Encoding_Error, NvsStreamingEngineHarwareErrorType_Video_Decoder_Setup_Error, NvsStreamingEngineHarwareErrorType_Video_Decoding_Error }
	Hardware error type. More...
enum	NvsAVFileinfoExtraFlag { NvsAVFileinfoExtra_None = 0, NvsAVFileinfoExtra_AVPixelFormat }
	Special identifier when acquiring audio and video information. More...
compile error type
enum	NvsStreamingEngineCompileErrorType {   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 }
capture device error code
enum	NvsStreamingEngineCaptureDeviceErrorCode { NvsStreamingEngineCaptureDeviceErrorCode_Unknown = 1, NvsStreamingEngineCaptureDeviceErrorCode_ServerDied = 2, NvsStreamingEngineCaptureDeviceErrorCode_FailToStart = 3, NvsStreamingEngineCaptureDeviceErrorCode_FailToConnect = 4 }
enum	NvsCreateTimelineTypeFlag {   NvsCreateTimelineType_LongestDurationConsiderAllTracks = 1, NvsCreateTimelineType_SyncAudioVideoTransOnVideoTrack = 2, NvsCreateTimelineType_UseMipmap = 4, NvsCreateTimelineType_VariantImageSize = 8,   NvsCreateTimelineType_DontAddDefaultVideoTransition = 16, NvsCreateTimelineType_Orphan = 128 }
	Create timeline flag. More...
HDR capability flags
enum	NvsHDRCapabilityFlag { NvsHDRCapabilityFlagSupportedByImporter = 1, NvsHDRCapabilityFlagSupportedByEditing = 2, NvsHDRCapabilityFlagSupportedByExporter = 4, NvsHDRCapabilityFlagSupportedByLivewindow = 8 }
Playback exception types
enum	NvsStreamingEnginePlaybackExceptionType { NvsStreamingEnginePlaybackExceptionType_MediaFileError = 0 }
enum	NvsDebugLevel {   NvsDebugLevelNone = 0, NvsDebugLevelError, NvsDebugLevelWarning, NvsDebugLevelDebug,   NvsDebugLevelMax }

Macro Definition Documentation

NVS_COMPILE_AUDIO_BITRATE

#define NVS_COMPILE_AUDIO_BITRATE   @"audio bitrate"

Compile audio bitrate, type: int, such as 128000 for 128k bitrate.

NVS_COMPILE_AUDIO_CHANNELS_MODE

#define NVS_COMPILE_AUDIO_CHANNELS_MODE   @"audio channels mode"

Set up audio channels, currently supporting "mixtomono", with default and timeline settings consistent.

NVS_COMPILE_AUDIO_ENCODEC_NAME

#define NVS_COMPILE_AUDIO_ENCODEC_NAME   @"audio encoder name"

Assigned audio encoding format, "amr-wb" and "mp3" are supported, default is "aac".

NVS_COMPILE_AUDIO_SAMPLE_RATE

#define NVS_COMPILE_AUDIO_SAMPLE_RATE   @"audio sample rate"

Set the audio sampling rate, currently supporting a minimum of 16K and a maximum of 128K.

NVS_COMPILE_BITRATE

#define NVS_COMPILE_BITRATE   @"bitrate"

Compile bitrate，type: int, such as 3000000 for 3M biterate.

NVS_COMPILE_CACHE_FILE_DURATION

#define NVS_COMPILE_CACHE_FILE_DURATION   @"cache file duration"

Breakpoint continuation cache file duration.

NVS_COMPILE_CACHE_FILE_PATH

#define NVS_COMPILE_CACHE_FILE_PATH   @"cache file path"

Breakpoint continuation cache file path.

NVS_COMPILE_CREATION_TIME

#define NVS_COMPILE_CREATION_TIME   @"creation time"

Set creation time for this file. Foramt:"YYYY-MM-DDTHH:MM:SS",eg:2010-12-24T12:00:00(use location time)

NVS_COMPILE_DONT_USE_VIDEO_TOOLBOX

#define NVS_COMPILE_DONT_USE_VIDEO_TOOLBOX   @"dont-use-video-toolbox"

Whether to use video toolbox, type: boolean.

NVS_COMPILE_ENABLE_BREAKPOINT_CONTINUATION

#define NVS_COMPILE_ENABLE_BREAKPOINT_CONTINUATION   @"enable breakpoint continuation"

Set whether enable breakpoint continuation.

NVS_COMPILE_FILE_META_DATA

#define NVS_COMPILE_FILE_META_DATA   @"file metadata"

Set meta data, for example:"creation-time=xxxxx;location=17.641347+160.931648;".

NVS_COMPILE_GIF_STATS_MODE

#define NVS_COMPILE_GIF_STATS_MODE   @"gif stats mode"

Set the statistical mode for GIF export. Currently, it supports diff, single, and defaults to single mode. If set to diff mode, it is best to export GIF for no more than 10 seconds. In this mode, memory requirements are relatively high

NVS_COMPILE_GOP_SIZE

#define NVS_COMPILE_GOP_SIZE   @"gopsize"

Compile GOP size, type: int, default is 30.

NVS_COMPILE_HDR_VIDEO_COLOR_TRANSFER

#define NVS_COMPILE_HDR_VIDEO_COLOR_TRANSFER   @"encorder color transfer"

Set color transfer for HDR to encode, curve: string, default is "none", can support "st2084" and "hlg",.

NVS_COMPILE_LOSSLESS_AUDIO

#define NVS_COMPILE_LOSSLESS_AUDIO   @"lossless audio"

Whether to compile lossless audio, type: boolean.

NVS_COMPILE_METADATADESCRIPTION

#define NVS_COMPILE_METADATADESCRIPTION   @"metadata description"

Corresponding AVMetadataCommonKeyDescription, sets the metadata description of the video files.

NVS_COMPILE_OPTIMIZE_FOR_NETWORK_USE

#define NVS_COMPILE_OPTIMIZE_FOR_NETWORK_USE   @"optimize-for-network-use"

Whether to prepose the index table, type: boolean.

NVS_COMPILE_SOFTWARE_ENCODER_CRF

#define NVS_COMPILE_SOFTWARE_ENCODER_CRF   @"software encorder crf"

Preset crf parameters for software encoder, type: int, range is [1, 99], less is better，default is 23.

NVS_COMPILE_SOFTWARE_ENCODER_CRF_BITRATE_MAX

#define NVS_COMPILE_SOFTWARE_ENCODER_CRF_BITRATE_MAX   @"software encorder crf bitrate max"

Preset maximum bitrate for software encoder in crf mode, type: int.

NVS_COMPILE_SOFTWARE_ENCODER_MODE

#define NVS_COMPILE_SOFTWARE_ENCODER_MODE   @"software encorder mode"

Software encoder mode, type: string, support “abr”、“crf”，default is crf.

NVS_COMPILE_VIDEO_ENCODEC_NAME

#define NVS_COMPILE_VIDEO_ENCODEC_NAME   @"video encoder name"

Assigned video encoding format, hevc(h.256) is supported, default is h.264.

NVS_COMPILE_VIDEO_FPS

#define NVS_COMPILE_VIDEO_FPS   @"fps"

frames per second when compiling, type: NSData, such as NvsRational videoFps = {30, 1},[NSData dataWithBytes:&videoFps length:sizeof(NvsRational)] forKey:NVS_COMPILE_VIDEO_FPS]

NVS_RECORD_BITRATE

#define NVS_RECORD_BITRATE   @"bitrate"

Record bitrate，type: int, such as 3000000 for 3M biterate.

NVS_RECORD_GOP_SIZE

#define NVS_RECORD_GOP_SIZE   @"gopsize"

Record GOP size, type: int, default is 30.

NVS_RECORD_HDR_VIDEO_COLOR_TRANSFER

#define NVS_RECORD_HDR_VIDEO_COLOR_TRANSFER   @"encorder color transfer"

Set color transfer for HDR to encode, curve: string, default is "none", can support "st2084" and "hlg",

NVS_RECORD_VIDEO_ENCODEC_NAME

#define NVS_RECORD_VIDEO_ENCODEC_NAME   @"video encoder name"

Assigned video encoding format, hevc(h.256) is supported, default is h.264.

Enumeration Type Documentation

BufferImageRotation

enum BufferImageRotation

Enters the image rotation angle of the buffer.

Enumerator
BufferImageRotation_0
BufferImageRotation_90
BufferImageRotation_180
BufferImageRotation_270

NvsAVFileinfoExtraFlag

enum NvsAVFileinfoExtraFlag

Special identifier when acquiring audio and video information.

Enumerator
NvsAVFileinfoExtra_None	Default.
NvsAVFileinfoExtra_AVPixelFormat	Gets AVPixelFormat.

NvsCameraFlashMode

enum NvsCameraFlashMode

Camera flash mode.

Enumerator
NvsCameraFlashMode_FlashOff	Turns off photo flash.
NvsCameraFlashMode_FlashOn	Turns On photo flash.
NvsCameraFlashMode_FlashAuto	Turns On the take photo to auto.
NvsCameraFlashMode_Torch	Turns On torch.

NvsClearCacheFlag

enum NvsClearCacheFlag

Clear cache flags.

Enumerator
NvsClearCacheFlag_StreamingEngine	Cache of streaming engine.
NvsClearCacheFlag_IconEngine	Cache of icon engine.
NvsClearCacheFlag_WaveformEngine	Cache of waveform engine.
NvsClearCacheFlag_AVFileInfo	Cache of avfile infors.
NvsClearCacheFlag_CaptionFontInfo	Cache of font infos.

NvsCompileVideoBitrateGrade

enum NvsCompileVideoBitrateGrade

The bitrate level of compiling the video file.

Enumerator
NvsCompileBitrateGradeLow	Low bitrate.
NvsCompileBitrateGradeMedium	Medium bitrate.
NvsCompileBitrateGradeHigh	High bitrate.

NvsCompileVideoResolutionGrade

enum NvsCompileVideoResolutionGrade

Resolution level for compiling video (define video resolution at time of createTimeline. Automatically defining rendering video width in according to output video height).

Enumerator
NvsCompileVideoResolutionGrade360	Output height: 360 pixel.
NvsCompileVideoResolutionGrade480	Output height: 480 pixel.
NvsCompileVideoResolutionGrade720	Output height: 720 pixel.
NvsCompileVideoResolutionGrade1080	Output height: 1080 pixel.
NvsCompileVideoResolutionGrade2160	Output height: 2160 pixel.
NvsCompileVideoResolutionGradeCustom	Custom height, used with setCustomCompileVideoHeight.

NvsCreateTimelineTypeFlag

enum NvsCreateTimelineTypeFlag

Create timeline flag.

Enumerator
NvsCreateTimelineType_LongestDurationConsiderAllTracks	timeline's longest duration consider all tracks
NvsCreateTimelineType_SyncAudioVideoTransOnVideoTrack	Sync audio transition and video transiton on video track.
NvsCreateTimelineType_UseMipmap	Use mipmap anti-aliasing.
NvsCreateTimelineType_VariantImageSize	Automatically adapt timeline resolution when add images.
NvsCreateTimelineType_DontAddDefaultVideoTransition	Do not add a default video transition.
NvsCreateTimelineType_Orphan	Orphan timeline flag, destroy the timeline after its parent timeline destroyed.

NvsDebugLevel

enum NvsDebugLevel

Enumerator
NvsDebugLevelNone
NvsDebugLevelError
NvsDebugLevelWarning
NvsDebugLevelDebug
NvsDebugLevelMax

NvsHDRCapabilityFlag

enum NvsHDRCapabilityFlag

Enumerator
NvsHDRCapabilityFlagSupportedByImporter	Support importing HDR video.
NvsHDRCapabilityFlagSupportedByEditing	Editing Support HDR.
NvsHDRCapabilityFlagSupportedByExporter	Support exporting HDR video.
NvsHDRCapabilityFlagSupportedByLivewindow	Livewindow support HDR.

NvsHumanDetectionDataTypeFlag

enum NvsHumanDetectionDataTypeFlag

Type of human detection data package.

Enumerator
NvsHumanDetectionDataType_FakeFace
NvsHumanDetectionDataType_Makeup
NvsHumanDetectionDataType_SkinColor
NvsHumanDetectionDataType_PE106
NvsHumanDetectionDataType_PE240
NvsHumanDetectionDataType_CustomAvatar
NvsHumanDetectionDataType_Makeup2

NvsHumanDetectionFeatureFlag

enum NvsHumanDetectionFeatureFlag

Flag of human detection.

Enumerator
NvsHumanDetectionFeature_FaceLandmark
NvsHumanDetectionFeature_FaceAction
NvsHumanDetectionFeature_AvatarExpression
NvsHumanDetectionFeature_VideoMode
NvsHumanDetectionFeature_ImageMode
NvsHumanDetectionFeature_MultiThread
NvsHumanDetectionFeature_SingleThread
NvsHumanDetectionFeature_Extra
NvsHumanDetectionFeature_Background
NvsHumanDetectionFeature_HandLandmark
NvsHumanDetectionFeature_HandAction
NvsHumanDetectionFeature_HandBone
NvsHumanDetectionFeature_EyeballLandmark
NvsHumanDetectionFeature_MultiDetect
NvsHumanDetectionFeature_SegmentationSky
NvsHumanDetectionFeature_SemiImageMode
NvsHumanDetectionFeature_HalfBody
NvsHumanDetectionFeature_FaceAttri
NvsHumanDetectionFeature_FaceAttriShape

NvsStreamingContextFlag

enum NvsStreamingContextFlag

Streaming context creation flag.

Enumerator
NvsStreamingContextFlag_Support4KEdit	Supports up to 4K video editing.
NvsStreamingContextFlag_Support8KEdit	Supports up to 8K (images only).
NvsStreamingContextFlag_AsyncEngineState	Asynchronous engine.
NvsStreamingContextFlag_Support16KEdit	Supports up to 16K (images only).
NvsStreamingContextFlag_EnableCaptionContextCacheLimit	Enable max cache cont limit of caption.
NvsStreamingContextFlag_DisableCapture	Disable capture.
NvsStreamingContextFlag_PlaybackDropFrameMode	Drop frame mode in playback timeline.
NvsStreamingContextFlag_NeedGifMotion	Need gif motion in playback timeline.
NvsStreamingContextFlag_DisableHardwareAudioReader	Disable hardware audio reader in mac os.
NvsStreamingContextFlag_InterruptStopForInternalStop	Interrupt stop is used for all internal stop, such as stop between seek state and playback state.
NvsStreamingContextFlag_UseFixedDefaultCaptionContextResolution

NvsStreamingEngineCaptureDeviceErrorCode

enum NvsStreamingEngineCaptureDeviceErrorCode

Enumerator
NvsStreamingEngineCaptureDeviceErrorCode_Unknown
NvsStreamingEngineCaptureDeviceErrorCode_ServerDied
NvsStreamingEngineCaptureDeviceErrorCode_FailToStart
NvsStreamingEngineCaptureDeviceErrorCode_FailToConnect

NvsStreamingEngineCaptureFlag

enum NvsStreamingEngineCaptureFlag

Flag of capturing.

Enumerator
NvsStreamingEngineCaptureFlag_GrabCapturedVideoFrame	Gets the capture frame content(this operation may reduce performance, use it only when needed).
NvsStreamingEngineCaptureFlag_StrictPreviewVideoSize	Preview video size within system-defined size.
NvsStreamingEngineCaptureFlag_DontCaptureAudio	No audio capturing.
NvsStreamingEngineCaptureFlag_CaptureBuddyHostVideoFrame	Captures buddy video frames.
NvsStreamingEngineCaptureFlag_IgnoreScreenOrientation	Does not apply screen coordinate for defining rotation angle of captured video. Since 1.15.2
NvsStreamingEngineCaptureFlag_AutoVideoStabilization	Enables auto video stabilization. Since 1.16.1
NvsStreamingEngineCaptureFlag_FaceActionWithParticle	Uses facial action to control particle effects. Since 2.1.0
NvsStreamingEngineCaptureFlag_LowPipelineSize	Decreases the size of pipeline when engine is capturing.
NS_ENUM_DEPRECATED_IOS	Does not apply automatically configures application audiosession. Note：This option is not available after version 3.11.0. If you need echo cancellation, refer to the setAECEnabled method . Since 2.12.0
NvsStreamingEngineCaptureFlag_DisableFlipOfFrontCamera	Disable flip of front camera.
NvsStreamingEngineCaptureFlag_InputAspectRatioUsed	Capture preview size aspect ratio use user input.
NvsStreamingEngineCaptureFlag_EnableTakePicture	Capture preview size aspect ratio use user input.
NvsStreamingEngineCaptureFlag_EnableHDR	Enable HDR video when Device is supported.
NvsStreamingEngineCaptureFlag_DontConfigAudioSession	With this flag, you must be responsible for implementing AudioSession that meets the recording requirements in the playback and recording category to meet the normal functional requirements of the SDK. This SDK is no longer responsible for the configuration of AudioSession.

NvsStreamingEngineCompileErrorType

enum NvsStreamingEngineCompileErrorType

Enumerator
NvsStreamingEngineCompileErrorType_No_Error
NvsStreamingEngineCompileErrorType_Cancelation
NvsStreamingEngineCompileErrorType_Video_Encoder_Setup_Error
NvsStreamingEngineCompileErrorType_Video_Encoding_Error
NvsStreamingEngineCompileErrorType_Video_Decoding_Error
NvsStreamingEngineCompileErrorType_Muxing_Error

NvsStreamingEngineCompileFlag

enum NvsStreamingEngineCompileFlag

Flag of compiling video.

Enumerator
NvsStreamingEngineCompileFlag_None	None.
NvsStreamingEngineCompileFlag_DisableHardwareEncoder	Disables the hardware encoder.
NvsStreamingEngineCompileFlag_OnlyVideo	Compile the video file only.
NvsStreamingEngineCompileFlag_OnlyAudio	Compile the audio file only.
NvsStreamingEngineCompileFlag_BuddyHostVideoFrame	Buddy video frame in host.
NvsStreamingEngineCompileFlag_TruncateAudioStream	Truncat audio stream make sure no longer than the length of the video.
NvsStreamingEngineCompileFlag_DisableAlignVideoSize
NvsStreamingEngineCompileFlag_IgnoreTimelineVideoSize	The resolution of output video can be over timeline's resolution.
NvsStreamingEngineCompileFlag_BuddyOriginHostVideoFrame	Buddy video frame in host after decoding.
NvsStreamingEngineCompileFlag_VariableFrameRateEnable	Enable variable frame rate export.

NvsStreamingEngineHarwareErrorType

enum NvsStreamingEngineHarwareErrorType

Hardware error type.

Enumerator
NvsStreamingEngineHarwareErrorType_Video_Encoder_Setup_Error
NvsStreamingEngineHarwareErrorType_Video_Encoding_Error
NvsStreamingEngineHarwareErrorType_Video_Decoder_Setup_Error
NvsStreamingEngineHarwareErrorType_Video_Decoding_Error

NvsStreamingEnginePlaybackExceptionType

enum NvsStreamingEnginePlaybackExceptionType

Enumerator
NvsStreamingEnginePlaybackExceptionType_MediaFileError

NvsStreamingEnginePlaybackFlag

enum NvsStreamingEnginePlaybackFlag

Flag of playing engine.

Enumerator
NvsStreamingEnginePlaybackFlag_LowPipelineSize	Reduces the internal pipeline size of the engine during playback.
NvsStreamingEnginePlaybackFlag_DisableFixedPrerollTime	Reduces the engine's playback delay of the first frame during playback.
NvsStreamingEnginePlaybackFlag_BuddyHostVideoFrame	Buddy video frame in host.
NvsStreamingEnginePlaybackFlag_AutoCacheAllCafFrames	Cache all frames of caf file.
NvsStreamingEnginePlaybackFlag_SpeedCompMode	Playback with speed compensation.
NvsStreamingEnginePlaybackFlag_BuddyOriginHostVideoFrame	Buddy video frame in host after decoding.
NvsStreamingEnginePlaybackFlag_VariableFrameRateEnable	Enable variable frame rate playback, and the playback frame rate will change with the video frame rate.
NvsStreamingEnginePlaybackFlag_DisableDropFrameMode	Disable the frame dropping mode for playback. If this flag is not added, the SDK will ensure continuous audio playback. If the video rendering is complex and so on, it will use the frame dropping mode to ensure video and audio synchronization.

NvsStreamingEngineRecordingFlag

enum NvsStreamingEngineRecordingFlag

Flag of Recording.

Enumerator
NvsStreamingEngineRecordingFlag_VideoIntraFrameOnly	Records a video file containing I-Frame only.
NvsStreamingEngineRecordingFlag_OnlyRecordVideo	Records only video stream.
NvsStreamingEngineRecordingFlag_IgnoreVideoRotation	Ignores video device rotation while recording. Remark：it has only effects when using the method of "startRecordingWithFx:".
NvsStreamingEngineRecordingFlag_WithoutFxUseStreamingWriter	Video record without fx that be streaming writer used. Remark：it has only effects when using the method of "startRecording:".
NvsStreamingEngineRecordingFlag_FlipHorizontally	Flip horizontally input video frame.

NvsStreamingEngineSeekFlag

enum NvsStreamingEngineSeekFlag

Flag of seeking engine.

Enumerator
NvsStreamingEngineSeekFlag_ShowCaptionPoster	Shows entire caption.
NvsStreamingEngineSeekFlag_ShowAnimatedStickerPoster	Shows entire animated sticker.
NvsStreamingEngineSeekFlag_BuddyHostVideoFrame	Buddy video frame in host.
NvsStreamingEngineSeekFlag_NotConnectToLivewindow	Seek can be done without connecting to the LiveWindow.
NvsStreamingEngineSeekFlag_BuddyOriginHostVideoFrame	Buddy video frame in host after decoding.

NvsStreamingEngineState

enum NvsStreamingEngineState

Streaming engine status.

Enumerator
NvsStreamingEngineState_Stopped	Engine stopped.
NvsStreamingEngineState_CapturePreview	Capturing preview.
NvsStreamingEngineState_CaptureRecording	Recording.
NvsStreamingEngineState_Playback	Playback.
NvsStreamingEngineState_Seeking	Seeking.
NvsStreamingEngineState_Compile	Compiling.

NvsStreamingEngineStopFlag

enum NvsStreamingEngineStopFlag

Flag of stoppoing engine stopp.

Enumerator
NvsStreamingEngineStopFlag_Async	Stops the engine asynchronously, and avoids blocking the main thread.

NvsVideoCaptureResolutionGrade

enum NvsVideoCaptureResolutionGrade

Resolution level for capturing video.

Enumerator
NvsVideoCaptureResolutionGradeLow	Low resolution.
NvsVideoCaptureResolutionGradeMedium	Medium resolution.
NvsVideoCaptureResolutionGradeHigh	High resolution.
NvsVideoCaptureResolutionGradeSupperHigh	Super high resolution.
NvsVideoCaptureResolutionGradeExtremelyHigh	Extremely high resolution.

NvsVideoPreviewSizeMode

enum NvsVideoPreviewSizeMode

Mode of preview video.

Enumerator
NvsVideoPreviewSizeModeFullSize	Preview in full size.
NvsVideoPreviewSizeModeLiveWindowSize	Preview in controll of "liveWindow".

VideoStabilizationFlag

enum VideoStabilizationFlag

Stabilization flag.

Enumerator
VideoStabilizationFlag_Off	Video stabilization mode is off.
VideoStabilizationFlag_Auto	Video stabilization automatic mode.
VideoStabilizationFlag_Standard	Video standard stabilization.
VideoStabilizationFlag_Super	Video stabilization movie mode.