org.myrobotlab.service

Class MarySpeech

java.lang.Object

org.myrobotlab.framework.MessageService

org.myrobotlab.framework.Service

org.myrobotlab.service.abstracts.AbstractSpeechSynthesis

org.myrobotlab.service.MarySpeech

All Implemented Interfaces:

java.io.Serializable, java.lang.Runnable, Attachable, Invoker, LoggingSink, MessageSender, MessageSubscriber, NameProvider, NameTypeProvider, ServiceInterface, ServiceQueue, StateSaver, TypeProvider, QueueReporter, SpeechSynthesis, TextListener

public class MarySpeech
extends AbstractSpeechSynthesis
implements TextListener

The Mary Speech service is a wrapper for the MaryTTS project. This service implements the speech synthesis interface and provides a Text To Speech capability. More info at : http://mary.dfki.de/

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String	confirmationString
static org.slf4j.Logger	log
java.lang.String	maryComponentsUrl

Fields inherited from class org.myrobotlab.framework.Service

cfgDir, dnaPool, MESSAGE_RECORDING_FORMAT_BINARY, MESSAGE_RECORDING_FORMAT_XML

Constructor Summary

Constructors

Constructor and Description
MarySpeech(java.lang.String reservedKey)

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)
static ServiceType	getMetaData() This static method returns all the details of the class without it having to be constructed.
java.lang.String	getVoice()
java.util.List<java.lang.String>	getVoices()
float	getVolume()
void	installComponentsAcceptLicense(java.lang.String component)
void	installComponentsAcceptLicense(java.lang.String[] components)
void	interrupt() Interrupt the current speaking.
static void	main(java.lang.String[] args)
void	onRequestConfirmation(java.lang.String text)
void	onText(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	setAudioEffects(java.lang.String effects)
void	setLanguage(java.lang.String lang)
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/
boolean	speakInternal(java.lang.String toSpeak, boolean blocking)

Methods inherited from class org.myrobotlab.service.abstracts.AbstractSpeechSynthesis

attach, attachTextPublisher, detach, detachTextPublisher

Methods inherited from class org.myrobotlab.framework.Service

addListener, addListener, addTask, addTask, addTask, addTaskOneShot, allowDisplay, allowDisplay, attach, broadcastState, buildDna, buildDna, buildDnaKeys, buildDnaNames, clearLastError, close, containsTask, copyShallowFrom, createPeer, createPeer, createRootReserved, detach, detach, echoHeartbeat, error, error, error, getAttached, getCfgDir, getComm, getDeclaredMethodNames, getDeclaredMethods, getDescription, getDna, getDnaString, getHostName, getInbox, getInstanceId, getIntanceName, getInterfaceSet, getLastError, getMessageSet, getMetaData, getMethodMap, getMethodNames, getMethods, getMethodToolTip, getMsg, getName, getNotifyList, getNotifyListKeySet, getOutbox, getPeerKey, getPeerName, getServiceResourceFile, getSimpleName, getTasks, getThisThread, getType, hasError, hasPeers, help, help, in, info, info, invoke, invoke, invoke, invokeOn, isAttached, isAttached, isLocal, isReady, isRunning, isRuntime, isVirtual, load, load, logTimeEnable, mergeDna, mergeDna, mergePeerDna, movePeerDna, out, out, preProcessHook, preRoutingHook, publishError, publishQueueStats, publishState, publishStats, publishStatus, purgeTask, purgeTasks, releasePeers, releaseService, removeAllListeners, removeListener, requiresSecurity, reserve, reserve, reserveRoot, reserveRoot, reserveRootAs, run, save, save, save, send, send, send, send, sendBlocking, sendBlocking, sendBlocking, sendBlocking, sendPeer, setInstanceId, setName, setPeer, setSecurityProvider, setState, setThisThread, setVirtual, sleep, stackToString, startHeartbeat, startPeer, startPeer, startRecording, startService, stopHeartbeat, stopMsgRecording, stopService, subscribe, subscribe, subscribe, toString, unsubscribe, unsubscribe, unsubscribe, updateStats, warn, warn

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.myrobotlab.service.interfaces.TextListener

getName

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

getName

Field Detail

log

public static final org.slf4j.Logger log

maryComponentsUrl

public java.lang.String maryComponentsUrl

confirmationString

public java.lang.String confirmationString

Constructor Detail

MarySpeech

public MarySpeech(java.lang.String reservedKey)

Method Detail

speakBlocking

public boolean speakBlocking(java.lang.String toSpeak)
                      throws marytts.exceptions.SynthesisException,
                             java.lang.InterruptedException

Description copied from interface: SpeechSynthesis

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

Specified by:

speakBlocking in interface SpeechSynthesis

Parameters:

toSpeak - - the string of text to speak.

Returns:

true/false

Throws:

marytts.exceptions.SynthesisException

java.lang.InterruptedException

speakInternal

public boolean speakInternal(java.lang.String toSpeak,
                             boolean blocking)
                      throws marytts.exceptions.SynthesisException,
                             java.lang.InterruptedException

Throws:

marytts.exceptions.SynthesisException

java.lang.InterruptedException

onText

public void onText(java.lang.String text)

Specified by:

onText in interface TextListener

speak

public AudioData speak(java.lang.String toSpeak)
                throws marytts.exceptions.SynthesisException,
                       java.lang.InterruptedException

Description copied from interface: SpeechSynthesis

Begin speaking something and return immediately

Specified by:

speak in interface SpeechSynthesis

Parameters:

toSpeak - - the string of text to speak.

Returns:

TODO

Throws:

marytts.exceptions.SynthesisException

java.lang.InterruptedException

getVoices

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

Specified by:

getVoices in interface SpeechSynthesis

setVoice

public boolean setVoice(java.lang.String voice)

Specified by:

setVoice in interface SpeechSynthesis

setLanguage

public void setLanguage(java.lang.String lang)

Specified by:

setLanguage in interface SpeechSynthesis

onRequestConfirmation

public void onRequestConfirmation(java.lang.String text)

Specified by:

onRequestConfirmation in interface SpeechSynthesis

getLanguage

public java.lang.String getLanguage()

Specified by:

getLanguage in interface SpeechSynthesis

setVolume

public void setVolume(float volume)

Specified by:

setVolume in interface SpeechSynthesis

getVolume

public float getVolume()

Specified by:

getVolume in interface SpeechSynthesis

interrupt

public void interrupt()

Description copied from interface: SpeechSynthesis

Interrupt the current speaking.

Specified by:

interrupt in interface SpeechSynthesis

publishStartSpeaking

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

Description copied from class: AbstractSpeechSynthesis

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

Specified by:

publishStartSpeaking in interface SpeechSynthesis

Overrides:

publishStartSpeaking in class AbstractSpeechSynthesis

Parameters:

utterance - text

Returns:

the same text

publishEndSpeaking

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

Description copied from class: AbstractSpeechSynthesis

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

Specified by:

publishEndSpeaking in interface SpeechSynthesis

Overrides:

publishEndSpeaking in class AbstractSpeechSynthesis

Parameters:

utterance - text

Returns:

text

getVoice

public java.lang.String getVoice()

Specified by:

getVoice in interface SpeechSynthesis

getLocalFileName

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

Specified by:

getLocalFileName in interface SpeechSynthesis

Throws:

java.io.UnsupportedEncodingException

addEar

public void addEar(SpeechRecognizer ear)

Specified by:

addEar in interface SpeechSynthesis

getLanguages

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

Specified by:

getLanguages in interface SpeechSynthesis

Returns:

a list of current possible languages

setAudioEffects

public void setAudioEffects(java.lang.String effects)

installComponentsAcceptLicense

public void installComponentsAcceptLicense(java.lang.String component)

installComponentsAcceptLicense

public void installComponentsAcceptLicense(java.lang.String[] components)

main

public static void main(java.lang.String[] args)

getMetaData

public static ServiceType getMetaData()

This static method returns all the details of the class without it having to be constructed. It has description, categories, dependencies, and peer definitions.

Returns:

ServiceType - returns all the data