MeiCam SDK For iOS  3.10.0
Classes | Macros | Typedefs | Enumerations
NvsCommonDef.h File Reference
#include <stdint.h>

Go to the source code of this file.

Classes

struct  NvsRational
 Rational value. More...
 
struct  NvsSize
 Size. More...
 
struct  NvsRect
 Rectangle. More...
 
struct  NvsAudioResolution
 Audio resolution. More...
 
struct  NvsVideoResolution
 Video resolution. More...
 
struct  NvsColor
 Self-defined color. More...
 
struct  NvsPosition2D
 2D coordinate structure More...
 
struct  NvsPosition3D
 3D coordinate structure More...
 
struct  NvsPointD
 2D coordinate point structure. The parameter type is double. More...
 
struct  NvsVideoFrameInfo
 Video frame information. More...
 
struct  NvsAudioSampleBuffers
 
struct  NvsCapturedAudioSampleInfo
 Audio sample info from capturing. More...
 

Macros

#define NVS_EXPORT   __attribute__((visibility("default")))
 
#define NVS_VIDEO_FRAME_MAX_PLANES   4
 
#define NV_AUDIO_MAX_CHANNEL_COUNT   8
 

Typedefs

typedef enum NvsRoleInTheme NvsRoleInTheme
 The role of the clip in the theme. More...
 
typedef enum NvsTextAlignment NvsTextAlignment
 Text alignment style. More...
 
typedef enum NvsLetterSpacingType NvsLetterSpacingType
 letter spacing type More...
 
typedef enum NvsAssetDefaultParam NvsAssetDefaultParam
 Uses the default caption package. More...
 
typedef enum NvsCategory NvsCategory
 The type of clip in theme. More...
 
typedef enum NvsVideoFramePixelFormat NvsVideoFramePixelFormat
 Video frame pixel format. More...
 
typedef enum NvsVideoResolutionBitDepth NvsVideoResolutionBitDepth
 Video frame pixel format. More...
 

Enumerations

enum  NvsAudioSampleFormat {
  NvsAudSmpFmt_None = -1, NvsAudSmpFmt_U8, NvsAudSmpFmt_S16, NvsAudSmpFmt_S32,
  NvsAudSmpFmt_FLT, NvsAudSmpFmt_DBL, NvsAudSmpFmt_U8P, NvsAudSmpFmt_S16P,
  NvsAudSmpFmt_S32P, NvsAudSmpFmt_FLTP, NvsAudSmpFmt_DBLP, NvsAudSmpFmt_Count
}
 Audio sampling format. More...
 
enum  NvsAVFileType { NvsAVFileType_Unknown = -1, NvsAVFileType_AudioVideo = 0, NvsAVFileType_Audio, NvsAVFileType_Image }
 File type. More...
 
enum  NvsVideoRotation { NvsVideoRotation_0 = 0, NvsVideoRotation_90, NvsVideoRotation_180, NvsVideoRotation_270 }
 Video rotation. More...
 
enum  NvsVideoCodecType { NvsVideoCodecType_Unknown = 0, NvsVideoCodecType_H264, NvsVideoCodecType_H265 }
 Video codec type. More...
 
enum  NvsVideoColorTransfer { NvsVideoColorTransfer_SDR_VIDEO = 0, NvsVideoColorTransfer_ST2084, NvsVideoColorTransfer_HLG }
 Color Transfer Characteristic. More...
 
enum  NvsVideoHDRType {
  NvsVideoHDRType_None = 0, NvsVideoHDRType_HDR10, NvsVideoHDRType_HLG, NvsVideoHDRType_HDR10Plus,
  NvsVideoHDRType_DolbyVision, NvsVideoHDRType_Vivid
}
 HDR type. More...
 
enum  NvsRoleInTheme { NvsRoleInThemeGeneral, NvsRoleInThemeTitle, NvsRoleInThemeTrailer }
 The role of the clip in the theme. More...
 
enum  NvsTextAlignment {
  NvsTextAlignmentLeft = 0, NvsTextAlignmentCenter, NvsTextAlignmentRight, NvsTextAlignmentTop,
  NvsTextAlignmentBottom, NvsTextAlignmentVCenter
}
 Text alignment style. More...
 
enum  NvsLetterSpacingType { NvsLetterSpacingTypePercentage = 0, NvsLetterSpacingTypeAbsolute }
 letter spacing type More...
 
enum  NvsAssetDefaultParam { USE_ASSET_DEFAULT_PARAM = 0, NOT_USE_ASSET_DEFAULT_PARAM }
 Uses the default caption package. More...
 
enum  NvsCategory { NvsDefaultCategory, NvsUserCategory, NvsThemeCategory }
 The type of clip in theme. More...
 
enum  NvsVideoFramePixelFormat { NvsPixelFormat_Nv12, NvsPixelFormat_YUV420, NvsPixelFormat_BGRA }
 Video frame pixel format. More...
 
enum  NvsVideoResolutionBitDepth { NvsVideoResolutionBitDepth_8Bit, NvsVideoResolutionBitDepth_16Bit_Float, NvsVideoResolutionBitDepth_Auto }
 Video frame pixel format. More...
 
enum  NvsLiveWindowFillMode { NvsLiveWindowFillModePreserveAspectCrop = 0, NvsLiveWindowFillModePreserveAspectFit, NvsLiveWindowFillModeStretch }
 Live Window fill mode. More...
 
enum  NvsLiveWindowHDRDisplayMode { NvsLiveWindowHDRDisplayMode_SDR = 0, NvsLiveWindowHDRDisplayMode_Device, NvsLiveWindowHDRDisplayMode_TONE_MAP_SDR }
 Live Window fill mode. More...
 

Macro Definition Documentation

◆ NV_AUDIO_MAX_CHANNEL_COUNT

