net.idrnd.voicesdk.verify

Class VoiceTemplateFactory

java.lang.Object

net.idrnd.voicesdk.common.VoiceSdkNativePeer

net.idrnd.voicesdk.verify.VoiceTemplateFactory

All Implemented Interfaces:

java.lang.AutoCloseable

public class VoiceTemplateFactory
extends VoiceSdkNativePeer

Provides capabilities for creating and comparing VoiceTemplate.

This class serves as gateway to native Voice SDK implementation and allocates resources on native heap. To release the allocated memory, AutoCloseable.close() method should be invoked when the instance is no longer needed.

Any method that delegates to native call may throw VoiceSdkEngineException

See Also:

VoiceTemplate

Field Summary

Fields inherited from class net.idrnd.voicesdk.common.VoiceSdkNativePeer

nativeId

Constructor Summary

Constructors

Constructor and Description
VoiceTemplateFactory(java.lang.String initDataPath) Sole constructor.

Method Summary

Modifier and Type	Method and Description
VoiceTemplate	createVoiceTemplate(byte[] buffer, int sampleRate)
VoiceTemplate	createVoiceTemplate(byte[] buffer, int sampleRate, ChannelType channelType) Creates VoiceTemplate from byte-array PCM16 encoded audio.
VoiceTemplate	createVoiceTemplate(float[] buffer, int sampleRate)
VoiceTemplate	createVoiceTemplate(float[] buffer, int sampleRate, ChannelType channelType) Creates VoiceTemplate from audio data encoded in 'truncated' float format Sampling frequency should be equal to or greater than the value returned by getMinimumAudioSampleRate().
VoiceTemplate	createVoiceTemplate(short[] buffer, int sampleRate)
VoiceTemplate	createVoiceTemplate(short[] buffer, int sampleRate, ChannelType channelType) Creates VoiceTemplate from PCM16 encoded audio.
VoiceTemplate	createVoiceTemplate(java.lang.String audioPath)
VoiceTemplate	createVoiceTemplate(java.lang.String audioPath, ChannelType channelType) Creates VoiceTemplate object from audio file.
protected VoiceTemplate	createVoiceTemplate1(java.lang.String audioPath, ChannelType channelType)
protected VoiceTemplate	createVoiceTemplate2(float[] buffer, int sampleRate, ChannelType channelType)
protected VoiceTemplate	createVoiceTemplate3(short[] buffer, int sampleRate, ChannelType channelType)
protected VoiceTemplate	createVoiceTemplate4(byte[] buffer, int sampleRate, ChannelType channelType)
java.lang.String	getInitDataId() Returns ID of the init data, which was used to create the factory
int	getMinimumAudioSampleRate() Returns Returns minimum supported input audio sampling frequency in Hz
protected static long	init(java.lang.String initDataPath)
VoiceTemplate	mergeVoiceTemplates(VoiceTemplate[] voiceTemplates) Merges multiple VoiceTemplate objects into single template.
protected VoiceTemplate	mergeVoiceTemplates1(VoiceTemplate[] voiceTemplates)
protected void	release() This method should release resources on native layer (indirectly using nativeId)

Methods inherited from class net.idrnd.voicesdk.common.VoiceSdkNativePeer

close, equals, finalize, hashCode

Methods inherited from class java.lang.Object

clone, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

VoiceTemplateFactory

public VoiceTemplateFactory(java.lang.String initDataPath)

Sole constructor. Initializes the Engine object and allocates the native resources.

Parameters:

initDataPath - full path to the directory with SDK data

Throws:

VoiceSdkEngineException - wraps native exceptions

Method Detail

createVoiceTemplate

public VoiceTemplate createVoiceTemplate(java.lang.String audioPath,
                                         ChannelType channelType)

Creates VoiceTemplate object from audio file. Sampling frequency should be equal to or greater than the value returned by getMinimumAudioSampleRate().

Parameters:

audioPath - path to audio file

