Tts library

Index:

Functions:

mixers

mixers

Synopsis
List all audio mixers available.
Usage
(mixers)
Returns
(mixer_name)
Where
  • mixer_name is string[0..1]: the name of a mixer.
Description
Returns a list that contains all the names of the audio mixers available.
Examples
(mixers)
(
  "Default Audio Device"
  "Built-in Microphone"
  "Built-in Output"
)
tts

tts

Synopsis
Synthetizes text to speech.
Usage
(tts
  text
  "voice" => voice
  "volume" => volume
  "rate" => rate
  "pitch" => pitch
  "pitch-range" => pitch_range
  "mixer" => mixer
)
Returns
text
Where
  • text is string: the text to speech.
  • voice is string[0..1]: the seleted voice. Voice names have this format: base/variant where base is the name of a base voice and variant is a suffix to identify a voice variant.
  • volume is number[0..1]: the volume of the speech, a double value between 0 and 1.
  • rate is number[0..1]: the voice rate (words per minute), normally a value in the range (50, 200).
  • pitch is number[0..1]: the voice pitch (tone of the voice), normally a value in the range (50, 200).
  • pitch_range is number[0..1]: the pitch range of the voice.
  • mixer is string[0..1]: the selected mixer.
Description
Synthetizes the given text the with the selected voice and parameters (rate, pitch and pitch_range). These parameters are bound to this voice and preserved for future calls to tts function.
Examples
(tts "Hello world")
"Hello world"
(tts
  (format-date (date))
  "mixer" => "Built-in Output"
)
"04-nov-2017 11:12:43"
(tts
  "Hello world"
  "voice" => "kevin16/sharp"
  "pitch" => 200
)
"Hello world"
(tts
  "Hello world"
  "voice" => "kevin16/slow"
  "rate" => 100
)
"Hello world"
voice-info

voice-info

Synopsis
Gets voice information.
Usage
(voice-info name)
Returns
(
  "name" => voice_name
  "description" => voice_description
  "organization" => organization
  "gender" => gender
  "age" => age
  "domain" => domain
  "locale" => locale
  "rate" => rate
  "pitch" => pitch
  "pitch-range" => pitch_range
)
Where
  • name is string[0..1]: the voice name.
  • voice_name is string: the voice name.
  • voice_description is string: the voice description.
  • organization is string: the voice organization.
  • gender is string: the voice gender (MALE or FEMALE).
  • age is string: the voice age.
  • domain is string: the voice domain.
  • locale is string: the voice locale.
  • rate is number: the voice rate (words per minute).
  • pitch is number: the voice pitch (tone of the voice).
  • pitch_range is number: the voice pitch range.
Description
Returns a list that describes the properties of the given voice.
Examples
(voice-info "kevin16")
(
  "name" => "kevin16"
  "description" => "default 16-bit diphone voice"
  "organization" => "cmu"
  "gender" => "MALE"
  "age" => "YOUNGER_ADULT"
  "domain" => "general"
  "locale" => "en_US"
  "rate" => 150
  "pitch" => 100
  "pitch-range" => 11
)
voices

voices

Synopsis
List all voices available.
Usage
(voices)
Returns
(voice_name ... voice_name)
Where
  • voice_name is string[0..N]: the name of a voice.
Description
Returns a list that contains all the names of the base voices and its variants in use.
Examples
(voices)
("kevin" "kevin16" "kevin16/sharp")
Top