AJA NTV2 SDK  17.0.1.1246
NTV2 SDK 17.0.1.1246
ntv2devicescanner.h File Reference

Declares the CNTV2DeviceScanner class. More...

#include "ntv2audiodefines.h"
#include "ntv2card.h"
#include <vector>
#include <algorithm>
Include dependency graph for ntv2devicescanner.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes

struct  NTV2DeviceInfo
 
struct  NTV2AudioPhysicalFormat
 
class  CNTV2DeviceScanner
 This class is used to enumerate AJA devices that are attached and known to the local host computer. More...
 

Typedefs

typedef std::vector< AudioSampleRateEnumNTV2AudioSampleRateList
 
typedef NTV2AudioSampleRateList::const_iterator NTV2AudioSampleRateListConstIter
 
typedef NTV2AudioSampleRateList::iterator NTV2AudioSampleRateListIter
 
typedef std::vector< AudioChannelsPerFrameEnumNTV2AudioChannelsPerFrameList
 
typedef NTV2AudioChannelsPerFrameList::const_iterator NTV2AudioChannelsPerFrameListConstIter
 
typedef NTV2AudioChannelsPerFrameList::iterator NTV2AudioChannelsPerFrameListIter
 
typedef std::vector< AudioSourceEnumNTV2AudioSourceList
 
typedef NTV2AudioSourceList::const_iterator NTV2AudioSourceListConstIter
 
typedef NTV2AudioSourceList::iterator NTV2AudioSourceListIter
 
typedef std::vector< AudioBitsPerSampleEnumNTV2AudioBitsPerSampleList
 
typedef NTV2AudioBitsPerSampleList::const_iterator NTV2AudioBitsPerSampleListConstIter
 
typedef NTV2AudioBitsPerSampleList::iterator NTV2AudioBitsPerSampleListIter
 
typedef struct NTV2DeviceInfo NTV2DeviceInfo
 
typedef std::vector< NTV2DeviceInfoNTV2DeviceInfoList
 I am an ordered list of NTV2DeviceInfo structs. More...
 
typedef NTV2DeviceInfoList::const_iterator NTV2DeviceInfoListConstIter
 
typedef NTV2DeviceInfoList::iterator NTV2DeviceInfoListIter
 
typedef std::vector< NTV2AudioPhysicalFormatNTV2AudioPhysicalFormatList
 I am an ordered list of NTV2AudioPhysicalFormat structs. More...
 
typedef NTV2AudioPhysicalFormatList::const_iterator NTV2AudioPhysicalFormatListConstIter
 
typedef NTV2AudioPhysicalFormatList::iterator NTV2AudioPhysicalFormatListIter
 

Functions

std::ostream & operator<< (std::ostream &inOutStr, const NTV2AudioSampleRateList &inList)
 Streams the NTV2AudioSampleRateList to the given output stream in a human-readable format. More...
 
std::ostream & operator<< (std::ostream &inOutStr, const NTV2AudioChannelsPerFrameList &inList)
 Streams the NTV2AudioChannelsPerFrameList to the given output stream in a human-readable format. More...
 
std::ostream & operator<< (std::ostream &inOutStr, const NTV2AudioSourceList &inList)
 Streams the NTV2AudioSourceList to the given output stream in a human-readable format. More...
 
std::ostream & operator<< (std::ostream &inOutStr, const NTV2AudioBitsPerSampleList &inList)
 Streams the NTV2AudioBitsPerSampleList to the given output stream in a human-readable format. More...
 
std::ostream & operator<< (std::ostream &inOutStr, const NTV2DeviceInfo &inInfo)
 Streams the NTV2DeviceInfo to the given output stream in a human-readable format. More...
 
std::ostream & operator<< (std::ostream &inOutStr, const NTV2DeviceInfoList &inList)
 Streams the NTV2DeviceInfoList to an output stream in a human-readable format. More...
 
std::ostream & operator<< (std::ostream &inOutStr, const NTV2AudioPhysicalFormat &inFormat)
 Streams the AudioPhysicalFormat to an output stream in a human-readable format. More...
 
std::ostream & operator<< (std::ostream &inOutStr, const NTV2AudioPhysicalFormatList &inList)
 Streams the AudioPhysicalFormatList to an output stream in a human-readable format. More...
 

Detailed Description

Declares the CNTV2DeviceScanner class.

Definition in file ntv2devicescanner.h.

Typedef Documentation

◆ NTV2AudioBitsPerSampleList

Definition at line 29 of file ntv2devicescanner.h.

◆ NTV2AudioBitsPerSampleListConstIter

typedef NTV2AudioBitsPerSampleList::const_iterator NTV2AudioBitsPerSampleListConstIter

Definition at line 30 of file ntv2devicescanner.h.

◆ NTV2AudioBitsPerSampleListIter

typedef NTV2AudioBitsPerSampleList::iterator NTV2AudioBitsPerSampleListIter

Definition at line 31 of file ntv2devicescanner.h.

◆ NTV2AudioChannelsPerFrameList

Definition at line 21 of file ntv2devicescanner.h.

◆ NTV2AudioChannelsPerFrameListConstIter

typedef NTV2AudioChannelsPerFrameList::const_iterator NTV2AudioChannelsPerFrameListConstIter

Definition at line 22 of file ntv2devicescanner.h.

◆ NTV2AudioChannelsPerFrameListIter

typedef NTV2AudioChannelsPerFrameList::iterator NTV2AudioChannelsPerFrameListIter

Definition at line 23 of file ntv2devicescanner.h.

◆ NTV2AudioPhysicalFormatList

I am an ordered list of NTV2AudioPhysicalFormat structs.

Definition at line 190 of file ntv2devicescanner.h.

◆ NTV2AudioPhysicalFormatListConstIter