channelType - audio record source channel

Returns:

VoiceTemplate

Throws:

VoiceSdkEngineException - wraps native exceptions

createVoiceTemplate

public VoiceTemplate createVoiceTemplate(java.lang.String audioPath)

createVoiceTemplate

public VoiceTemplate createVoiceTemplate(byte[] buffer,
                                         int sampleRate,
                                         ChannelType channelType)

Creates VoiceTemplate from byte-array PCM16 encoded audio. Sampling frequency should be equal to or greater than the value returned by getMinimumAudioSampleRate().

Parameters:

buffer - input array of byte samples

sampleRate - sample frequency, Hz

channelType - audio record source channel

Returns:

VoiceTemplate

Throws:

VoiceSdkEngineException - wraps native exceptions

createVoiceTemplate

public VoiceTemplate createVoiceTemplate(byte[] buffer,
                                         int sampleRate)

createVoiceTemplate

public VoiceTemplate createVoiceTemplate(short[] buffer,
                                         int sampleRate,
                                         ChannelType channelType)

Creates VoiceTemplate from PCM16 encoded audio. Sampling frequency should be equal to or greater than the value returned by getMinimumAudioSampleRate().

Parameters:

buffer - input array of PCM16 samples

sampleRate - sample frequency, Hz

channelType - audio record source channel

Returns:

VoiceTemplate

Throws:

VoiceSdkEngineException - wraps native exceptions

createVoiceTemplate

public VoiceTemplate createVoiceTemplate(short[] buffer,
                                         int sampleRate)

createVoiceTemplate

public VoiceTemplate createVoiceTemplate(float[] buffer,
                                         int sampleRate,
                                         ChannelType channelType)

Creates VoiceTemplate from audio data encoded in 'truncated' float format Sampling frequency should be equal to or greater than the value returned by getMinimumAudioSampleRate().

Parameters:

buffer - input array of float samples, values are limited by range [-1; 1]

sampleRate - sample frequency, Hz

channelType - audio record source channel

Returns:

VoiceTemplate

Throws:

VoiceSdkEngineException - wraps native exceptions

createVoiceTemplate

public VoiceTemplate createVoiceTemplate(float[] buffer,
                                         int sampleRate)

mergeVoiceTemplates

public VoiceTemplate mergeVoiceTemplates(VoiceTemplate[] voiceTemplates)

Merges multiple VoiceTemplate objects into single template. All the templates should have the same init data ID as the factory instance.

Parameters:

voiceTemplates - input VoiceTemplate objects

Returns:

VoiceTemplate

Throws:

VoiceSdkEngineException - wraps native exceptions

getInitDataId

public java.lang.String getInitDataId()

Returns ID of the init data, which was used to create the factory

Returns:

A string containing init data ID

getMinimumAudioSampleRate

public int getMinimumAudioSampleRate()

Returns Returns minimum supported input audio sampling frequency in Hz

Returns:

A minimum sampling rate in Hz

init

protected static long init(java.lang.String initDataPath)

createVoiceTemplate1

protected VoiceTemplate createVoiceTemplate1(java.lang.String audioPath,
                                             ChannelType channelType)

createVoiceTemplate2

protected VoiceTemplate createVoiceTemplate2(float[] buffer,
                                             int sampleRate,
                                             ChannelType channelType)

createVoiceTemplate3

protected VoiceTemplate createVoiceTemplate3(short[] buffer,
                                             int sampleRate,
                                             ChannelType channelType)

createVoiceTemplate4

protected VoiceTemplate createVoiceTemplate4(byte[] buffer,
                                             int sampleRate,
                                             ChannelType channelType)

mergeVoiceTemplates1

protected VoiceTemplate mergeVoiceTemplates1(VoiceTemplate[] voiceTemplates)

release

protected void release()

Description copied from class: VoiceSdkNativePeer

This method should release resources on native layer (indirectly using nativeId)

Specified by:

release in class VoiceSdkNativePeer