AJA NTV2 SDK  17.1.3.1410
NTV2 SDK 17.1.3.1410
Public Member Functions | List of all members
CNTV2Config2022 Class Reference

The CNTV2Config2022 class is the interface to Kona-IP network I/O using SMPTE 2022. More...

#include <ntv2config2022.h>

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

Public Member Functions

 CNTV2Config2022 (CNTV2Card &device)
 
 ~CNTV2Config2022 ()
 
bool SetNetworkConfiguration (const eSFP sfp, const IPVNetConfig &netConfig)
 
bool GetNetworkConfiguration (const eSFP sfp, IPVNetConfig &netConfig)
 
bool SetNetworkConfiguration (const eSFP sfp, const std::string localIPAddress, const std::string subnetMask, const std::string gateway)
 
bool GetNetworkConfiguration (const eSFP sfp, std::string &localIPAddress, std::string &subnetMask, std::string &gateway)
 
bool DisableNetworkInterface (const eSFP sfp)
 
bool SetRxChannelConfiguration (const NTV2Channel channel, const rx_2022_channel &rxConfig)
 
bool GetRxChannelConfiguration (const NTV2Channel channel, rx_2022_channel &rxConfig)
 
bool SetRxChannelEnable (const NTV2Channel channel, bool enable)
 
bool GetRxChannelEnable (const NTV2Channel channel, bool &enabled)
 
bool SetTxChannelConfiguration (const NTV2Channel channel, const tx_2022_channel &txConfig)
 
bool GetTxChannelConfiguration (const NTV2Channel channel, tx_2022_channel &txConfig)
 
bool SetTxChannelEnable (const NTV2Channel channel, bool enable)
 
bool GetTxChannelEnable (const NTV2Channel channel, bool &enabled)
 
bool SetJ2KEncoderConfiguration (const NTV2Channel channel, const j2kEncoderConfig &j2kConfig)
 
bool GetJ2KEncoderConfiguration (const NTV2Channel channel, j2kEncoderConfig &j2kConfig)
 
bool SetJ2KDecoderConfiguration (const j2kDecoderConfig &j2kConfig)
 
bool GetJ2KDecoderConfiguration (j2kDecoderConfig &j2kConfig)
 
bool GetJ2KDecoderStatus (j2kDecoderStatus &j2kStatus)
 
bool Set2022_7_Mode (bool enable, uint32_t rx_networkPathDifferential)
 
bool Get2022_7_Mode (bool &enable, uint32_t &rx_networkPathDifferential)
 
bool SetIGMPDisable (eSFP sfp, bool disable)
 Disables the automatic (default) joining of multicast groups using IGMP, based on remote IP address for Rx Channels. More...
 
bool GetIGMPDisable (eSFP sfp, bool &disabled)
 
bool SetIGMPVersion (eIGMPVersion_t version)
 
bool GetIGMPVersion (eIGMPVersion_t &version)
 
void SetBiDirectionalChannels (bool bidirectional)
 
bool GetBiDirectionalChannels ()
 
bool GetMACAddress (eSFP sfp, NTV2Stream stream, std::string remoteIP, uint32_t &hi, uint32_t &lo)
 
bool GetSFPMSAData (eSFP sfp, SFPMSAData &data)
 
bool GetLinkStatus (eSFP sfp, SFPStatus &sfpStatus)
 
bool Get2022ChannelRxStatus (NTV2Channel channel, s2022RxChannelStatus &status)
 
bool SetIPServicesControl (const bool enable, const bool forceReconfig)
 
bool GetIPServicesControl (bool &enable, bool &forceReconfig)
 
std::string getLastError ()
 
NTV2IpError getLastErrorCode ()
 
- Public Member Functions inherited from CNTV2MBController
 CNTV2MBController (CNTV2Card &device)
 
- Public Member Functions inherited from CNTV2MailBox
 CNTV2MailBox (CNTV2Card &device)
 
 ~CNTV2MailBox ()
 
bool sendMsg (char *msg, uint32_t timeout)
 
bool sendMsg (uint32_t timeout)
 
void getError (std::string &error)
 
void getResponse (std::string &response)
 
