Call Center SDK  1.11.3
Public Types | Public Member Functions | Static Public Member Functions | List of all members
voicesdk::SpeechEndpointDetector Class Referenceabstract

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

#include <voicesdk/media/speech.h>

Public Types

using Ptr = std::shared_ptr< SpeechEndpointDetector >
 

Public Member Functions

virtual void reset ()=0
 Resets detector state.
 
virtual void addSamples (const uint8_t *bytes, size_t bytesNum)=0
 Adds PCM16 audio samples to process. More...
 
virtual void addSamples (const float *samples, size_t samplesNum)=0
 Adds float audio samples to process. More...
 
virtual void addSamples (const int16_t *samples, size_t samplesNum)=0
 Adds PCM16 audio samples to process. More...
 
virtual bool isSpeechEnded ()=0
 Returns detection state. More...
 

Static Public Member Functions

static SpeechEndpointDetector::Ptr create (size_t minSpeechLengthMs, size_t maxSilenceLengthMs, size_t sampleRate)
 Factory method for creating SpeechEndpointDetector instance. More...
 

Detailed Description

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

Member Function Documentation

◆ addSamples() [1/3]

virtual void voicesdk::SpeechEndpointDetector::addSamples ( const float *  samples,
size_t  samplesNum 
)
pure virtual

Adds float audio samples to process.

Parameters
samplespointer to array containing normalized (from -1 to 1) float audio samples
samplesNumsize of array with samples
Exceptions
std::runtime_errorif runtime error occurred
voicesdk::LicenseExceptionif license error occurred

◆ addSamples() [2/3]

virtual void voicesdk::SpeechEndpointDetector::addSamples ( const int16_t *  samples,
size_t  samplesNum 
)
pure virtual

Adds PCM16 audio samples to process.

Parameters
samplespointer to array with samples
samplesNumsize of array with samples
Exceptions
std::runtime_errorif runtime error occurred
voicesdk::LicenseExceptionif license error occurred

◆ addSamples() [3/3]

virtual void voicesdk::SpeechEndpointDetector::addSamples ( const uint8_t *  bytes,
size_t  bytesNum 
)
pure virtual

Adds PCM16 audio samples to process.

Parameters
bytespointer to array with samples
bytesNumsize of array with samples
Exceptions
std::runtime_errorif runtime error occurred
voicesdk::LicenseExceptionif license error occurred

◆ create()

static SpeechEndpointDetector::Ptr voicesdk::SpeechEndpointDetector::create ( size_t  minSpeechLengthMs,
size_t  maxSilenceLengthMs,
size_t  sampleRate 
)
static

Factory method for creating SpeechEndpointDetector instance.

Parameters
minSpeechLengthMsminimum speech length required to begin speech end detection (ms)
maxSilenceLengthMssilence after speech threshold used to determine if speech is already ended (ms)
sampleRateinput signal sampling rate
Returns
smart pointer to SpeechEndpointDetector instance
Exceptions
std::runtime_errorif runtime error occurred
voicesdk::LicenseExceptionif license error occurred

◆ isSpeechEnded()

virtual bool voicesdk::SpeechEndpointDetector::isSpeechEnded ( )
pure virtual

Returns detection state.

Returns
true if speech end was detected, false otherwise