com.amazonaws.services.polly.model

Class SynthesizeSpeechRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.polly.model.SynthesizeSpeechRequest

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class SynthesizeSpeechRequest
extends com.amazonaws.AmazonWebServiceRequest
implements java.io.Serializable

Synthesizes UTF-8 input, plain text or SSML, to a stream of bytes. SSML input must be valid, well-formed SSML. Some alphabets might not be available with all the voices (for example, Cyrillic might not be read at all by English voices) unless phoneme mapping is used. For more information, see How it Works.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
SynthesizeSpeechRequest()

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
java.lang.String	getEngine() Specifies the engine (standard or neural) for Amazon Polly to use when processing input text for speech synthesis.
java.lang.String	getLanguageCode() Optional language code for the Synthesize Speech request.
java.util.List<java.lang.String>	getLexiconNames() List of one or more pronunciation lexicon names you want the service to apply during synthesis.
java.lang.String	getOutputFormat() The format in which the returned output will be encoded.
java.lang.String	getSampleRate() The audio frequency specified in Hz.
java.util.List<java.lang.String>	getSpeechMarkTypes() The type of speech marks returned for the input text.
java.lang.String	getText() Input text to synthesize.
java.lang.String	getTextType() Specifies whether the input text is plain text or SSML.
java.lang.String	getVoiceId() Voice ID to use for the synthesis.
int	hashCode()
void	setEngine(Engine engine) Specifies the engine (standard or neural) for Amazon Polly to use when processing input text for speech synthesis.
void	setEngine(java.lang.String engine) Specifies the engine (standard or neural) for Amazon Polly to use when processing input text for speech synthesis.
void	setLanguageCode(LanguageCode languageCode) Optional language code for the Synthesize Speech request.
void	setLanguageCode(java.lang.String languageCode) Optional language code for the Synthesize Speech request.
void	setLexiconNames(java.util.Collection<java.lang.String> lexiconNames) List of one or more pronunciation lexicon names you want the service to apply during synthesis.
void	setOutputFormat(OutputFormat outputFormat) The format in which the returned output will be encoded.
void	setOutputFormat(java.lang.String outputFormat) The format in which the returned output will be encoded.
void	setSampleRate(java.lang.String sampleRate) The audio frequency specified in Hz.
void	setSpeechMarkTypes(java.util.Collection<java.lang.String> speechMarkTypes) The type of speech marks returned for the input text.
void	setText(java.lang.String text) Input text to synthesize.
void	setTextType(java.lang.String textType) Specifies whether the input text is plain text or SSML.
void	setTextType(TextType textType) Specifies whether the input text is plain text or SSML.
void	setVoiceId(java.lang.String voiceId) Voice ID to use for the synthesis.
void	setVoiceId(VoiceId voiceId) Voice ID to use for the synthesis.
java.lang.String	toString() Returns a string representation of this object; useful for testing and debugging.
SynthesizeSpeechRequest	withEngine(Engine engine) Specifies the engine (standard or neural) for Amazon Polly to use when processing input text for speech synthesis.
SynthesizeSpeechRequest	withEngine(java.lang.String engine) Specifies the engine (standard or neural) for Amazon Polly to use when processing input text for speech synthesis.
SynthesizeSpeechRequest	withLanguageCode(LanguageCode languageCode) Optional language code for the Synthesize Speech request.
SynthesizeSpeechRequest	withLanguageCode(java.lang.String languageCode) Optional language code for the Synthesize Speech request.
SynthesizeSpeechRequest	withLexiconNames(java.util.Collection<java.lang.String> lexiconNames) List of one or more pronunciation lexicon names you want the service to apply during synthesis.
SynthesizeSpeechRequest	withLexiconNames(java.lang.String... lexiconNames) List of one or more pronunciation lexicon names you want the service to apply during synthesis.
SynthesizeSpeechRequest	withOutputFormat(OutputFormat outputFormat) The format in which the returned output will be encoded.
SynthesizeSpeechRequest	withOutputFormat(java.lang.String outputFormat) The format in which the returned output will be encoded.
SynthesizeSpeechRequest	withSampleRate(java.lang.String sampleRate) The audio frequency specified in Hz.
SynthesizeSpeechRequest	withSpeechMarkTypes(java.util.Collection<java.lang.String> speechMarkTypes) The type of speech marks returned for the input text.
SynthesizeSpeechRequest	withSpeechMarkTypes(java.lang.String... speechMarkTypes) The type of speech marks returned for the input text.
SynthesizeSpeechRequest	withText(java.lang.String text) Input text to synthesize.
SynthesizeSpeechRequest	withTextType(java.lang.String textType) Specifies whether the input text is plain text or SSML.
SynthesizeSpeechRequest	withTextType(TextType textType) Specifies whether the input text is plain text or SSML.
SynthesizeSpeechRequest	withVoiceId(java.lang.String voiceId) Voice ID to use for the synthesis.
SynthesizeSpeechRequest	withVoiceId(VoiceId voiceId) Voice ID to use for the synthesis.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

