org.myrobotlab.service

Class Polly

java.lang.Object

org.myrobotlab.framework.MessageService

org.myrobotlab.framework.Service

org.myrobotlab.service.abstracts.AbstractSpeechSynthesis

org.myrobotlab.service.Polly

All Implemented Interfaces:

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

public class Polly
extends AbstractSpeechSynthesis
implements AudioListener

Amazon's cloud speech service Free Tier The Amazon Polly free tier includes 5 million characters per month, for the first 12 months, starting from the first request for speech. Polly Pricing Pay-as-you-go $4.00 per 1 million characters (when outside the free tier).

Author:

gperry

See Also:

Serialized Form

Field Summary

Fields

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

Fields inherited from class org.myrobotlab.framework.Service

cfgDir, dnaPool, MESSAGE_RECORDING_FORMAT_BINARY, MESSAGE_RECORDING_FORMAT_XML

Constructor Summary

Constructors

Constructor and Description
Polly(java.lang.String n)

Method Summary

Modifier and Type	Method and Description
void	addEar(SpeechRecognizer ear)
byte[]	cacheFile(java.lang.String toSpeak, com.amazonaws.services.polly.model.OutputFormat format)
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	interrupt() Interrupt the current speaking.
static void	main(java.lang.String[] args)
void	onAudioEnd(AudioData data)
void	onAudioStart(AudioData data)
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	setKey(java.lang.String keyId, java.lang.String keyIdSecret)
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/
void	startService()

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, 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.framework.interfaces.NameProvider

getName

Field Detail

log

public static final org.slf4j.Logger log

credentialsError

public boolean credentialsError

Constructor Detail

Polly

public Polly(java.lang.String n)

Method Detail

setKey

public void setKey(java.lang.String keyId,
                   java.lang.String keyIdSecret)

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 l)

Specified by:

setLanguage in interface SpeechSynthesis

getLanguage

public java.lang.String getLanguage()

Specified by:

getLanguage 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

cacheFile

public byte[] cacheFile(java.lang.String toSpeak,
                        com.amazonaws.services.polly.model.OutputFormat format)
                 throws java.io.IOException

Throws:

java.io.IOException

speak

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

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:

java.lang.Exception - e

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

onAudioStart

public void onAudioStart(AudioData data)

Specified by:

onAudioStart in interface AudioListener

onAudioEnd

public void onAudioEnd(AudioData data)

Specified by:

onAudioEnd in interface AudioListener

speakBlocking

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

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:

java.lang.Exception - e

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

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

onRequestConfirmation

public void onRequestConfirmation(java.lang.String text)

Specified by:

onRequestConfirmation in interface SpeechSynthesis

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

startService

public void startService()

Specified by:

startService in interface ServiceInterface

Overrides:

startService in class Service

main

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