Configures an NTV2Player instance. More...

#include <ntv2democommon.h>

Inheritance diagram for PlayerConfig:

Collaboration diagram for PlayerConfig:

Public Member Functions
	PlayerConfig (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	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 audio tone. More...

bool	fSuppressVideo
	If true, suppress video; otherwise generate 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 NTV2Player instance.

Definition at line 310 of file ntv2democommon.h.

Constructor & Destructor Documentation

◆ PlayerConfig()

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

inlineexplicit

Constructs a default Player configuration.

Definition at line 336 of file ntv2democommon.h.

Member Function Documentation

◆ Get()

AJALabelValuePairs PlayerConfig::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 1715 of file ntv2democommon.cpp.

Member Data Documentation

◆ fAncDataFilePath

std::string PlayerConfig::fAncDataFilePath

Optional path to Anc binary data file to playout.

Definition at line 314 of file ntv2democommon.h.

◆ fDeviceSpec

std::string PlayerConfig::fDeviceSpec

The AJA device to use.

Definition at line 313 of file ntv2democommon.h.

◆ fDoABConversion

bool PlayerConfig::fDoABConversion

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

Definition at line 327 of file ntv2democommon.h.

◆ fDoHDMIOutput

bool PlayerConfig::fDoHDMIOutput

If true, enable HDMI output; otherwise, disable HDMI output.

Definition at line 328 of file ntv2democommon.h.

◆ fDoLinkGrouping

bool PlayerConfig::fDoLinkGrouping

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

Definition at line 331 of file ntv2democommon.h.

◆ fDoMultiFormat

bool PlayerConfig::fDoMultiFormat

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

Definition at line 323 of file ntv2democommon.h.

◆ fDoRGBOnWire

bool PlayerConfig::fDoRGBOnWire

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

Definition at line 330 of file ntv2democommon.h.

◆ fDoTsiRouting

bool PlayerConfig::fDoTsiRouting

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

Definition at line 329 of file ntv2democommon.h.

◆ fFrames

NTV2ACFrameRange PlayerConfig::fFrames

AutoCirculate frame count or range.

Definition at line 317 of file ntv2democommon.h.

◆ fNumAudioLinks

UWord PlayerConfig::fNumAudioLinks

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

Definition at line 322 of file ntv2democommon.h.

◆ fOutputChannel

NTV2Channel PlayerConfig::fOutputChannel

The device channel to use.

Definition at line 315 of file ntv2democommon.h.

◆ fOutputDest

NTV2OutputDest PlayerConfig::fOutputDest

The desired output connector to use.

Definition at line 316 of file ntv2democommon.h.

◆ fPixelFormat

NTV2PixelFormat PlayerConfig::fPixelFormat

The pixel format to use.

Definition at line 318 of file ntv2democommon.h.

◆ fSuppressAudio

bool PlayerConfig::fSuppressAudio

If true, suppress audio; otherwise generate audio tone.

Definition at line 324 of file ntv2democommon.h.

◆ fSuppressVideo

bool PlayerConfig::fSuppressVideo

If true, suppress video; otherwise generate test patterns.

Definition at line 325 of file ntv2democommon.h.

◆ fTransmitHDRType

AJAAncDataType PlayerConfig::fTransmitHDRType

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

Definition at line 321 of file ntv2democommon.h.

◆ fTransmitLTC

bool PlayerConfig::fTransmitLTC

If true, embed LTC; otherwise embed VITC.

Definition at line 326 of file ntv2democommon.h.

◆ fVancMode

NTV2VANCMode PlayerConfig::fVancMode

VANC mode to use.

Definition at line 320 of file ntv2democommon.h.

◆ fVideoFormat

NTV2VideoFormat PlayerConfig::fVideoFormat

The video format to use.

Definition at line 319 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