Browse
 
Tools
Rss Categories

LVTTSClient::GetSSMLMarkName

Reference Number: AA-01025 Views: 1889 0 Rating/ Voters

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 GetSSMLMarkName(unsigned int ssml_mark_idx, char * name_buffer, int name_buffer_length)

Parameters

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 GetSSMLMarksCount.

name_buffer

Pointer to 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 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 ssml_mark_idx is out of range.

LV_EXCEPTION

An exception occurred while processing the request.