Data Structures
struct	DocSdkFeature
	DocSDK feature information. More...

struct	Image
	Image representation. More...

class	LicenseException
	A type for exception which is thrown on license expiration or absence. More...

struct	LivenessCheckOptions
	Configurable options used for document liveness check. More...

class	LivenessPipeline
	Document liveness checking pipeline. More...

class	LivenessPipelineComposition
	Document liveness checking pipeline composition. More...

struct	LivenessPipelineResult
	Liveness pipeline result. More...

Enumerations
enum	AttackType { AttackType::kScreenReplay, AttackType::kPrintedCopy, AttackType::kPortraitSubstitution, AttackType::kDigitalManipulation, AttackType::kOther }
	Document spoofing attack type. More...

Functions
DOCSDK_API void	SetNumThreads (unsigned int num_threads) noexcept
	Sets the maximum number of CPU threads available for DocSDK. If 0 is passed, then the optimal number of CPU threads is detected automatically (the same effect is achieved if the function is not called). More...

DOCSDK_API std::vector< DocSdkFeature >	GetLicenseInfo ()
	Returns information (e.g. supported features and expiration dates) about the installed license if available. More...

DOCSDK_API void	SetRuntimeLicense (const std::string &license_str)
	Sets the runtime license. Only takes effect in "Lambda" SDK distribution and should be called before any other SDK invocation. More...

Enumeration Type Documentation

◆ AttackType

enum docsdk::AttackType

strong

Document spoofing attack type.

Enumerator
kScreenReplay	Screen replay attack
kPrintedCopy	Printed copy attack
kPortraitSubstitution	Portrait substitution attack
kDigitalManipulation	Digital manipulation attack
kOther	Other attack

Function Documentation

◆ GetLicenseInfo()

DOCSDK_API std::vector<DocSdkFeature> docsdk::GetLicenseInfo ( )

Returns information (e.g. supported features and expiration dates) about the installed license if available.

Returns: List of document liveness features available with the installed license.

◆ SetNumThreads()

DOCSDK_API void docsdk::SetNumThreads ( unsigned int num_threads )

noexcept

Sets the maximum number of CPU threads available for DocSDK. If 0 is passed, then the optimal number of CPU threads is detected automatically (the same effect is achieved if the function is not called).

Parameters

num_threads Maximum number of CPU threads available for DocSDK

Note: Function call is equivalent to setting DOCSDK_NUM_THREADS_PIPELINE, DOCSDK_NUM_THREADS_ENGINE and DOCSDK_NUM_THREADS_OPERATOR environment variables to the same value before loading the DocSDK library.; Function call takes precedence over environment variables.

◆ SetRuntimeLicense()

DOCSDK_API void docsdk::SetRuntimeLicense ( const std::string & license_str )

Sets the runtime license. Only takes effect in "Lambda" SDK distribution and should be called before any other SDK invocation.

Parameters

license_str String holding the license content.

Exceptions

LicenseException on invalid license string.

Data Structures