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

Speech summary engine class (interface), intended to calculate SpeechSummary with given audio samples. More...

#include <voicesdk/media/speech_summary.h>

Public Types

using Ptr = std::shared_ptr< SpeechSummaryEngine >
 

Public Member Functions

virtual SpeechSummary getSpeechSummary (const uint8_t *bytes, size_t bytesNum, size_t sampleRate)=0
 Calculates speech summary with given PCM16 audio samples. More...
 
virtual SpeechSummary getSpeechSummary (const int16_t *pcm16Samples, size_t samplesNum, size_t sampleRate)=0
 Calculates speech summary with given PCM16 audio samples. More...
 
virtual SpeechSummary getSpeechSummary (const float *floatSamples, size_t samplesNum, size_t sampleRate)=0
 Calculates speech summary with given float audio samples (in [-1; 1] range) More...
 
virtual SpeechSummary getSpeechSummary (const std::string &audioFile)=0
 Calculates speech summary with given audio file. More...
 
virtual SpeechSummaryStream::Ptr createStream (int sampleRate)=0
 Factory method for creating SpeechSummaryStream. More...
 

Static Public Member Functions

static SpeechSummaryEngine::Ptr create (const std::string &initPath="")
 Creates SpeechSummaryEngine instance. More...
 

Detailed Description

Speech summary engine class (interface), intended to calculate SpeechSummary with given audio samples.

Member Function Documentation

◆ create()

static SpeechSummaryEngine::Ptr voicesdk::SpeechSummaryEngine::create ( const std::string &  initPath = "")
static

Creates SpeechSummaryEngine instance.

Parameters
initPathInitialization data path
Returns
Smart pointer to created SpeechSummaryEngine instance
Exceptions
std::runtime_errorif runtime error occurred

◆ createStream()

virtual SpeechSummaryStream::Ptr voicesdk::SpeechSummaryEngine::createStream ( int  sampleRate)
pure virtual

Factory method for creating SpeechSummaryStream.

Parameters
sampleRatesample rate of audio stream
Returns
speech summary stream
Exceptions
std::runtime_errorif runtime error occurred*

◆ getSpeechSummary() [1/4]

virtual SpeechSummary voicesdk::SpeechSummaryEngine::getSpeechSummary ( const float *  floatSamples,
size_t  samplesNum,
size_t  sampleRate 
)
pure virtual

Calculates speech summary with given float audio samples (in [-1; 1] range)

Parameters
floatSamplespointer to array with samples
samplesNumsize of array with samples
sampleRatesample rate
Returns
speech summary
Exceptions
std::runtime_errorif runtime error occurred

◆ getSpeechSummary() [2/4]

virtual SpeechSummary voicesdk::SpeechSummaryEngine::getSpeechSummary ( const int16_t *  pcm16Samples,
size_t  samplesNum,
size_t  sampleRate 
)
pure virtual

Calculates speech summary with given PCM16 audio samples.

Parameters
pcm16Samplespointer to array with samples
samplesNumsize of array with samples
sampleRatesample rate
Returns
speech summary
Exceptions
std::runtime_errorif runtime error occurred

◆ getSpeechSummary() [3/4]

virtual SpeechSummary voicesdk::SpeechSummaryEngine::getSpeechSummary ( const std::string &  audioFile)
pure virtual

Calculates speech summary with given audio file.

Parameters
audioFilepath to audio file
Returns
speech summary
Exceptions
std::runtime_errorif runtime error occurred

◆ getSpeechSummary() [4/4]

virtual SpeechSummary voicesdk::SpeechSummaryEngine::getSpeechSummary ( const uint8_t *  bytes,
size_t  bytesNum,
size_t  sampleRate 
)
pure virtual

Calculates speech summary with given PCM16 audio samples.

Parameters
bytespointer to array with samples
bytesNumsize of array with samples
sampleRatesample rate
Returns
speech summary
Exceptions
std::runtime_errorif runtime error occurred