com.aldebaran.qi.helper.proxies

Class ALTextToSpeech

java.lang.Object

com.aldebaran.qi.helper.ALProxy

com.aldebaran.qi.helper.proxies.ALTextToSpeech

public class ALTextToSpeech
extends ALProxy

This module embeds a speech synthetizer whose role is to convert text commands into sound waves that are then either sent to Nao's loudspeakers or written into a file. This service supports several languages and some parameters of the synthetizer can be tuned to change each language's synthetic voice.

See Also:

NAOqi APIs for ALTextToSpeech

Field Summary

Fields inherited from class com.aldebaran.qi.helper.ALProxy

name, service

Constructor Summary

Constructors

Constructor and Description
ALTextToSpeech(Session session)

Method Summary

Modifier and Type	Method and Description
void	clearStats()
void	disableNotifications() Disables the notifications puted in ALMemory during the synthesis (TextStarted, TextDone, CurrentBookMark, CurrentWord, ...)
void	enableNotifications() Enables the notifications puted in ALMemory during the synthesis (TextStarted, TextDone, CurrentBookMark, CurrentWord, ...)
void	exit() Exits and unregisters the module.
java.util.List<java.lang.String>	getAvailableLanguages() Outputs the languages installed on the system.
java.util.List<java.lang.String>	getAvailableVoices() Outputs the available voices.
java.lang.String	getBrokerName() Gets the name of the parent broker.
java.lang.String	getLanguage() Returns the language currently used by the text-to-speech engine.
java.lang.String	getLanguageEncoding(java.lang.String pLanguage) Returns the encoding that should be used with the specified language.
java.lang.Object	getMethodHelp(java.lang.String methodName) Retrieves a method's description.
java.util.List<java.lang.String>	getMethodList() Retrieves the module's method list.
java.lang.Object	getModuleHelp() Retrieves the module's description.
java.lang.Float	getParameter(java.lang.String pParameterName) Returns the value of one of the voice parameters.
java.util.List<java.lang.String>	getSupportedLanguages() Outputs all the languages supported (may be installed or not).
java.lang.String	getUsage(java.lang.String name) Gets the method usage string.
java.lang.String	getVoice() Returns the voice currently used by the text-to-speech engine.
java.lang.Float	getVolume() Fetches the current volume the text to speech.
java.lang.Boolean	isRunning(java.lang.Integer id) Returns true if the method is currently running.
java.lang.Boolean	isStatsEnabled()
java.lang.Boolean	isTraceEnabled()
void	loadVoicePreference(java.lang.String pPreferenceName) Loads a set of voice parameters defined in a xml file contained in the preferences folder.The name of the xml file must begin with ALTextToSpeech_Voice_
java.lang.String	locale() Get the locale associate to the current language.
java.lang.Boolean	ping() Just a ping.
void	resetSpeed() Changes the parameters of the voice.
void	say(java.lang.String stringToSay) Performs the text-to-speech operations : it takes a std::string as input and outputs a sound in both speakers.
void	say(java.lang.String stringToSay, java.lang.String language) Performs the text-to-speech operations in a specific language: it takes a std::string as input and outputs a sound in both speakers.
void	sayToFile(java.lang.String pStringToSay, java.lang.String pFileName) Performs the text-to-speech operations: it takes a std::string as input and outputs the corresponding audio signal in the specified file.
void	sayToFileAndPlay(java.lang.String pStringToSay) This method performs the text-to-speech operations: it takes a std::string, outputs the synthesis resulting audio signal in a file, and then plays the audio file.
void	setLanguage(java.lang.String pLanguage) Changes the language used by the Text-to-Speech engine.
void	setLanguageDefaultVoice(java.lang.String Language, java.lang.String Voice) Sets a voice as the default voice for the corresponding language
void	setParameter(java.lang.String pEffectName, java.lang.Float pEffectValue) Changes the parameters of the voice.
void	setVoice(java.lang.String pVoiceID) Changes the voice used by the text-to-speech engine.
void	setVolume(java.lang.Float volume) Sets the volume of text-to-speech output.
void	stop(java.lang.Integer id) returns true if the method is currently running
void	stopAll() This method stops the current and all the pending tasks immediately.
java.lang.String	version() Returns the version of the module.
java.lang.Boolean	wait(java.lang.Integer id, java.lang.Integer timeoutPeriod) Wait for the end of a long running method that was called using 'post'

