AJA NTV2 SDK  17.5.0.1242
NTV2 SDK 17.5.0.1242
Public Member Functions | Public Attributes | List of all members
BurnConfig Struct Reference

Configures an NTV2Burn or NTV2FieldBurn instance. More...

#include <ntv2democommon.h>

Collaboration diagram for BurnConfig:
[legend]

Public Member Functions

 BurnConfig (const std::string &inDeviceSpecifier="0")
 Constructs a default Player configuration. More...
 
std::string ISrcStr (void) const
 
NTV2Channel ISrcCh (void) const
 
bool ISrcIsSDI (void) const
 
std::string ODstStr (void) const
 
NTV2Channel ODstCh (void) const
 
std::string IChStr (void) const
 
std::string OChStr (void) const
 
bool ODstIsSDI (void) const
 
AJALabelValuePairs Get (const bool inCompact=(0)) const
 Renders a human-readable representation of me. More...
 

Public Attributes

std::string fDeviceSpec
 The AJA device to use. More...
 
std::string fDeviceSpec2
 Second AJA device to use (Burn4KQuadrant or BurnBoardToBoard only) More...
 
NTV2Channel fInputChannel
 The input channel to use. More...
 
NTV2Channel fOutputChannel
 The output channel to use. More...
 
NTV2InputSource fInputSource
 The device input connector to use. More...
 
NTV2OutputDest fOutputDest
 The device output connector to use (NTV2_OUTPUTDESTINATION_INVALID means unspecified) More...
 
NTV2ACFrameRange fInputFrames
 Ingest frame count or range. More...
 
NTV2ACFrameRange fOutputFrames
 Playout frame count or range. More...
 
NTV2PixelFormat fPixelFormat
 The pixel format to use. More...
 
NTV2TCIndex fTimecodeSource
 Timecode source to use. More...
 
bool fDoMultiFormat
 If true, enables device-sharing; otherwise takes exclusive control of the device. More...
 
bool fSuppressAudio
 If true, suppress audio; otherwise include audio. More...
 
bool fSuppressVideo
 If true, suppress video; otherwise include video. More...
 
bool fIsFieldMode
 True if Field Mode, otherwise Frame Mode. More...
 
bool fWithAnc
 If true, capture & play anc data (LLBurn). Defaults to false. More...
 
bool fWithTallFrames
 If true && fWithAnc, use "taller" VANC mode for anc. Defaults to false. More...
 
bool fWithHanc
 If true, capture & play HANC data, including audio (LLBurn). Defaults to false. More...
 
bool fVerbose
 If true, emit explanatory messages to stdout/stderr. Defaults to false. More...
 

Detailed Description

Configures an NTV2Burn or NTV2FieldBurn instance.

Definition at line 385 of file ntv2democommon.h.

Constructor & Destructor Documentation

◆ BurnConfig()

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

Constructs a default Player configuration.

Definition at line 410 of file ntv2democommon.h.

Member Function Documentation

◆ Get()

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

Renders a human-readable representation of me.

Parameters
[in]inCompactIf true, setting values are printed in a more compact form. Defaults to false.
Returns
A list of label/value pairs.

Definition at line 1838 of file ntv2democommon.cpp.

◆ IChStr()

std::string BurnConfig::IChStr ( void  ) const
inline

Definition at line 446 of file ntv2democommon.h.

◆ ISrcCh()

NTV2Channel BurnConfig::ISrcCh ( void  ) const
inline

Definition at line 442 of file ntv2democommon.h.

◆ ISrcIsSDI()

bool BurnConfig::ISrcIsSDI ( void  ) const
inline

Definition at line 443 of file ntv2democommon.h.

◆ ISrcStr()

std::string BurnConfig::ISrcStr ( void  ) const
inline

Definition at line 441 of file ntv2democommon.h.

◆ OChStr()

std::string BurnConfig::OChStr ( void  ) const
inline

Definition at line 447 of file ntv2democommon.h.

◆ ODstCh()

NTV2Channel BurnConfig::ODstCh ( void  ) const
inline

Definition at line 445 of file ntv2democommon.h.

◆ ODstIsSDI()

bool BurnConfig::ODstIsSDI ( void  ) const
inline

Definition at line 448 of file ntv2democommon.h.

◆ ODstStr()

std::string BurnConfig::ODstStr ( void  ) const
inline

Definition at line 444 of file ntv2democommon.h.

Member Data Documentation

◆ fDeviceSpec

std::string BurnConfig::fDeviceSpec

The AJA device to use.

Definition at line 388 of file ntv2democommon.h.

◆ fDeviceSpec2

std::string BurnConfig::fDeviceSpec2

Second AJA device to use (Burn4KQuadrant or BurnBoardToBoard only)

Definition at line 389 of file ntv2democommon.h.

◆ fDoMultiFormat

bool BurnConfig::fDoMultiFormat

If true, enables device-sharing; otherwise takes exclusive control of the device.

Definition at line 398 of file ntv2democommon.h.

◆ fInputChannel

NTV2Channel BurnConfig::fInputChannel

The input channel to use.

Definition at line 390 of file ntv2democommon.h.

◆ fInputFrames

NTV2ACFrameRange BurnConfig::fInputFrames

Ingest frame count or range.

Definition at line 394 of file ntv2democommon.h.

◆ fInputSource

NTV2InputSource BurnConfig::fInputSource

The device input connector to use.

Definition at line 392 of file ntv2democommon.h.

◆ fIsFieldMode

bool BurnConfig::fIsFieldMode

True if Field Mode, otherwise Frame Mode.

Definition at line 401 of file ntv2democommon.h.

◆ fOutputChannel

NTV2Channel BurnConfig::fOutputChannel

The output channel to use.

Definition at line 391 of file ntv2democommon.h.

◆ fOutputDest

NTV2OutputDest BurnConfig::fOutputDest

The device output connector to use (NTV2_OUTPUTDESTINATION_INVALID means unspecified)

Definition at line 393 of file ntv2democommon.h.

◆ fOutputFrames

NTV2ACFrameRange BurnConfig::fOutputFrames

Playout frame count or range.

Definition at line 395 of file ntv2democommon.h.

◆ fPixelFormat

NTV2PixelFormat BurnConfig::fPixelFormat

The pixel format to use.

Definition at line 396 of file ntv2democommon.h.

◆ fSuppressAudio

bool BurnConfig::fSuppressAudio

If true, suppress audio; otherwise include audio.

Definition at line 399 of file ntv2democommon.h.

◆ fSuppressVideo

bool BurnConfig::fSuppressVideo

If true, suppress video; otherwise include video.

Definition at line 400 of file ntv2democommon.h.

◆ fTimecodeSource

NTV2TCIndex BurnConfig::fTimecodeSource

Timecode source to use.

Definition at line 397 of file ntv2democommon.h.

◆ fVerbose

bool BurnConfig::fVerbose

If true, emit explanatory messages to stdout/stderr. Defaults to false.

Definition at line 405 of file ntv2democommon.h.

◆ fWithAnc

bool BurnConfig::fWithAnc

If true, capture & play anc data (LLBurn). Defaults to false.

Definition at line 402 of file ntv2democommon.h.

◆ fWithHanc

bool BurnConfig::fWithHanc

If true, capture & play HANC data, including audio (LLBurn). Defaults to false.

Definition at line 404 of file ntv2democommon.h.

◆ fWithTallFrames

bool BurnConfig::fWithTallFrames

If true && fWithAnc, use "taller" VANC mode for anc. Defaults to false.

Definition at line 403 of file ntv2democommon.h.

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