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

#include <ntv2devicescanner.h>

Public Member Functions
	CNTV2DeviceScanner (const bool inScanNow=(!(0)))

	CNTV2DeviceScanner (bool inScanNow, UWord inDeviceMask)

Static Public Member Functions
static bool	GetDeviceAtIndex (const ULWord inDeviceIndexNumber, CNTV2Card &outDevice)
	Rescans the host, and returns an open CNTV2Card instance for the AJA device having the given zero-based index number. More...

static bool	GetFirstDeviceWithID (const NTV2DeviceID inDeviceID, CNTV2Card &outDevice)
	Rescans the host, and returns an open CNTV2Card instance for the first AJA device found on the host that has the given NTV2DeviceID. More...

static bool	GetFirstDeviceWithName (const std::string &inNameSubString, CNTV2Card &outDevice)
	Rescans the host, and returns an open CNTV2Card instance for the first AJA device whose device identifier name contains the given substring. More...

static bool	GetVirtualDeviceWithName (const std::string &inNameString, CNTV2Card &outDevice, const bool inRescan=(!(0)))
	Rescans the host, and returns an open CNTV2Card instance for the first virtual device with a matching name. More...

static bool	GetFirstDeviceWithSerial (const std::string &inSerialStr, CNTV2Card &outDevice)
	Rescans the host, and returns an open CNTV2Card instance for the first AJA device whose serial number contains the given value. More...

static bool	GetDeviceWithSerial (const std::string &inSerialNumber, CNTV2Card &outDevice)
	Rescans the host, and returns an open CNTV2Card instance for the first AJA device whose serial number matches the given value. More...

static bool	GetFirstDeviceFromArgument (const std::string &inArgument, CNTV2Card &outDevice)
	Rescans the host, and returns an open CNTV2Card instance for the AJA device that matches a command line argument according to the following evaluation sequence: 1 or 2 digit unsigned decimal integer: a zero-based device index number; 8 or 9 character alphanumeric string: device with a matching serial number string (case-insensitive comparison); 3-16 character hexadecimal integer, optionally preceded by '0x': device having a matching 64-bit serial number; All other cases: first device (lowest index number) whose name contains the argument string (compared case-insensitively). More...

static size_t	GetNumDevices (void)

static std::string	GetDeviceRefName (CNTV2Card &inDevice)

static bool	IsLegalSerialNumber (const std::string &inStr)

static bool	IsLegalDecimalNumber (const std::string &inStr, const size_t maxLen=2)

static uint64_t	IsLegalHexSerialNumber (const std::string &inStr)

static bool	IsHexDigit (const char inChr)

static bool	IsDecimalDigit (const char inChr)

static bool	IsAlphaNumeric (const char inStr)

static bool	IsAlphaNumeric (const std::string &inStr)

static bool	GetDeviceWithSerial (const uint64_t sn, CNTV2Card &dev)

static void	ScanHardware (void)

static void	ScanHardware (const UWord inMask)

static bool	DeviceIDPresent (const NTV2DeviceID inDeviceID, const bool inRescan=(0))

static bool	GetDeviceInfo (const ULWord inDeviceIndexNumber, NTV2DeviceInfo &outDeviceInfo, const bool inRescan=(0))

static NTV2DeviceInfoList	GetDeviceInfoList (void)

static void	SortDeviceInfoList (void)

static bool	CompareDeviceInfoLists (const NTV2DeviceInfoList &inOldList, const NTV2DeviceInfoList &inNewList, NTV2DeviceInfoList &outDevicesAdded, NTV2DeviceInfoList &outDevicesRemoved)

Detailed Description

This class is used to enumerate AJA devices that are attached and known to the local host computer.

Definition at line 212 of file ntv2devicescanner.h.

Constructor & Destructor Documentation

◆ CNTV2DeviceScanner() [1/2]

CNTV2DeviceScanner::CNTV2DeviceScanner ( const bool inScanNow = (! (0) ) )

explicit

Definition at line 82 of file ntv2devicescanner.cpp.

◆ CNTV2DeviceScanner() [2/2]

CNTV2DeviceScanner::CNTV2DeviceScanner	(	bool	inScanNow,
		UWord	inDeviceMask
	)

explicit

Definition at line 89 of file ntv2devicescanner.cpp.

Member Function Documentation

◆ CompareDeviceInfoLists()

bool CNTV2DeviceScanner::CompareDeviceInfoLists	(	const NTV2DeviceInfoList &	inOldList,
		const NTV2DeviceInfoList &	inNewList,
		NTV2DeviceInfoList &	outDevicesAdded,
		NTV2DeviceInfoList &	outDevicesRemoved
	)

static

Definition at line 514 of file ntv2devicescanner.cpp.

◆ DeviceIDPresent()

bool CNTV2DeviceScanner::DeviceIDPresent	(	const NTV2DeviceID	inDeviceID,
		const bool	inRescan = `(0)`
	)

static

Deprecated:: Do not use

