QualityCheckEngine

Superclass:
NSObject
Declared In:

Introduction

Class for audio quality checking.



Methods

-checkQuality:sampleRate:thresholds:error:

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

-checkQuality:thresholds:error:

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

-getRecommendedThresholds:error:

Gets recommended quality checking thresholds for the specified scenario.

-initWithPath:error:

Creates QualityCheckEngine instance.


checkQuality:sampleRate:thresholds:error:


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

- (QualityCheckEngineResult* _Nullable)checkQuality:(NSData* _Nonnull)PCM16Samples 
        sampleRate:(size_t)sampleRate thresholds:(QualityCheckMetricsThresholds* _Nonnull)thresholds 
        error:(NSError* _Nullable* _Nullable)error; 
Parameters
PCM16Samples

PCM16 audio data

sampleRate

audio sample rate

thresholds

quality checking thresholds that will be applied to the output quality check metrics

error

pointer to NSError for error reporting

Return Value

Quality check result.


checkQuality:thresholds:error:


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

- (QualityCheckEngineResult* _Nullable)checkQuality:(NSString* _Nonnull)wavPath 
        thresholds:(QualityCheckMetricsThresholds* _Nonnull)thresholds 
        error:(NSError* _Nullable* _Nullable)error; 
Parameters
wavPath

path to WAV file

thresholds

quality checking thresholds that will be applied to the output quality check metrics

error

pointer to NSError for error reporting

Return Value

Quality check result.


getRecommendedThresholds:error:


Gets recommended quality checking thresholds for the specified scenario.

- (QualityCheckMetricsThresholds* _Nullable)
        getRecommendedThresholds:(QualityCheckScenario)scenario error:(NSError* _Nullable* _Nullable)error; 
Parameters
scenario

scenario for which recommended thresholds will be returned

error

pointer to NSError for error reporting

Return Value

Quality check thresholds that can be used on quality checking.


initWithPath:error:


Creates QualityCheckEngine instance.

- (instancetype _Nullable)initWithPath:(NSString* _Nonnull)initPath 
        error:(NSError* _Nullable* _Nullable)error; 
Parameters
initPath

initialization data path

error

pointer to NSError for error reporting