com.amazonaws.services.polly.model

Class Voice

java.lang.Object

com.amazonaws.services.polly.model.Voice

All Implemented Interfaces:

java.io.Serializable

public class Voice
extends java.lang.Object
implements java.io.Serializable

Description of the voice.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Voice()

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
java.util.List<java.lang.String>	getAdditionalLanguageCodes() Additional codes for languages available for the specified voice in addition to its default language.
java.lang.String	getGender() Gender of the voice.
java.lang.String	getId() Amazon Polly assigned voice ID.
java.lang.String	getLanguageCode() Language code of the voice.
java.lang.String	getLanguageName() Human readable name of the language in English.
java.lang.String	getName() Name of the voice (for example, Salli, Kendra, etc.).
java.util.List<java.lang.String>	getSupportedEngines() Specifies which engines (standard or neural) that are supported by a given voice.
int	hashCode()
void	setAdditionalLanguageCodes(java.util.Collection<java.lang.String> additionalLanguageCodes) Additional codes for languages available for the specified voice in addition to its default language.
void	setGender(Gender gender) Gender of the voice.
void	setGender(java.lang.String gender) Gender of the voice.
void	setId(java.lang.String id) Amazon Polly assigned voice ID.
void	setId(VoiceId id) Amazon Polly assigned voice ID.
void	setLanguageCode(LanguageCode languageCode) Language code of the voice.
void	setLanguageCode(java.lang.String languageCode) Language code of the voice.
void	setLanguageName(java.lang.String languageName) Human readable name of the language in English.
void	setName(java.lang.String name) Name of the voice (for example, Salli, Kendra, etc.).
void	setSupportedEngines(java.util.Collection<java.lang.String> supportedEngines) Specifies which engines (standard or neural) that are supported by a given voice.
java.lang.String	toString() Returns a string representation of this object; useful for testing and debugging.
Voice	withAdditionalLanguageCodes(java.util.Collection<java.lang.String> additionalLanguageCodes) Additional codes for languages available for the specified voice in addition to its default language.
Voice	withAdditionalLanguageCodes(java.lang.String... additionalLanguageCodes) Additional codes for languages available for the specified voice in addition to its default language.
Voice	withGender(Gender gender) Gender of the voice.
Voice	withGender(java.lang.String gender) Gender of the voice.
Voice	withId(java.lang.String id) Amazon Polly assigned voice ID.
Voice	withId(VoiceId id) Amazon Polly assigned voice ID.
Voice	withLanguageCode(LanguageCode languageCode) Language code of the voice.
Voice	withLanguageCode(java.lang.String languageCode) Language code of the voice.
Voice	withLanguageName(java.lang.String languageName) Human readable name of the language in English.
Voice	withName(java.lang.String name) Name of the voice (for example, Salli, Kendra, etc.).
Voice	withSupportedEngines(java.util.Collection<java.lang.String> supportedEngines) Specifies which engines (standard or neural) that are supported by a given voice.
Voice	withSupportedEngines(java.lang.String... supportedEngines) Specifies which engines (standard or neural) that are supported by a given voice.

Methods inherited from class java.lang.Object

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

Constructor Detail

Voice

public Voice()

Method Detail

getGender

public java.lang.String getGender()

Gender of the voice.

Constraints:
Allowed Values: Female, Male

Returns:

Gender of the voice.

See Also:

Gender

setGender

public void setGender(java.lang.String gender)

Gender of the voice.

Constraints:
Allowed Values: Female, Male

Parameters:

gender -

Gender of the voice.

See Also:

Gender

withGender

public Voice withGender(java.lang.String gender)

Gender of the voice.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Allowed Values: Female, Male

Parameters:

gender -

Gender of the voice.

Returns:

A reference to this updated object so that method calls can be chained together.

See Also:

Gender

setGender

public void setGender(Gender gender)

Gender of the voice.

Constraints:
Allowed Values: Female, Male

Parameters:

