com.ibm.watson.developer_cloud.text_to_speech.v1.model

Class Voice

java.lang.Object

com.ibm.watson.developer_cloud.service.model.GenericModel

com.ibm.watson.developer_cloud.text_to_speech.v1.model.Voice

All Implemented Interfaces:

ObjectModel

public class Voice
extends GenericModel

TextToSpeech voice.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	Voice.SupportedFeatures Describes the additional service features supported with the voice.

Field Summary

Fields

Modifier and Type	Field and Description
static java.util.List<Voice>	ALL The List of all predefined Voices.
static Voice	DE_BIRGIT The Constant DE_BIRGIT (value is "de-DE_BirgitVoice").
static Voice	DE_DIETER The Constant DE_DIETER (value is "de-DE_DieterVoice").
static Voice	EN_ALLISON The Constant EN_ALLISON (value is "en-US_AllisonVoice").
static Voice	EN_LISA The Constant EN_LISA (value is "en-US_LisaVoice").
static Voice	EN_MICHAEL The Constant EN_MICHAEL (value is "en-US_MichaelVoice").
static Voice	ES_ENRIQUE The Constant ES_ENRIQUE (value is "es-ES_EnriqueVoice").
static Voice	ES_LAURA The Constant ES_LAURA (value is "es-ES_LauraVoice").
static Voice	ES_SOFIA The Constant ES_SOFIA (value is "es-US_SofiaVoice").
static Voice	FR_RENEE The Constant FR_RENEE (value is "fr-FR_ReneeVoice").
static Voice	GB_KATE The Constant GB_KATE (value is "en-GB_KateVoice").
static Voice	IT_FRANCESCA The Constant IT_FRANCESCA (value is "it-IT_FrancescaVoice").
static Voice	JA_EMI The Constant JA_EMI (value is "ja-JP_EmiVoice").
static Voice	LA_SOFIA The Constant LA_SOFIA (value is "es-LA_SofiaVoice").
static Voice	PT_ISABELA The Constant PT_ISABELA (value is "pt-BR_IsabelaVoice").

Constructor Summary

Constructors

Constructor and Description
Voice() Instantiates a new voice.
Voice(java.lang.String name, java.lang.String gender, java.lang.String language) Instantiates a new voice.

Method Summary

Modifier and Type	Method and Description
static Voice	getByName(java.lang.String name) Gets the Voice by its name (e.g.
CustomVoiceModel	getCustomVoiceModel() Gets the custom voice model if present.
java.lang.String	getDescription() Gets the description.
java.lang.String	getGender() Gets the gender.
java.lang.String	getLanguage() Gets the language.
java.lang.String	getName() Gets the name.
Voice.SupportedFeatures	getSupportedFeatures() Gets the supported features.
java.lang.String	getUrl() Gets the url.
void	setCustomVoiceModel(CustomVoiceModel customVoiceModel) Sets the custom voice model if present.
void	setDescription(java.lang.String description) Sets the description.
void	setGender(java.lang.String gender) Sets the gender.
void	setLanguage(java.lang.String language) Sets the language.
void	setName(java.lang.String name) Sets the name.
void	setSupportedFeatures(Voice.SupportedFeatures supportedFeatures) Sets the supported features.
void	setUrl(java.lang.String url) Sets the url.

Methods inherited from class com.ibm.watson.developer_cloud.service.model.GenericModel

equals, hashCode, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

DE_BIRGIT

public static final Voice DE_BIRGIT

The Constant DE_BIRGIT (value is "de-DE_BirgitVoice").

DE_DIETER

public static final Voice DE_DIETER

The Constant DE_DIETER (value is "de-DE_DieterVoice").

EN_ALLISON

public static final Voice EN_ALLISON

The Constant EN_ALLISON (value is "en-US_AllisonVoice").

EN_LISA

public static final Voice EN_LISA

The Constant EN_LISA (value is "en-US_LisaVoice").

EN_MICHAEL

public static final Voice EN_MICHAEL

The Constant EN_MICHAEL (value is "en-US_MichaelVoice").

ES_ENRIQUE

public static final Voice ES_ENRIQUE

The Constant ES_ENRIQUE (value is "es-ES_EnriqueVoice").

ES_LAURA

public static final Voice ES_LAURA

The Constant ES_LAURA (value is "es-ES_LauraVoice").

ES_SOFIA

public static final Voice ES_SOFIA

The Constant ES_SOFIA (value is "es-US_SofiaVoice").

FR_RENEE

public static final Voice FR_RENEE

The Constant FR_RENEE (value is "fr-FR_ReneeVoice").

GB_KATE

public static final Voice GB_KATE

The Constant GB_KATE (value is "en-GB_KateVoice").

IT_FRANCESCA

public static final Voice IT_FRANCESCA

The Constant IT_FRANCESCA (value is "it-IT_FrancescaVoice").

JA_EMI

public static final Voice JA_EMI

The Constant JA_EMI (value is "ja-JP_EmiVoice").

LA_SOFIA

public static final Voice LA_SOFIA

The Constant LA_SOFIA (value is "es-LA_SofiaVoice").

PT_ISABELA

public static final Voice PT_ISABELA

The Constant PT_ISABELA (value is "pt-BR_IsabelaVoice").

ALL

public static final java.util.List<Voice> ALL

The List of all predefined Voices.

Constructor Detail

Voice

public Voice()

Instantiates a new voice.

Voice

public Voice(java.lang.String name,
             java.lang.String gender,
             java.lang.String language)

Instantiates a new voice.

Parameters:

name - the name

gender - the gender

language - the language

Method Detail

getByName

public static Voice getByName(java.lang.String name)

Gets the Voice by its name (e.g. en-US_AllisonVoice).

Parameters:

name - the Voice name

Returns:

the Voice, or null if no matching Voice was found

getDescription

public java.lang.String getDescription()

Gets the description.

Returns:

the description

getGender

public java.lang.String getGender()

Gets the gender.

Returns:

the gender

getLanguage

public java.lang.String getLanguage()

Gets the language.

Returns:

the language

getName

public java.lang.String getName()

Gets the name.

Returns:

the name

getUrl

public java.lang.String getUrl()

Gets the url.

Returns:

the url

getSupportedFeatures

public Voice.SupportedFeatures getSupportedFeatures()

Gets the supported features.

Returns:

the supported features

getCustomVoiceModel

public CustomVoiceModel getCustomVoiceModel()

Gets the custom voice model if present.

Returns:

the custom voice model

setDescription

public void setDescription(java.lang.String description)

Sets the description.

Parameters:

description - the new description

setGender

public void setGender(java.lang.String gender)

Sets the gender.

Parameters:

gender - the new gender

setLanguage

public void setLanguage(java.lang.String language)

Sets the language.

Parameters:

language - the new language

setName

public void setName(java.lang.String name)

Sets the name.

Parameters:

name - the new name

setUrl

public void setUrl(java.lang.String url)

Sets the url.

Parameters:

url - the new url

setSupportedFeatures

public void setSupportedFeatures(Voice.SupportedFeatures supportedFeatures)

Sets the supported features.

Parameters:

supportedFeatures - the new supported features

setCustomVoiceModel

public void setCustomVoiceModel(CustomVoiceModel customVoiceModel)

Sets the custom voice model if present.

Parameters:

customVoiceModel - the new custom voice model