bool WriteChannelRegister (ULWord reg, ULWord value, ULWord mask=0xFFFFFFFF, ULWord shift=0x0)
 
bool ReadChannelRegister (const ULWord inReg, ULWord &outValue, const ULWord inMask=0xFFFFFFFF, const ULWord inShift=0x0)
 
bool ReadChannelRegister (ULWord inReg, ULWord *pOutValue, ULWord mask=0xFFFFFFFF, ULWord shift=0x0)
 
void SetChannel (ULWord channelOffset, ULWord channelNumber)
 
bool AcquireMailbox ()
 
void ReleaseMailbox ()
 

Additional Inherited Members

- Protected Member Functions inherited from CNTV2MBController
bool SetMBNetworkConfiguration (eSFP port, std::string ipaddr, std::string netmask, std::string gateway)
 
bool DisableNetworkInterface (eSFP port)
 
bool GetRemoteMAC (std::string remote_IPAddress, eSFP port, NTV2Stream stream, std::string &MACaddress)
 
bool SetIGMPVersion (uint32_t version)
 
void SetIGMPGroup (eSFP port, NTV2Stream stream, uint32_t mcast_addr, uint32_t src_addr, bool enable)
 
void UnsetIGMPGroup (eSFP port, NTV2Stream stream)
 
void EnableIGMPGroup (eSFP port, NTV2Stream stream, bool enable)
 
bool SetTxLinkState (NTV2Channel channel, bool sfp1Enable, bool sfp2Enable)
 
bool GetTxLinkState (NTV2Channel channel, bool &sfp1Enable, bool &sfp2Enable)
 
bool SetRxLinkState (NTV2Channel channel, bool sfp1Enable, bool sfp2Enable)
 
bool GetRxLinkState (NTV2Channel channel, bool &sfp1Enable, bool &sfp2Enable)
 
bool SetDualLinkMode (bool enable)
 
bool GetDualLinkMode (bool &enable)
 
bool SetRxMatch (NTV2Channel channel, eSFP link, uint8_t match)
 
bool GetRxMatch (NTV2Channel channel, eSFP link, uint8_t &match)
 
bool SetSFPActive (eSFP sfp)
 
bool SetSFPInactive (eSFP sfp)
 
bool GetSFPActive (eSFP sfp)
 
bool SetTxFormat (NTV2Channel chan, NTV2VideoFormat fmt)
 
bool GetTxFormat (NTV2Channel chan, NTV2VideoFormat &fmt)
 
uint64_t GetNTPTimestamp ()
 
bool PushSDP (std::string filename, std::stringstream &sdpstream)
 
bool GetSDP (std::string url, std::string &sdp)
 
bool GetSFPInfo (eSFP port, SFPMSAData &sfpdata)
 
bool SetLLDPInfo (std::string sysname)
 
bool GetLLDPInfo (std::string &chassisId0, std::string &portId0, std::string &chassisId1, std::string &portId1)
 
- Protected Member Functions inherited from CNTV2MailBox
bool rcvMsg (uint32_t timeout)
 
bool writeMB (uint32_t val, uint32_t timeout=50)
 
bool readMB (uint32_t &val, uint32_t timeout=50)
 
bool waitSOM (uint32_t timeout)
 
bool waitRxReady (uint32_t timeout)
 
bool waitTxReady (uint32_t timeout)
 
bool rxReady ()
 
uint32_t getStatus ()
 
uint32_t getFeatures ()
 
- Protected Attributes inherited from CNTV2MailBox
CNTV2Card & mDevice
 
NTV2IpError mIpErrorCode
 
std::string mIpInternalErrorString
 
uint32_t txBuf [1024+1]
 

Detailed Description

The CNTV2Config2022 class is the interface to Kona-IP network I/O using SMPTE 2022.

Definition at line 159 of file ntv2config2022.h.

Constructor & Destructor Documentation

◆ CNTV2Config2022()

CNTV2Config2022::CNTV2Config2022 ( CNTV2Card &  device)

Definition at line 209 of file ntv2config2022.cpp.

◆ ~CNTV2Config2022()

CNTV2Config2022::~CNTV2Config2022 ( )

