Protocol YSKVocalizing

The protocol describes the interface of the object that performs text-to-speech synthesis and conversion.

Instance Methods

-cancel

Cancels the speech synthesis process.

-play

Starts playback of synthesized speech.

-prepare

Prepares an object of the class that implements the YSKVocalizing protocol for speech synthesis.

-synthesize:mode:

Starts text-to-speech synthesis.

Properties

delegate

Delegate for tracking speech synthesis events.

Method Detail

-cancel

- (void)cancel

Cancels the speech synthesis process.

-play

- (void)play

Starts playback of synthesized speech.

-prepare

- (void)prepare

Prepares an object of the class that implements the YSKVocalizing protocol for speech synthesis.

Makes preparation for speech synthesis in advance. If the method is not called explicitly, it is called automatically in the synthesize:mode: method. Asynchronous execution.

-synthesize:mode:

- (void)synthesize:(nonnull NSString *)text
              mode:(YSKTextSynthesizingMode)mode 

Starts text-to-speech synthesis.

Can be called multiple times for a single class object that implements the YSKVocalizing protocol. If speech synthesis is not completed when the method is called again, the object's behavior will be determined by the mode parameter. Asynchronous execution.
Parameters:
text

The text for synthesis.

mode

The behavior of the class object that implements the YSKVocalizing protocol if the previously launched synthesis process was not completed.

Property Detail

delegate

(weak, readwrite) id< YSKVocalizerDelegate > delegate

Delegate for tracking speech synthesis events.