org.ispeech

Class SpeechSynthesis

java.lang.Object

org.ispeech.SpeechSynthesis

All Implemented Interfaces:

Synthesizer

public class SpeechSynthesis
extends Object
implements Synthesizer

Contains methods to convert text to audio and play through android's MediaPlayer.

Method Summary

Methods

Modifier and Type	Method and Description
void	addMarkerCallback(MarkerCallback mc)
void	addMeta(MetaType type, String value) Add meta value to synthesizer
void	addOptionalCommand(String command, String parameter) Specify additional parameters to send to the server.
void	addVisemeCallback(VisemeCallback mc)
void	cancel()
void	clearOptionalCommand() Clears optional parameters.
byte[]	downloadByteArray(String text)
int	getCurrentPosition()
static SpeechSynthesis	getInstance(Activity callingActivity)
static SpeechSynthesis	getInstance(Context context, Activity callingActivity) Gets an instance of the iSpeech Speech Synthesis class.
MarkerHolder	getMarkerHolder()
boolean	getMarkerHolderReady()
MarkerHolder	getMarkerInfo(String text, String voice, String speed, String format)
org.ispeech.core.TTSEngine	getTTSEngine()
VisemeHolder	getVisemeInfo(String text, String voice, String speed, String format) Returns a VisemeHolder Object that contains all the information for a viseme animation for a given text.
void	setConnectionTimeout(int timeout) Set connection timeout in milliseconds for HTTP connections
void	setSpeakWhenSilent(boolean alwaysSpeak) Sets SDK so that TTS will always speak, regardless of whether the user has device on silent or not.
void	setSpeechSynthesisEvent(SpeechSynthesisEvent speechSynthesisEvent) TODO :: this method needs to be renamed to registerSpeechSynthesisEventListener (or addSpeechSynthesisEventListener) has to correspond with unregisterSpeechSynthesisEventListener(SpeechSynthesisEvent) See SpeechSynthesisEvent
void	setStreamType(int streamType) Sets streamType to be used by SDK.
void	setUpMarkers(String ttsText)
void	setUpVisemes(String ttsText)
void	setVoiceType(String voiceType) Set the voice type
void	speak(String text) Converts text to speech and begins playing it as soon as it is ready, method does not block.
void	stop() Stops the currently playing audio.
void	toDisableTheDialogContact_salesATiSpeechDOTorg() To disable loading dialogs and prompts please contact sales@iSpeech.org
void	unregisterSpeechSynthesisEventListener(SpeechSynthesisEvent speechSynthesisEvent)

Methods inherited from class java.lang.Object

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

Method Detail

getTTSEngine

public org.ispeech.core.TTSEngine getTTSEngine()

getInstance

public static SpeechSynthesis getInstance(Context context,
                          Activity callingActivity)
                                   throws InvalidApiKeyException

Gets an instance of the iSpeech Speech Synthesis class. The ApiKey is only required on initial call to this method.

Parameters:

context - Context object

callingActivity -

isProduction - Set to true to specify that this application is in production mode. Set to false to use the sandbox servers. Your key must be provisioned for production use in order to deploy your application.

Throws:

InvalidApiKeyException - If the key is null or invalid.

getVisemeInfo

public VisemeHolder getVisemeInfo(String text,
                         String voice,
                         String speed,
                         String format)
                           throws InvalidApiKeyException

Returns a VisemeHolder Object that contains all the information for a viseme animation for a given text.

Parameters:

text - text for viseme information

voice - voice to be used for viseme information, ie usenglishfemale

speed - speed to be used for viseme information ie 3

format - format that speech spoken is downloaded as (mp3 or wav)

Throws:

InvalidApiKeyException

getMarkerInfo

public MarkerHolder getMarkerInfo(String text,
                         String voice,
                         String speed,
                         String format)
                           throws InvalidApiKeyException

Throws:

InvalidApiKeyException

getInstance

public static SpeechSynthesis getInstance(Activity callingActivity)
                                   throws InvalidApiKeyException

Throws:

InvalidApiKeyException

toDisableTheDialogContact_salesATiSpeechDOTorg

public void toDisableTheDialogContact_salesATiSpeechDOTorg()

To disable loading dialogs and prompts please contact sales@iSpeech.org

setStreamType

public void setStreamType(int streamType)

Sets streamType to be used by SDK. Default is AudioManager.STREAM_MUSIC.

Parameters:

streamType - sets stream type ie. AudioManager.STREAM_SYSTEM (int value 1) or AudioManager.STREAM_MUSIC (int value 3)

setSpeakWhenSilent

public void setSpeakWhenSilent(boolean alwaysSpeak)

Sets SDK so that TTS will always speak, regardless of whether the user has device on silent or not. Default is false.

Parameters:

alwaysSpeak - set to TRUE to have SDK always speak. set to FALSE to have SDK stay silent if device is silent.

downloadByteArray

public byte[] downloadByteArray(String text)
                         throws BusyException,
                                NoNetworkException

Throws:

BusyException

NoNetworkException

speak

public void speak(String text)
           throws BusyException,
                  NoNetworkException

Converts text to speech and begins playing it as soon as it is ready, method does not block.

Specified by:

speak in interface Synthesizer

Parameters:

text - The text to convert into audio.

Throws:

BusyException

NoNetworkException

setSpeechSynthesisEvent

public void setSpeechSynthesisEvent(SpeechSynthesisEvent speechSynthesisEvent)

TODO :: this method needs to be renamed to registerSpeechSynthesisEventListener (or addSpeechSynthesisEventListener) has to correspond with unregisterSpeechSynthesisEventListener(SpeechSynthesisEvent) See SpeechSynthesisEvent

unregisterSpeechSynthesisEventListener

public void unregisterSpeechSynthesisEventListener(SpeechSynthesisEvent speechSynthesisEvent)

setVoiceType

public void setVoiceType(String voiceType)

Set the voice type

Parameters:

voiceType -

getCurrentPosition

public int getCurrentPosition()

stop

public void stop()

Stops the currently playing audio. This command is ignored if an advertisement is currently playing.

Specified by:

stop in interface Synthesizer

See Also:

Synthesizer.stop()

cancel

public void cancel()

setConnectionTimeout

public void setConnectionTimeout(int timeout)

Set connection timeout in milliseconds for HTTP connections

Parameters:

timeout -

addMeta

public void addMeta(MetaType type,
           String value)

Add meta value to synthesizer

Specified by:

addMeta in interface Synthesizer

Parameters:

type -

value -

addOptionalCommand

public void addOptionalCommand(String command,
                      String parameter)

Description copied from interface: Synthesizer

Specify additional parameters to send to the server.

Specified by:

addOptionalCommand in interface Synthesizer

clearOptionalCommand

public void clearOptionalCommand()

Description copied from interface: Synthesizer

Clears optional parameters.

Specified by:

clearOptionalCommand in interface Synthesizer

addMarkerCallback

public void addMarkerCallback(MarkerCallback mc)

addVisemeCallback

public void addVisemeCallback(VisemeCallback mc)

setUpMarkers

public void setUpMarkers(String ttsText)

setUpVisemes

public void setUpVisemes(String ttsText)

getMarkerHolderReady

public boolean getMarkerHolderReady()

getMarkerHolder

public MarkerHolder getMarkerHolder()