LV_TTS_CreateClient

Create a TTS client object that is necessary to perform any TTS operations.

Function

HTTSCLIENT LV_TTS_CreateClient(const char * lang_code,
const char * gender,
const char * speaker_name,
unsigned int sampling_rate,
LV_TTS_RETURN_CODE * error_return_code)

Parameters

lang_code

The language of the voice that is to be used for synthesis.

gender

The default gender of the voice that is to be used for synthesis. If speaker_name is not NULL, the gender of the chosen speaker will override this setting. Possible values are "Male" and "Female".

speaker_name

Specify the name of the speaker whose voice is to be used for synthesis. If NULL, a general voice for the specified gender will be used.

sampling_rate

The sampling rate (in Hz) the synthesized audio is expected to be produced in.

error_return_code

A variable that would contain a code representing the reason for failure. Passing in NULL (if you do not care to know the reason for failure) does not affect the functioning.

Return Values

Non-NULL

Creation of a TTS client handle succeeded

NULL

Creation of a TTS client handle failed

Possible values returned with error_return_code

LV_SUCCESS

No errors; the call succeeded.

LV_INVALID_API_PARAMETER

One or more inputs to the call are invalid.

LV_NO_COMPATIBLE_TTS_SERVERS

None of the connected TTS servers carry a voice corresponding to the requested features.

LV_ACQUIRING_LICENSE_FAILED

Acquiring of a license matching the input voice specifications failed.

LV_EXCEPTION

An exception occured while processing the request.

Remarks

The above inputs to the call only specify the defaults. If the input for synthesis is an SSML document, any additionally required voices are loaded automatically (if available).

Upon call failure, you must inspect the value returned in error_return_code to determine the reason for the failure.