clone, copyBaseTo, getCloneRoot, getCloneSource, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

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

Constructor Detail

SynthesizeSpeechRequest

public SynthesizeSpeechRequest()

Method Detail

getEngine

public java.lang.String getEngine()

Specifies the engine (standard or neural) for Amazon Polly to use when processing input text for speech synthesis. For information on Amazon Polly voices and which voices are available in standard-only, NTTS-only, and both standard and NTTS formats, see Available Voices.

NTTS-only voices

When using NTTS-only voices such as Kevin (en-US), this parameter is required and must be set to neural. If the engine is not specified, or is set to standard, this will result in an error.

Type: String

Valid Values: standard | neural

Required: Yes

Standard voices

For standard voices, this is not required; the engine parameter defaults to standard. If the engine is not specified, or is set to standard and an NTTS-only voice is selected, this will result in an error.

Constraints:
Allowed Values: standard, neural

Returns:

Specifies the engine (standard or neural) for Amazon Polly to use when processing input text for speech synthesis. For information on Amazon Polly voices and which voices are available in standard-only, NTTS-only, and both standard and NTTS formats, see Available Voices.

NTTS-only voices

When using NTTS-only voices such as Kevin (en-US), this parameter is required and must be set to neural. If the engine is not specified, or is set to standard, this will result in an error.

Type: String

Valid Values: standard | neural

Required: Yes

Standard voices

For standard voices, this is not required; the engine parameter defaults to standard. If the engine is not specified, or is set to standard and an NTTS-only voice is selected, this will result in an error.

See Also:

Engine

setEngine

public void setEngine(java.lang.String engine)

Specifies the engine (standard or neural) for Amazon Polly to use when processing input text for speech synthesis. For information on Amazon Polly voices and which voices are available in standard-only, NTTS-only, and both standard and NTTS formats, see Available Voices.

NTTS-only voices

When using NTTS-only voices such as Kevin (en-US), this parameter is required and must be set to neural. If the engine is not specified, or is set to standard, this will result in an error.

Type: String

Valid Values: standard | neural

Required: Yes

Standard voices

For standard voices, this is not required; the engine parameter defaults to standard. If the engine is not specified, or is set to standard and an NTTS-only voice is selected, this will result in an error.

Constraints:
Allowed Values: standard, neural

Parameters:

engine -

Specifies the engine (standard or neural) for Amazon Polly to use when processing input text for speech synthesis. For information on Amazon Polly voices and which voices are available in standard-only, NTTS-only, and both standard and NTTS formats, see Available Voices.

NTTS-only voices

When using NTTS-only voices such as Kevin (en-US), this parameter is required and must be set to neural. If the engine is not specified, or is set to standard, this will result in an error.

Type: String

Valid Values: standard | neural

Required: Yes

Standard voices

For standard voices, this is not required; the engine parameter defaults to standard. If the engine is not specified, or is set to standard and an NTTS-only voice is selected, this will result in an error.

See Also:

Engine

withEngine

public SynthesizeSpeechRequest withEngine(java.lang.String engine)

Specifies the engine (standard or neural) for Amazon Polly to use when processing input text for speech synthesis. For information on Amazon Polly voices and which voices are available in standard-only, NTTS-only, and both standard and NTTS formats, see Available Voices.

NTTS-only voices

When using NTTS-only voices such as Kevin (en-US), this parameter is required and must be set to neural. If the engine is not specified, or is set to standard, this will result in an error.

Type: String

Valid Values: standard | neural

Required: Yes

Standard voices