typedef NTV2AudioPhysicalFormatList::const_iterator NTV2AudioPhysicalFormatListConstIter

Definition at line 191 of file ntv2devicescanner.h.

◆ NTV2AudioPhysicalFormatListIter

typedef NTV2AudioPhysicalFormatList::iterator NTV2AudioPhysicalFormatListIter

Definition at line 192 of file ntv2devicescanner.h.

◆ NTV2AudioSampleRateList

Definition at line 17 of file ntv2devicescanner.h.

◆ NTV2AudioSampleRateListConstIter

typedef NTV2AudioSampleRateList::const_iterator NTV2AudioSampleRateListConstIter

Definition at line 18 of file ntv2devicescanner.h.

◆ NTV2AudioSampleRateListIter

typedef NTV2AudioSampleRateList::iterator NTV2AudioSampleRateListIter

Definition at line 19 of file ntv2devicescanner.h.

◆ NTV2AudioSourceList

typedef std::vector<AudioSourceEnum> NTV2AudioSourceList

Definition at line 25 of file ntv2devicescanner.h.

◆ NTV2AudioSourceListConstIter

typedef NTV2AudioSourceList::const_iterator NTV2AudioSourceListConstIter

Definition at line 26 of file ntv2devicescanner.h.

◆ NTV2AudioSourceListIter

typedef NTV2AudioSourceList::iterator NTV2AudioSourceListIter

Definition at line 27 of file ntv2devicescanner.h.

◆ NTV2DeviceInfo

Deprecated:
Please use the functions provided in 'ntv2devicefeatures.h' and 'ntv2devicefeatures.hh' instead.

◆ NTV2DeviceInfoList

typedef std::vector<NTV2DeviceInfo> NTV2DeviceInfoList

I am an ordered list of NTV2DeviceInfo structs.

Definition at line 154 of file ntv2devicescanner.h.

◆ NTV2DeviceInfoListConstIter

typedef NTV2DeviceInfoList::const_iterator NTV2DeviceInfoListConstIter

Definition at line 155 of file ntv2devicescanner.h.

◆ NTV2DeviceInfoListIter

typedef NTV2DeviceInfoList::iterator NTV2DeviceInfoListIter

Definition at line 156 of file ntv2devicescanner.h.

Function Documentation

◆ operator<<() [1/8]

std::ostream& operator<< ( std::ostream &  inOutStr,
const NTV2AudioBitsPerSampleList inList 
)

Streams the NTV2AudioBitsPerSampleList to the given output stream in a human-readable format.

Parameters
inOutStrThe output stream into which the NTV2AudioBitsPerSampleList is to be streamed.
[in]inListSpecifies the NTV2AudioBitsPerSampleList to be streamed.
Returns
The output stream.

◆ operator<<() [2/8]

std::ostream& operator<< ( std::ostream &  inOutStr,
const NTV2AudioChannelsPerFrameList inList 
)

Streams the NTV2AudioChannelsPerFrameList to the given output stream in a human-readable format.

Parameters
inOutStrThe output stream into which the NTV2AudioChannelsPerFrameList is to be streamed.
[in]inListSpecifies the NTV2AudioChannelsPerFrameList to be streamed.
Returns
The output stream.

◆ operator<<() [3/8]

std::ostream& operator<< ( std::ostream &  inOutStr,
const NTV2AudioPhysicalFormat inFormat 
)

Streams the AudioPhysicalFormat to an output stream in a human-readable format.

Parameters
inOutStrThe output stream into which the AudioPhysicalFormat is to be streamed.
[in]inFormatSpecifies the AudioPhysicalFormat to be streamed.
Returns
The output stream.

◆ operator<<() [4/8]

std::ostream& operator<< ( std::ostream &  inOutStr,
const NTV2AudioPhysicalFormatList inList 
)

Streams the AudioPhysicalFormatList to an output stream in a human-readable format.

Parameters
inOutStrThe output stream into which the AudioPhysicalFormatList is to be streamed.
[in]inListSpecifies the AudioPhysicalFormatList to be streamed.
Returns
The output stream.

Definition at line 610 of file ntv2devicescanner.cpp.

◆ operator<<() [5/8]

std::ostream& operator<< ( std::ostream &  inOutStr,
const NTV2AudioSampleRateList inList 
)

Streams the NTV2AudioSampleRateList to the given output stream in a human-readable format.

Parameters
inOutStrThe output stream into which the NTV2AudioSampleRateList is to be streamed.
[in]inListSpecifies the NTV2AudioSampleRateList to be streamed.
Returns
The output stream.

◆ operator<<() [6/8]

std::ostream& operator<< ( std::ostream &  inOutStr,
const NTV2AudioSourceList inList 
)

Streams the NTV2AudioSourceList to the given output stream in a human-readable format.

Parameters
inOutStrThe output stream into which the NTV2AudioSourceList is to be streamed.
[in]inListSpecifies the NTV2AudioSourceList to be streamed.
Returns
The output stream.

◆ operator<<() [7/8]

std::ostream& operator<< ( std::ostream &  inOutStr,
const NTV2DeviceInfo inInfo 
)

Streams the NTV2DeviceInfo to the given output stream in a human-readable format.

Parameters
inOutStrThe output stream into which the NTV2DeviceInfo is to be streamed.
[in]inInfoSpecifies the NTV2DeviceInfo to be streamed.
Returns
The output stream.

◆ operator<<() [8/8]

std::ostream& operator<< ( std::ostream &  inOutStr,
const NTV2DeviceInfoList inList 
)

Streams the NTV2DeviceInfoList to an output stream in a human-readable format.

Parameters
inOutStrThe output stream into which the NTV2DeviceInfoList is to be streamed.
[in]inListSpecifies the NTV2DeviceInfoList to be streamed.
Returns
The output stream.