Classes
struct	AudioInfo
	Structure containing audio info. More...

struct	AudioInterval
	Structure representing interval of audio data. More...

struct	BuildInfo
	Structure containing present VoiceSDK build info. More...

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

struct	LicenseFeatureInfo
	VoiceSDK feature information. More...

class	LivenessEngine
	Voice liveness check class. LivenessEngine is thread-safe. More...

struct	LivenessResult
	Voice liveness check result. More...

struct	OpusUtils
	Class with some static utility functions for working with Opus files data. More...

class	QualityCheckEngine
	Quality check engine class. More...

struct	QualityCheckEngineResult
	Structure representing audio quality check result. More...

struct	QualityCheckMetricsThresholds
	Struct for quality checking metrics thresholds QualityCheckEngine::CheckQuality. More...

class	SNRComputer
	Class (interface) for calculating input voice signal signal-to-noise ratio (SNR) More...

class	SpeechEndpointDetector
	Speech endpoint detector class (interface), intended to detect speech end in the audio stream. More...

class	SpeechEndpointDetectorOpus
	Speech endpoint detector class (interface), intended to detect speech end in the Opus audio stream. More...

struct	SpeechEvent

struct	SpeechInfo

struct	SpeechSummary
	Structure containing speech statistics and audio intervals marked as speech or non-speech. More...

class	SpeechSummaryEngine
	Speech summary engine class (interface), intended to calculate SpeechSummary with given audio samples. More...

class	SpeechSummaryStream
	Class for online audio stream processing (voice activity detection and speech statistics computation) More...

class	SpeechSummaryStreamOpus
	Class for online Opus audio stream processing (voice activity detection and speech statistics computation) More...

struct	TimeInterval
	Structure representing time interval. More...

struct	VerifyFileBatchElement
	Struct for verify factory batch processing VoiceTemplateFactory::createVoiceTemplateBatch. More...

struct	VerifyResult
	Structure representing voice verification result. More...

struct	VerifySamplesBatchElement
	Struct for verify factory batch processing VoiceTemplateFactory::createVoiceTemplateBatch. More...

struct	VerifyStreamResult
	Structure containing streaming voice verification result. More...

class	VoiceTemplate
	Class representing a voice template (voice profile) More...

class	VoiceTemplateConverter
	Class representing a voice template converter. More...

class	VoiceTemplateFactory
	Class for creating and merging voice templates. More...

class	VoiceTemplateMatcher
	Class for matching voice templates one-to-one. More...

class	VoiceVerifyStream
	Class for continuous voice verification using audio stream. More...

class	VoiceVerifyStreamOpus
	Class for continuous voice verification using Opus audio stream. More...

struct	WavUtils
	Class with some static utility functions for working with WAV-data. More...

Enumerations
enum	ChannelType { ChannelType::MIC = 1, ChannelType::TEL = 2, ChannelType::MIXED = 3 }
	An enumeration for audio source labeling during voice template creation. More...

enum	LicenseFeature : unsigned int { LicenseFeature::kCore = 7, LicenseFeature::kVerification = 2, LicenseFeature::kLivenessPresentationAttackDetection = 4, LicenseFeature::kLivenessVoiceClonesDetection = 31, LicenseFeature::kQualityChecking = 6 }
	VoiceSDK licensed features. More...

enum	QualityCheckScenario : uint8_t { QualityCheckScenario::kVerifyTiEnrollment = 0, QualityCheckScenario::kVerifyTiVerification = 1, QualityCheckScenario::kVerifyTdEnrollment = 2, QualityCheckScenario::kVerifyTdVerification = 3, QualityCheckScenario::kLiveness = 4 }
	Enumeration representing scenarios used to get recommended quality check thresholds. More...

Functions
std::ostream &	operator<< (std::ostream &os, const LicenseFeature &feature)

VOICE_SDK_API std::vector< LicenseFeatureInfo >	getLicenseInfo ()
	Returns information (enabled features and expiration dates) about the installed license if available. More...

VOICE_SDK_API void	setNumThreads (unsigned int numThreads) noexcept
	Sets the maximum number of threads available for VoiceSDK. If 0 passed, then the optimal number of threads is detected automatically (the same effect is achieved if setNumThreads is not called). More...

VOICE_SDK_API void	setAllowMobileGPU (bool allowMobileGPU) noexcept
	Sets whether GPU delegate allowed to be used for VoiceSDK (for Android devices only). More...

