Class YSKOnlineVocalizer

Class for online speech synthesis and text-to-speech.

Responsible for sending text to the server and vocalizing synthesized speech. Implements the YSKVocalizing protocol.
Note.
When playing the synthesized speech using the embedded player in the YSKOnlineVocalizer class object, correctly configure the app's audio session. The YSKAudioSessionHandler class makes it easier to configure the audio session:
  • If your app uses an audio session only when working with the SpeechKit library, we recommend using this class to configure the audio session.

  • If your app uses the audio session outside the library (for audio and video playback, audio recording, and so on), you can also use this class or configure the audio session independently. If you decide to configure an audio session yourself, pay attention to the settings which may affect the operation of the player in the YSKOnlineVocalizer class object (the audio session settings are described in the YSKAudioSessionHandler class). Without appropriate settings, the YSKOnlineVocalizer class object returns the YSKErrorAudioPlaying error in the vocalizer:didFailWithError: method. Possible error codes are listed in YSKErrorCode.

Instance Methods

-initWithSettings:

Initializes an object of the YSKOnlineVocalizer class with the specified settings.

-initWithSettings:session:

Initializes an object of the YSKOnlineVocalizer class with the specified settings and network connection.

Properties

settings

Settings of an object of the YSKOnlineVocalizer class.

Method Detail

-initWithSettings:

- (instancetype)initWithSettings:(YSKOnlineVocalizerSettings *)settings 

Initializes an object of the YSKOnlineVocalizer class with the specified settings.

Parameters:
settings

Settings of an object of the YSKOnlineVocalizer class.

Returns:

An object of the YSKOnlineVocalizer class.

-initWithSettings:session:

- (instancetype)initWithSettings:(YSKOnlineVocalizerSettings *)settings
                         session:(YSKUniProxySession *)session 

Initializes an object of the YSKOnlineVocalizer class with the specified settings and network connection.

The session parameter allows using multiple components within a single network connection. This method is a designated initializer for the YSKOnlineVocalizer class.
Parameters:
settings

Settings of an object of the YSKOnlineVocalizer class.

session

An object of the YSKUniProxySession class that will be used for a network connection.

Returns:

An object of the YSKOnlineVocalizer class.