KIOSRecognizer.h

//
//  KIOSRecognizer.h
//  KeenASR
//
//  Created by Ognjen Todic on 2/29/16.
//  Copyright © 2016 Keen Research. All rights reserved.
//
 
#ifndef KIOSRecognizer_h
#define KIOSRecognizer_h
 
@class KIOSRecognizer;
@class KIOSResponse;
 
// @name Constants

typedef NS_ENUM(NSInteger, KIOSRecognizerType) {
  KIOSRecognizerTypeUnknown = -1,
  KIOSRecognizerTypeGMM,
  KIOSRecognizerTypeNNet,
  KIOSRecognizerTypeNNet3,
  KIOSRecognizerTypeNNet3Chain
};
 

typedef NS_ENUM(NSInteger, KIOSRecognizerLogLevel) {
  KIOSRecognizerLogLevelDebug=0,
  KIOSRecognizerLogLevelInfo,
  KIOSRecognizerLogLevelWarning,
};

typedef NS_ENUM(NSInteger, KIOSRecognizerState) {
  KIOSRecognizerStateNeedsDecodingGraph=0,
  KIOSRecognizerStateReadyToListen,
  KIOSRecognizerStateListening,
  KIOSRecognizerStateFinalProcessing,
};

//typedef NS_ENUM(NSInteger, KIOSResponseDataKey) {
//  KIOSResponseDataKeyExpectedResult,
//  KIOSResponseDataKeyPrompt,
//  KIOSResponseDataKeyCustomJSONData,
//};

typedef NS_ENUM(NSInteger, KIOSVadParameter) {
  KIOSVadTimeoutForNoSpeech=0,

  KIOSVadTimeoutEndSilenceForGoodMatch,
  
  KIOSVadTimeoutEndSilenceForAnyMatch,

  KIOSVadTimeoutMaxDuration
};
 
 
 
/*  ################## KIOSResult #############*/
 
@class KIOSWord;

@interface KIOSResult : NSObject

@property(nonatomic, readonly, nonnull) NSString *text;

@property(nonatomic, readonly, nonnull) NSString *cleanText;

@property(nonatomic, strong, readonly, nullable) NSArray<KIOSWord *> *words;
 
@property(nonatomic, readonly, nullable) NSNumber *confidence DEPRECATED_MSG_ATTRIBUTE("Deprecated");
 
 
- (nonnull NSString *)description;

- (nullable NSString *)toJSON;
 
- (nullable NSDictionary *)toDictionary;
 
@end
 
 
@class KIOSPhone;
@interface KIOSWord : NSObject
@property (nonatomic, readonly, nonnull) NSString *text;

@property (nonatomic, strong, nullable, readonly) NSNumber *startTime;

@property (nonatomic, strong, nullable, readonly) NSNumber *duration;
 
@property (nonatomic, strong, nullable, readonly) NSNumber *confidence
__deprecated_msg("Deprecated. Result will most likely contain <SPOKEN_NOISE> word");

@property(nonatomic, strong, nullable) NSArray<KIOSPhone *> *phones;
 

@property (nonatomic, assign, readonly, getter=isTag) BOOL tag
__deprecated_msg("Temporarily deprecated");
 
- (nonnull NSString *)description;
 
@end

@interface KIOSPhone : NSObject
@property (nonatomic, readonly, nonnull) NSString *text;
 
@property (nonatomic, strong, nullable, readonly) NSNumber *startTime;
 
@property (nonatomic, strong, nullable, readonly) NSNumber *duration;
 
@property (nonatomic, strong, nullable, readonly) NSNumber *pronunciationScore;
 
@end
 
/*  ################## KIOSRecognizerDelegate #############*/
 

@protocol KIOSRecognizerDelegate <NSObject>


- (void)unwindAppAudioBeforeAudioInterrupt;

 
@optional
- (void)triggerPhraseDetected:(nonnull KIOSRecognizer *)recognizer;
 
- (void)recognizerTriggerPhraseDetectedForRecognizer:(nonnull KIOSRecognizer *)recognizer
__deprecated_msg("Please see triggerPhraseDetected");
;
 

- (void)recognizerPartialResult:(nonnull KIOSResult *)result
                  forRecognizer:(nonnull KIOSRecognizer *)recognizer;
 

- (void)recognizerFinalResponse:(nonnull KIOSResponse *)response
                forRecognizer:(nonnull KIOSRecognizer *)recognizer;
 

- (void)recognizerReadyToListenAfterInterrupt:(nonnull KIOSRecognizer *)recognizer;
 

// is about to re-init its audio stack. This callback will be called *before*
// KIOSRecognizer audio stack is reinitialized and you would use it to setup your
// own audio stack, if necessary.
// 
// */
//- (void)setupAppAudioAfterInterrupt;
 
 
@end
 
 
 
/*  ################## KIOSRecognizer #############*/

@interface KIOSRecognizer : NSObject
 


+ (nullable KIOSRecognizer *)sharedInstance;
 

@property(nonatomic, weak, nullable) id<KIOSRecognizerDelegate> delegate;

@property(assign, readonly) KIOSRecognizerState recognizerState;