For standard voices, this is not required; the engine parameter defaults to standard. If the engine is not specified, or is set to standard and an NTTS-only voice is selected, this will result in an error.

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

Constraints:
Allowed Values: standard, neural

Parameters:

engine -

Specifies the engine (standard or neural) for Amazon Polly to use when processing input text for speech synthesis. For information on Amazon Polly voices and which voices are available in standard-only, NTTS-only, and both standard and NTTS formats, see Available Voices.

NTTS-only voices

When using NTTS-only voices such as Kevin (en-US), this parameter is required and must be set to neural. If the engine is not specified, or is set to standard, this will result in an error.

Type: String

Valid Values: standard | neural

Required: Yes

Standard voices

For standard voices, this is not required; the engine parameter defaults to standard. If the engine is not specified, or is set to standard and an NTTS-only voice is selected, this will result in an error.

Returns:

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

See Also:

Engine

setEngine

public void setEngine(Engine engine)

Specifies the engine (standard or neural) for Amazon Polly to use when processing input text for speech synthesis. For information on Amazon Polly voices and which voices are available in standard-only, NTTS-only, and both standard and NTTS formats, see Available Voices.

NTTS-only voices

When using NTTS-only voices such as Kevin (en-US), this parameter is required and must be set to neural. If the engine is not specified, or is set to standard, this will result in an error.

Type: String

Valid Values: standard | neural

Required: Yes

Standard voices

For standard voices, this is not required; the engine parameter defaults to standard. If the engine is not specified, or is set to standard and an NTTS-only voice is selected, this will result in an error.

Constraints:
Allowed Values: standard, neural

Parameters:

engine -

Specifies the engine (standard or neural) for Amazon Polly to use when processing input text for speech synthesis. For information on Amazon Polly voices and which voices are available in standard-only, NTTS-only, and both standard and NTTS formats, see Available Voices.

NTTS-only voices

When using NTTS-only voices such as Kevin (en-US), this parameter is required and must be set to neural. If the engine is not specified, or is set to standard, this will result in an error.

Type: String

Valid Values: standard | neural

Required: Yes

Standard voices

For standard voices, this is not required; the engine parameter defaults to standard. If the engine is not specified, or is set to standard and an NTTS-only voice is selected, this will result in an error.

See Also:

Engine

withEngine

public SynthesizeSpeechRequest withEngine(Engine engine)

Specifies the engine (standard or neural) for Amazon Polly to use when processing input text for speech synthesis. For information on Amazon Polly voices and which voices are available in standard-only, NTTS-only, and both standard and NTTS formats, see Available Voices.

NTTS-only voices

When using NTTS-only voices such as Kevin (en-US), this parameter is required and must be set to neural. If the engine is not specified, or is set to standard, this will result in an error.

Type: String

Valid Values: standard | neural

Required: Yes

Standard voices

For standard voices, this is not required; the engine parameter defaults to standard. If the engine is not specified, or is set to standard and an NTTS-only voice is selected, this will result in an error.

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

Constraints:
Allowed Values: standard, neural

Parameters:

engine -

Specifies the engine (standard or neural) for Amazon Polly to use when processing input text for speech synthesis. For information on Amazon Polly voices and which voices are available in standard-only, NTTS-only, and both standard and NTTS formats, see Available Voices.

NTTS-only voices

When using NTTS-only voices such as Kevin (en-US), this parameter is required and must be set to neural. If the engine is not specified, or is set to standard, this will result in an error.

Type: String

Valid Values: standard | neural

Required: Yes

Standard voices

For standard voices, this is not required; the engine parameter defaults to standard. If the engine is not specified, or is set to standard and an NTTS-only voice is selected, this will result in an error.

Returns:

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

See Also:

Engine

getLanguageCode

public java.lang.String getLanguageCode()

Optional language code for the Synthesize Speech request. This is only necessary if using a bilingual voice, such as Aditi, which can be used for either Indian English (en-IN) or Hindi (hi-IN).

If a bilingual voice is used and no language code is specified, Amazon Polly uses the default language of the bilingual voice. The default language for any voice is the one returned by the DescribeVoices operation for the LanguageCode parameter. For example, if no language code is specified, Aditi will use Indian English rather than Hindi.

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:

Optional language code for the Synthesize Speech request. This is only necessary if using a bilingual voice, such as Aditi, which can be used for either Indian English (en-IN) or Hindi (hi-IN).

