AJA NTV2 SDK  17.1.1.1245
NTV2 SDK 17.1.1.1245
NTV2SDIInputStatus Class Reference

For devices that support it (see NTV2DeviceCanDoSDIErrorChecks ), this struct reports SDI input error status information. More...

#include <ntv2publicinterface.h>

Public Member Functions

 NTV2SDIInputStatus ()
 Constructs a default NTV2SDIInputStatus. More...
 
void Clear (void)
 Constructs a default NTV2SDIInputStatus. More...
 
std::ostream & Print (std::ostream &inOutStream) const
 Prints a human-readable representation of me into the given output stream. More...
 

Public Attributes

UWord mCRCTallyA
 The number of lines having a CRC error was detected in the "B" stream of the SDI link since this tally was last reset. More...
 
UWord mCRCTallyB
 The number of lines having a CRC error was detected in the "A" stream of the SDI link since this tally was last reset. More...
 
ULWord mUnlockTally
 The number of times "RX Locked" went inactive since this tally was last reset. More...
 
ULWord64 mFrameRefClockCount
 This count is incremented on each 148.xx reference clock, and latched at EAV for each frame. More...
 
ULWord64 mGlobalClockCount
 This count is incremented on each 148.xx reference clock. More...
 
bool mFrameTRSError
 If true, SAV/EAV was missing, or the SDI framer had to realign, or "RX Locked" went inactive. This is updated once per frame (unless vertical timing is absent on the input). More...
 
bool mLocked
 If true, a valid SDI transport was detected in the received data stream. If false, at least 15 consecutive lines in the received stream had TRS errors. More...
 
bool mVPIDValidA
 If true, at least one valid SMPTE 352 packet was received over the last four VBI periods. More...
 
bool mVPIDValidB
 If true, at least one valid SMPTE 352 packet was received over the last four VBI periods. More...
 

Detailed Description

For devices that support it (see NTV2DeviceCanDoSDIErrorChecks ), this struct reports SDI input error status information.

Note
This struct uses a constructor to properly initialize itself. Do not use memset or bzero to initialize or "clear" it.

Definition at line 6866 of file ntv2publicinterface.h.

Constructor & Destructor Documentation

◆ NTV2SDIInputStatus()

NTV2SDIInputStatus::NTV2SDIInputStatus ( )
explicit

Constructs a default NTV2SDIInputStatus.

Definition at line 112 of file ntv2publicinterface.cpp.

Member Function Documentation

◆ Clear()

void NTV2SDIInputStatus::Clear ( void  )

Constructs a default NTV2SDIInputStatus.

Definition at line 118 of file ntv2publicinterface.cpp.

◆ Print()

ostream & NTV2SDIInputStatus::Print ( std::ostream &  inOutStream) const

Prints a human-readable representation of me into the given output stream.

Parameters
inOutStreamThe output stream to receive my human-readable representation.
Returns
A reference to the given output stream.

Definition at line 132 of file ntv2publicinterface.cpp.

Member Data Documentation

◆ mCRCTallyA

UWord NTV2SDIInputStatus::mCRCTallyA

The number of lines having a CRC error was detected in the "B" stream of the SDI link since this tally was last reset.

Definition at line 6867 of file ntv2publicinterface.h.

◆ mCRCTallyB

UWord NTV2SDIInputStatus::mCRCTallyB

The number of lines having a CRC error was detected in the "A" stream of the SDI link since this tally was last reset.

Definition at line 6869 of file ntv2publicinterface.h.

◆ mFrameRefClockCount

ULWord64 NTV2SDIInputStatus::mFrameRefClockCount

This count is incremented on each 148.xx reference clock, and latched at EAV for each frame.

Definition at line 6873 of file ntv2publicinterface.h.

◆ mFrameTRSError

bool NTV2SDIInputStatus::mFrameTRSError

If true, SAV/EAV was missing, or the SDI framer had to realign, or "RX Locked" went inactive. This is updated once per frame (unless vertical timing is absent on the input).

Definition at line 6875 of file ntv2publicinterface.h.

◆ mGlobalClockCount

ULWord64 NTV2SDIInputStatus::mGlobalClockCount

This count is incremented on each 148.xx reference clock.

Definition at line 6874 of file ntv2publicinterface.h.

◆ mLocked

bool NTV2SDIInputStatus::mLocked

If true, a valid SDI transport was detected in the received data stream. If false, at least 15 consecutive lines in the received stream had TRS errors.

Definition at line 6877 of file ntv2publicinterface.h.

◆ mUnlockTally

ULWord NTV2SDIInputStatus::mUnlockTally

The number of times "RX Locked" went inactive since this tally was last reset.

Definition at line 6871 of file ntv2publicinterface.h.

◆ mVPIDValidA

bool NTV2SDIInputStatus::mVPIDValidA

If true, at least one valid SMPTE 352 packet was received over the last four VBI periods.

Definition at line 6879 of file ntv2publicinterface.h.

◆ mVPIDValidB

bool NTV2SDIInputStatus::mVPIDValidB

If true, at least one valid SMPTE 352 packet was received over the last four VBI periods.

Definition at line 6880 of file ntv2publicinterface.h.


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