Library Class Reference

Initializes AVBlocks and manages license information. More...

List of all members.

Static Public Member Functions
static bool	Initialize ()
	Initializes the AVBlocks library.
static void	Shutdown ()
	Closes the AVBlocks library and frees the resources that are used (if any).
static LicenseStatusFlags	SetLicense (string license)
	Sets a license string.
static bool	IsLicensed (string product, string feature)
	Checks whether a product feature is licensed.
Properties
static LicenseStatusFlags	LicenseStatus [get]
	Returns the current license status.
static string	Description [get]
	Returns library build description.
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

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.

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.

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

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

string Description [static, get]

Returns library build description.

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

LicenseStatusFlags LicenseStatus [static, get]

Returns the current license status.

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

See also:

Library.SetLicense

int PatchVersion [static, get]

Returns library patch version.

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