Global

Members

(constant) LicenseFeature :number

Enumeration representing VoiceSDK licensed features
Type:
  • number
Properties:
Name Type Description
CORE number Core functionality.
VERIFICATION number
LIVENESS_PRESENTATION_ATTACK_DETECTION number
LIVENESS_VOICE_CLONES_DETECTION number
QUALITY_CHECKING number

(constant) QualityCheckScenario :number

Enumeration representing scenarios used to get recommended quality check thresholds
Type:
  • number
Properties:
Name Type Description
VERIFY_TI_ENROLLMENT number Verification, TI enrollment step.
VERIFY_TI_VERIFICATION number Verification, TI verification step.
VERIFY_TD_ENROLLMENT number Verification, TD enrollment step.
VERIFY_TD_VERIFICATION number Verification, TD verification step.
LIVENESS number Liveness check.

(constant) QualityCheckShortDescription :number

Enumeration representing short quality check description
Type:
  • number
Properties:
Name Type Description
TOO_NOISY number Too noisy audio.
TOO_SMALL_SPEECH_TOTAL_LENGTH number Too small speech length in the audio.
OK number Audio successfully passed quality check.
TOO_SMALL_SPEECH_RELATIVE_LENGTH number Too small speech relative length (speech length relative to the total audio length).
MULTIPLE_SPEAKERS_DETECTED number Multiple speakers detected.

Methods

createVoiceSdkModule() → {Object}

Creates promise of the Voice SDK object which can be used for SDK classes instantiation and SDK functions calls
Returns:
Promise of the main Voice SDK object
Type
Object

getBuildInfo() → {BuildInfo}

Returns present VoiceSDK build info
Returns:
VoiceSDK present build info
Type
BuildInfo

getExceptionMessage(error) → {string}

Returns string representation of the message of the exception thrown by Voice SDK API
Parameters:
Name Type Description
error number Pointer to the exception thrown by Voice SDK
Returns:
Exception message
Type
string

getLicenseInfo() → {VectorLicenseFeatureInfo}

Returns information (enabled features and expiration dates) about the installed license if available
Returns:
List of VoiceSDK features available with the installed license
Type
VectorLicenseFeatureInfo

setLicense(licenseString)

Sets SDK license
Parameters:
Name Type Description
licenseString string License string