Returns the name of the specified SSML mark as a character string. See SSML documentation for more information relating to Mark elements and how they can be used within SSML syntheses.
Function
- LV_TTS_RETURN_CODE LV_TTS_GetSSMLMarkName(HTTSCLIENT client_handle, unsigned int ssml_mark_idx, char * name_buffer, int name_buffer_length);
Parameters
client_handle
Handle to the active TTS client object.
ssml_mark_idx
Index of the SSML mark whose name is being queried. It must be in the range [0, (ssml_marks_count - 1)] where ssml_marks_count was obtained from a call to LV_TTS_GetSSMLMarksCount.
name_buffer
Memory address of a character string array that will be populated with the queried SSML mark's name.
name_buffer_length
Length in bytes of the maximum string length permitted in name_buffer.
Return Values
LV_SUCCESS
No errors; the queried SSML mark name is available in name_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 ssml_mark_idx is out of range.
LV_EXCEPTION
An exception occurred while processing the request.
