Declares the AJAAncillaryList class. More...

#include "ancillarydata.h"
#include "ntv2formatdescriptor.h"
#include <map>
#include <set>
#include <vector>

Include dependency graph for ancillarylist.h:

This graph shows which files directly or indirectly include this file:

Classes
class	AJAAncillaryList
	I am an ordered collection of AJAAncillaryData instances which represent one or more SMPTE 291 data packets that were captured from, or destined to be played into, one video field or frame. I can be built from the ancillary data received by the hardware during one field/frame, and/or built "from scratch" and used as the source of outgoing ancillary data to hardware. More...

Macros
#define	AJAANCLISTIMPL_VECTOR

Typedefs
typedef std::map< uint16_t, AJAAncDataType >	AJAAncillaryAnalogTypeMap
	Associates certain frame line numbers with specific types of "raw" or "analog" ancillary data. For example, you may wish to associate line 21 (in 525i) with AJAAncDataType_Cea608_Line21. More...

typedef std::vector< ULWordSequence >	AJAU32Pkts
	Ordered sequence of U32 RTP packets (U32s in network byte order) More...

typedef AJAU32Pkts::const_iterator	AJAU32PktsConstIter
	Handy const iterator over AJAU32Pkts. More...

typedef AJAU32Pkts::iterator	AJAU32PktsIter
	Handy non-const iterator over AJAU32Pkts. More...

typedef UByteSequence	AJAAncPktCounts
	Ordered sequence of SMPTE Anc packet counts. More...

typedef AJAAncPktCounts::const_iterator	AJAAncPktCountsConstIter
	Handy const iterator over AJAAncPktCounts. More...

typedef std::set< AJAAncPktDIDSID >	AJAAncPktDIDSIDSet
	Set of distinct packet DID/SIDs (New in SDK 16.0) More...

typedef AJAAncPktDIDSIDSet::const_iterator	AJAAncPktDIDSIDSetConstIter
	Handy const iterator for AJAAncPktDIDSIDSet (New in SDK 16.0) More...

typedef AJAAncPktDIDSIDSet::iterator	AJAAncPktDIDSIDSetIter
	Handy non-const iterator for AJAAncPktDIDSIDSet (New in SDK 16.0) More...

typedef AJAAncillaryList	AJAAuxiliaryList

typedef AJAAncillaryList	AJAAncList

typedef AJAAncillaryList	AJAAuxList

Functions
std::ostream &	operator<< (std::ostream &inOutStream, const AJAAncillaryList &inList)
	Writes a human-readable rendition of the given AJAAncillaryList into the given output stream. More...

std::ostream &	operator<< (std::ostream &inOutStream, const AJAU32Pkts &inPkts)
	Writes the given AJAU32Pkts object into the given output stream in a human-readable format. More...

std::ostream &	operator<< (std::ostream &inOutStream, const AJAAncPktDIDSIDSet &inSet)
	Writes the given AJAAncPktDIDSIDSet set into the given output stream in a human-readable format. More...

Variables
const uint8_t	AJAAncillaryDataWildcard_DID = 0xFF

const uint8_t	AJAAncillaryDataWildcard_SID = 0xFF

Detailed Description

Declares the AJAAncillaryList class.

Copyright: (C) 2010-2022 AJA Video Systems, Inc.

Definition in file ancillarylist.h.

Macro Definition Documentation

◆ AJAANCLISTIMPL_VECTOR

#define AJAANCLISTIMPL_VECTOR

Definition at line 18 of file ancillarylist.h.

Typedef Documentation

◆ AJAAncillaryAnalogTypeMap

typedef std::map<uint16_t, AJAAncDataType> AJAAncillaryAnalogTypeMap

Associates certain frame line numbers with specific types of "raw" or "analog" ancillary data. For example, you may wish to associate line 21 (in 525i) with AJAAncDataType_Cea608_Line21.

Note: This facility is ONLY used by AJAAncillaryList::AddReceivedAncillaryData to identify captured "raw" data (AJAAncillaryDataCoding_Analog).

Definition at line 36 of file ancillarylist.h.

◆ AJAAncList

typedef AJAAncillaryList AJAAncList

Definition at line 711 of file ancillarylist.h.

◆ AJAAncPktCounts

typedef UByteSequence AJAAncPktCounts

Ordered sequence of SMPTE Anc packet counts.

Definition at line 42 of file ancillarylist.h.

◆ AJAAncPktCountsConstIter

typedef AJAAncPktCounts::const_iterator AJAAncPktCountsConstIter

Handy const iterator over AJAAncPktCounts.

