YSKSpeechKit class

#import <YSKSpeechKit.h>

Singleton class aimed at setting up and controlling overall SpeechKit operation.

SpeechKit objects should not be explicitly created or destroyed by the user. To access an object, use the sharedInstance method, which creates a YSKSpeechKit object when called for the first time. This object is destroyed along with the end of the app.

Instance methods

- configureWithAPIKey:

Configuring SpeechKit.

- getParameterValue:

Returns the value of SpeechKit internal parameters.

- setParameter:withValue:

Sets internal SpeechKit library parameters.

Class methods

+ sharedInstance

Returns a shared instance of the YSKSpeechKit class.

+ speechkitVersion

Returns the SpeechKit version.

Method descriptions

- configureWithAPIKey:

- (void) configureWithAPIKey:(NSString *) apiKey

Configuring SpeechKit.

The method should be called before beginning to use the SpeechKit functionality (for example, before creating instances of YSKRecognizer).
Parameters:
apiKey

The API key provided by Yandex. For more information about keys, see the section "apikeys".

Note.

In the current implementation, the API key is verified only when working with the server (for example, when performing initialization) and this may fail with the kYSKErrorAPIKey error.

- getParameterValue:

- (NSString *) getParameterValue:(NSString *) name

Returns the value of SpeechKit internal parameters.

Parameters:
name

name of the internal parameter

Returns:

Value of the internal parameter

- setParameter:withValue:

- (void) setParameter:(NSString *) name
withValue:(NSString *) value

Sets internal SpeechKit library parameters.

Parameters:
name

name of the internal parameter

value

value of the internal parameter

+ sharedInstance

+ (instancetype) sharedInstance

Returns a shared instance of the YSKSpeechKit class.

Returns:

shared instance of the YSKSpeechKit class.

+ speechkitVersion

+ (NSString *) speechkitVersion

Returns the SpeechKit version.

Returns:

String representation of the SpeechKit version number.