Call Center SDK  1.11.3
All Classes Functions Variables Typedefs Enumerations Enumerator Pages
Public Types | Public Member Functions | Static Public Member Functions | List of all members
voicesdk::QualityCheckEngine Class Referenceabstract

Quality check engine class. More...

#include <voicesdk/media/quality_check.h>

Public Types

using Ptr = std::shared_ptr< QualityCheckEngine >
 

Public Member Functions

virtual QualityCheckMetricsThresholds GetRecommendedThresholds (QualityCheckScenario scenario) const =0
 Gets recommended quality checking thresholds for the specified scenario. More...
 
virtual QualityCheckEngineResult CheckQuality (const std::string &audio_path, const QualityCheckMetricsThresholds &thresholds) const =0
 Checks whether audio file is suitable from the quality perspective, from the given audio file. More...
 
virtual QualityCheckEngineResult CheckQuality (const float *float_samples, size_t num_samples, size_t sample_rate, const QualityCheckMetricsThresholds &thresholds) const =0
 Checks whether audio buffer is suitable from the quality perspective, from the given float audio samples. More...
 
virtual QualityCheckEngineResult CheckQuality (const int16_t *pcm16_samples, size_t num_samples, size_t sample_rate, const QualityCheckMetricsThresholds &threshold) const =0
 Checks whether audio buffer is suitable from the quality perspective, from the given PCM16 audio samples. More...
 
virtual QualityCheckEngineResult CheckQuality (const uint8_t *pcm16_bytes, size_t num_bytes, size_t sample_rate, const QualityCheckMetricsThresholds &thresholds) const =0
 Checks whether audio buffer is suitable from the quality perspective, from the given PCM16 audio samples. More...
 

Static Public Member Functions

static QualityCheckEngine::Ptr Create (const std::string &init_path)
 Creates QualityCheckEngine instance. More...
 

Detailed Description

Quality check engine class.

Member Function Documentation

◆ CheckQuality() [1/4]

virtual QualityCheckEngineResult voicesdk::QualityCheckEngine::CheckQuality ( const float *  float_samples,
size_t  num_samples,
size_t  sample_rate,
const QualityCheckMetricsThresholds thresholds 
) const
pure virtual

Checks whether audio buffer is suitable from the quality perspective, from the given float audio samples.

Parameters
float_samplesA buffer containing normalized (from -1 to 1) float audio samples
num_samplesNumber of audio samples
sample_rateAudio sampling rate in Hz
thresholdsQuality checking thresholds that will be applied to the output quality check metrics
Returns
Quality check result
Exceptions
std::runtime_errorif runtime error occurred
voicesdk::LicenseExceptionif license error occurred

◆ CheckQuality() [2/4]

virtual QualityCheckEngineResult voicesdk::QualityCheckEngine::CheckQuality ( const int16_t *  pcm16_samples,
size_t  num_samples,
size_t  sample_rate,
const QualityCheckMetricsThresholds threshold 
) const
pure virtual

Checks whether audio buffer is suitable from the quality perspective, from the given PCM16 audio samples.

Parameters
pcm16_samplesA buffer containing PCM16 audio samples
num_samplesNumber of audio samples
sample_rateAudio sampling rate in Hz
thresholdsQuality checking thresholds that will be applied to the output quality check metrics
Returns
Quality check result
Exceptions
std::runtime_errorif runtime error occurred

◆ CheckQuality() [3/4]

virtual QualityCheckEngineResult voicesdk::QualityCheckEngine::CheckQuality ( const std::string &  audio_path,
const QualityCheckMetricsThresholds thresholds 
) const
pure virtual

Checks whether audio file is suitable from the quality perspective, from the given audio file.

Parameters
audio_pathPath to audio file
thresholdsQuality checking thresholds that will be applied to the output quality check metrics
Returns
Quality check result
Exceptions
std::runtime_errorif runtime error occurred
voicesdk::LicenseExceptionif license error occurred

◆ CheckQuality() [4/4]

virtual QualityCheckEngineResult voicesdk::QualityCheckEngine::CheckQuality ( const uint8_t *  pcm16_bytes,
size_t  num_bytes,
size_t  sample_rate,
const QualityCheckMetricsThresholds thresholds 
) const
pure virtual

Checks whether audio buffer is suitable from the quality perspective, from the given PCM16 audio samples.

Parameters
pcm16_bytesA buffer containing byte representation of PCM16 audio bytes
num_bytesNumber of bytes
sample_rateAudio sampling rate in Hz
thresholdsQuality checking thresholds that will be applied to the output quality check metrics
Returns
Quality check result
Exceptions
std::runtime_errorif runtime error occurred
voicesdk::LicenseExceptionif license error occurred

◆ Create()

static QualityCheckEngine::Ptr voicesdk::QualityCheckEngine::Create ( const std::string &  init_path)
static

Creates QualityCheckEngine instance.

Parameters
init_pathInitialization data path
Returns
Smart pointer to created QualityCheckEngine instance
Exceptions
std::runtime_errorif runtime error occurred
voicesdk::LicenseExceptionif license error occurred

◆ GetRecommendedThresholds()

virtual QualityCheckMetricsThresholds voicesdk::QualityCheckEngine::GetRecommendedThresholds ( QualityCheckScenario  scenario) const
pure virtual

Gets recommended quality checking thresholds for the specified scenario.

Parameters
scenarioScenario for which recommended thresholds will be returned
Returns
Quality check thresholds that can be used on quality checking
Exceptions
std::runtime_errorif runtime error occurred
voicesdk::LicenseExceptionif license error occurred