C++ SDK

◆ PlaySoundTTS()

static int CApplicationAPI::PlaySoundTTS ( LpError  lpError,
LPCTSTR  lpszText,
DWORD  dwMaxTime = DEFAULT_MAX_TIME 
)
static

Uses the TTS engine, if installed, to speak the given text message.

Parameters
lpErrorAdditional error information returned from Drive.
lpszTextText message to be read by TTS
dwMaxTimeMaximum time (in milliseconds) function can take. If dwMaxTime=0 function execution is not time limited.
Returns
1 if successful, other value otherwise.

Possible error codes returned from Drive are:

  • 0 - Function not succeeded.
  • 1 - Function succeeded.
  • 2 - Drive not succeeded.
  • 3 - Function reached timeout.