LV_TTS_Synthesize

Perform the text to speech operation for the given sentence or SSML text.

Function

• LV_TTS_RETURN_CODE LV_TTS_Synthesize(HTTSCLIENT client_handle,
• const char * input_sentence,
• unsigned int flags)

Parameters

client_handle

Handle to the TTS client object.

input_sentence

Can be a simple sequence of words/sentences or an SSML document.

flags

Used to control certain facets of the operation. Mostly unused in the current implementation besides LV_TTS_BLOCK. Setting the LV_TTS_BLOCK bit in flags causes the call to wait for a response back from the TTS server before returning.

Return Values

LV_SUCCESS

No errors; synthesis succeeded.

LV_INVALID_TTS_HANDLE

The input TTS client handle is not a valid one.

LV_NO_COMPATIBLE_TTS_SERVERS

Either none of the connected TTS servers carry a voice corresponding to the requested features, or no TTS servers are available at the time.

LV_ACQUIRING_LICENSE_FAILED

Either failed to switch license type based on the currently set voice properties or failed to acquire any additionally needed licenses.

LV_EXPIRED_LICENSE

The acquired license(s) do not permit using the current version of the TTS server.

LV_INVALID_LICENSE_MAINT_DATE

The maintenance date of the available license(s) is/are invalid.

LV_INVALID_CLIENT_OBJECT

The internal representation of the client_handle is corrupted.

LV_NO_TTS_SERVERS

Not connected to any TTS server yet.

LV_EXCEPTION

An exception occured while processing the request.

-- -- The following values may be returned only when blocking synthesis is performed. -- --

LV_SSML_ERROR

The input SSML had syntax error(s).

LV_RESOURCE_ERROR

The TTS server is out of resources, or no voices have been loaded.

LV_FAILED_NO_VOICE_SPECIFIED

There was an error in the request, no voices were specified.

LV_FAILED_VOICE_LOAD

The TTS server failed to load one or more of the needed voices.

LV_FAILED_SYNTHESIS

The input was neither plain text nor SSML; or conversion of input SSML to UTF-8 format failed.

LV_FAILED_STREAMER

An exception occured on the TTS server while processing the input SSML.

LV_FAILED_AUDIO_CONVERSION

Conversion of the synthesized audio to the requested sound format and/or sampling rate has failed.

LV_TIME_OUT

The synthesis request timed out.

See Also

• LV_TTS_WaitForSynthesis
• LV_TTS_GetLastSSMLError
• LVTTSClient::Synthesize (C++ API)