- Installation
- Administration
- Programmer's Guide
- Grammars
- MRCP Server
- FAQs
Various Speech Port Properties can be set via the API at a scope of the application level or the client port level. In the C API they are set through LV_TTS_SetPropertyEx. In the C++ API, they are set through LVTTSClient::SetPropertyEx at the client port or application level, or LVTTSClient::SetClientPropertyEx at the application level. LVTTSClient::SetClientPropertyEx is a static function that allows for application level properties to be applied without creating an instance.
The properties that were set can be queried with the following functions/methods:
Setting of these properties prior to calling LV_TTS_Synthesize / LVTTSClient::Synthesize only provides a hint about the desired settings to the synthesizer. If the input to LV_TTS_Synthesize / LVTTSClient::Synthesize is plain text, then these settings may have an effect. If the input were SSML, then the properties defined in the SSML document override these settings.
All of the properties listed in this section are based on SSML settings. For a description of possible values and corresponding defaults, please consult the SSML specification.
PROP_EX_SYNTH_PROSODY_PITCH
Description: Controls the pitch of the audio produced.
Scope: PROP_EX_TARGET_PORT, PROP_EX_TARGET_CLIENT
Value Type: PROP_EX_VALUE_TYPE_STRING
PROP_EX_SYNTH_PROSODY_CONTOUR
Description: Controls the contour of the sound pitch produced.
Scope: PROP_EX_TARGET_PORT, PROP_EX_TARGET_CLIENT
Value Type: PROP_EX_VALUE_TYPE_STRING
PROP_EX_SYNTH_PROSODY_RANGE
Description: Controls the range of the sound produced.
Scope: PROP_EX_TARGET_PORT, PROP_EX_TARGET_CLIENT
Value Type: PROP_EX_VALUE_TYPE_STRING
PROP_EX_SYNTH_PROSODY_RATE
Description: Controls the speaking rate of the sound produced.
Scope: PROP_EX_TARGET_PORT, PROP_EX_TARGET_CLIENT
Value Type: PROP_EX_VALUE_TYPE_STRING
PROP_EX_SYNTH_PROSODY_DURATION
Description: Controls the duration of time it takes for the texts to play.
Scope: PROP_EX_TARGET_PORT, PROP_EX_TARGET_CLIENT
Value Type: PROP_EX_VALUE_TYPE_STRING
PROP_EX_SYNTH_PROSODY_VOLUME
Description: Controls the volume of the audio produced.
Scope: PROP_EX_TARGET_PORT, PROP_EX_TARGET_CLIENT
Value Type: PROP_EX_VALUE_TYPE_STRING
PROP_EX_SYNTH_VOICE_GENDER
Description: Controls the gender of the voice timbre of the audio produced.
Scope: PROP_EX_TARGET_PORT, PROP_EX_TARGET_CLIENT
Value Type: PROP_EX_VALUE_TYPE_STRING
PROP_EX_SYNTH_VOICE_AGE
Description: Controls the age of the voice timbre of the audio produced.
Scope: PROP_EX_TARGET_PORT, PROP_EX_TARGET_CLIENT
Value Type: PROP_EX_VALUE_TYPE_STRING
PROP_EX_SYNTH_VOICE_VARIANT
Description: Sets the preferred voice variant of the audio produced.
Scope: PROP_EX_TARGET_PORT, PROP_EX_TARGET_CLIENT
Value Type: PROP_EX_VALUE_TYPE_STRING
PROP_EX_SYNTH_VOICE_NAME
Description: Sets the synthesis processor-specific voice name of the audio produced.
Scope: PROP_EX_TARGET_PORT, PROP_EX_TARGET_CLIENT
Value Type: PROP_EX_VALUE_TYPE_STRING
PROP_EX_SYNTH_EMPHASIS_LEVEL
Description: Controls the strength of emphasis of the audio produced.
Scope: PROP_EX_TARGET_PORT, PROP_EX_TARGET_CLIENT
Value Type: PROP_EX_VALUE_TYPE_STRING
PROP_EX_SYNTH_SOUND_FORMAT
Description: Controls the format of the sound that the synthesized audio will be produced in.
Scope: PROP_EX_TARGET_PORT, PROP_EX_TARGET_CLIENT
Value Type: PROP_EX_VALUE_TYPE_INT, PROP_EX_VALUE_TYPE_INT_PTR
Possible Values: SFMT_ULAW, SFMT_PCM, SFMT_ALAW
Default Value: SFMT_ULAW
PROP_EX_SYNTHESIS_LANGUAGE
Description: Set the language that the synthesized audio is to be produced in.
Scope: PROP_EX_TARGET_PORT, PROP_EX_TARGET_CLIENT
Value Type: PROP_EX_VALUE_TYPE_STRING
Possible Values: "en-US", "en-GB", "es-LA"
Default Value: "en-US"
PROP_EX_SYNTHESIS_SAMPLING_RATE
Description: Sets the sampling rate that the audio is to be synthesized in.
Scope: PROP_EX_TARGET_PORT, PROP_EX_TARGET_CLIENT
Value Type: PROP_EX_VALUE_TYPE_INT, PROP_EX_VALUE_TYPE_INT_PTR
Possible Values: 8000
Default Value: 8000
PROP_EX_LOG_TTS_EVENTS
Description: Controls whether the application will save off call log files used with the LumenVox Speech Tuner. Turn this on to capture audio and more information related to each synthesis.
Scope: PROP_EX_TARGET_PORT, PROP_EX_TARGET_CLIENT
Value Type: PROP_EX_VALUE_TYPE_INT, PROP_EX_VALUE_TYPE_INT_PTR
Possible Values: 0 and 1
Default Value: 0