Definition at line 138 of file ntv2devicescanner.cpp.

◆ GetDeviceAtIndex()

bool CNTV2DeviceScanner::GetDeviceAtIndex	(	const ULWord	inDeviceIndexNumber,
		CNTV2Card &	outDevice
	)

static

Rescans the host, and returns an open CNTV2Card instance for the AJA device having the given zero-based index number.

Returns: True if successful; otherwise false.

Parameters

[in]	inDeviceIndexNumber	Specifies the AJA device using a zero-based index number.
[out]	outDevice	Receives the open, ready-to-use CNTV2Card instance.

Definition at line 168 of file ntv2devicescanner.cpp.

◆ GetDeviceInfo()

bool CNTV2DeviceScanner::GetDeviceInfo	(	const ULWord	inDeviceIndexNumber,
		NTV2DeviceInfo &	outDeviceInfo,
		const bool	inRescan = `(0)`
	)

static

Deprecated:: Do not use

Definition at line 152 of file ntv2devicescanner.cpp.

◆ GetDeviceInfoList()

static NTV2DeviceInfoList CNTV2DeviceScanner::GetDeviceInfoList ( void )

static

Deprecated:: Do not use

◆ GetDeviceRefName()

string CNTV2DeviceScanner::GetDeviceRefName ( CNTV2Card & inDevice )

static

Parameters

[in] inDevice The CNTV2Card instance that's open for the device of interest.

Returns: A string containing the device name that will find the same given device using CNTV2DeviceScanner::GetFirstDeviceFromArgument.

Definition at line 383 of file ntv2devicescanner.cpp.

◆ GetDeviceWithSerial() [1/2]

static bool CNTV2DeviceScanner::GetDeviceWithSerial	(	const std::string &	inSerialNumber,
		CNTV2Card &	outDevice
	)

static

Rescans the host, and returns an open CNTV2Card instance for the first AJA device whose serial number matches the given value.

Returns: True if successful; otherwise false.

Parameters

[in]	inSerialNumber	Specifies the device serial value to search for.
[out]	outDevice	Receives the open, ready-to-use CNTV2Card instance.

◆ GetDeviceWithSerial() [2/2]

bool CNTV2DeviceScanner::GetDeviceWithSerial	(	const uint64_t	sn,
		CNTV2Card &	dev
	)

static

Deprecated:: Use the string version of this function instead

Definition at line 282 of file ntv2devicescanner.cpp.

◆ GetFirstDeviceFromArgument()

bool CNTV2DeviceScanner::GetFirstDeviceFromArgument	(	const std::string &	inArgument,
		CNTV2Card &	outDevice
	)

static

Rescans the host, and returns an open CNTV2Card instance for the AJA device that matches a command line argument according to the following evaluation sequence:

1 or 2 digit unsigned decimal integer: a zero-based device index number;
8 or 9 character alphanumeric string: device with a matching serial number string (case-insensitive comparison);
3-16 character hexadecimal integer, optionally preceded by '0x': device having a matching 64-bit serial number;
All other cases: first device (lowest index number) whose name contains the argument string (compared case-insensitively).

Returns: True if successful; otherwise false.

Parameters

[in]	inArgument	The argument string. If 'list' or '?', the std::cout stream is sent some "help text" showing a list of all available devices.
[out]	outDevice	Receives the open, ready-to-use CNTV2Card instance.

Definition at line 306 of file ntv2devicescanner.cpp.

◆ GetFirstDeviceWithID()

bool CNTV2DeviceScanner::GetFirstDeviceWithID	(	const NTV2DeviceID	inDeviceID,
		CNTV2Card &	outDevice
	)

static

Rescans the host, and returns an open CNTV2Card instance for the first AJA device found on the host that has the given NTV2DeviceID.

Returns: True if successful; otherwise false.

Parameters

[in]	inDeviceID	Specifies the device identifier of interest.
[out]	outDevice	Receives the open, ready-to-use CNTV2Card instance.

Definition at line 186 of file ntv2devicescanner.cpp.

◆ GetFirstDeviceWithName()

bool CNTV2DeviceScanner::GetFirstDeviceWithName	(	const std::string &	inNameSubString,
		CNTV2Card &	outDevice
	)

static

Rescans the host, and returns an open CNTV2Card instance for the first AJA device whose device identifier name contains the given substring.

Note: The name is compared case-insensitively (e.g., "iO4K" == "Io4k").

Returns: True if successful; otherwise false.

Parameters

[in]	inNameSubString	Specifies a portion of the device name to search for.
[out]	outDevice	Receives the open, ready-to-use CNTV2Card instance.

Definition at line 204 of file ntv2devicescanner.cpp.

◆ GetFirstDeviceWithSerial()

bool CNTV2DeviceScanner::GetFirstDeviceWithSerial	(	const std::string &	inSerialStr,
		CNTV2Card &	outDevice
	)

static

Rescans the host, and returns an open CNTV2Card instance for the first AJA device whose serial number contains the given value.

