Returns the message of the specified warning as a character string.
This functionality was added in LumenVox 13.0 (December 2014).
Function
- LV_TTS_RETURN_CODE GetSynthesisWarningMessage( unsigned int warning_idx, char * message_buffer, int message_buffer_length )
Parameters
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 LVTTSClient::GetSynthesisWarningCount.
message_buffer
Pointer to 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 message is available in message_buffer.
LV_INVALID_TTS_HANDLE
The TTS client handle is invalid (either Initialize has not been called or Destroy has already been called).
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.
