net.idrnd.voicesdk.media

Class SpeechEndpointDetectorOpus

java.lang.Object

net.idrnd.voicesdk.common.VoiceSdkNativePeer

net.idrnd.voicesdk.media.SpeechEndpointDetectorOpus

All Implemented Interfaces:

java.lang.AutoCloseable

public class SpeechEndpointDetectorOpus
extends VoiceSdkNativePeer

Provides the functionality of speech end detection in Opus audio stream.

Enables streaming scenario for end detection when Opus audio data is processed by packets. Intended usage scenario is following:

• initialize SpeechEndpointDetector
• call 1 or more addPacket(byte[]) methods with incoming Opus packets
• call isSpeechEnded()
• if false, repeat
• if true, stop processing and VoiceSdkNativePeer.close()

End detection is parameterized with 2 thresholds: minimum speech length and maximum silence length. End detection is triggered when minimum speech length is accumulated and then uninterrupted silence longer that 'max silence length' occurs.

This class is stateful and is not thread safe.

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
SpeechEndpointDetectorOpus(int minSpeechLengthMs, int maxSilenceLengthMs, int sampleRate) Initializes Opus speech endpoint detector.

Method Summary

Modifier and Type	Method and Description
void	addPacket(byte[] bytes) Adds Opus packet for processing
protected static long	init(int minSpeechLengthMs, int maxSilenceLengthMs, int sampleRate)
boolean	isSpeechEnded() Checks if speech end is detected after the previous addPacket(byte[]) call
protected void	release() This method should release resources on native layer (indirectly using nativeId)
void	reset() Resets detector, clearing all the accumulated statistics

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

SpeechEndpointDetectorOpus

public SpeechEndpointDetectorOpus(int minSpeechLengthMs,
                                  int maxSilenceLengthMs,
                                  int sampleRate)

Initializes Opus speech endpoint detector.

Parameters:

minSpeechLengthMs - the threshold for required accumulated speech duration

maxSilenceLengthMs - the threshold for the duration of continuous silence that triggers the end detection if the required amount of speech is accumulated

sampleRate - sample rate of incoming audio data stream

Throws:

VoiceSdkEngineException - wraps native exceptions

Method Detail

reset

public void reset()

Resets detector, clearing all the accumulated statistics

Throws:

VoiceSdkEngineException - wraps native exceptions

addPacket

public void addPacket(byte[] bytes)

Adds Opus packet for processing

Parameters:

bytes - Array containing single Opus packet. It is expected that packet contains data for single mono stream

Throws:

VoiceSdkEngineException - wraps native exceptions

isSpeechEnded

public boolean isSpeechEnded()

Checks if speech end is detected after the previous addPacket(byte[]) call

Returns:

true if speech end is detected

init

protected static long init(int minSpeechLengthMs,
                           int maxSilenceLengthMs,
                           int sampleRate)

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