gender -

Gender of the voice.

See Also:

Gender

withGender

public Voice withGender(Gender gender)

Gender of the voice.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Allowed Values: Female, Male

Parameters:

gender -

Gender of the voice.

Returns:

A reference to this updated object so that method calls can be chained together.

See Also:

Gender

getId

public java.lang.String getId()

Amazon Polly assigned voice ID. This is the ID that you specify when calling the SynthesizeSpeech operation.

Constraints:
Allowed Values: Aditi, Amy, Astrid, Bianca, Brian, Camila, Carla, Carmen, Celine, Chantal, Conchita, Cristiano, Dora, Emma, Enrique, Ewa, Filiz, Gabrielle, Geraint, Giorgio, Gwyneth, Hans, Ines, Ivy, Jacek, Jan, Joanna, Joey, Justin, Karl, Kendra, Kevin, Kimberly, Lea, Liv, Lotte, Lucia, Lupe, Mads, Maja, Marlene, Mathieu, Matthew, Maxim, Mia, Miguel, Mizuki, Naja, Nicole, Olivia, Penelope, Raveena, Ricardo, Ruben, Russell, Salli, Seoyeon, Takumi, Tatyana, Vicki, Vitoria, Zeina, Zhiyu, Aria, Ayanda, Arlet, Hannah, Arthur, Daniel, Liam, Pedro, Kajal

Returns:

Amazon Polly assigned voice ID. This is the ID that you specify when calling the SynthesizeSpeech operation.

See Also:

VoiceId

setId

public void setId(java.lang.String id)

Amazon Polly assigned voice ID. This is the ID that you specify when calling the SynthesizeSpeech operation.

Constraints:
Allowed Values: Aditi, Amy, Astrid, Bianca, Brian, Camila, Carla, Carmen, Celine, Chantal, Conchita, Cristiano, Dora, Emma, Enrique, Ewa, Filiz, Gabrielle, Geraint, Giorgio, Gwyneth, Hans, Ines, Ivy, Jacek, Jan, Joanna, Joey, Justin, Karl, Kendra, Kevin, Kimberly, Lea, Liv, Lotte, Lucia, Lupe, Mads, Maja, Marlene, Mathieu, Matthew, Maxim, Mia, Miguel, Mizuki, Naja, Nicole, Olivia, Penelope, Raveena, Ricardo, Ruben, Russell, Salli, Seoyeon, Takumi, Tatyana, Vicki, Vitoria, Zeina, Zhiyu, Aria, Ayanda, Arlet, Hannah, Arthur, Daniel, Liam, Pedro, Kajal

Parameters:

id -

Amazon Polly assigned voice ID. This is the ID that you specify when calling the SynthesizeSpeech operation.

See Also:

VoiceId

withId

public Voice withId(java.lang.String id)

Amazon Polly assigned voice ID. This is the ID that you specify when calling the SynthesizeSpeech operation.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Allowed Values: Aditi, Amy, Astrid, Bianca, Brian, Camila, Carla, Carmen, Celine, Chantal, Conchita, Cristiano, Dora, Emma, Enrique, Ewa, Filiz, Gabrielle, Geraint, Giorgio, Gwyneth, Hans, Ines, Ivy, Jacek, Jan, Joanna, Joey, Justin, Karl, Kendra, Kevin, Kimberly, Lea, Liv, Lotte, Lucia, Lupe, Mads, Maja, Marlene, Mathieu, Matthew, Maxim, Mia, Miguel, Mizuki, Naja, Nicole, Olivia, Penelope, Raveena, Ricardo, Ruben, Russell, Salli, Seoyeon, Takumi, Tatyana, Vicki, Vitoria, Zeina, Zhiyu, Aria, Ayanda, Arlet, Hannah, Arthur, Daniel, Liam, Pedro, Kajal

Parameters:

id -

Amazon Polly assigned voice ID. This is the ID that you specify when calling the SynthesizeSpeech operation.