Definition at line 237 of file ntv2config2022.cpp.

Member Function Documentation

◆ DisableNetworkInterface()

bool CNTV2Config2022::DisableNetworkInterface ( const eSFP  sfp)

Definition at line 392 of file ntv2config2022.cpp.

◆ Get2022_7_Mode()

bool CNTV2Config2022::Get2022_7_Mode ( bool &  enable,
uint32_t &  rx_networkPathDifferential 
)

Definition at line 1240 of file ntv2config2022.cpp.

◆ Get2022ChannelRxStatus()

bool CNTV2Config2022::Get2022ChannelRxStatus ( NTV2Channel  channel,
s2022RxChannelStatus &  status 
)

Definition at line 1622 of file ntv2config2022.cpp.

◆ GetBiDirectionalChannels()

bool CNTV2Config2022::GetBiDirectionalChannels ( )
inline

Definition at line 208 of file ntv2config2022.h.

◆ GetIGMPDisable()

bool CNTV2Config2022::GetIGMPDisable ( eSFP  sfp,
bool &  disabled 
)

Definition at line 1279 of file ntv2config2022.cpp.

◆ GetIGMPVersion()

bool CNTV2Config2022::GetIGMPVersion ( eIGMPVersion_t &  version)

Definition at line 1314 of file ntv2config2022.cpp.

◆ GetIPServicesControl()

bool CNTV2Config2022::GetIPServicesControl ( bool &  enable,
bool &  forceReconfig 
)

Definition at line 1651 of file ntv2config2022.cpp.

◆ GetJ2KDecoderConfiguration()

bool CNTV2Config2022::GetJ2KDecoderConfiguration ( j2kDecoderConfig &  j2kConfig)

Definition at line 1359 of file ntv2config2022.cpp.

◆ GetJ2KDecoderStatus()

bool CNTV2Config2022::GetJ2KDecoderStatus ( j2kDecoderStatus &  j2kStatus)

Definition at line 1371 of file ntv2config2022.cpp.

◆ GetJ2KEncoderConfiguration()

bool CNTV2Config2022::GetJ2KEncoderConfiguration ( const NTV2Channel  channel,
j2kEncoderConfig &  j2kConfig 
)

Definition at line 1334 of file ntv2config2022.cpp.

◆ getLastError()

std::string CNTV2Config2022::getLastError ( )

Definition at line 1504 of file ntv2config2022.cpp.

◆ getLastErrorCode()

NTV2IpError CNTV2Config2022::getLastErrorCode ( )

Definition at line 1509 of file ntv2config2022.cpp.

◆ GetLinkStatus()

bool CNTV2Config2022::GetLinkStatus ( eSFP  sfp,
SFPStatus &  sfpStatus 
)

Definition at line 1597 of file ntv2config2022.cpp.

◆ GetMACAddress()

bool CNTV2Config2022::GetMACAddress ( eSFP  sfp,
NTV2Stream  stream,
std::string  remoteIP,
uint32_t &  hi,
uint32_t &  lo 
)

Definition at line 1531 of file ntv2config2022.cpp.

◆ GetNetworkConfiguration() [1/2]

bool CNTV2Config2022::GetNetworkConfiguration ( const eSFP  sfp,
IPVNetConfig &  netConfig 
)

Definition at line 260 of file ntv2config2022.cpp.

◆ GetNetworkConfiguration() [2/2]

bool CNTV2Config2022::GetNetworkConfiguration ( const eSFP  sfp,
std::string &  localIPAddress,
std::string &  subnetMask,
std::string &  gateway 
)

Definition at line 355 of file ntv2config2022.cpp.

◆ GetRxChannelConfiguration()

bool CNTV2Config2022::GetRxChannelConfiguration ( const NTV2Channel  channel,
rx_2022_channel &  rxConfig 
)

Definition at line 583 of file ntv2config2022.cpp.

◆ GetRxChannelEnable()

bool CNTV2Config2022::GetRxChannelEnable ( const NTV2Channel  channel,
bool &  enabled 
)

Definition at line 785 of file ntv2config2022.cpp.

◆ GetSFPMSAData()

