Defines for the NTV2 SDK version number, used by ajantv2/includes/ntv2enums.h. See the ajantv2/includes/ntv2version.h.in template when building with with CMake. More...

#include "ajaexport.h"
#include <string>

Include dependency graph for ntv2version.h:

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

Go to the source code of this file.

Macros
#define	AJA_NTV2_SDK_VERSION_MAJOR 17
	The SDK major version number, an unsigned decimal integer. More...

#define	AJA_NTV2_SDK_VERSION_MINOR 1
	The SDK minor version number, an unsigned decimal integer. More...

#define	AJA_NTV2_SDK_VERSION_POINT 1
	The SDK "point" release version, an unsigned decimal integer. More...

#define	AJA_NTV2_SDK_BUILD_NUMBER 1245
	The SDK build number, an unsigned decimal integer. More...

#define	AJA_NTV2_SDK_BUILD_DATETIME "2024-10-01T23:19:24Z"
	The date and time the SDK was built, in ISO-8601 format. More...

#define	AJA_NTV2_SDK_BUILD_TYPE ""
	The SDK build type, where "a"=alpha, "b"=beta, "d"=development, ""=release. More...

#define	AJA_NTV2_SDK_VERSION ((AJA_NTV2_SDK_VERSION_MAJOR << 24) \| (AJA_NTV2_SDK_VERSION_MINOR << 16) \| (AJA_NTV2_SDK_VERSION_POINT << 8) \| (AJA_NTV2_SDK_BUILD_NUMBER))

#define	AJA_NTV2_SDK_VERSION_AT_LEAST(__a__, __b__) (AJA_NTV2_SDK_VERSION >= (((__a__) << 24) \| ((__b__) << 16)))

#define	AJA_NTV2_SDK_VERSION_BEFORE(__a__, __b__) (AJA_NTV2_SDK_VERSION < (((__a__) << 24) \| ((__b__) << 16)))

Functions
std::string	NTV2Version (const bool inDetailed=false)

const std::string &	NTV2GitHash (void)

const std::string &	NTV2GitHashShort (void)

Detailed Description

Defines for the NTV2 SDK version number, used by ajantv2/includes/ntv2enums.h. See the ajantv2/includes/ntv2version.h.in template when building with with CMake.

Copyright: (C) 2013-2022 AJA Video Systems, Inc. All rights reserved.

Definition in file ntv2version.h.

Macro Definition Documentation

◆ AJA_NTV2_SDK_BUILD_DATETIME

#define AJA_NTV2_SDK_BUILD_DATETIME "2024-10-01T23:19:24Z"

The date and time the SDK was built, in ISO-8601 format.

Definition at line 17 of file ntv2version.h.

◆ AJA_NTV2_SDK_BUILD_NUMBER

#define AJA_NTV2_SDK_BUILD_NUMBER 1245

The SDK build number, an unsigned decimal integer.

Definition at line 16 of file ntv2version.h.

◆ AJA_NTV2_SDK_BUILD_TYPE

#define AJA_NTV2_SDK_BUILD_TYPE ""

The SDK build type, where "a"=alpha, "b"=beta, "d"=development, ""=release.

Definition at line 18 of file ntv2version.h.

◆ AJA_NTV2_SDK_VERSION

#define AJA_NTV2_SDK_VERSION ((AJA_NTV2_SDK_VERSION_MAJOR << 24) | (AJA_NTV2_SDK_VERSION_MINOR << 16) | (AJA_NTV2_SDK_VERSION_POINT << 8) | (AJA_NTV2_SDK_BUILD_NUMBER))

Definition at line 20 of file ntv2version.h.

◆ AJA_NTV2_SDK_VERSION_AT_LEAST

#define AJA_NTV2_SDK_VERSION_AT_LEAST	(	__a__,
		__b__
	)	(AJA_NTV2_SDK_VERSION >= (((__a__) << 24) \| ((__b__) << 16)))

Definition at line 21 of file ntv2version.h.

◆ AJA_NTV2_SDK_VERSION_BEFORE

#define AJA_NTV2_SDK_VERSION_BEFORE	(	__a__,
		__b__
	)	(AJA_NTV2_SDK_VERSION < (((__a__) << 24) \| ((__b__) << 16)))

Definition at line 22 of file ntv2version.h.

◆ AJA_NTV2_SDK_VERSION_MAJOR

#define AJA_NTV2_SDK_VERSION_MAJOR 17

The SDK major version number, an unsigned decimal integer.

Definition at line 13 of file ntv2version.h.

◆ AJA_NTV2_SDK_VERSION_MINOR

#define AJA_NTV2_SDK_VERSION_MINOR 1

The SDK minor version number, an unsigned decimal integer.

Definition at line 14 of file ntv2version.h.

◆ AJA_NTV2_SDK_VERSION_POINT

#define AJA_NTV2_SDK_VERSION_POINT 1

The SDK "point" release version, an unsigned decimal integer.

Definition at line 15 of file ntv2version.h.

Function Documentation

◆ NTV2GitHash()

const std::string& NTV2GitHash ( void )

Returns: the 40-character ID of the last commit for this SDK build

Definition at line 19 of file ntv2version.cpp.

◆ NTV2GitHashShort()

const std::string& NTV2GitHashShort ( void )

Returns: the 10-character ID of the last commit for this SDK build

Definition at line 30 of file ntv2version.cpp.

◆ NTV2Version()

std::string NTV2Version ( const bool inDetailed = false )

Returns: a string containing SDK version information

Definition at line 41 of file ntv2version.cpp.

Macros

Functions