YSKInitializer class

#import <YSKInitializer.h>

Class that initializes the library.

Initialization is a process for initializing internal SpeechKit mechanisms.

The initializer sends a request to the server and gets a set of parameters and configurations in response (such as the audio format or parameters of the active voice detection algorithm), which are then used by other library components.

You don't have to perform explicit initialization. SpeechKit initializes automatically when it receives the first request for speech recognition or synthesis. However, initialization may take a considerable time, because it involves reading from permanent memory and network requests. To reduce the time for executing the first request, perform initialization before using other library components.

Note.

The initializer is designed to carry out a single startup and may not be reused.

Note.

Before creating YSKInitializer objects, you must call configureWithAPIKey: or configureWithAPIKey:andLocationProvider:.

Instance methods

-init

Creates a single-use initializer.

-start

Releases resources used by the initializer.

Class methods

+isInitializationCompleted

Checks whether the initialization process is completed.

Properties

delegate

Delegate for notification about the progress of initialization.

Method descriptions

-init

- (instancetype) init

Creates a single-use initializer.

To start the initialization process, call the start method.

Returns:

The created initializer.

+isInitializationCompleted

+ (BOOL) isInitializationCompleted

Checks whether the initialization process is completed.

-start

- (void) start

Releases resources used by the initializer.

Starts the initialization process.

Property descriptions

delegate

(weak, readwrite) id< YSKInitializerDelegate > delegate

Delegate for notification about the progress of initialization.

The delegate will receive notifications when the initialization starts and finishes, and when initialization errors occur.