Methods inherited from class com.aldebaran.qi.helper.ALProxy

call, connect, connect, disconnect, getNaoqiType, getService, isProxyReady, setService

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ALTextToSpeech

public ALTextToSpeech(Session session)
               throws java.lang.Exception

Throws:

java.lang.Exception

Method Detail

loadVoicePreference

public void loadVoicePreference(java.lang.String pPreferenceName)
                         throws CallError,
                                java.lang.InterruptedException

Loads a set of voice parameters defined in a xml file contained in the preferences folder.The name of the xml file must begin with ALTextToSpeech_Voice_

Parameters:

pPreferenceName - Name of the voice preference.

Throws:

CallError

java.lang.InterruptedException

getAvailableVoices

public java.util.List<java.lang.String> getAvailableVoices()
                                                    throws CallError,
                                                           java.lang.InterruptedException

Outputs the available voices. The returned list contains the voice IDs.

Returns:

Array of std::string containing the voices installed on the system.

Throws:

CallError

java.lang.InterruptedException

getVolume

public java.lang.Float getVolume()
                          throws CallError,
                                 java.lang.InterruptedException

Fetches the current volume the text to speech.

Returns:

Volume (integer between 0 and 100).

Throws:

CallError

java.lang.InterruptedException

locale

public java.lang.String locale()
                        throws CallError,
                               java.lang.InterruptedException

Get the locale associate to the current language.

Returns:

A string with xx_XX format (region_country)

Throws:

CallError

java.lang.InterruptedException

setLanguageDefaultVoice

public void setLanguageDefaultVoice(java.lang.String Language,
                                    java.lang.String Voice)
                             throws CallError,
                                    java.lang.InterruptedException

Sets a voice as the default voice for the corresponding language

Parameters:

Language - The language among those available on your robot as a String

Voice - The voice among those available on your robot as a String

Throws:

CallError

java.lang.InterruptedException

setVolume

public void setVolume(java.lang.Float volume)
               throws CallError,
                      java.lang.InterruptedException

Sets the volume of text-to-speech output.

Parameters:

volume - Volume (between 0.0 and 1.0).

Throws:

CallError

java.lang.InterruptedException

enableNotifications

public void enableNotifications()
                         throws CallError,
                                java.lang.InterruptedException

Enables the notifications puted in ALMemory during the synthesis (TextStarted, TextDone, CurrentBookMark, CurrentWord, ...)

Throws:

CallError

java.lang.InterruptedException

disableNotifications

public void disableNotifications()
                          throws CallError,
                                 java.lang.InterruptedException

Disables the notifications puted in ALMemory during the synthesis (TextStarted, TextDone, CurrentBookMark, CurrentWord, ...)

Throws:

CallError

java.lang.InterruptedException

isStatsEnabled

public java.lang.Boolean isStatsEnabled()
                                 throws CallError,
                                        java.lang.InterruptedException

Throws:

CallError

java.lang.InterruptedException

clearStats

public void clearStats()
                throws CallError,
                       java.lang.InterruptedException

Throws:

CallError

java.lang.InterruptedException

isTraceEnabled

public java.lang.Boolean isTraceEnabled()
                                 throws CallError,
                                        java.lang.InterruptedException

Throws:

CallError

java.lang.InterruptedException

exit

public void exit()
          throws CallError,
                 java.lang.InterruptedException

Exits and unregisters the module.

Throws:

CallError

java.lang.InterruptedException

version

public java.lang.String version()
                         throws CallError,
                                java.lang.InterruptedException

Returns the version of the module.

Returns:

A string containing the version of the module.

Throws:

CallError

java.lang.InterruptedException

ping

public java.lang.Boolean ping()
                       throws CallError,
                              java.lang.InterruptedException

Just a ping. Always returns true

Returns:

returns true

Throws:

CallError

java.lang.InterruptedException

getMethodList

public java.util.List<java.lang.String> getMethodList()
                                               throws CallError,
                                                      java.lang.InterruptedException

Retrieves the module's method list.

Returns:

An array of method names.

Throws:

CallError

java.lang.InterruptedException

getMethodHelp

public java.lang.Object getMethodHelp(java.lang.String methodName)
                               throws CallError,
                                      java.lang.InterruptedException

