Returns the length of the message of the specified warning. This can be used to properly size the buffer needed for LV_TTS_GetSynthesisWarningMessage.
This functionality was added in LumenVox version 13.0 (December 2014).
Function
- LV_TTS_RETURN_CODE LV_TTS_GetSynthesisWarningMessageLen(HTTSCLIENT client_handle, unsigned int warning_idx, int * return_val);
Parameters
client_handle
Handle to the TTS client object.
warning_idx
Index of the warning whose message length 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.
return_val
Pointer to an integer variable into which the message length will be copied.
Return Values
LV_SUCCESS
No errors; the queried message length value is available in return_val.
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_idxis out of range.
LV_EXCEPTION
An exception occurred while processing the request.