@property(nonatomic, readonly, nonnull) NSString *asrBundlePath;

@property(nonatomic, readonly, nonnull) NSString *asrBundleName;

@property(nonatomic, readonly, copy, nullable) NSString *asrBundleLang;

@property(nonatomic, readonly, nullable) NSString *currentDecodingGraphName;

@property(nonatomic, readonly, nullable) NSString *recordingsDir;

@property(nonatomic, readonly, nullable) NSString *miscDataDirectory;

//@property(nonatomic, readonly, nonnull) NSString *langCode; // TODO

@property(nonatomic, assign) BOOL rescore;
 

 

 
+ (BOOL)initWithASRBundle:(nonnull NSString *)bundleName;
 

 
+ (BOOL)initWithASRBundleAtPath:(nonnull NSString *)pathToASRBundle;
 
 
//+ (instancetype) alloc  __attribute__((unavailable("alloc not available, call sharedInstance instead")));
//- (instancetype) init   __attribute__((unavailable("init not available, call sharedInstance instead")));
+ (nullable instancetype) new __attribute__((unavailable("new not available, call sharedInstance instead")));

 
+ (BOOL)teardown;
 

- (void) setVadGating:(BOOL)value;
 

- (BOOL)prepareForListeningWithDecodingGraphWithName:(nonnull NSString *)dgName
                                  withGoPComputation:(BOOL)computeGoP;
 

- (BOOL)prepareForListeningWithDecodingGraphAtPath:(nonnull NSString *)pathToDecodingGraphDirectory
                                withGoPComputation:(BOOL)computeGoP;

- (BOOL)prepareForListeningWithContextualDecodingGraphWithName:(nonnull NSString *)dgName
                                                  andContextId:(nonnull NSNumber *) contextId
                                            withGoPComputation:(BOOL)computeGoP;

- (BOOL)prepareForListeningWithContextualDecodingGraphAtPath:(nonnull NSString *)dgPath
                                                andContextId:(nonnull NSNumber *)contextId
                                          withGoPComputation:(BOOL)computeGoP;
 
 

- (BOOL)startListening:(NSString *_Nullable*_Nullable) responseId;
 
 
 

- (void)stopListening;
 


- (void)adaptToSpeakerWithName:(nonnull NSString *)speakerName;
 

- (void)resetSpeakerAdaptation;
 

- (void)saveSpeakerAdaptationProfile;
 
 

+ (BOOL)removeAllSpeakerAdaptationProfiles;

+ (BOOL)removeSpeakerAdaptationProfiles:(nonnull NSString *)speakerName;
 
 
/*
 @name Audio Interruption Management
 When audio interruption occurs, due to a phone call, SMS, etc.  SDK will
 automatically stop listening if necessary, and tear down the internal audio setup.
 When interrupt ends audio will be automatically reinitialized. You can define
 a callback method recognizerReadyToListenAfterInterrupt: to track when these
 changes happen.
 */

//- (void)audioInterruptionEndedHandler:(nonnull void (^)(void))callbackBlock;
 

@property(nonatomic, assign, setter=setHandleNotifications:) BOOL handleNotifications;
 

- (float)inputLevel;

+ (BOOL)echoCancellationAvailable;
 

- (BOOL)performEchoCancellation:(BOOL)value;
 
 

- (void)setBluetoothA2DPOutput:(BOOL)value;
 
 

- (BOOL)deactivateAudioStack;
 

- (BOOL)activateAudioStack;

- (void) reinitAudioStack;


- (void)setVADParameter:(KIOSVadParameter)parameter toValue:(float)value;
 
 


+ (nonnull NSString *)version;
 

 
+ (void)setLogLevel:(KIOSRecognizerLogLevel)logLevel;
 
 

 
@property(nonatomic, readonly, nullable) NSString *lastRecordingFilename
__deprecated_msg("Please see KIOSResponse for more details");
 
@property(nonatomic, readonly, nullable) NSString *lastJSONMetadataFilename
__deprecated_msg("Please see KIOSResponse for more details");
 
- (BOOL)prepareForListeningWithCustomDecodingGraphWithName:(nonnull NSString *)dgName
__deprecated_msg("Please use prepareForListeningWithDecodingGraphWithName");
 
- (BOOL)prepareForListeningWithCustomDecodingGraphAtPath:(nonnull NSString *)pathToDecodingGraphDirectory
__deprecated_msg("Please use prepareForListeningWithDecodingGraphAtPath");
 
- (BOOL)startListeningFromAudioFile:(nonnull NSString *)pathToAudioFile
__deprecated_msg("Temporarily deprecated; methods to feed audio directly to the recognizer will be provided in the future");
 
 
//- (BOOL)setResponseDataForKey:(KIOSResponseDataKey) key
//                        value:(nonnull NSObject *) value
//__deprecated_msg("Temporarily disabled");
 
 
- (void)enableBluetoothOutput:(BOOL)value __attribute__((deprecated("use setBluetoothA2DPOutput instead")));
 
- (void)enableBluetoothA2DPOutput:(BOOL)value __attribute__((deprecated("use setBluetoothA2DPOutput instead")));
 
@end
 
#endif /* KIOSRecognizer_h */