Returns:

A reference to this updated object so that method calls can be chained together.

See Also:

VoiceId

setId

public void setId(VoiceId id)

Amazon Polly assigned voice ID. This is the ID that you specify when calling the SynthesizeSpeech operation.

Constraints:
Allowed Values: Aditi, Amy, Astrid, Bianca, Brian, Camila, Carla, Carmen, Celine, Chantal, Conchita, Cristiano, Dora, Emma, Enrique, Ewa, Filiz, Gabrielle, Geraint, Giorgio, Gwyneth, Hans, Ines, Ivy, Jacek, Jan, Joanna, Joey, Justin, Karl, Kendra, Kevin, Kimberly, Lea, Liv, Lotte, Lucia, Lupe, Mads, Maja, Marlene, Mathieu, Matthew, Maxim, Mia, Miguel, Mizuki, Naja, Nicole, Olivia, Penelope, Raveena, Ricardo, Ruben, Russell, Salli, Seoyeon, Takumi, Tatyana, Vicki, Vitoria, Zeina, Zhiyu, Aria, Ayanda, Arlet, Hannah, Arthur, Daniel, Liam, Pedro, Kajal

Parameters:

id -

Amazon Polly assigned voice ID. This is the ID that you specify when calling the SynthesizeSpeech operation.

See Also:

VoiceId

withId

public Voice withId(VoiceId id)

Amazon Polly assigned voice ID. This is the ID that you specify when calling the SynthesizeSpeech operation.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Allowed Values: Aditi, Amy, Astrid, Bianca, Brian, Camila, Carla, Carmen, Celine, Chantal, Conchita, Cristiano, Dora, Emma, Enrique, Ewa, Filiz, Gabrielle, Geraint, Giorgio, Gwyneth, Hans, Ines, Ivy, Jacek, Jan, Joanna, Joey, Justin, Karl, Kendra, Kevin, Kimberly, Lea, Liv, Lotte, Lucia, Lupe, Mads, Maja, Marlene, Mathieu, Matthew, Maxim, Mia, Miguel, Mizuki, Naja, Nicole, Olivia, Penelope, Raveena, Ricardo, Ruben, Russell, Salli, Seoyeon, Takumi, Tatyana, Vicki, Vitoria, Zeina, Zhiyu, Aria, Ayanda, Arlet, Hannah, Arthur, Daniel, Liam, Pedro, Kajal

Parameters:

id -

Amazon Polly assigned voice ID. This is the ID that you specify when calling the SynthesizeSpeech operation.

Returns:

A reference to this updated object so that method calls can be chained together.

See Also:

VoiceId

getLanguageCode

public java.lang.String getLanguageCode()

Language code of the voice.

Constraints:
Allowed Values: arb, cmn-CN, cy-GB, da-DK, de-DE, en-AU, en-GB, en-GB-WLS, en-IN, en-US, es-ES, es-MX, es-US, fr-CA, fr-FR, is-IS, it-IT, ja-JP, hi-IN, ko-KR, nb-NO, nl-NL, pl-PL, pt-BR, pt-PT, ro-RO, ru-RU, sv-SE, tr-TR, en-NZ, en-ZA, ca-ES, de-AT

Returns:

Language code of the voice.

See Also:

LanguageCode

setLanguageCode

public void setLanguageCode(java.lang.String languageCode)

Language code of the voice.

Constraints:
Allowed Values: arb, cmn-CN, cy-GB, da-DK, de-DE, en-AU, en-GB, en-GB-WLS, en-IN, en-US, es-ES, es-MX, es-US, fr-CA, fr-FR, is-IS, it-IT, ja-JP, hi-IN, ko-KR, nb-NO, nl-NL, pl-PL, pt-BR, pt-PT, ro-RO, ru-RU, sv-SE, tr-TR, en-NZ, en-ZA, ca-ES, de-AT

Parameters:

languageCode -

Language code of the voice.

See Also:

LanguageCode

withLanguageCode

public Voice withLanguageCode(java.lang.String languageCode)

Language code of the voice.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Allowed Values: arb, cmn-CN, cy-GB, da-DK, de-DE, en-AU, en-GB, en-GB-WLS, en-IN, en-US, es-ES, es-MX, es-US, fr-CA, fr-FR, is-IS, it-IT, ja-JP, hi-IN, ko-KR, nb-NO, nl-NL, pl-PL, pt-BR, pt-PT, ro-RO, ru-RU, sv-SE, tr-TR, en-NZ, en-ZA, ca-ES, de-AT

Parameters:

languageCode -

Language code of the voice.

Returns:

A reference to this updated object so that method calls can be chained together.

See Also:

LanguageCode

setLanguageCode

public void setLanguageCode(LanguageCode languageCode)

Language code of the voice.

Constraints:
Allowed Values: arb, cmn-CN, cy-GB, da-DK, de-DE, en-AU, en-GB, en-GB-WLS, en-IN, en-US, es-ES, es-MX, es-US, fr-CA, fr-FR, is-IS, it-IT, ja-JP, hi-IN, ko-KR, nb-NO, nl-NL, pl-PL, pt-BR, pt-PT, ro-RO, ru-RU, sv-SE, tr-TR, en-NZ, en-ZA, ca-ES, de-AT

Parameters:

languageCode -

Language code of the voice.

See Also:

LanguageCode

withLanguageCode

public Voice withLanguageCode(LanguageCode languageCode)

Language code of the voice.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Allowed Values: arb, cmn-CN, cy-GB, da-DK, de-DE, en-AU, en-GB, en-GB-WLS, en-IN, en-US, es-ES, es-MX, es-US, fr-CA, fr-FR, is-IS, it-IT, ja-JP, hi-IN, ko-KR, nb-NO, nl-NL, pl-PL, pt-BR, pt-PT, ro-RO, ru-RU, sv-SE, tr-TR, en-NZ, en-ZA, ca-ES, de-AT

Parameters:

languageCode -

Language code of the voice.

Returns:

A reference to this updated object so that method calls can be chained together.

See Also:

LanguageCode

getLanguageName

public java.lang.String getLanguageName()

Human readable name of the language in English.

Returns:

Human readable name of the language in English.

setLanguageName

public void setLanguageName(java.lang.String languageName)

Human readable name of the language in English.

Parameters:

languageName -

Human readable name of the language in English.

withLanguageName

public Voice withLanguageName(java.lang.String languageName)

Human readable name of the language in English.

Returns a reference to this object so that method calls can be chained together.

Parameters:

languageName -

Human readable name of the language in English.

Returns:

A reference to this updated object so that method calls can be chained together.

getName

public java.lang.String getName()

Name of the voice (for example, Salli, Kendra, etc.). This provides a human readable voice name that you might display in your application.

Returns:

Name of the voice (for example, Salli, Kendra, etc.). This provides a human readable voice name that you might display in your application.

setName

public void setName(java.lang.String name)

Name of the voice (for example, Salli, Kendra, etc.). This provides a human readable voice name that you might display in your application.

Parameters:

name -

Name of the voice (for example, Salli, Kendra, etc.). This provides a human readable voice name that you might display in your application.

withName

public Voice withName(java.lang.String name)

Name of the voice (for example, Salli, Kendra, etc.). This provides a human readable voice name that you might display in your application.

Returns a reference to this object so that method calls can be chained together.

Parameters:

name -

Name of the voice (for example, Salli, Kendra, etc.). This provides a human readable voice name that you might display in your application.

Returns:

A reference to this updated object so that method calls can be chained together.

getAdditionalLanguageCodes

public java.util.List<java.lang.String> getAdditionalLanguageCodes()

Additional codes for languages available for the specified voice in addition to its default language.