If a bilingual voice is used and no language code is specified, Amazon Polly uses the default language of the bilingual voice. The default language for any voice is the one returned by the DescribeVoices operation for the LanguageCode parameter. For example, if no language code is specified, Aditi will use Indian English rather than Hindi.

See Also:

LanguageCode

setLanguageCode

public void setLanguageCode(java.lang.String languageCode)

Optional language code for the Synthesize Speech request. This is only necessary if using a bilingual voice, such as Aditi, which can be used for either Indian English (en-IN) or Hindi (hi-IN).

If a bilingual voice is used and no language code is specified, Amazon Polly uses the default language of the bilingual voice. The default language for any voice is the one returned by the DescribeVoices operation for the LanguageCode parameter. For example, if no language code is specified, Aditi will use Indian English rather than Hindi.

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 -

Optional language code for the Synthesize Speech request. This is only necessary if using a bilingual voice, such as Aditi, which can be used for either Indian English (en-IN) or Hindi (hi-IN).

If a bilingual voice is used and no language code is specified, Amazon Polly uses the default language of the bilingual voice. The default language for any voice is the one returned by the DescribeVoices operation for the LanguageCode parameter. For example, if no language code is specified, Aditi will use Indian English rather than Hindi.

See Also:

LanguageCode

withLanguageCode

public SynthesizeSpeechRequest withLanguageCode(java.lang.String languageCode)

Optional language code for the Synthesize Speech request. This is only necessary if using a bilingual voice, such as Aditi, which can be used for either Indian English (en-IN) or Hindi (hi-IN).

If a bilingual voice is used and no language code is specified, Amazon Polly uses the default language of the bilingual voice. The default language for any voice is the one returned by the DescribeVoices operation for the LanguageCode parameter. For example, if no language code is specified, Aditi will use Indian English rather than Hindi.

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 -

Optional language code for the Synthesize Speech request. This is only necessary if using a bilingual voice, such as Aditi, which can be used for either Indian English (en-IN) or Hindi (hi-IN).

If a bilingual voice is used and no language code is specified, Amazon Polly uses the default language of the bilingual voice. The default language for any voice is the one returned by the DescribeVoices operation for the LanguageCode parameter. For example, if no language code is specified, Aditi will use Indian English rather than Hindi.

Returns:

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

See Also:

LanguageCode

setLanguageCode

public void setLanguageCode(LanguageCode languageCode)

Optional language code for the Synthesize Speech request. This is only necessary if using a bilingual voice, such as Aditi, which can be used for either Indian English (en-IN) or Hindi (hi-IN).

If a bilingual voice is used and no language code is specified, Amazon Polly uses the default language of the bilingual voice. The default language for any voice is the one returned by the DescribeVoices operation for the LanguageCode parameter. For example, if no language code is specified, Aditi will use Indian English rather than Hindi.

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 -

Optional language code for the Synthesize Speech request. This is only necessary if using a bilingual voice, such as Aditi, which can be used for either Indian English (en-IN) or Hindi (hi-IN).

If a bilingual voice is used and no language code is specified, Amazon Polly uses the default language of the bilingual voice. The default language for any voice is the one returned by the DescribeVoices operation for the LanguageCode parameter. For example, if no language code is specified, Aditi will use Indian English rather than Hindi.

See Also:

LanguageCode

withLanguageCode

public SynthesizeSpeechRequest withLanguageCode(LanguageCode languageCode)

Optional language code for the Synthesize Speech request. This is only necessary if using a bilingual voice, such as Aditi, which can be used for either Indian English (en-IN) or Hindi (hi-IN).

If a bilingual voice is used and no language code is specified, Amazon Polly uses the default language of the bilingual voice. The default language for any voice is the one returned by the DescribeVoices operation for the LanguageCode parameter. For example, if no language code is specified, Aditi will use Indian English rather than Hindi.

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 -

Optional language code for the Synthesize Speech request. This is only necessary if using a bilingual voice, such as Aditi, which can be used for either Indian English (en-IN) or Hindi (hi-IN).

If a bilingual voice is used and no language code is specified, Amazon Polly uses the default language of the bilingual voice. The default language for any voice is the one returned by the DescribeVoices operation for the LanguageCode parameter. For example, if no language code is specified, Aditi will use Indian English rather than Hindi.