#define NV_AUDIO_MAX_CHANNEL_COUNT   8

◆ NVS_EXPORT

#define NVS_EXPORT   __attribute__((visibility("default")))

◆ NVS_VIDEO_FRAME_MAX_PLANES

#define NVS_VIDEO_FRAME_MAX_PLANES   4

Typedef Documentation

◆ NvsAssetDefaultParam

Uses the default caption package.

◆ NvsCategory

typedef enum NvsCategory NvsCategory

The type of clip in theme.

◆ NvsLetterSpacingType

letter spacing type

◆ NvsRoleInTheme

The role of the clip in the theme.

◆ NvsTextAlignment

Text alignment style.

◆ NvsVideoFramePixelFormat

Video frame pixel format.

◆ NvsVideoResolutionBitDepth

Video frame pixel format.

Enumeration Type Documentation

◆ NvsAssetDefaultParam

Uses the default caption package.

Enumerator
USE_ASSET_DEFAULT_PARAM 
NOT_USE_ASSET_DEFAULT_PARAM 

◆ NvsAudioSampleFormat

Audio sampling format.

Enumerator
NvsAudSmpFmt_None 

None.

NvsAudSmpFmt_U8 

unsigned 8 bit

NvsAudSmpFmt_S16 

signed 16 bit

NvsAudSmpFmt_S32 

signed 32 bit

NvsAudSmpFmt_FLT 

single precision float

NvsAudSmpFmt_DBL 

double precision float

NvsAudSmpFmt_U8P 

unsigned 8 bit,planer

NvsAudSmpFmt_S16P 

signed 16 bit,planer

NvsAudSmpFmt_S32P 

signed 32 bit,planer

NvsAudSmpFmt_FLTP 

single precision float,planar

NvsAudSmpFmt_DBLP 

double precision float,olanar

NvsAudSmpFmt_Count 

◆ NvsAVFileType

File type.

Enumerator
NvsAVFileType_Unknown 

Unknown.

NvsAVFileType_AudioVideo 

Video.

NvsAVFileType_Audio 

Audio.

NvsAVFileType_Image 

Image.

◆ NvsCategory

The type of clip in theme.

Enumerator
NvsDefaultCategory 

Default type.

NvsUserCategory 

User-defined type.

NvsThemeCategory 

Theme category.

◆ NvsLetterSpacingType

letter spacing type

Enumerator
NvsLetterSpacingTypePercentage 
NvsLetterSpacingTypeAbsolute 

◆ NvsLiveWindowFillMode

Live Window fill mode.

Enumerator
NvsLiveWindowFillModePreserveAspectCrop 

The image is evenly filled and cropped if necessary (default mode).

NvsLiveWindowFillModePreserveAspectFit 

The image is evenly scaled to fit the window, without cropping.

NvsLiveWindowFillModeStretch 

The image is scaled to fit the window.

◆ NvsLiveWindowHDRDisplayMode

Live Window fill mode.

Enumerator
NvsLiveWindowHDRDisplayMode_SDR 

Forced to use SDR display, regardless of whether the device supports HDR display.

NvsLiveWindowHDRDisplayMode_Device 

If the device supports HDR, use HDR display.

NvsLiveWindowHDRDisplayMode_TONE_MAP_SDR 

If the device supports HDR, use HDR display, and use NO HDR mode display if it is not supported.

◆ NvsRoleInTheme

The role of the clip in the theme.

Enumerator
NvsRoleInThemeGeneral 

General.

NvsRoleInThemeTitle 

Title.

NvsRoleInThemeTrailer 

Trailer.

◆ NvsTextAlignment

Text alignment style.

Enumerator
NvsTextAlignmentLeft 
NvsTextAlignmentCenter 
NvsTextAlignmentRight 
NvsTextAlignmentTop 
NvsTextAlignmentBottom 
NvsTextAlignmentVCenter 

◆ NvsVideoCodecType

Video codec type.

Enumerator
NvsVideoCodecType_Unknown 
NvsVideoCodecType_H264 
NvsVideoCodecType_H265 

◆ NvsVideoColorTransfer

Color Transfer Characteristic.

Enumerator
NvsVideoColorTransfer_SDR_VIDEO 
NvsVideoColorTransfer_ST2084 
NvsVideoColorTransfer_HLG 

◆ NvsVideoFramePixelFormat

Video frame pixel format.

Enumerator
NvsPixelFormat_Nv12 

YUV 4:2:0 12bpp (Two channels, one channel is a continuous luminance channel, and the other channel is VU component interlaced)

NvsPixelFormat_YUV420 

YUV 4:2:0 12bpp (Three channels, one luminance channel, the other two are U component and V component channels, all channels are continuous)

NvsPixelFormat_BGRA 

BGRA.

◆ NvsVideoHDRType

HDR type.

Enumerator
NvsVideoHDRType_None 
NvsVideoHDRType_HDR10 
NvsVideoHDRType_HLG 
NvsVideoHDRType_HDR10Plus 
NvsVideoHDRType_DolbyVision 
NvsVideoHDRType_Vivid 

◆ NvsVideoResolutionBitDepth

Video frame pixel format.

Enumerator
NvsVideoResolutionBitDepth_8Bit 

The bit depth of processing pixel is 8bit.

NvsVideoResolutionBitDepth_16Bit_Float 

The bit depth of processing pixel is half float.

NvsVideoResolutionBitDepth_Auto 

The bit depth of processing pixel is adaptive. For example, for videos with HDR in editing, half precision floating point will be used for HDR video processing in SDK.

◆ NvsVideoRotation

Video rotation.

Enumerator
NvsVideoRotation_0 
NvsVideoRotation_90 
NvsVideoRotation_180 
NvsVideoRotation_270