org.myrobotlab.service.interfaces

Interface SpeechSynthesis

All Superinterfaces:

NameProvider

All Known Implementing Classes:

AbstractSpeechSynthesis, AcapelaSpeech, IndianTts, LocalSpeech, MarySpeech, MicrosoftSpeech, MimicSpeech, NaturalReaderSpeech, Polly, VoiceRss

public interface SpeechSynthesis
extends NameProvider

SpeechSynthesis - This is the interface that services that provide text to speech should implement.

Field Summary

Fields

Modifier and Type	Field and Description
static org.slf4j.Logger	log

Method Summary

Modifier and Type	Method and Description
void	addEar(SpeechRecognizer ear)
java.lang.String	getLanguage()
java.util.List<java.lang.String>	getLanguages()
java.lang.String	getLocalFileName(SpeechSynthesis provider, java.lang.String toSpeak, java.lang.String audioFileType)
java.lang.String	getVoice()
java.util.List<java.lang.String>	getVoices()
float	getVolume()
void	interrupt() Interrupt the current speaking.
void	onRequestConfirmation(java.lang.String text)
java.lang.String	publishEndSpeaking(java.lang.String utterance) stop callback for speech synth.
java.lang.String	publishStartSpeaking(java.lang.String utterance) start callback for speech synth.
void	setLanguage(java.lang.String l)
boolean	setVoice(java.lang.String voice)
void	setVolume(float volume)
AudioData	speak(java.lang.String toSpeak) Begin speaking something and return immediately
boolean	speakBlocking(java.lang.String toSpeak) Begin speaking and wait until all speech has been played back/

Methods inherited from interface org.myrobotlab.framework.interfaces.NameProvider

getName

Field Detail

log

static final org.slf4j.Logger log

Method Detail

getVoices

java.util.List<java.lang.String> getVoices()

setVoice

boolean setVoice(java.lang.String voice)

setLanguage

void setLanguage(java.lang.String l)

getLanguage

java.lang.String getLanguage()

getLanguages

java.util.List<java.lang.String> getLanguages()

Returns:

a list of current possible languages

speak

AudioData speak(java.lang.String toSpeak)
         throws java.lang.Exception

Begin speaking something and return immediately

Parameters:

toSpeak - - the string of text to speak.

Returns:

TODO

Throws:

java.lang.Exception - e

speakBlocking

boolean speakBlocking(java.lang.String toSpeak)
               throws java.lang.Exception

Begin speaking and wait until all speech has been played back/

Parameters:

toSpeak - - the string of text to speak.

Returns:

true/false

Throws:

java.lang.Exception - e

setVolume

void setVolume(float volume)

getVolume

float getVolume()

interrupt

void interrupt()

Interrupt the current speaking.

getVoice

java.lang.String getVoice()

publishStartSpeaking

java.lang.String publishStartSpeaking(java.lang.String utterance)

start callback for speech synth. (Invoked when speaking starts)

Parameters:

utterance - text

Returns:

the same text

publishEndSpeaking

java.lang.String publishEndSpeaking(java.lang.String utterance)

stop callback for speech synth. (Invoked when speaking stops.)

Parameters:

utterance - text

Returns:

text

getLocalFileName

java.lang.String getLocalFileName(SpeechSynthesis provider,
                                  java.lang.String toSpeak,
                                  java.lang.String audioFileType)
                           throws java.io.UnsupportedEncodingException

Throws:

java.io.UnsupportedEncodingException

addEar

void addEar(SpeechRecognizer ear)

onRequestConfirmation

void onRequestConfirmation(java.lang.String text)