Retrieves a method's description.

Parameters:

methodName - The name of the method.

Returns:

A structure containing the method's description.

Throws:

CallError

java.lang.InterruptedException

getModuleHelp

public java.lang.Object getModuleHelp()
                               throws CallError,
                                      java.lang.InterruptedException

Retrieves the module's description.

Returns:

A structure describing the module.

Throws:

CallError

java.lang.InterruptedException

wait

public java.lang.Boolean wait(java.lang.Integer id,
                              java.lang.Integer timeoutPeriod)
                       throws CallError,
                              java.lang.InterruptedException

Wait for the end of a long running method that was called using 'post'

Parameters:

id - The ID of the method that was returned when calling the method using 'post'

timeoutPeriod - The timeout period in ms. To wait indefinately, use a timeoutPeriod of zero.

Returns:

True if the timeout period terminated. False if the method returned.

Throws:

CallError

java.lang.InterruptedException

isRunning

public java.lang.Boolean isRunning(java.lang.Integer id)
                            throws CallError,
                                   java.lang.InterruptedException

Returns true if the method is currently running.

Parameters:

id - The ID of the method that was returned when calling the method using 'post'

Returns:

True if the method is currently running

Throws:

CallError

java.lang.InterruptedException

stop

public void stop(java.lang.Integer id)
          throws CallError,
                 java.lang.InterruptedException

returns true if the method is currently running

Parameters:

id - the ID of the method to wait for

Throws:

CallError

java.lang.InterruptedException

getBrokerName

public java.lang.String getBrokerName()
                               throws CallError,
                                      java.lang.InterruptedException

Gets the name of the parent broker.

Returns:

The name of the parent broker.

Throws:

CallError

java.lang.InterruptedException

getUsage

public java.lang.String getUsage(java.lang.String name)
                          throws CallError,
                                 java.lang.InterruptedException

Gets the method usage string. This summarises how to use the method.

Parameters:

name - The name of the method.

Returns:

A string that summarises the usage of the method.

Throws:

CallError

java.lang.InterruptedException

say

public void say(java.lang.String stringToSay)
         throws CallError,
                java.lang.InterruptedException

Performs the text-to-speech operations : it takes a std::string as input and outputs a sound in both speakers. String encoding must be UTF8.

Parameters:

stringToSay - Text to say, encoded in UTF-8.

Throws:

CallError

java.lang.InterruptedException

say

public void say(java.lang.String stringToSay,
                java.lang.String language)
         throws CallError,
                java.lang.InterruptedException

Performs the text-to-speech operations in a specific language: it takes a std::string as input and outputs a sound in both speakers. String encoding must be UTF8. Once the text is said, the language is set back to its initial value.

Parameters:

stringToSay - Text to say, encoded in UTF-8.

language - Language used to say the text.

Throws:

CallError

java.lang.InterruptedException

sayToFile

public void sayToFile(java.lang.String pStringToSay,
                      java.lang.String pFileName)
               throws CallError,
                      java.lang.InterruptedException

Performs the text-to-speech operations: it takes a std::string as input and outputs the corresponding audio signal in the specified file.

Parameters:

pStringToSay - Text to say, encoded in UTF-8.

pFileName - RAW file where to store the generated signal. The signal is encoded with a sample rate of 22050Hz, format S16_LE, 2 channels.

Throws:

CallError

java.lang.InterruptedException

sayToFileAndPlay

public void sayToFileAndPlay(java.lang.String pStringToSay)
                      throws CallError,
                             java.lang.InterruptedException

This method performs the text-to-speech operations: it takes a std::string, outputs the synthesis resulting audio signal in a file, and then plays the audio file. The file is deleted afterwards. It is useful when you want to perform a short synthesis, when few CPU is available. Do not use it if you want a low-latency synthesis or to synthesize a long std::string.

Parameters:

pStringToSay - Text to say, encoded in UTF-8.

Throws:

CallError

java.lang.InterruptedException

stopAll

public void stopAll()
             throws CallError,
                    java.lang.InterruptedException

This method stops the current and all the pending tasks immediately.

Throws:

CallError

java.lang.InterruptedException

setLanguage

public void setLanguage(java.lang.String pLanguage)
                 throws CallError,
                        java.lang.InterruptedException

