Configures an NTV2CCPlayer instance. More...

#include <ntv2ccplayer.h>

Inheritance diagram for CCPlayerConfig:

Collaboration diagram for CCPlayerConfig:

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

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

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

AJALabelValuePairs	Get (const bool inCompact=(0)) const
	Renders a human-readable representation of me. More...

Public Attributes
bool	fEmitStats
	If true, show stats while playing; otherwise echo caption text being played. More...

bool	fSuppressLine21
	SD output only: if true, do not encode Line 21 waveform; otherwise encode Line 21 waveform. More...

bool	fSuppress608
	If true, don't transmit CEA608 packets; otherwise include 608 packets. More...

bool	fSuppress708
	If true, don't transmit CEA708 packets; otherwise include 708 packets. More...

bool	fSuppressTimecode
	If true, suppress timecode; otherwise embed VITC/LTC. More...

uint16_t	fForceRTP
	BIT(0):0=normal,1=forceRTP BIT(1):0=uniPkt,1=multiPkt BIT(2):0=normal,1=patchDeviceID. More...

std::string	fTestPatternName
	The test pattern to use. More...

CaptionChanGenMap	fCapChanGenConfigs
	Caption channel generator configs. More...

Public Attributes inherited from PlayerConfig
std::string	fDeviceSpec
	The AJA device to use. More...

std::string	fAncDataFilePath
	Optional path to Anc binary data file to playout. More...

NTV2Channel	fOutputChannel
	The device channel to use. More...

NTV2OutputDest	fOutputDest
	The desired output connector to use. More...

NTV2ACFrameRange	fFrames
	AutoCirculate frame count or range. More...

NTV2PixelFormat	fPixelFormat
	The pixel format to use. More...

NTV2VideoFormat	fVideoFormat
	The video format to use. More...

NTV2VANCMode	fVancMode
	VANC mode to use. More...

AJAAncDataType	fTransmitHDRType
	Specifies the HDR anc data packet to transmit, if any. More...

UWord	fNumAudioLinks
	The number of audio systems to control for multi-link audio (4K/8K) More...

bool	fDoMultiFormat
	If true, enable device-sharing; otherwise take exclusive control of device. More...

bool	fSuppressAudio
	If true, suppress audio; otherwise generate & xfer audio tone. More...

bool	fSuppressVideo
	If true, suppress video; otherwise generate & xfer test patterns. More...

bool	fTransmitLTC
	If true, embed LTC; otherwise embed VITC. More...

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

bool	fDoHDMIOutput
	If true, enable HDMI output; otherwise, disable HDMI output. More...

bool	fDoTsiRouting
	If true, enable TSI routing; otherwise route for square division (4K/8K) More...

bool	fDoRGBOnWire
	If true, produce RGB on the wire; otherwise output YUV. More...

bool	fDoLinkGrouping
	If true, enables 6/12G output mode on IoX3/Kona5 (4K/8K) More...

Detailed Description

Configures an NTV2CCPlayer instance.

Definition at line 80 of file ntv2ccplayer.h.

Constructor & Destructor Documentation

◆ CCPlayerConfig()

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

inlineexplicit

Constructs a default CCPlayer configuration.

Definition at line 95 of file ntv2ccplayer.h.

Member Function Documentation

◆ Get()

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

Definition at line 227 of file ntv2ccplayer.cpp.

Member Data Documentation

◆ fCapChanGenConfigs

CaptionChanGenMap CCPlayerConfig::fCapChanGenConfigs

Caption channel generator configs.

Definition at line 90 of file ntv2ccplayer.h.

◆ fEmitStats

bool CCPlayerConfig::fEmitStats

If true, show stats while playing; otherwise echo caption text being played.

Definition at line 83 of file ntv2ccplayer.h.

◆ fForceRTP

uint16_t CCPlayerConfig::fForceRTP

BIT(0):0=normal,1=forceRTP BIT(1):0=uniPkt,1=multiPkt BIT(2):0=normal,1=patchDeviceID.

Definition at line 88 of file ntv2ccplayer.h.

◆ fSuppress608

bool CCPlayerConfig::fSuppress608

If true, don't transmit CEA608 packets; otherwise include 608 packets.

Definition at line 85 of file ntv2ccplayer.h.

◆ fSuppress708

bool CCPlayerConfig::fSuppress708

If true, don't transmit CEA708 packets; otherwise include 708 packets.

Definition at line 86 of file ntv2ccplayer.h.

◆ fSuppressLine21

bool CCPlayerConfig::fSuppressLine21

SD output only: if true, do not encode Line 21 waveform; otherwise encode Line 21 waveform.

Definition at line 84 of file ntv2ccplayer.h.

◆ fSuppressTimecode

bool CCPlayerConfig::fSuppressTimecode

If true, suppress timecode; otherwise embed VITC/LTC.

Definition at line 87 of file ntv2ccplayer.h.

◆ fTestPatternName

std::string CCPlayerConfig::fTestPatternName

The test pattern to use.

Definition at line 89 of file ntv2ccplayer.h.

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

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

Public Member Functions

Public Attributes