com.ibm.watson.developer_cloud.text_to_speech.v1

Class TextToSpeech

java.lang.Object

com.ibm.watson.developer_cloud.service.WatsonService

com.ibm.watson.developer_cloud.text_to_speech.v1.TextToSpeech

public class TextToSpeech
extends WatsonService

The Text to Speech service uses IBM's speech synthesis capabilities to convert text to an audio signal. The audio is streamed back to the client in a InputStream

Version:

v1

See Also:

Text to Speech

Field Summary

Fields inherited from class com.ibm.watson.developer_cloud.service.WatsonService

defaultHeaders, MESSAGE_CODE, MESSAGE_ERROR, skipAuthentication, VERSION

Constructor Summary

Constructors

Constructor and Description
TextToSpeech() Instantiates a new text to speech.
TextToSpeech(String username, String password) Instantiates a new text to speech service by username and password.

Method Summary

Modifier and Type	Method and Description
ServiceCall<Void>	deleteCustomVoiceModel(CustomVoiceModel model) Deletes the given CustomVoiceModel (requires a valid id to be set).
ServiceCall<Void>	deleteWord(CustomVoiceModel model, CustomTranslation translation) Deletes a custom word translation.
ServiceCall<CustomVoiceModel>	getCustomVoiceModel(String id) Gets the meta data of a specific CustomVoiceModel.
ServiceCall<List<CustomVoiceModel>>	getCustomVoiceModels(String language) Gets all meta data of the CustomVoiceModels that you own.
ServiceCall<Pronunciation>	getPronunciation(String word, Voice voice, Phoneme phoneme) Returns the phonetic pronunciation for the word specified.
ServiceCall<Voice>	getVoice(String voiceName) Gets the voice based on a given name.
ServiceCall<List<Voice>>	getVoices() Gets the voices.
ServiceCall<List<CustomTranslation>>	getWords(CustomVoiceModel model) Gets all customized word translation of the given CustomVoiceModel.
ServiceCall<CustomVoiceModel>	saveCustomVoiceModel(CustomVoiceModel model) Saves a CustomVoiceModel.
ServiceCall<Void>	saveWords(CustomVoiceModel model, CustomTranslation... translations) Saves or updates custom word translations.
ServiceCall<InputStream>	synthesize(String text, Voice voice) Synthesize text using a voice.
ServiceCall<InputStream>	synthesize(String text, Voice voice, AudioFormat audioFormat) Synthesize text using a Voice and AudioFormat.
ServiceCall<InputStream>	synthesize(String text, Voice voice, AudioFormat audioFormat, String customizationId) Synthesize text using a Voice and AudioFormat.

Methods inherited from class com.ibm.watson.developer_cloud.service.WatsonService

configureHttpClient, createServiceCall, getApiKey, getEndPoint, getName, getToken, processServiceCall, setApiKey, setAuthentication, setDefaultHeaders, setEndPoint, setSkipAuthentication, setUsernameAndPassword, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

TextToSpeech

public TextToSpeech()

Instantiates a new text to speech.

TextToSpeech

public TextToSpeech(String username,
                    String password)

Instantiates a new text to speech service by username and password.

Parameters:

username - the username

password - the password

Method Detail

getVoices

public ServiceCall<List<Voice>> getVoices()

Gets the voices.

Returns:

the list of Voice

getVoice

public ServiceCall<Voice> getVoice(String voiceName)

Gets the voice based on a given name.

Parameters:

voiceName - the voice name

Returns:

the Voice

getPronunciation

public ServiceCall<Pronunciation> getPronunciation(String word,
                                                   Voice voice,
                                                   Phoneme phoneme)

Returns the phonetic pronunciation for the word specified.

Parameters:

word - The word for which the pronunciation is requested.

voice - the voice to obtain the pronunciation for the specified word in the language of that voice.

phoneme - the phoneme set in which to return the pronunciation

Returns:

the word pronunciation

See Also:

Pronunciation

synthesize

public ServiceCall<InputStream> synthesize(String text,
                                           Voice voice)

Synthesize text using a voice.

Parameters:

text - the text to synthesize

voice - the voice

Returns:

the input stream

synthesize

public ServiceCall<InputStream> synthesize(String text,
                                           Voice voice,
                                           AudioFormat audioFormat)

Synthesize text using a Voice and AudioFormat.

Parameters:

text - the text

voice - the voice

audioFormat - the AudioFormat

Returns:

the input stream

synthesize

public ServiceCall<InputStream> synthesize(String text,
                                           Voice voice,
                                           AudioFormat audioFormat,
                                           String customizationId)

Synthesize text using a Voice and AudioFormat.

Parameters:

text - the text

voice - the voice

audioFormat - the AudioFormat

customizationId - the customization ID

Returns:

the input stream

getCustomVoiceModels

public ServiceCall<List<CustomVoiceModel>> getCustomVoiceModels(String language)

Gets all meta data of the CustomVoiceModels that you own.

Parameters:

language - the language (e.g. "en-us")

Returns:

the VoiceModels

getCustomVoiceModel

public ServiceCall<CustomVoiceModel> getCustomVoiceModel(String id)

Gets the meta data of a specific CustomVoiceModel.

Parameters:

id - the customization id of the CustomVoiceModel

Returns:

the VoiceModel

saveCustomVoiceModel

public ServiceCall<CustomVoiceModel> saveCustomVoiceModel(CustomVoiceModel model)

Saves a CustomVoiceModel. If the given model has an id, this service will update an existing model. When no id is set, a new CustomVoiceModel is created and the id field set.

Parameters:

model - the model to be saved

Returns:

a reference to the given CustomVoiceModel. If a new CustomVoiceModel is created, the id field will be populated.

deleteCustomVoiceModel

public ServiceCall<Void> deleteCustomVoiceModel(CustomVoiceModel model)

Deletes the given CustomVoiceModel (requires a valid id to be set).

Parameters:

model - the model

Returns:

the service call

getWords

public ServiceCall<List<CustomTranslation>> getWords(CustomVoiceModel model)

Gets all customized word translation of the given CustomVoiceModel.

Parameters:

model - the VoiceModel

Returns:

a list of all CustomTranslations

saveWords

public ServiceCall<Void> saveWords(CustomVoiceModel model,
                                   CustomTranslation... translations)

Saves or updates custom word translations. If no translation with the given word is existing, a new translation is created. Elsewise, the existing translation is updated.

Parameters:

model - the CustomVoiceModel

translations - the translations to be saved or updated

Returns:

the service call

deleteWord

public ServiceCall<Void> deleteWord(CustomVoiceModel model,
                                    CustomTranslation translation)

Deletes a custom word translation.

Parameters:

model - the CustomVoiceModel

translation - the translation

Returns:

the service call