Changes the language used by the Text-to-Speech engine. It automatically changes the voice used since each of them is related to a unique language. If you want that change to take effect automatically after reboot of your robot, refer to the robot web page (setting page).

Parameters:

pLanguage - Language name. Must belong to the languages available in TTS (can be obtained with the getAvailableLanguages method). It should be an identifier std::string.

Throws:

CallError

java.lang.InterruptedException

getLanguage

public java.lang.String getLanguage()
                             throws CallError,
                                    java.lang.InterruptedException

Returns the language currently used by the text-to-speech engine.

Returns:

Language of the current voice.

Throws:

CallError

java.lang.InterruptedException

getLanguageEncoding

public java.lang.String getLanguageEncoding(java.lang.String pLanguage)
                                     throws CallError,
                                            java.lang.InterruptedException

Returns the encoding that should be used with the specified language.

Parameters:

pLanguage - Language name (as a std::string). Must belong to the languages available in TTS.

Returns:

Encoding of the specified language.

Throws:

CallError

java.lang.InterruptedException

getAvailableLanguages

public java.util.List<java.lang.String> getAvailableLanguages()
                                                       throws CallError,
                                                              java.lang.InterruptedException

Outputs the languages installed on the system.

Returns:

Array of std::string that contains the languages installed on the system.

Throws:

CallError

java.lang.InterruptedException

getSupportedLanguages

public java.util.List<java.lang.String> getSupportedLanguages()
                                                       throws CallError,
                                                              java.lang.InterruptedException

Outputs all the languages supported (may be installed or not).

Returns:

Array of std::string that contains all the supported languages (may be installed or not).

Throws:

CallError

java.lang.InterruptedException

resetSpeed

public void resetSpeed()
                throws CallError,
                       java.lang.InterruptedException

Changes the parameters of the voice. For now, it is only possible to reset the voice speed.

Parameters:

pEffectName - Name of the parameter.

Throws:

CallError

java.lang.InterruptedException

setParameter

public void setParameter(java.lang.String pEffectName,
                         java.lang.Float pEffectValue)
                  throws CallError,
                         java.lang.InterruptedException

Changes the parameters of the voice. The available parameters are: pitchShift: applies a pitch shifting to the voice. The value indicates the ratio between the new fundamental frequencies and the old ones (examples: 2.0: an octave above, 1.5: a quint above). Correct range is (1.0 -- 4), or 0 to disable effect. doubleVoice: adds a second voice to the first one. The value indicates the ratio between the second voice fundamental frequency and the first one. Correct range is (1.0 -- 4), or 0 to disable effect doubleVoiceLevel: the corresponding value is the level of the double voice (1.0: equal to the main voice one). Correct range is (0 -- 4). doubleVoiceTimeShift: the corresponding value is the delay between the double voice and the main one. Correct range is (0 -- 0.5) If the effect value is not available, the effect parameter remains unchanged.

Parameters:

pEffectName - Name of the parameter.

pEffectValue - Value of the parameter.

Throws:

CallError

java.lang.InterruptedException

getParameter

public java.lang.Float getParameter(java.lang.String pParameterName)
                             throws CallError,
                                    java.lang.InterruptedException

Returns the value of one of the voice parameters. The available parameters are: "pitchShift", "doubleVoice","doubleVoiceLevel" and "doubleVoiceTimeShift"

Parameters:

pParameterName - Name of the parameter.

Returns:

Value of the specified parameter

Throws:

CallError

java.lang.InterruptedException

setVoice

public void setVoice(java.lang.String pVoiceID)
              throws CallError,
                     java.lang.InterruptedException

Changes the voice used by the text-to-speech engine. The voice identifier must belong to the installed voices, that can be listed using the 'getAvailableVoices' method. If the voice is not available, it remains unchanged. No exception is thrown in this case. For the time being, only two voices are available by default : Kenny22Enhanced (English voice) and Julie22Enhanced (French voice)

Parameters:

pVoiceID - The voice (as a std::string).

Throws:

CallError

java.lang.InterruptedException

getVoice

public java.lang.String getVoice()
                          throws CallError,
                                 java.lang.InterruptedException

Returns the voice currently used by the text-to-speech engine.

Returns:

Name of the current voice

Throws:

CallError

java.lang.InterruptedException