Browse
 
Tools
Rss Categories

LV_TTS_GetSynthesisWarningMessage

Reference Number: AA-01990 Views: 2128 0 Rating/ Voters
    

Returns the message of the specified warning as a character string.

This functionality was added in LumenVox version 13.0 (December 2014).

Function

  • LV_TTS_RETURN_CODE LV_TTS_GetSynthesisWarningMessage(HTTSCLIENT client_handle, unsigned int warning_idx, char * message_buffer, int message_buffer_length);

Parameters

client_handle

Handle to the active TTS client object.

warning_idx

Index of the warning whose message is being queried. It must be in the range [0, (warning_count - 1)] where warning_count was obtained from a call to LV_TTS_GetSynthesisWarningCount.

message_buffer

Memory address of a character string array that will be populated with the queried warning message.

message_buffer_length

Length in bytes of the maximum string length permitted in message_buffer.

Return Values

LV_SUCCESS

No errors; the queried warning message is available in warning_buffer.

LV_INVALID_TTS_HANDLE

The input TTS client handle is not a valid one.

LV_NO_RESULT_AVAILABLE

Synthesis results are not yet available.

LV_FAILURE

The input warning_idx is out of range.

LV_EXCEPTION

An exception occurred while processing the request.