AJA NTV2 SDK  17.1.3.1410
NTV2 SDK 17.1.3.1410
Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
CCGrabberConfig Struct Reference

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

#include <ntv2ccgrabber.h>

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

Public Member Functions

 CCGrabberConfig (const std::string &inDeviceSpecifier="0")
 Constructs a default CCPlayer configuration. More...
 
unsigned GetNumSourceSpecs (void) const
 
AJALabelValuePairs Get (const bool inCompact=(0)) const
 
- Public Member Functions inherited from CaptureConfig
 CaptureConfig (const std::string &inDeviceSpec="0")
 Constructs a default NTV2Capture configuration. More...
 
AJALabelValuePairs Get (const bool inCompact=(0)) const
 

Static Public Member Functions

static std::string GetLegalOutputModes (void)
 
static std::string OutputModeToString (const OutputMode inMode)
 
static OutputMode StringToOutputMode (const std::string &inModeStr)
 
static std::string GetLegalCaptionDataSources (void)
 
static std::string CaptionDataSrcToString (const CaptionDataSrc inDataSrc)
 
static CaptionDataSrc StringToCaptionDataSrc (const std::string &inDataSrcStr)
 

Public Attributes

OutputMode fOutputMode
 Desired output (captionStream, Screen etc) More...
 
CaptionDataSrc fCaptionSrc
 Caption data source (Line21? 608 VANC? 608 Anc? etc) More...
 
NTV2TCIndex fTimecodeSrc
 Timecode source to use (if any) More...
 
NTV2Line21Channel fCaptionChannel
 Caption channel to monitor (defaults to CC1) More...
 
bool fBurnCaptions
 If true, burn-in captions on 2nd channel. More...
 
bool fUseVanc
 If true, use Vanc, even if the device supports Anc insertion. More...
 
- Public Attributes inherited from CaptureConfig
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 NTV2CCGrabber instance.

Definition at line 62 of file ntv2ccgrabber.h.

Constructor & Destructor Documentation

◆ CCGrabberConfig()

CCGrabberConfig::CCGrabberConfig ( const std::string &  inDeviceSpecifier = "0")
inlineexplicit

Constructs a default CCPlayer configuration.

Definition at line 75 of file ntv2ccgrabber.h.

Member Function Documentation

◆ CaptionDataSrcToString()

string CCGrabberConfig::CaptionDataSrcToString ( const CaptionDataSrc  inDataSrc)
static

Definition at line 1656 of file ntv2ccgrabber.cpp.

◆ Get()

AJALabelValuePairs CCGrabberConfig::Get ( const bool  inCompact = (0)) const

Definition at line 1578 of file ntv2ccgrabber.cpp.

◆ GetLegalCaptionDataSources()

string CCGrabberConfig::GetLegalCaptionDataSources ( void  )
static

Definition at line 1643 of file ntv2ccgrabber.cpp.

◆ GetLegalOutputModes()

string CCGrabberConfig::GetLegalOutputModes ( void  )
static

Definition at line 1592 of file ntv2ccgrabber.cpp.

◆ GetNumSourceSpecs()

unsigned CCGrabberConfig::GetNumSourceSpecs ( void  ) const
inline

Definition at line 87 of file ntv2ccgrabber.h.

◆ OutputModeToString()

string CCGrabberConfig::OutputModeToString ( const OutputMode  inMode)
static

Definition at line 1605 of file ntv2ccgrabber.cpp.

◆ StringToCaptionDataSrc()

CaptionDataSrc CCGrabberConfig::StringToCaptionDataSrc ( const std::string &  inDataSrcStr)
static

Definition at line 1671 of file ntv2ccgrabber.cpp.

◆ StringToOutputMode()

OutputMode CCGrabberConfig::StringToOutputMode ( const std::string &  inModeStr)
static

Definition at line 1620 of file ntv2ccgrabber.cpp.

Member Data Documentation

◆ fBurnCaptions

bool CCGrabberConfig::fBurnCaptions

If true, burn-in captions on 2nd channel.

Definition at line 69 of file ntv2ccgrabber.h.

◆ fCaptionChannel

NTV2Line21Channel CCGrabberConfig::fCaptionChannel

Caption channel to monitor (defaults to CC1)

Definition at line 68 of file ntv2ccgrabber.h.

◆ fCaptionSrc

CaptionDataSrc CCGrabberConfig::fCaptionSrc

Caption data source (Line21? 608 VANC? 608 Anc? etc)

Definition at line 66 of file ntv2ccgrabber.h.

◆ fOutputMode

OutputMode CCGrabberConfig::fOutputMode

Desired output (captionStream, Screen etc)

Definition at line 65 of file ntv2ccgrabber.h.

◆ fTimecodeSrc

NTV2TCIndex CCGrabberConfig::fTimecodeSrc

Timecode source to use (if any)

Definition at line 67 of file ntv2ccgrabber.h.

◆ fUseVanc

bool CCGrabberConfig::fUseVanc

If true, use Vanc, even if the device supports Anc insertion.

Definition at line 70 of file ntv2ccgrabber.h.

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