SpeechSummaryEngine

Superclass:
NSObject
Declared In:

Introduction

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



Methods

-createStream:error:

Factory method for creating SpeechSummaryStream.

-getSpeechSummary:error:

Calculates speech summary with given WAW file.

-getSpeechSummary:sampleRate:error:

Calculates speech summary with given PCM16 audio samples.

-initWithPath:error:

Creates SpeechSummaryEngine instance.


createStream:error:


Factory method for creating SpeechSummaryStream.

- (SpeechSummaryStream* _Nullable)createStream:(int)sampleRate 
        error:(NSError* _Nullable* _Nullable)error; 
Parameters
sampleRate

sampling rate of input audio signal in (Hz)

error

pointer to NSError for error reporting

Return Value

Speech summary stream.


getSpeechSummary:error:


Calculates speech summary with given WAW file.

- (SpeechSummary* _Nullable)getSpeechSummary:(NSString* _Nonnull)wavPath 
        error:(NSError* _Nullable* _Nullable)error; 
Parameters
wavPath

path to WAV file

error

pointer to NSError for error reporting

Return Value

Speech summary.


getSpeechSummary:sampleRate:error:


Calculates speech summary with given PCM16 audio samples.

- (SpeechSummary* _Nullable)getSpeechSummary:(NSData* _Nonnull)PCM16Samples 
        sampleRate:(int)sampleRate error:(NSError* _Nullable* _Nullable)error; 
Parameters
PCM16Samples

audio samples in PCM16 format

sampleRate

sampling rate of audio samples

error

pointer to NSError for error reporting

Return Value

Speech summary.


initWithPath:error:


Creates SpeechSummaryEngine instance.

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

path to config file or directory containing init data

error

pointer to NSError for error reporting