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)
	Clears (zeroes) all of my member variables. More...

bool	isLocked (void) const

ULWord	unlockTally (void) const

UWord	CRCLines (const UWord ndx=0) const

bool	hasFrameTRSError (void) const

bool	hasValidVPID (const UWord ndx=0) const

std::ostream &	Print (std::ostream &oStream) 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 on Link A over the last 4 VBI periods. More...

bool	mVPIDValidB
	If true, at least one valid SMPTE 352 packet was received on Link B over the last 4 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 7155 of file ntv2publicinterface.h.

Constructor & Destructor Documentation

◆ NTV2SDIInputStatus()

NTV2SDIInputStatus::NTV2SDIInputStatus ( )

explicit

Constructs a default NTV2SDIInputStatus.

Definition at line 137 of file ntv2publicinterface.cpp.

Member Function Documentation

◆ Clear()

void NTV2SDIInputStatus::Clear ( void )

Clears (zeroes) all of my member variables.

Definition at line 143 of file ntv2publicinterface.cpp.

◆ CRCLines()

UWord NTV2SDIInputStatus::CRCLines ( const UWord ndx = 0 ) const

inline

Returns: the number of lines having a CRC error detected in the given stream since last reset.

Parameters

[in] ndx Specifies the link index (0=="A", 1=="B"). Defaults to Link "A".

Definition at line 7179 of file ntv2publicinterface.h.

◆ hasFrameTRSError()

bool NTV2SDIInputStatus::hasFrameTRSError ( void ) const

inline

Returns: true if SAV/EAV missing or SDI framer had to realign, or "RX Locked" went inactive; (Updated once per frame unless timing is absent on input.)

Definition at line 7180 of file ntv2publicinterface.h.

◆ hasValidVPID()

bool NTV2SDIInputStatus::hasValidVPID ( const UWord ndx = 0 ) const

inline

Returns: true if at least one valid SMPTE 352 packet was received on the given link over the last 4 VBI periods.

Parameters

[in] ndx Specifies the link index (0=="A", 1=="B"). Defaults to Link "A".

Definition at line 7186 of file ntv2publicinterface.h.

◆ isLocked()

bool NTV2SDIInputStatus::isLocked ( void ) const

inline

Returns: true if a valid SDI transport was detected in the received data stream; otherwise at least 15 consecutive lines in the received stream had TRS errors

Definition at line 7172 of file ntv2publicinterface.h.

◆ Print()

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

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

Parameters

oStream The output stream to receive the information.

Returns: A reference to the given output stream.

Definition at line 157 of file ntv2publicinterface.cpp.

◆ unlockTally()

ULWord NTV2SDIInputStatus::unlockTally ( void ) const

inline

Returns: the number of times "RX Locked" went inactive since last reset.

Definition at line 7174 of file ntv2publicinterface.h.

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 7156 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 7158 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 7161 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 7163 of file ntv2publicinterface.h.

◆ mGlobalClockCount

ULWord64 NTV2SDIInputStatus::mGlobalClockCount

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

Definition at line 7162 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 7165 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 7160 of file ntv2publicinterface.h.

◆ mVPIDValidA

bool NTV2SDIInputStatus::mVPIDValidA

If true, at least one valid SMPTE 352 packet was received on Link A over the last 4 VBI periods.

Definition at line 7167 of file ntv2publicinterface.h.

◆ mVPIDValidB

bool NTV2SDIInputStatus::mVPIDValidB

If true, at least one valid SMPTE 352 packet was received on Link B over the last 4 VBI periods.

Definition at line 7168 of file ntv2publicinterface.h.

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

/home/tcbuilder/buildAgent/work/df8e8cce5bebfd58/libajantv2/ajantv2/includes/ntv2publicinterface.h
/home/tcbuilder/buildAgent/work/df8e8cce5bebfd58/libajantv2/ajantv2/src/ntv2publicinterface.cpp

Public Member Functions

Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ NTV2SDIInputStatus()

Member Function Documentation

◆ Clear()

◆ CRCLines()

◆ hasFrameTRSError()

◆ hasValidVPID()

◆ isLocked()

◆ Print()

◆ unlockTally()

Member Data Documentation

◆ mCRCTallyA

◆ mCRCTallyB

◆ mFrameRefClockCount

◆ mFrameTRSError

◆ mGlobalClockCount

◆ mLocked

◆ mUnlockTally

◆ mVPIDValidA

◆ mVPIDValidB