Definition at line 43 of file ancillarylist.h.

◆ AJAAncPktDIDSIDSet

typedef std::set<AJAAncPktDIDSID> AJAAncPktDIDSIDSet

Set of distinct packet DID/SIDs (New in SDK 16.0)

Definition at line 44 of file ancillarylist.h.

◆ AJAAncPktDIDSIDSetConstIter

typedef AJAAncPktDIDSIDSet::const_iterator AJAAncPktDIDSIDSetConstIter

Handy const iterator for AJAAncPktDIDSIDSet (New in SDK 16.0)

Definition at line 47 of file ancillarylist.h.

◆ AJAAncPktDIDSIDSetIter

typedef AJAAncPktDIDSIDSet::iterator AJAAncPktDIDSIDSetIter

Handy non-const iterator for AJAAncPktDIDSIDSet (New in SDK 16.0)

Definition at line 48 of file ancillarylist.h.

◆ AJAAuxiliaryList

typedef AJAAncillaryList AJAAuxiliaryList

Definition at line 711 of file ancillarylist.h.

◆ AJAAuxList

typedef AJAAncillaryList AJAAuxList

Definition at line 711 of file ancillarylist.h.

◆ AJAU32Pkts

typedef std::vector<ULWordSequence> AJAU32Pkts

Ordered sequence of U32 RTP packets (U32s in network byte order)

Definition at line 38 of file ancillarylist.h.

◆ AJAU32PktsConstIter

typedef AJAU32Pkts::const_iterator AJAU32PktsConstIter

Handy const iterator over AJAU32Pkts.

Definition at line 39 of file ancillarylist.h.

◆ AJAU32PktsIter

typedef AJAU32Pkts::iterator AJAU32PktsIter

Handy non-const iterator over AJAU32Pkts.

Definition at line 40 of file ancillarylist.h.

Function Documentation

◆ operator<<() [1/3]

std::ostream& operator<<	(	std::ostream &	inOutStream,
		const AJAAncillaryList &	inList
	)

inline

Writes a human-readable rendition of the given AJAAncillaryList into the given output stream.

Parameters

	inOutStream	Specifies the output stream to be written.
[in]	inList	Specifies the AJAAncillaryList to be rendered into the output stream.

Returns: A non-constant reference to the specified output stream.

Definition at line 720 of file ancillarylist.h.

◆ operator<<() [2/3]

std::ostream& operator<<	(	std::ostream &	inOutStream,
		const AJAAncPktDIDSIDSet &	inSet
	)

Writes the given AJAAncPktDIDSIDSet set into the given output stream in a human-readable format.

Parameters

	inOutStream	Specifies the output stream to be written.
[in]	inSet	Specifies the AJAAncPktDIDSIDSet to be rendered into the output stream.

Returns: A non-constant reference to the specified output stream.

◆ operator<<() [3/3]

std::ostream& operator<<	(	std::ostream &	inOutStream,
		const AJAU32Pkts &	inPkts
	)

Writes the given AJAU32Pkts object into the given output stream in a human-readable format.

Parameters

	inOutStream	Specifies the output stream to be written.
[in]	inPkts	Specifies the AJAU32Pkts object to be rendered into the output stream.

Returns: A non-constant reference to the specified output stream.

Variable Documentation

◆ AJAAncillaryDataWildcard_DID

const uint8_t AJAAncillaryDataWildcard_DID = 0xFF

Definition at line 27 of file ancillarylist.h.

◆ AJAAncillaryDataWildcard_SID

const uint8_t AJAAncillaryDataWildcard_SID = 0xFF

Definition at line 28 of file ancillarylist.h.

Classes

Macros

Typedefs

Functions

Variables

Detailed Description

Macro Definition Documentation

◆ AJAANCLISTIMPL_VECTOR

Typedef Documentation

◆ AJAAncillaryAnalogTypeMap

◆ AJAAncList

◆ AJAAncPktCounts

◆ AJAAncPktCountsConstIter

◆ AJAAncPktDIDSIDSet

◆ AJAAncPktDIDSIDSetConstIter

◆ AJAAncPktDIDSIDSetIter

◆ AJAAuxiliaryList

◆ AJAAuxList

◆ AJAU32Pkts

◆ AJAU32PktsConstIter

◆ AJAU32PktsIter

Function Documentation

◆ operator<<() [1/3]

◆ operator<<() [2/3]

◆ operator<<() [3/3]

Variable Documentation

◆ AJAAncillaryDataWildcard_DID

◆ AJAAncillaryDataWildcard_SID