4.10 voice-select.scm

The voice-select module provides a mechanism for voice and language selection. For its configuration information, see See section Voice Selection.

The following voice selection functions are available:

voice-list

Return the list of names of all available voices. Unlike the list returned by the standard Festival function voice.list, the list includes all registered voices.

voice-list-language-codes

Return the list of names, language codes and dialect codes of all available voices. Each element of the returned list is of the form (name language-code dialect-code), where all the elements of the tripple are symbols. If the language code or the dialect code is not known for the voice, the corresponding element is nil.

current-language-voices

Return a list of all the voices available for the current language.

select-voice language dialect gender age variant name

Select voice according to the specified parameters and return its name. language is the language name, dialect is a language dialect name. gender can be one of the symbols male or female (the value is currently ignored). age is age of the speaker in years given as a number. variant is a positive integer that selects one of several voices, if more than one voice is selected by all other parameters. name can be a particular voice name.

Each of the function arguments can have nil as its value. In such a case, default value of the corresponding parameter is used. If there is no default value, the parameter is not considered in the selection process.

If more than one voice matches, one of the matched voices is selected. If no voice satisfying all the given parameters is available, some voice satisfying the most important parameters is selected.

select-voice* lang-code gender age variant name

Like select-voice, except that language and dialect are specified by an ISO lang-code.

reset-voice

Reset currently selected voice parameters to their default values.

Additionally, there is a variable holding information about voice properties currently in effect for the purpose of voice selection by the voice-select function:

voice-select-current-defaults

Alist containing current voice properties used by voice selection.

This document was generated by Milan Zamazal on August, 11 2009 using texi2html 1.78.