Configures an NTV2Burn or NTV2FieldBurn instance. More...

#include <ntv2democommon.h>

Collaboration diagram for BurnConfig:

Public Member Functions
	BurnConfig (const std::string &inDeviceSpecifier="0")
	Constructs a default Player configuration. More...

AJALabelValuePairs	Get (const bool inCompact=false) 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...

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	fWithHanc
	If true, capture & play HANC data, including audio (LLBurn). Defaults to false. More...

Detailed Description

Configures an NTV2Burn or NTV2FieldBurn instance.

Definition at line 376 of file ntv2democommon.h.

Constructor & Destructor Documentation

◆ BurnConfig()

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

inlineexplicit

Constructs a default Player configuration.

Definition at line 398 of file ntv2democommon.h.

Member Function Documentation

◆ Get()

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

Renders a human-readable representation of me.

Parameters

[in] inCompact If true, setting values are printed in a more compact form. Defaults to false.

Returns: A list of label/value pairs.

Definition at line 1752 of file ntv2democommon.cpp.

Member Data Documentation

◆ fDeviceSpec

std::string BurnConfig::fDeviceSpec

The AJA device to use.

Definition at line 379 of file ntv2democommon.h.

◆ fDeviceSpec2

std::string BurnConfig::fDeviceSpec2

Second AJA device to use (Burn4KQuadrant or BurnBoardToBoard only)

Definition at line 380 of file ntv2democommon.h.

◆ fDoMultiFormat

bool BurnConfig::fDoMultiFormat

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

Definition at line 388 of file ntv2democommon.h.

◆ fInputChannel

NTV2Channel BurnConfig::fInputChannel

The input channel to use.

Definition at line 381 of file ntv2democommon.h.

◆ fInputFrames

NTV2ACFrameRange BurnConfig::fInputFrames

Ingest frame count or range.

Definition at line 384 of file ntv2democommon.h.

◆ fInputSource

NTV2InputSource BurnConfig::fInputSource

The device input connector to use.

Definition at line 383 of file ntv2democommon.h.

◆ fIsFieldMode

bool BurnConfig::fIsFieldMode

True if Field Mode, otherwise Frame Mode.

Definition at line 391 of file ntv2democommon.h.

◆ fOutputChannel

NTV2Channel BurnConfig::fOutputChannel

The output channel to use.

Definition at line 382 of file ntv2democommon.h.

◆ fOutputFrames

NTV2ACFrameRange BurnConfig::fOutputFrames

Playout frame count or range.

Definition at line 385 of file ntv2democommon.h.

◆ fPixelFormat

NTV2PixelFormat BurnConfig::fPixelFormat

The pixel format to use.

Definition at line 386 of file ntv2democommon.h.

◆ fSuppressAudio

bool BurnConfig::fSuppressAudio

If true, suppress audio; otherwise include audio.

Definition at line 389 of file ntv2democommon.h.

◆ fSuppressVideo

bool BurnConfig::fSuppressVideo

If true, suppress video; otherwise include video.

Definition at line 390 of file ntv2democommon.h.

◆ fTimecodeSource

NTV2TCIndex BurnConfig::fTimecodeSource

Timecode source to use.

Definition at line 387 of file ntv2democommon.h.

◆ fWithAnc

bool BurnConfig::fWithAnc

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

Definition at line 392 of file ntv2democommon.h.

◆ fWithHanc

bool BurnConfig::fWithHanc

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

Definition at line 393 of file ntv2democommon.h.

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

/home/tcbuilder/buildAgent/work/df8e8cce5bebfd58/libajantv2/demos/ntv2democommon.h
/home/tcbuilder/buildAgent/work/df8e8cce5bebfd58/libajantv2/demos/ntv2democommon.cpp

Public Member Functions

Public Attributes