yodaRT.activity.Activity. TtsClient

Extends

Methods

speak(text, optionsopt) → {Promise.<void>}

Speak the given text.

Parameters:
Name Type Attributes Description
text string
options object <optional>
Name Type Attributes Default Description
impatient boolean <optional>
false

wait for end of tts speech, set false to resolve once tts are scheduled

Returns:
Type:
Promise<void>

Resolved on end of speech

stop() → {Promise.<void>}

Stop the current task.

Returns:
Type:
Promise<void>

Events

start

The TTS job is started.

Parameters:
Name Type Description
id string

tts player id

cancel

The TTS job is cancelled.

Parameters:
Name Type Description
id string

tts player id

end

The TTS job is ended.

Parameters:
Name Type Description
id string

tts player id

error

The TTS job went wrong.

Parameters:
Name Type Description
id string

tts player id