Library Class Reference

Initializes AVBlocks and manages license information. More...

Classes
class	Config
	Global hardware configuration. More...

Static Public Member Functions
static bool	Initialize ()
	Initializes the AVBlocks library.
static bool	IsLicensed (string product, string feature)
	Checks whether a product feature is licensed.
static LicenseStatusFlags	SetLicense (string license)
	Sets a license string.
static void	Shutdown ()
	Closes the AVBlocks library and frees the resources that are used (if any).

Properties
static string	Description [get]
	Returns library build description.
static LicenseStatusFlags	LicenseStatus [get]
	Returns the current license status.
static int	MajorVersion [get]
	Returns library major version.
static int	MinorVersion [get]
	Returns library minor version.
static int	PatchVersion [get]
	Returns library patch version.

Detailed Description

Initializes AVBlocks and manages license information.

Member Function Documentation

Initialize()

static bool Initialize ( )

static

Initializes the AVBlocks library.

Must be called once before the library is used, usually when the application starts.

Returns

true if the library is successfully initialized, otherwise false.

IsLicensed()

static bool IsLicensed ( string  product, string  feature  )

static

Checks whether a product feature is licensed.

Parameters

product	The product id. If null the AVBlocks product is implied.
feature	The feature id. If null> the default AVBlocks product feature is implied.

Returns

If true the specified product feature is licensed.

If a product is fully licensed then the function will always return true for that product regardless of the feature parameter.

If a product is licensed for a limited set of features then the function will return true for that product only if the feature parameter specifies one of the licensed features or is null.

SetLicense()

static LicenseStatusFlags SetLicense ( string  license )

static

Sets a license string.

The supplied license is appended to the library license state.

Parameters

license

A string with license information. If the license string is null the library license state is cleared.

Returns

The status after the license is set. The returned value is a combination of flags from the LicenseStatusFlags enum.

A Demo build of the library cannot be licensed and always returns LicenseStatusFlags.DemoBuild.

See also

Library.LicenseStatus

Shutdown()

static void Shutdown ( )

static

Closes the AVBlocks library and frees the resources that are used (if any).

Should be called when the library will not be used anymore, e.g. when the application ends.

Property Documentation

Description

string Description

staticget

Returns library build description.

Contains details about the build including full version,
architecture (x86/x64), configuration (Release/Debug), license (OEM/Demo) and platform (OS).

LicenseStatus

LicenseStatusFlags LicenseStatus

staticget

Returns the current license status.

In the Demo build the license status is always LicenseStatusFlags.DemoBuild.

See also

Library.SetLicense

MajorVersion

int MajorVersion

staticget

Returns library major version.

MinorVersion

int MinorVersion

staticget

Returns library minor version.

PatchVersion

int PatchVersion

staticget

Returns library patch version.

The patch version is used for bugfixes and small improvements that do not involve API changes.