For example, the default language for Aditi is Indian English (en-IN) because it was first used for that language. Since Aditi is bilingual and fluent in both Indian English and Hindi, this parameter would show the code hi-IN.

Returns:

Additional codes for languages available for the specified voice in addition to its default language.

For example, the default language for Aditi is Indian English (en-IN) because it was first used for that language. Since Aditi is bilingual and fluent in both Indian English and Hindi, this parameter would show the code hi-IN.

setAdditionalLanguageCodes

public void setAdditionalLanguageCodes(java.util.Collection<java.lang.String> additionalLanguageCodes)

Additional codes for languages available for the specified voice in addition to its default language.

For example, the default language for Aditi is Indian English (en-IN) because it was first used for that language. Since Aditi is bilingual and fluent in both Indian English and Hindi, this parameter would show the code hi-IN.

Parameters:

additionalLanguageCodes -

Additional codes for languages available for the specified voice in addition to its default language.

For example, the default language for Aditi is Indian English (en-IN) because it was first used for that language. Since Aditi is bilingual and fluent in both Indian English and Hindi, this parameter would show the code hi-IN.

withAdditionalLanguageCodes

public Voice withAdditionalLanguageCodes(java.lang.String... additionalLanguageCodes)

Additional codes for languages available for the specified voice in addition to its default language.

For example, the default language for Aditi is Indian English (en-IN) because it was first used for that language. Since Aditi is bilingual and fluent in both Indian English and Hindi, this parameter would show the code hi-IN.

Returns a reference to this object so that method calls can be chained together.

Parameters:

additionalLanguageCodes -

Additional codes for languages available for the specified voice in addition to its default language.

For example, the default language for Aditi is Indian English (en-IN) because it was first used for that language. Since Aditi is bilingual and fluent in both Indian English and Hindi, this parameter would show the code hi-IN.

Returns:

A reference to this updated object so that method calls can be chained together.

withAdditionalLanguageCodes

public Voice withAdditionalLanguageCodes(java.util.Collection<java.lang.String> additionalLanguageCodes)

Additional codes for languages available for the specified voice in addition to its default language.

For example, the default language for Aditi is Indian English (en-IN) because it was first used for that language. Since Aditi is bilingual and fluent in both Indian English and Hindi, this parameter would show the code hi-IN.

Returns a reference to this object so that method calls can be chained together.

Parameters:

additionalLanguageCodes -

Additional codes for languages available for the specified voice in addition to its default language.

For example, the default language for Aditi is Indian English (en-IN) because it was first used for that language. Since Aditi is bilingual and fluent in both Indian English and Hindi, this parameter would show the code hi-IN.

Returns:

A reference to this updated object so that method calls can be chained together.

getSupportedEngines

public java.util.List<java.lang.String> getSupportedEngines()

Specifies which engines (standard or neural) that are supported by a given voice.

Returns:

Specifies which engines (standard or neural) that are supported by a given voice.

setSupportedEngines

public void setSupportedEngines(java.util.Collection<java.lang.String> supportedEngines)

Specifies which engines (standard or neural) that are supported by a given voice.

Parameters:

supportedEngines -

Specifies which engines (standard or neural) that are supported by a given voice.

withSupportedEngines

public Voice withSupportedEngines(java.lang.String... supportedEngines)

Specifies which engines (standard or neural) that are supported by a given voice.

Returns a reference to this object so that method calls can be chained together.

Parameters:

supportedEngines -

Specifies which engines (standard or neural) that are supported by a given voice.

Returns:

A reference to this updated object so that method calls can be chained together.

withSupportedEngines

public Voice withSupportedEngines(java.util.Collection<java.lang.String> supportedEngines)

Specifies which engines (standard or neural) that are supported by a given voice.

Returns a reference to this object so that method calls can be chained together.

Parameters:

supportedEngines -

Specifies which engines (standard or neural) that are supported by a given voice.

Returns:

A reference to this updated object so that method calls can be chained together.

toString

public java.lang.String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class java.lang.Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object