net.idrnd.voicesdk.media

Class SpeechSummaryEngine

java.lang.Object

net.idrnd.voicesdk.common.VoiceSdkNativePeer

net.idrnd.voicesdk.media.SpeechSummaryEngine

All Implemented Interfaces:

java.lang.AutoCloseable

public class SpeechSummaryEngine
extends VoiceSdkNativePeer

Provides the set of capabilities related to calculation SpeechSummary over various types of audio data. 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

Field Summary

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

nativeId

Constructor Summary

Constructors

Constructor and Description
SpeechSummaryEngine(java.lang.String initPath) Initializes the engine, allocating native memory.

Method Summary

Modifier and Type	Method and Description
SpeechSummaryStream	createStream(int sampleRate) Produces SpeechSummaryStream that accepts audio data with the specified constant sampling rate.
SpeechSummary	getSpeechSummary(byte[] pcm16Bytes, int sampleRate) Calculates SpeechSummary over the specified audio buffer provided as an array of PCM16 samples.
SpeechSummary	getSpeechSummary(float[] floatSamples, int sampleRate) Calculates SpeechSummary over the specified audio buffer provided as an array of normalized float values.
SpeechSummary	getSpeechSummary(short[] pcm16Samples, int sampleRate) Calculates SpeechSummary over the specified audio buffer provided as an array of PCM16 samples.
SpeechSummary	getSpeechSummary(java.lang.String audioFile) Calculates SpeechSummary over the specified audio record.
protected SpeechSummary	getSpeechSummary1(byte[] pcm16Bytes, int sampleRate)
protected SpeechSummary	getSpeechSummary2(short[] pcm16Samples, int sampleRate)
protected SpeechSummary	getSpeechSummary3(float[] floatSamples, int sampleRate)
protected SpeechSummary	getSpeechSummary4(java.lang.String audioFile)
protected static long	init(java.lang.String initPath)
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

SpeechSummaryEngine

public SpeechSummaryEngine(java.lang.String initPath)

Initializes the engine, allocating native memory.

Parameters:

initPath - path to the initialization folder containing the required binaries and configuration files

Throws:

VoiceSdkEngineException - wraps native exceptions

Method Detail

getSpeechSummary

public SpeechSummary getSpeechSummary(byte[] pcm16Bytes,
                                      int sampleRate)

Calculates SpeechSummary over the specified audio buffer provided as an array of PCM16 samples.

Parameters:

pcm16Bytes - Array of little-endian PCM16 audio bytes

sampleRate - audio stream sampling rate, Hz

Returns:

SpeechSummary

Throws:

VoiceSdkEngineException - wraps native exceptions

getSpeechSummary

public SpeechSummary getSpeechSummary(short[] pcm16Samples,
                                      int sampleRate)

Calculates SpeechSummary over the specified audio buffer provided as an array of PCM16 samples.

Parameters:

pcm16Samples - Array of PCM16 audio samples

sampleRate - audio stream sampling rate, Hz

Returns:

SpeechSummary

Throws:

VoiceSdkEngineException - wraps native exceptions

getSpeechSummary

public SpeechSummary getSpeechSummary(float[] floatSamples,
                                      int sampleRate)

Calculates SpeechSummary over the specified audio buffer provided as an array of normalized float values.

Parameters:

floatSamples - Array of float audio samples (in [-1, 1] range)

sampleRate - audio stream sampling rate, Hz

Returns:

SpeechSummary

Throws:

VoiceSdkEngineException - wraps native exceptions

getSpeechSummary

public SpeechSummary getSpeechSummary(java.lang.String audioFile)

Calculates SpeechSummary over the specified audio record.

Parameters:

audioFile - Path to the audio file

Returns:

SpeechSummary

Throws:

VoiceSdkEngineException - wraps native exceptions

createStream

public SpeechSummaryStream createStream(int sampleRate)

Produces SpeechSummaryStream that accepts audio data with the specified constant sampling rate.

Parameters:

sampleRate - audio stream sampling rate, Hz

Returns:

SpeechSummaryStream

Throws:

VoiceSdkEngineException - wraps native exceptions

init

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

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

getSpeechSummary1

protected SpeechSummary getSpeechSummary1(byte[] pcm16Bytes,
                                          int sampleRate)

getSpeechSummary2

protected SpeechSummary getSpeechSummary2(short[] pcm16Samples,
                                          int sampleRate)

getSpeechSummary3

protected SpeechSummary getSpeechSummary3(float[] floatSamples,
                                          int sampleRate)

getSpeechSummary4

protected SpeechSummary getSpeechSummary4(java.lang.String audioFile)