AJA NTV2 SDK  17.0.1.1246
NTV2 SDK 17.0.1.1246
CaptureConfig Class Reference

This class is used to configure an NTV2Capture instance. More...

#include <ntv2democommon.h>

Inheritance diagram for CaptureConfig:
[legend]
Collaboration diagram for CaptureConfig:
[legend]

Public Member Functions

 CaptureConfig (const std::string &inDeviceSpec="0")
 Constructs a default NTV2Capture configuration. More...
 
AJALabelValuePairs Get (const bool inCompact=false) const
 

Public Attributes

std::string fDeviceSpec
 The AJA device to use. More...
 
std::string fAncDataFilePath
 Optional path to Anc binary data file. More...
 
NTV2Channel fInputChannel
 The device channel to use. More...
 
NTV2InputSource fInputSource
 The device input connector to use. More...
 
NTV2ACFrameRange fFrames
 AutoCirculate frame count or range. More...
 
NTV2PixelFormat fPixelFormat
 Pixel format to use. More...
 
UWord fNumAudioLinks
 Number of audio links to capture. More...
 
bool fDoABConversion
 If true, do level-A/B conversion; otherwise don't. More...
 
bool fDoMultiFormat
 If true, use multi-format/multi-channel mode, if device supports it; otherwise normal mode. More...
 
bool fWithAnc
 If true, also capture Anc. More...
 
bool fWithAudio
 If true, also capture Audio. More...
 
bool fDoTSIRouting
 If true, do TSI routing; otherwise squares. More...
 

Detailed Description

This class is used to configure an NTV2Capture instance.

Definition at line 265 of file ntv2democommon.h.

Constructor & Destructor Documentation

◆ CaptureConfig()

CaptureConfig::CaptureConfig ( const std::string &  inDeviceSpec = "0")
inlineexplicit

Constructs a default NTV2Capture configuration.

Definition at line 284 of file ntv2democommon.h.

Member Function Documentation

◆ Get()

AJALabelValuePairs CaptureConfig::Get ( const bool  inCompact = false) const

Definition at line 1685 of file ntv2democommon.cpp.

Member Data Documentation

◆ fAncDataFilePath

std::string CaptureConfig::fAncDataFilePath

Optional path to Anc binary data file.

Definition at line 269 of file ntv2democommon.h.

◆ fDeviceSpec

std::string CaptureConfig::fDeviceSpec

The AJA device to use.

Definition at line 268 of file ntv2democommon.h.

◆ fDoABConversion

bool CaptureConfig::fDoABConversion

If true, do level-A/B conversion; otherwise don't.

Definition at line 275 of file ntv2democommon.h.

◆ fDoMultiFormat

bool CaptureConfig::fDoMultiFormat

If true, use multi-format/multi-channel mode, if device supports it; otherwise normal mode.

Definition at line 276 of file ntv2democommon.h.

◆ fDoTSIRouting

bool CaptureConfig::fDoTSIRouting

If true, do TSI routing; otherwise squares.

Definition at line 279 of file ntv2democommon.h.

◆ fFrames

NTV2ACFrameRange CaptureConfig::fFrames

AutoCirculate frame count or range.

Definition at line 272 of file ntv2democommon.h.

◆ fInputChannel

NTV2Channel CaptureConfig::fInputChannel

The device channel to use.

Definition at line 270 of file ntv2democommon.h.

◆ fInputSource

NTV2InputSource CaptureConfig::fInputSource

The device input connector to use.

Definition at line 271 of file ntv2democommon.h.

◆ fNumAudioLinks

UWord CaptureConfig::fNumAudioLinks

Number of audio links to capture.

Definition at line 274 of file ntv2democommon.h.

◆ fPixelFormat

NTV2PixelFormat CaptureConfig::fPixelFormat

Pixel format to use.

Definition at line 273 of file ntv2democommon.h.

◆ fWithAnc

bool CaptureConfig::fWithAnc

If true, also capture Anc.

Definition at line 277 of file ntv2democommon.h.

◆ fWithAudio

bool CaptureConfig::fWithAudio

If true, also capture Audio.

Definition at line 278 of file ntv2democommon.h.


The documentation for this class was generated from the following files: