NTV2SmpteLineNumber Struct Reference

Used to describe Start of Active Video (SAV) location and field dominance for a given NTV2Standard. (See GetSmpteLineNumber function.) More...

#include <ntv2utils.h>

Public Member Functions
	NTV2SmpteLineNumber (const NTV2Standard inStandard=NTV2_STANDARD_INVALID)
	Constructs me from a given NTV2Standard. More...
bool	IsValid (void) const
ULWord	GetFirstActiveLine (const NTV2FieldID inRasterFieldID=NTV2_FIELD0) const
ULWord	GetLastLine (const NTV2FieldID inRasterFieldID=NTV2_FIELD0) const
bool	operator== (const NTV2SmpteLineNumber &inRHS) const
std::ostream &	Print (std::ostream &inOutStream) const
	Writes a human-readable description of me into the given output stream. More...
std::string	PrintLineNumber (const ULWord inLineOffset=0, const NTV2FieldID inRasterFieldID=NTV2_FIELD0) const

Public Attributes
ULWord	smpteFirstActiveLine
	SMPTE line number of first (top-most) active line of video. More...
ULWord	smpteSecondActiveLine
	SMPTE line number of second active line of video. More...
bool	firstFieldTop
	True if the first field on the wire is the top-most field in the raster (field dominance) More...

Detailed Description

Used to describe Start of Active Video (SAV) location and field dominance for a given NTV2Standard. (See GetSmpteLineNumber function.)

Definition at line 877 of file ntv2utils.h.

Constructor & Destructor Documentation

NTV2SmpteLineNumber()

NTV2SmpteLineNumber::NTV2SmpteLineNumber ( const NTV2Standard  inStandard = NTV2_STANDARD_INVALID )

explicit

Constructs me from a given NTV2Standard.

Parameters

[in]

inStandard

Specifies the NTV2Standard.

Definition at line 1384 of file ntv2formatdescriptor.cpp.

Member Function Documentation

GetFirstActiveLine()

ULWord NTV2SmpteLineNumber::GetFirstActiveLine

(

const NTV2FieldID

inRasterFieldID = NTV2_FIELD0

)

const

Returns

The SMPTE line number of the Start of Active Video (SAV).

Parameters

[in]

inRasterFieldID

Specifies a valid raster field ID (not the wire field ID). Defaults to NTV2_FIELD0 (i.e. first field) of the raster. Use NTV2_FIELD1 for the starting line of a PsF frame.

Definition at line 4123 of file ntv2utils.cpp.

GetLastLine()

ULWord NTV2SmpteLineNumber::GetLastLine

(

const NTV2FieldID

inRasterFieldID = NTV2_FIELD0

)

const

Returns

The SMPTE line number of the last raster line.

Parameters

[in]

inRasterFieldID

Specifies a valid raster field ID (not the wire field ID). Defaults to NTV2_FIELD0 (i.e. first field) of the raster. Use NTV2_FIELD1 for the starting line of a PsF frame.

Definition at line 1391 of file ntv2formatdescriptor.cpp.

IsValid()

bool NTV2SmpteLineNumber::IsValid ( void  ) const

inline

Returns

True if valid; otherwise false.

Definition at line 895 of file ntv2utils.h.

operator==()

bool NTV2SmpteLineNumber::operator==

(

const NTV2SmpteLineNumber &

inRHS

)

const

Returns

True if I'm equal to the given NTV2SmpteLineNumber.

Parameters

[in]

inRHS

The right-hand-side operand that I'll be compared with.

Print()

ostream & NTV2SmpteLineNumber::Print

(

std::ostream &

inOutStream

)

const

Writes a human-readable description of me into the given output stream.

Parameters

inOutStream

The output stream to be written into.

Returns

The output stream I was handed.

Definition at line 4135 of file ntv2utils.cpp.

PrintLineNumber()

string NTV2SmpteLineNumber::PrintLineNumber	(	const ULWord	inLineOffset = 0,
		const NTV2FieldID	inRasterFieldID = NTV2_FIELD0
	)		const

Parameters

[in]	inLineOffset	Specifies a line offset to add to the printed SMPTE line number. Defaults to zero.
[in]	inRasterFieldID	Specifies a valid raster field ID (not the wire field ID). Defaults to NTV2_FIELD0 (i.e. first field) of the raster.

Returns

A string containing the human-readable line number.

Definition at line 4150 of file ntv2utils.cpp.

Member Data Documentation

firstFieldTop

bool NTV2SmpteLineNumber::firstFieldTop

True if the first field on the wire is the top-most field in the raster (field dominance)

Definition at line 881 of file ntv2utils.h.

smpteFirstActiveLine

ULWord NTV2SmpteLineNumber::smpteFirstActiveLine

SMPTE line number of first (top-most) active line of video.

Definition at line 879 of file ntv2utils.h.

smpteSecondActiveLine

ULWord NTV2SmpteLineNumber::smpteSecondActiveLine

SMPTE line number of second active line of video.

Definition at line 880 of file ntv2utils.h.

---

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

• /home/tcbuilder/buildAgent/work/df8e8cce5bebfd58/libajantv2/ajantv2/includes/ntv2utils.h
• /home/tcbuilder/buildAgent/work/df8e8cce5bebfd58/libajantv2/ajantv2/src/ntv2formatdescriptor.cpp
• /home/tcbuilder/buildAgent/work/df8e8cce5bebfd58/libajantv2/ajantv2/src/ntv2utils.cpp