VOICE_SDK_API void	setAllowMobileNNAPI (bool allowMobileNNAPI) noexcept
	Sets whether NNAPI delegate allowed to be used for VoiceSDK (for Android devices only). More...

VOICE_SDK_API void	setUseVoiceTemplateCompression (bool useVoiceTemplateCompression) noexcept
	Sets whether to compress voice templates serialization. Voice template compression is not used by default. More...

VOICE_SDK_API void	setMobileLicense (const std::string &mobile_license_string)
	Sets the mobile SDK license (only can be used for Android and iOS SDKs). More...

VOICE_SDK_API BuildInfo	getBuildInfo () noexcept
	Returns present VoiceSDK build info. More...

Enumeration Type Documentation

◆ ChannelType

enum voicesdk::ChannelType

strong

An enumeration for audio source labeling during voice template creation.

Enumerator
MIC
TEL
MIXED

◆ LicenseFeature

enum voicesdk::LicenseFeature : unsigned int

strong

VoiceSDK licensed features.

Enumerator
kCore	Core functionality
kVerification	Voice verification
kLivenessPresentationAttackDetection	Voice liveness (presentation/replay attack detection)
kLivenessVoiceClonesDetection	Voice liveness (voice clones detection)
kQualityChecking	Quality checking functionality (SNR, speech length etc.)

◆ QualityCheckScenario

enum voicesdk::QualityCheckScenario : uint8_t

strong

Enumeration representing scenarios used to get recommended quality check thresholds.

Enumerator
kVerifyTiEnrollment	Verification, TI enrollment step.
kVerifyTiVerification	Verification, TI verification step.
kVerifyTdEnrollment	Verification, TD enrollment step.
kVerifyTdVerification	Verification, TD verification step.
kLiveness	Liveness check.

Function Documentation

◆ getBuildInfo()

VOICE_SDK_API BuildInfo voicesdk::getBuildInfo ( )

noexcept

Returns present VoiceSDK build info.

Returns: Present VoiceSDK present build info.

◆ getLicenseInfo()

VOICE_SDK_API std::vector<LicenseFeatureInfo> voicesdk::getLicenseInfo ( )

Returns information (enabled features and expiration dates) about the installed license if available.

Returns: List of VoiceSDK features available with the installed license.

◆ operator<<()

std::ostream& voicesdk::operator<<	(	std::ostream &	os,
		const LicenseFeature &	feature
	)

inline

◆ setAllowMobileGPU()

VOICE_SDK_API void voicesdk::setAllowMobileGPU ( bool allowMobileGPU )

noexcept

Sets whether GPU delegate allowed to be used for VoiceSDK (for Android devices only).

Parameters

allowMobileGPU whether GPU is allowed to be used for VoiceSDK execution.

◆ setAllowMobileNNAPI()

VOICE_SDK_API void voicesdk::setAllowMobileNNAPI ( bool allowMobileNNAPI )

noexcept

Sets whether NNAPI delegate allowed to be used for VoiceSDK (for Android devices only).

Parameters

allowMobileNNAPI whether NNAPI is allowed to be used for VoiceSDK execution.

◆ setMobileLicense()

VOICE_SDK_API void voicesdk::setMobileLicense ( const std::string & mobile_license_string )

Sets the mobile SDK license (only can be used for Android and iOS SDKs).

Parameters

mobile_license_string mobile SDK license string.

◆ setNumThreads()

VOICE_SDK_API void voicesdk::setNumThreads ( unsigned int numThreads )

noexcept

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

Parameters

numThreads maximum number of threads available for VoiceSDK.

◆ setUseVoiceTemplateCompression()

VOICE_SDK_API void voicesdk::setUseVoiceTemplateCompression ( bool useVoiceTemplateCompression )

noexcept

Sets whether to compress voice templates serialization. Voice template compression is not used by default.

Parameters

useVoiceTemplateCompression whether to compress voice templates serialization.

Classes

Enumerations

Functions

Enumeration Type Documentation

◆ ChannelType

◆ LicenseFeature

◆ QualityCheckScenario

Function Documentation

◆ getBuildInfo()

◆ getLicenseInfo()

◆ operator<<()

◆ setAllowMobileGPU()

◆ setAllowMobileNNAPI()

◆ setMobileLicense()

◆ setNumThreads()

◆ setUseVoiceTemplateCompression()