SUI_InitializeTTS Table of Contents || Prev | Next || [?]

 
SUI_InitializeTTS ({engineMode}) --> error
 
ParameterTypeDescription
engineModeInteger0 = Native TTS Engine; 1 = Cepstral TTS Engine
 
ReturnsTypeDescription
errorIntegererror code
 
Description

SUI_InitializeTTS prepares the text-to-speech engine for use. This command must be called once before SUI_Say or SUI_GetSpeechBusy can be used. The voice settings used will be those specified in the Speech Control Panel.

Error Codes

>0: TTS engine failed to initialize
-1: TTS engine already initialized

New in v3.0.0

If you have Cepstral voices installed, you can call Cepstral's TTS engine directly by calling this with a parameter of 1. Some benefits include faster response on older Macs than when using Apple's TTS engine, and the ability to use SSML tags. If you choose this option, the first Cepstral voice found will be loaded. You can change it using SUI_SetTTSVoice.