Note: The serial value is compared case-sensitively.

Returns: True if successful; otherwise false.

Parameters

[in]	inSerialStr	Specifies the device serial value to search for.
[out]	outDevice	Receives the open, ready-to-use CNTV2Card instance of the first matching device.

Definition at line 260 of file ntv2devicescanner.cpp.

◆ GetNumDevices()

size_t CNTV2DeviceScanner::GetNumDevices ( void )

static

Deprecated:: Do not use

Definition at line 76 of file ntv2devicescanner.cpp.

◆ GetVirtualDeviceWithName()

bool CNTV2DeviceScanner::GetVirtualDeviceWithName	(	const std::string &	inNameString,
		CNTV2Card &	outDevice,
		const bool	inRescan = `(! (0) )`
	)

static

Rescans the host, and returns an open CNTV2Card instance for the first virtual device with a matching name.

Note: Only virtual devices are compared. The name is compared case-insensitively (e.g., "KONA5_Playout1" == "kona5_playout1").

Returns: True if successful; otherwise false.

Parameters

[in]	inNameString	Specifies the virtual device name to search for.
[out]	outDevice	Receives the open, ready-to-use CNTV2Card instance.
[in]	inRescan	Will rescan devices before returning the open CNTV2Card instance.

Definition at line 240 of file ntv2devicescanner.cpp.

◆ IsAlphaNumeric() [1/2]

bool CNTV2DeviceScanner::IsAlphaNumeric ( const char inStr )

static

Deprecated:: Use aja::is_alpha_numeric instead

Definition at line 42 of file ntv2devicescanner.cpp.

◆ IsAlphaNumeric() [2/2]

static bool CNTV2DeviceScanner::IsAlphaNumeric ( const std::string & inStr )

static

Deprecated:: Use aja::is_alpha_numeric instead

◆ IsDecimalDigit()

bool CNTV2DeviceScanner::IsDecimalDigit ( const char inChr )

static

Deprecated:: Use aja::is_decimal_digit instead

Definition at line 37 of file ntv2devicescanner.cpp.

◆ IsHexDigit()

bool CNTV2DeviceScanner::IsHexDigit ( const char inChr )

static

Deprecated:: Use aja::is_hex_digit instead

Definition at line 32 of file ntv2devicescanner.cpp.

◆ IsLegalDecimalNumber()

bool CNTV2DeviceScanner::IsLegalDecimalNumber	(	const std::string &	inStr,
		const size_t	maxLen = `2`
	)

static

Deprecated:: Use aja::is_legal_decimal_number instead

Definition at line 47 of file ntv2devicescanner.cpp.

◆ IsLegalHexSerialNumber()

uint64_t CNTV2DeviceScanner::IsLegalHexSerialNumber ( const std::string & inStr )

static

Deprecated:: Use aja::is_legal_hex_serial_number instead

Definition at line 52 of file ntv2devicescanner.cpp.

◆ IsLegalSerialNumber()

bool CNTV2DeviceScanner::IsLegalSerialNumber ( const std::string & inStr )

static

Returns: True if the string contains a legal serial number.

Parameters

[in] inStr The string to be tested.

Definition at line 66 of file ntv2devicescanner.cpp.

◆ ScanHardware() [1/2]

void CNTV2DeviceScanner::ScanHardware ( void )

static

Deprecated:: Do not use

Definition at line 104 of file ntv2devicescanner.cpp.

◆ ScanHardware() [2/2]

static void CNTV2DeviceScanner::ScanHardware ( const UWord inMask )

inlinestatic

Deprecated:: Do not use

Definition at line 319 of file ntv2devicescanner.h.

◆ SortDeviceInfoList()

static void CNTV2DeviceScanner::SortDeviceInfoList ( void )

inlinestatic

Deprecated:: Obsolete

Definition at line 324 of file ntv2devicescanner.h.

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

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

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ CNTV2DeviceScanner() [1/2]

◆ CNTV2DeviceScanner() [2/2]

Member Function Documentation

◆ CompareDeviceInfoLists()

◆ DeviceIDPresent()

◆ GetDeviceAtIndex()

◆ GetDeviceInfo()

◆ GetDeviceInfoList()

◆ GetDeviceRefName()

◆ GetDeviceWithSerial() [1/2]

◆ GetDeviceWithSerial() [2/2]

◆ GetFirstDeviceFromArgument()

◆ GetFirstDeviceWithID()

◆ GetFirstDeviceWithName()

◆ GetFirstDeviceWithSerial()

◆ GetNumDevices()

◆ GetVirtualDeviceWithName()

◆ IsAlphaNumeric() [1/2]

◆ IsAlphaNumeric() [2/2]

◆ IsDecimalDigit()

◆ IsHexDigit()

◆ IsLegalDecimalNumber()

◆ IsLegalHexSerialNumber()

◆ IsLegalSerialNumber()

◆ ScanHardware() [1/2]

◆ ScanHardware() [2/2]

◆ SortDeviceInfoList()