voicesdk::QualityCheckEngineResult Struct Reference

Structure representing audio quality check result. More...

#include <voicesdk/media/quality_check.h>

Public Types
enum	QualityCheckShortDescription : uint8_t {   QualityCheckShortDescription::kTooNoisy = 0, QualityCheckShortDescription::kTooSmallSpeechLength = 1, QualityCheckShortDescription::kOk = 2, QualityCheckShortDescription::kTooSmallSpeechRelativeLength = 3,   QualityCheckShortDescription::kMultipleSpeakersDetected = 4 }
	Enumeration representing short quality check description. More...

Public Member Functions
bool	operator== (const QualityCheckEngineResult &other) const

Public Attributes
float	snr_db
	SNR metric value obtained on quality check in Db. More...
float	speech_length_ms
	Speech length metric value obtained on quality check in milliseconds. More...
float	speech_relative_length
	Speech relative length (speech length relative to the total audio length) metric value obtained on quality check. More...
float	multiple_speakers_detector_score
	Multiple speakers detector score value obtained on quality check. More...
QualityCheckShortDescription	quality_check_short_description
	Short description of the quality check results. More...

Friends
std::ostream &	operator<< (std::ostream &os, const QualityCheckEngineResult &obj)

Detailed Description

Structure representing audio quality check result.

Member Enumeration Documentation

QualityCheckShortDescription

enum voicesdk::QualityCheckEngineResult::QualityCheckShortDescription : uint8_t

strong

Enumeration representing short quality check description.

Enumerator
kTooNoisy	Too noisy audio.
kTooSmallSpeechLength	Too small speech length in the audio.
kOk	Audio successfully passed quality check.
kTooSmallSpeechRelativeLength	Too small speech relative length (speech length relative to the total audio length).
kMultipleSpeakersDetected	Multiple speakers detected.

Member Function Documentation

operator==()

bool voicesdk::QualityCheckEngineResult::operator== ( const QualityCheckEngineResult &  other ) const

inline

Friends And Related Function Documentation

operator<<

std::ostream& operator<< ( std::ostream &  os, const QualityCheckEngineResult &  obj  )

friend

Member Data Documentation

multiple_speakers_detector_score

float voicesdk::QualityCheckEngineResult::multiple_speakers_detector_score

Multiple speakers detector score value obtained on quality check.

quality_check_short_description

QualityCheckShortDescription voicesdk::QualityCheckEngineResult::quality_check_short_description

Short description of the quality check results.

snr_db

float voicesdk::QualityCheckEngineResult::snr_db

SNR metric value obtained on quality check in Db.

speech_length_ms

float voicesdk::QualityCheckEngineResult::speech_length_ms

Speech length metric value obtained on quality check in milliseconds.

speech_relative_length

float voicesdk::QualityCheckEngineResult::speech_relative_length

Speech relative length (speech length relative to the total audio length) metric value obtained on quality check.