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

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(java.lang.String username, java.lang.String password) Instantiates a new text to speech service by username and password.

Method Summary

Modifier and Type	Method and Description
ServiceCall<java.lang.Void>	addWord(CustomVoiceModel model, CustomTranslation translation) Adds or updates a single custom word translation for a CustomVoiceModel.
ServiceCall<java.lang.Void>	addWords(CustomVoiceModel model, CustomTranslation... translations) Adds or updates one or more custom word translations for a CustomVoiceModel.
ServiceCall<CustomVoiceModel>	createCustomVoiceModel(java.lang.String name, java.lang.String language, java.lang.String description) Creates a new CustomVoiceModel with the specified name, description, and language.
ServiceCall<java.lang.Void>	deleteCustomVoiceModel(CustomVoiceModel model) Deletes the given CustomVoiceModel.
ServiceCall<java.lang.Void>	deleteWord(CustomVoiceModel model, CustomTranslation translation) Deletes a custom word based on a translation object.
ServiceCall<java.lang.Void>	deleteWord(CustomVoiceModel model, java.lang.String word) Deletes a custom word based on a string.
ServiceCall<CustomVoiceModel>	getCustomVoiceModel(CustomVoiceModel model) Gets the metadata for a CustomVoiceModel specified by object.
ServiceCall<CustomVoiceModel>	getCustomVoiceModel(java.lang.String customizationId) Gets the metadata for a CustomVoiceModel specified by customization id.
ServiceCall<java.util.List<CustomVoiceModel>>	getCustomVoiceModels(java.lang.String language) Gets all meta data of the CustomVoiceModels that you own.
ServiceCall<Pronunciation>	getPronunciation(java.lang.String word, Voice voice, Phoneme phoneme) Returns the phonetic pronunciation for the word specified.
ServiceCall<Pronunciation>	getPronunciation(java.lang.String word, Voice voice, Phoneme phoneme, java.lang.String customizationId) Returns the phonetic pronunciation for the word specified.
ServiceCall<Voice>	getVoice(java.lang.String voiceName) Lists information about the voice specified with the voice path parameter.
ServiceCall<Voice>	getVoice(java.lang.String voiceName, java.lang.String customizationId) Lists information about the voice specified with the voice path parameter.
ServiceCall<java.util.List<Voice>>	getVoices() Lists information about all available voices.
ServiceCall<CustomTranslation>	getWord(CustomVoiceModel model, java.lang.String word) Gets a custom word translation for the given CustomVoiceModel.
ServiceCall<java.util.List<CustomTranslation>>	getWords(CustomVoiceModel model) Gets all custom word translation for the given CustomVoiceModel.
ServiceCall<java.io.InputStream>	synthesize(java.lang.String text, Voice voice) Synthesize text using a voice.
ServiceCall<java.io.InputStream>	synthesize(java.lang.String text, Voice voice, AudioFormat audioFormat) Synthesize text using a Voice and AudioFormat.
ServiceCall<java.io.InputStream>	synthesize(java.lang.String text, Voice voice, AudioFormat audioFormat, java.lang.String customizationId) Synthesize text using a Voice and AudioFormat.
ServiceCall<java.lang.Void>	updateCustomVoiceModel(CustomVoiceModel model) Updates an existing CustomVoiceModel with new name, new description, and new custom word translations.

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

