speech-dispatcher: Parameter Setting Commands in C
4.1.6 Parameter Settings Commands
---------------------------------
The following parameter setting commands are available. For
configuration and history clients there are also functions for setting
the value for some other connection and for all connections. They are
listed separately below.
Please see ⇒Parameter Setting Commands (ssip)Top. for a general
description of what they mean.
-- C API function: int spd_set_data_mode(SPDConnection *connection,
SPDDataMode mode)
Set Speech Dispatcher data mode. Currently, plain text and SSML
are supported. SSML is especially useful if you want to use index
marks or include changes of voice parameters in the text.
'mode' is the requested data mode: 'SPD_DATA_TEXT' or
'SPD_DATA_SSML'.
-- C API function: int spd_set_language(SPDConnection* connection,
const char* language);
Sets the language that should be used for synthesis.
'connection' is the SPDConnection* connection created by
spd_open().
'language' is the language code as defined in RFC 1766 ("cs", "en",
"en-US", ...).
-- C API function: int spd_set_output_module(SPDConnection* connection,
const char* output_module);
Sets the output module that should be used for synthesis. The
parameter of this command should always be entered by the user in
some way and not hardcoded anywhere in the code as the available
synthesizers and their registration names may vary from machine to
machine.
'connection' is the SPDConnection* connection created by
spd_open().
'output_module' is the output module name under which the module
was loaded into Speech Dispatcher in its configuration ("flite",
"festival", "epos-generic"... )
-- C API function: char* spd_get_output_module(SPDConnection*
connection);
Gets the current output module in use for synthesis.
'connection' is the SPDConnection* connection created by
spd_open().
It returns the output module name under which the module was loaded
into Speech Dispatcher in its configuration ("flite", "festival",
"espeak"... )
-- C API function: int spd_set_punctuation(SPDConnection* connection,
SPDPunctuation type);
Set punctuation mode to the given value. 'all' means speak all
punctuation characters, 'none' means speak no punctuation
characters, 'some' and 'most' mean speak intermediate sets of
punctuation characters as set in symbols tables or output modules.
'connection' is the SPDConnection* connection created by
spd_open().
'type' is one of the following values: 'SPD_PUNCT_ALL',
'SPD_PUNCT_NONE', 'SPD_PUNCT_SOME'.
It returns 0 on success, -1 otherwise.
-- C API function: int spd_set_spelling(SPDConnection* connection,
SPDSpelling type);
Switches spelling mode on and off. If set to on, all incoming
messages from this particular connection will be processed
according to appropriate spelling tables (see
spd_set_spelling_table()).
'connection' is the SPDConnection* connection created by
spd_open().
'type' is one of the following values: 'SPD_SPELL_ON',
'SPD_SPELL_OFF'.
-- C API function: int spd_set_voice_type(SPDConnection* connection,
SPDVoiceType voice);
Set a preferred symbolic voice.
'connection' is the SPDConnection* connection created by
spd_open().
'voice' is one of the following values: 'SPD_MALE1', 'SPD_MALE2',
'SPD_MALE3', 'SPD_FEMALE1', 'SPD_FEMALE2', 'SPD_FEMALE3',
'SPD_CHILD_MALE', 'SPD_CHILD_FEMALE'.
-- C API function: int spd_set_synthesis_voice(SPDConnection*
connection, const char* voice_name);
Set the speech synthesizer voice to use. Please note that
synthesis voices are an attribute of the synthesizer, so this
setting only takes effect until the output module in use is changed
(via 'spd_set_output_module()' or via 'spd_set_language').
'connection' is the SPDConnection* connection created by
spd_open().
'voice_name' is any of the voice name values retrieved by ⇒
spd_list_synthesis_voices.
-- C API function: int spd_set_voice_rate(SPDConnection* connection,
int rate);
Set voice speaking rate.
'connection' is the SPDConnection* connection created by
spd_open().
'rate' is a number between -100 and +100 which means the slowest
and the fastest speech rate respectively.
-- C API function: int spd_get_voice_rate(SPDConnection* connection);
Get voice speaking rate.
'connection' is the SPDConnection* connection created by
spd_open().
It returns the current voice rate.
-- C API function: int spd_set_voice_pitch(SPDConnection* connection,
int pitch);
Set voice pitch.
'connection' is the SPDConnection* connection created by
spd_open().
'pitch' is a number between -100 and +100, which means the lowest
and the highest pitch respectively.
-- C API function: int spd_get_voice_pitch(SPDConnection* connection);
Get voice pitch.
'connection' is the SPDConnection* connection created by
spd_open().
It returns the current voice pitch.
-- C API function: int spd_set_voice_pitch_range(SPDConnection*
connection, int pitch_range);
Set voice pitch range.
'connection' is the SPDConnection* connection created by
spd_open().
'pitch_range' is a number between -100 and +100, which means the
lowest and the highest pitch range respectively.
-- C API function: int spd_set_volume(SPDConnection* connection, int
volume);
Set the volume of the voice and sounds produced by Speech
Dispatcher's output modules.
'connection' is the SPDConnection* connection created by
spd_open().
'volume' is a number between -100 and +100 which means the lowest
and the loudest voice respectively.
-- C API function: int spd_get_volume(SPDConnection* connection);
Get the volume of the voice and sounds produced by Speech
Dispatcher's output modules.
'connection' is the SPDConnection* connection created by
spd_open().
It returns the current volume.
Info Catalog
speech-dispatcher: Sound Icons in C
speech-dispatcher: C API
speech-dispatcher: Other Functions in C