AJA NTV2 SDK  17.1.1.1245
NTV2 SDK 17.1.1.1245
DolbyPlayerConfig Struct Reference

Configures an NTV2DolbyPlayer instance. More...

#include <ntv2dolbyplayer.h>

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

Public Member Functions

 DolbyPlayerConfig (const std::string &inDeviceSpecifier="0")
 Constructs a default DolbyPlayer 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 fDoRamp
 If true, use audio ramp pattern instead of tone. More...
 
std::string fDolbyFilePath
 Optional path to Dolby audio source file. 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 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 NTV2DolbyPlayer instance.

Definition at line 25 of file ntv2dolbyplayer.h.

Constructor & Destructor Documentation

◆ DolbyPlayerConfig()

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

Constructs a default DolbyPlayer configuration.

Definition at line 34 of file ntv2dolbyplayer.h.

Member Function Documentation

◆ Get()

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

Definition at line 1420 of file ntv2dolbyplayer.cpp.

Member Data Documentation

◆ fDolbyFilePath

std::string DolbyPlayerConfig::fDolbyFilePath

Optional path to Dolby audio source file.

Definition at line 29 of file ntv2dolbyplayer.h.

◆ fDoRamp

bool DolbyPlayerConfig::fDoRamp

If true, use audio ramp pattern instead of tone.

Definition at line 28 of file ntv2dolbyplayer.h.


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