Returns:

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

See Also:

LanguageCode

getLexiconNames

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

List of one or more pronunciation lexicon names you want the service to apply during synthesis. Lexicons are applied only if the language of the lexicon is the same as the language of the voice. For information about storing lexicons, see PutLexicon.

Returns:

List of one or more pronunciation lexicon names you want the service to apply during synthesis. Lexicons are applied only if the language of the lexicon is the same as the language of the voice. For information about storing lexicons, see PutLexicon.

setLexiconNames

public void setLexiconNames(java.util.Collection<java.lang.String> lexiconNames)

List of one or more pronunciation lexicon names you want the service to apply during synthesis. Lexicons are applied only if the language of the lexicon is the same as the language of the voice. For information about storing lexicons, see PutLexicon.

Parameters:

lexiconNames -

List of one or more pronunciation lexicon names you want the service to apply during synthesis. Lexicons are applied only if the language of the lexicon is the same as the language of the voice. For information about storing lexicons, see PutLexicon.

withLexiconNames

public SynthesizeSpeechRequest withLexiconNames(java.lang.String... lexiconNames)

List of one or more pronunciation lexicon names you want the service to apply during synthesis. Lexicons are applied only if the language of the lexicon is the same as the language of the voice. For information about storing lexicons, see PutLexicon.

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

Parameters:

lexiconNames -

List of one or more pronunciation lexicon names you want the service to apply during synthesis. Lexicons are applied only if the language of the lexicon is the same as the language of the voice. For information about storing lexicons, see PutLexicon.

Returns:

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

withLexiconNames

public SynthesizeSpeechRequest withLexiconNames(java.util.Collection<java.lang.String> lexiconNames)

List of one or more pronunciation lexicon names you want the service to apply during synthesis. Lexicons are applied only if the language of the lexicon is the same as the language of the voice. For information about storing lexicons, see PutLexicon.

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

Parameters:

lexiconNames -

List of one or more pronunciation lexicon names you want the service to apply during synthesis. Lexicons are applied only if the language of the lexicon is the same as the language of the voice. For information about storing lexicons, see PutLexicon.

Returns:

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

getOutputFormat

public java.lang.String getOutputFormat()

The format in which the returned output will be encoded. For audio stream, this will be mp3, ogg_vorbis, or pcm. For speech marks, this will be json.

When pcm is used, the content returned is audio/pcm in a signed 16-bit, 1 channel (mono), little-endian format.

Constraints:
Allowed Values: json, mp3, ogg_vorbis, pcm

Returns:

The format in which the returned output will be encoded. For audio stream, this will be mp3, ogg_vorbis, or pcm. For speech marks, this will be json.

When pcm is used, the content returned is audio/pcm in a signed 16-bit, 1 channel (mono), little-endian format.

See Also:

OutputFormat

setOutputFormat

public void setOutputFormat(java.lang.String outputFormat)

The format in which the returned output will be encoded. For audio stream, this will be mp3, ogg_vorbis, or pcm. For speech marks, this will be json.

When pcm is used, the content returned is audio/pcm in a signed 16-bit, 1 channel (mono), little-endian format.

Constraints:
Allowed Values: json, mp3, ogg_vorbis, pcm

Parameters:

outputFormat -

The format in which the returned output will be encoded. For audio stream, this will be mp3, ogg_vorbis, or pcm. For speech marks, this will be json.

When pcm is used, the content returned is audio/pcm in a signed 16-bit, 1 channel (mono), little-endian format.

See Also:

OutputFormat

withOutputFormat

public SynthesizeSpeechRequest withOutputFormat(java.lang.String outputFormat)

The format in which the returned output will be encoded. For audio stream, this will be mp3, ogg_vorbis, or pcm. For speech marks, this will be json.

When pcm is used, the content returned is audio/pcm in a signed 16-bit, 1 channel (mono), little-endian format.

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

Constraints:
Allowed Values: json, mp3, ogg_vorbis, pcm

Parameters:

outputFormat -

The format in which the returned output will be encoded. For audio stream, this will be mp3, ogg_vorbis, or pcm. For speech marks, this will be json.

When pcm is used, the content returned is audio/pcm in a signed 16-bit, 1 channel (mono), little-endian format.