bool CNTV2Config2022::GetSFPMSAData ( eSFP  sfp,
SFPMSAData &  data 
)

Definition at line 1592 of file ntv2config2022.cpp.

◆ GetTxChannelConfiguration()

bool CNTV2Config2022::GetTxChannelConfiguration ( const NTV2Channel  channel,
tx_2022_channel &  txConfig 
)

Definition at line 952 of file ntv2config2022.cpp.

◆ GetTxChannelEnable()

bool CNTV2Config2022::GetTxChannelEnable ( const NTV2Channel  channel,
bool &  enabled 
)

Definition at line 1125 of file ntv2config2022.cpp.

◆ Set2022_7_Mode()

bool CNTV2Config2022::Set2022_7_Mode ( bool  enable,
uint32_t  rx_networkPathDifferential 
)

Definition at line 1145 of file ntv2config2022.cpp.

◆ SetBiDirectionalChannels()

void CNTV2Config2022::SetBiDirectionalChannels ( bool  bidirectional)
inline

Definition at line 207 of file ntv2config2022.h.

◆ SetIGMPDisable()

bool CNTV2Config2022::SetIGMPDisable ( eSFP  sfp,
bool  disable 
)

Disables the automatic (default) joining of multicast groups using IGMP, based on remote IP address for Rx Channels.

Parameters
[in]sfpSpecifies SFP connector used.
[in]disableIf true, IGMP messages will not be sent to join multicast groups
Note
When Rx channels are enabled for multicast IP addresses, by default the multicast group is joined. When Rx Channels are disabled, if the channel is the last user of the group, then the subscription to the multicast group will be ended. When IGMP is disabled, the above actions are not performed,

Definition at line 1265 of file ntv2config2022.cpp.

◆ SetIGMPVersion()

bool CNTV2Config2022::SetIGMPVersion ( eIGMPVersion_t  version)

Definition at line 1296 of file ntv2config2022.cpp.

◆ SetIPServicesControl()

bool CNTV2Config2022::SetIPServicesControl ( const bool  enable,
const bool  forceReconfig 
)

Definition at line 1637 of file ntv2config2022.cpp.

◆ SetJ2KDecoderConfiguration()

bool CNTV2Config2022::SetJ2KDecoderConfiguration ( const j2kDecoderConfig &  j2kConfig)

Definition at line 1346 of file ntv2config2022.cpp.

◆ SetJ2KEncoderConfiguration()

bool CNTV2Config2022::SetJ2KEncoderConfiguration ( const NTV2Channel  channel,
const j2kEncoderConfig &  j2kConfig 
)

Definition at line 1322 of file ntv2config2022.cpp.

◆ SetNetworkConfiguration() [1/2]

bool CNTV2Config2022::SetNetworkConfiguration ( const eSFP  sfp,
const IPVNetConfig &  netConfig 
)

Definition at line 245 of file ntv2config2022.cpp.

◆ SetNetworkConfiguration() [2/2]

bool CNTV2Config2022::SetNetworkConfiguration ( const eSFP  sfp,
const std::string  localIPAddress,
const std::string  subnetMask,
const std::string  gateway 
)

Definition at line 272 of file ntv2config2022.cpp.

◆ SetRxChannelConfiguration()

bool CNTV2Config2022::SetRxChannelConfiguration ( const NTV2Channel  channel,
const rx_2022_channel &  rxConfig 
)

Definition at line 398 of file ntv2config2022.cpp.

◆ SetRxChannelEnable()

bool CNTV2Config2022::SetRxChannelEnable ( const NTV2Channel  channel,
bool  enable 
)

Definition at line 670 of file ntv2config2022.cpp.

◆ SetTxChannelConfiguration()

bool CNTV2Config2022::SetTxChannelConfiguration ( const NTV2Channel  channel,
const tx_2022_channel &  txConfig 
)

Definition at line 831 of file ntv2config2022.cpp.

◆ SetTxChannelEnable()

bool CNTV2Config2022::SetTxChannelEnable ( const NTV2Channel  channel,
bool  enable 
)

Definition at line 1007 of file ntv2config2022.cpp.

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