configureHttpClient, createServiceCall, getApiKey, getEndPoint, getName, getToken, processServiceCall, setApiKey, setAuthentication, setDefaultHeaders, 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(java.lang.String username,
                    java.lang.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<java.util.List<Voice>> getVoices()

Lists information about all available voices. To see information about a specific voice, use the getVoice(String,String) method.

Returns:

the list of Voice

getVoice

public ServiceCall<Voice> getVoice(java.lang.String voiceName)

Lists information about the voice specified with the voice path parameter.

Parameters:

voiceName - the voice name

Returns:

the Voice

getVoice

public ServiceCall<Voice> getVoice(java.lang.String voiceName,
                                   java.lang.String customizationId)

Lists information about the voice specified with the voice path parameter. Specify the customizationId parameter to obtain information for that custom voice model of the specified voice.

Parameters:

voiceName - the voice name

customizationId - the customization id

Returns:

the Voice

getPronunciation

public ServiceCall<Pronunciation> getPronunciation(java.lang.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

getPronunciation

public ServiceCall<Pronunciation> getPronunciation(java.lang.String word,
                                                   Voice voice,
                                                   Phoneme phoneme,
                                                   java.lang.String customizationId)

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

customizationId - the customization id

Returns:

the word pronunciation

See Also:

Pronunciation

synthesize

public ServiceCall<java.io.InputStream> synthesize(java.lang.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<java.io.InputStream> synthesize(java.lang.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<java.io.InputStream> synthesize(java.lang.String text,
                                                   Voice voice,
                                                   AudioFormat audioFormat,
                                                   java.lang.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<java.util.List<CustomVoiceModel>> getCustomVoiceModels(java.lang.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(CustomVoiceModel model)

Gets the metadata for a CustomVoiceModel specified by object.

Parameters:

model - the custom voice model object to be queried

Returns:

the CustomVoiceModel with full metadata

getCustomVoiceModel

public ServiceCall<CustomVoiceModel> getCustomVoiceModel(java.lang.String customizationId)

Gets the metadata for a CustomVoiceModel specified by customization id.

Parameters:

customizationId - the id of the custom voice model to be queried

Returns:

the CustomVoiceModel with full metadata

createCustomVoiceModel

public ServiceCall<CustomVoiceModel> createCustomVoiceModel(java.lang.String name,
                                                            java.lang.String language,
                                                            java.lang.String description)

Creates a new CustomVoiceModel with the specified name, description, and language.

Parameters:

name - the name of the new model

language - the language of the new model (the default is "en-US")

description - a description of the new model (the default is no description)

Returns:

a CustomVoiceModel that contains the id of the new model

updateCustomVoiceModel

public ServiceCall<java.lang.Void> updateCustomVoiceModel(CustomVoiceModel model)

Updates an existing CustomVoiceModel with new name, new description, and new custom word translations. If no translation with a given word exists, a new translation is created. Otherwise, the existing translation is updated.

Parameters:

model - the custom voice model object to be updated with new name, description, and words

Returns:

the service call

deleteCustomVoiceModel

public ServiceCall<java.lang.Void> deleteCustomVoiceModel(CustomVoiceModel model)

Deletes the given CustomVoiceModel.

Parameters:

model - the custom voice model object to be deleted

Returns:

the service call

getWords

public ServiceCall<java.util.List<CustomTranslation>> getWords(CustomVoiceModel model)

Gets all custom word translation for the given CustomVoiceModel.

Parameters:

model - the custom voice model object from which words are to be listed

Returns:

a list of all CustomTranslations for the model

getWord

public ServiceCall<CustomTranslation> getWord(CustomVoiceModel model,
                                              java.lang.String word)

Gets a custom word translation for the given CustomVoiceModel.

Parameters:

model - the custom voice model object from which a word is to be listed

word - a word from the CustomVoiceModel

Returns:

the translation of the word

addWords

public ServiceCall<java.lang.Void> addWords(CustomVoiceModel model,
                                            CustomTranslation... translations)

Adds or updates one or more custom word translations for a CustomVoiceModel. If no translation with a given word exists, a new translation is created. Otherwise, the existing translation is updated.

Parameters:

model - the custom voice model object for which words are to be added or updated

translations - the custom translations to be added or updated

Returns:

the service call

addWord

public ServiceCall<java.lang.Void> addWord(CustomVoiceModel model,
                                           CustomTranslation translation)

Adds or updates a single custom word translation for a CustomVoiceModel. If no translation with the given word exists, a new translation is created. Otherwise, the existing translation is updated.

Parameters:

model - the custom voice model object for which a word is to be added or updated

translation - the translation to be added or updated

Returns:

the service call

deleteWord

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

Deletes a custom word based on a translation object.

Parameters:

model - the custom voice model object from which a word is to be deleted

translation - the translation object to be deleted

Returns:

the service call

deleteWord

public ServiceCall<java.lang.Void> deleteWord(CustomVoiceModel model,
                                              java.lang.String word)

Deletes a custom word based on a string.

Parameters:

model - the custom voice model object from which a word is to be deleted

word - the word to be deleted

Returns:

the service call