Returns:

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

See Also:

OutputFormat

setOutputFormat

public void setOutputFormat(OutputFormat outputFormat)

The format in which the returned output will be encoded. For audio stream, this will be mp3, ogg_vorbis, or pcm. For speech marks, this will be json.

When pcm is used, the content returned is audio/pcm in a signed 16-bit, 1 channel (mono), little-endian format.

Constraints:
Allowed Values: json, mp3, ogg_vorbis, pcm

Parameters:

outputFormat -

The format in which the returned output will be encoded. For audio stream, this will be mp3, ogg_vorbis, or pcm. For speech marks, this will be json.

When pcm is used, the content returned is audio/pcm in a signed 16-bit, 1 channel (mono), little-endian format.

See Also:

OutputFormat

withOutputFormat

public SynthesizeSpeechRequest withOutputFormat(OutputFormat outputFormat)

The format in which the returned output will be encoded. For audio stream, this will be mp3, ogg_vorbis, or pcm. For speech marks, this will be json.

When pcm is used, the content returned is audio/pcm in a signed 16-bit, 1 channel (mono), little-endian format.

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

Constraints:
Allowed Values: json, mp3, ogg_vorbis, pcm

Parameters:

outputFormat -

The format in which the returned output will be encoded. For audio stream, this will be mp3, ogg_vorbis, or pcm. For speech marks, this will be json.

When pcm is used, the content returned is audio/pcm in a signed 16-bit, 1 channel (mono), little-endian format.

Returns:

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

See Also:

OutputFormat

getSampleRate

public java.lang.String getSampleRate()

The audio frequency specified in Hz.

The valid values for mp3 and ogg_vorbis are "8000", "16000", "22050", and "24000". The default value for standard voices is "22050". The default value for neural voices is "24000".

Valid values for pcm are "8000" and "16000" The default value is "16000".

Returns:

The audio frequency specified in Hz.

The valid values for mp3 and ogg_vorbis are "8000", "16000", "22050", and "24000". The default value for standard voices is "22050". The default value for neural voices is "24000".

Valid values for pcm are "8000" and "16000" The default value is "16000".

setSampleRate

public void setSampleRate(java.lang.String sampleRate)

The audio frequency specified in Hz.

The valid values for mp3 and ogg_vorbis are "8000", "16000", "22050", and "24000". The default value for standard voices is "22050". The default value for neural voices is "24000".

Valid values for pcm are "8000" and "16000" The default value is "16000".

Parameters:

sampleRate -

The audio frequency specified in Hz.

The valid values for mp3 and ogg_vorbis are "8000", "16000", "22050", and "24000". The default value for standard voices is "22050". The default value for neural voices is "24000".

Valid values for pcm are "8000" and "16000" The default value is "16000".

withSampleRate

public SynthesizeSpeechRequest withSampleRate(java.lang.String sampleRate)

The audio frequency specified in Hz.

The valid values for mp3 and ogg_vorbis are "8000", "16000", "22050", and "24000". The default value for standard voices is "22050". The default value for neural voices is "24000".

Valid values for pcm are "8000" and "16000" The default value is "16000".

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

Parameters:

sampleRate -

The audio frequency specified in Hz.

The valid values for mp3 and ogg_vorbis are "8000", "16000", "22050", and "24000". The default value for standard voices is "22050". The default value for neural voices is "24000".

Valid values for pcm are "8000" and "16000" The default value is "16000".

Returns:

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

getSpeechMarkTypes

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

The type of speech marks returned for the input text.

Returns:

The type of speech marks returned for the input text.

setSpeechMarkTypes

public void setSpeechMarkTypes(java.util.Collection<java.lang.String> speechMarkTypes)

The type of speech marks returned for the input text.

Parameters:

speechMarkTypes -

The type of speech marks returned for the input text.

withSpeechMarkTypes

public SynthesizeSpeechRequest withSpeechMarkTypes(java.lang.String... speechMarkTypes)

The type of speech marks returned for the input text.

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

Parameters:

speechMarkTypes -

The type of speech marks returned for the input text.

Returns:

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

withSpeechMarkTypes

public SynthesizeSpeechRequest withSpeechMarkTypes(java.util.Collection<java.lang.String> speechMarkTypes)

The type of speech marks returned for the input text.

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

Parameters:

speechMarkTypes -

The type of speech marks returned for the input text.

Returns:

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

getText

public java.lang.String getText()

Input text to synthesize. If you specify ssml as the TextType, follow the SSML format for the input text.

Returns:

Input text to synthesize. If you specify ssml as the TextType, follow the SSML format for the input text.

setText

public void setText(java.lang.String text)

Input text to synthesize. If you specify ssml as the TextType, follow the SSML format for the input text.

Parameters:

text -

Input text to synthesize. If you specify ssml as the TextType, follow the SSML format for the input text.

withText

public SynthesizeSpeechRequest withText(java.lang.String text)

Input text to synthesize. If you specify ssml as the TextType, follow the SSML format for the input text.

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

Parameters:

text -

Input text to synthesize. If you specify ssml as the TextType, follow the SSML format for the input text.

Returns:

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

getTextType

public java.lang.String getTextType()

Specifies whether the input text is plain text or SSML. The default value is plain text. For more information, see Using SSML.

Constraints:
Allowed Values: ssml, text

Returns:

Specifies whether the input text is plain text or SSML. The default value is plain text. For more information, see Using SSML.

See Also:

TextType

setTextType

public void setTextType(java.lang.String textType)

Specifies whether the input text is plain text or SSML. The default value is plain text. For more information, see Using SSML.

Constraints:
Allowed Values: ssml, text

Parameters:

textType -

Specifies whether the input text is plain text or SSML. The default value is plain text. For more information, see Using SSML.

See Also:

TextType

withTextType

public SynthesizeSpeechRequest withTextType(java.lang.String textType)

Specifies whether the input text is plain text or SSML. The default value is plain text. For more information, see Using SSML.

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

Constraints:
Allowed Values: ssml, text

Parameters:

textType -

Specifies whether the input text is plain text or SSML. The default value is plain text. For more information, see Using SSML.

Returns:

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

See Also:

TextType

setTextType

public void setTextType(TextType textType)

Specifies whether the input text is plain text or SSML. The default value is plain text. For more information, see Using SSML.

Constraints:
Allowed Values: ssml, text

Parameters:

textType -

Specifies whether the input text is plain text or SSML. The default value is plain text. For more information, see Using SSML.

See Also:

TextType

withTextType

public SynthesizeSpeechRequest withTextType(TextType textType)

Specifies whether the input text is plain text or SSML. The default value is plain text. For more information, see Using SSML.

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

Constraints:
Allowed Values: ssml, text

Parameters:

textType -

Specifies whether the input text is plain text or SSML. The default value is plain text. For more information, see Using SSML.

Returns:

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

See Also:

TextType

getVoiceId

public java.lang.String getVoiceId()

Voice ID to use for the synthesis. You can get a list of available voice IDs by calling the DescribeVoices 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:

Voice ID to use for the synthesis. You can get a list of available voice IDs by calling the DescribeVoices operation.

See Also:

VoiceId

setVoiceId

public void setVoiceId(java.lang.String voiceId)

Voice ID to use for the synthesis. You can get a list of available voice IDs by calling the DescribeVoices 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:

voiceId -

Voice ID to use for the synthesis. You can get a list of available voice IDs by calling the DescribeVoices operation.

See Also:

VoiceId

withVoiceId

public SynthesizeSpeechRequest withVoiceId(java.lang.String voiceId)

Voice ID to use for the synthesis. You can get a list of available voice IDs by calling the DescribeVoices 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:

voiceId -

Voice ID to use for the synthesis. You can get a list of available voice IDs by calling the DescribeVoices operation.

Returns:

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

See Also:

VoiceId

setVoiceId

public void setVoiceId(VoiceId voiceId)

Voice ID to use for the synthesis. You can get a list of available voice IDs by calling the DescribeVoices 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:

voiceId -

Voice ID to use for the synthesis. You can get a list of available voice IDs by calling the DescribeVoices operation.

See Also:

VoiceId

withVoiceId

public SynthesizeSpeechRequest withVoiceId(VoiceId voiceId)

Voice ID to use for the synthesis. You can get a list of available voice IDs by calling the DescribeVoices 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:

voiceId -

Voice ID to use for the synthesis. You can get a list of available voice IDs by calling the DescribeVoices operation.

Returns:

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

See Also:

VoiceId

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