com.amazonaws.services.polly.model

Class SynthesizeSpeechPresignRequest

java.lang.Object

com.amazonaws.services.polly.model.SynthesizeSpeechPresignRequest

All Implemented Interfaces:

Serializable

public class SynthesizeSpeechPresignRequest
extends Object
implements Serializable

Synthesizes UTF-8 input, plain text or SSML, to a pre-signed URL to a stream of bytes. SSML input must be valid, well-formed SSML. Some alphabets might not be available with all the voices (eg. 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
SynthesizeSpeechPresignRequest()

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
Date	getExpiration() The expiration date at which point the new pre-signed URL will no longer be accepted by Amazon Polly.
List<String>	getLexiconNames() List of one or more pronunciation lexicon names you want the service to apply during synthesis.
String	getOutputFormat() The audio format in which the resulting stream will be encoded.
AWSCredentials	getRequestCredentials() Returns the optional credentials to use to sign this request, overriding the default credentials set at the client level.
String	getSampleRate() The audio frequency specified in Hz.
String	getText() Input text to synthesize.
String	getTextType() Specifies whether the input text is plain text or SSML.
String	getVoiceId() Voice ID to use for the synthesis.
int	hashCode()
void	setExpiration(Date expiration) Sets the expiration date at which point the new pre-signed URL will no longer be accepted by Amazon Polly.
void	setLexiconNames(Collection<String> lexiconNames) List of one or more pronunciation lexicon names you want the service to apply during synthesis.
void	setOutputFormat(OutputFormat outputFormat) The audio format in which the resulting stream will be encoded.
void	setOutputFormat(String outputFormat) The audio format in which the resulting stream will be encoded.
void	setRequestCredentials(AWSCredentials credentials) Sets the optional credentials to use for this request, overriding the default credentials set at the client level.
void	setSampleRate(String sampleRate) The audio frequency specified in Hz.
void	setText(String text) Input text to synthesize.
void	setTextType(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(String voiceId) Voice ID to use for the synthesis.
void	setVoiceId(VoiceId voiceId) Voice ID to use for the synthesis.
String	toString() Returns a string representation of this object; useful for testing and debugging.
SynthesizeSpeechPresignRequest	withExpiration(Date expiration) Sets the expiration date at which point the new pre-signed URL will no longer be accepted by Amazon Polly.
SynthesizeSpeechPresignRequest	withLexiconNames(Collection<String> lexiconNames) List of one or more pronunciation lexicon names you want the service to apply during synthesis.
SynthesizeSpeechPresignRequest	withLexiconNames(String... lexiconNames) List of one or more pronunciation lexicon names you want the service to apply during synthesis.
SynthesizeSpeechPresignRequest	withOutputFormat(OutputFormat outputFormat) The audio format in which the resulting stream will be encoded.
SynthesizeSpeechPresignRequest	withOutputFormat(String outputFormat) The audio format in which the resulting stream will be encoded.
SynthesizeSpeechPresignRequest	withSampleRate(String sampleRate) The audio frequency specified in Hz.
SynthesizeSpeechPresignRequest	withText(String text) Input text to synthesize.
SynthesizeSpeechPresignRequest	withTextType(String textType) Specifies whether the input text is plain text or SSML.
SynthesizeSpeechPresignRequest	withTextType(TextType textType) Specifies whether the input text is plain text or SSML.
SynthesizeSpeechPresignRequest	withVoiceId(String voiceId) Voice ID to use for the synthesis.
SynthesizeSpeechPresignRequest	withVoiceId(VoiceId voiceId) Voice ID to use for the synthesis.

Methods inherited from class java.lang.Object

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

Constructor Detail

SynthesizeSpeechPresignRequest

public SynthesizeSpeechPresignRequest()

Method Detail

getExpiration

public Date getExpiration()

The expiration date at which point the new pre-signed URL will no longer be accepted by Amazon Polly. If not specified, a default value will be supplied.

Returns:

The expiration date at which point the new pre-signed URL will no longer be accepted by Amazon Polly.

setExpiration

public void setExpiration(Date expiration)

Sets the expiration date at which point the new pre-signed URL will no longer be accepted by Amazon Polly. If not specified, a default value will be supplied.

Parameters:

expiration - The expiration date at which point the new pre-signed URL will no longer be accepted by Amazon Polly.

withExpiration

public SynthesizeSpeechPresignRequest withExpiration(Date expiration)

Sets the expiration date at which point the new pre-signed URL will no longer be accepted by Amazon Polly. If not specified, a default value will be supplied.

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

Parameters:

expiration - The expiration date at which point the new pre-signed URL will no longer be accepted by Amazon Polly.

Returns:

The updated request object, so that additional method calls can be chained together.

setRequestCredentials

public void setRequestCredentials(AWSCredentials credentials)

Sets the optional credentials to use for this request, overriding the default credentials set at the client level.

Parameters:

credentials - The optional AWS security credentials to use for this request, overriding the default credentials set at the client level.

getRequestCredentials

public AWSCredentials getRequestCredentials()

Returns the optional credentials to use to sign this request, overriding the default credentials set at the client level.

Returns:

The optional credentials to use to sign this request, overriding the default credentials set at the client level.

getLexiconNames

public List<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.

Currently only one lexicon per request is supported by AWS SDK for Android.

Returns:

Lexicon name (returned as a single item of the List) 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 AmazonPolly.putLexicon(PutLexiconRequest).

setLexiconNames

public void setLexiconNames(Collection<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.

Currently only one lexicon per request is supported by AWS SDK for Android.

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 SynthesizeSpeechPresignRequest withLexiconNames(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.

Currently only one lexicon per request is supported by AWS SDK for Android.

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 SynthesizeSpeechPresignRequest withLexiconNames(Collection<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.

Currently only one lexicon per request is supported by AWS SDK for Android.

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 String getOutputFormat()

The audio format in which the resulting stream will be encoded.

Constraints:
Allowed Values: mp3, ogg_vorbis, pcm

Returns:

The audio format in which the resulting stream will be encoded.

See Also:

OutputFormat

setOutputFormat

public void setOutputFormat(String outputFormat)

The audio format in which the resulting stream will be encoded.

Constraints:
Allowed Values: mp3, ogg_vorbis, pcm

Parameters:

outputFormat -

The audio format in which the resulting stream will be encoded.

See Also:

OutputFormat

withOutputFormat

public SynthesizeSpeechPresignRequest withOutputFormat(String outputFormat)

The audio format in which the resulting stream will be encoded.

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

Constraints:
Allowed Values: mp3, ogg_vorbis, pcm

Parameters:

outputFormat -

The audio format in which the resulting stream will be encoded.

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 audio format in which the resulting stream will be encoded.

Constraints:
Allowed Values: mp3, ogg_vorbis, pcm

Parameters:

outputFormat -

The audio format in which the resulting stream will be encoded.

See Also:

OutputFormat

withOutputFormat

public SynthesizeSpeechPresignRequest withOutputFormat(OutputFormat outputFormat)

The audio format in which the resulting stream will be encoded.

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

Constraints:
Allowed Values: mp3, ogg_vorbis, pcm

Parameters:

outputFormat -

The audio format in which the resulting stream will be encoded.

Returns:

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

See Also:

OutputFormat

getSampleRate

public String getSampleRate()

The audio frequency specified in Hz.

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

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", and "22050". The default value is "22050".

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

setSampleRate

public void setSampleRate(String sampleRate)

The audio frequency specified in Hz.

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

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", and "22050". The default value is "22050".

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

withSampleRate

public SynthesizeSpeechPresignRequest withSampleRate(String sampleRate)

The audio frequency specified in Hz.

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

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", and "22050". The default value is "22050".

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.

getText

public 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(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 SynthesizeSpeechPresignRequest withText(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 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(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 SynthesizeSpeechPresignRequest withTextType(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 SynthesizeSpeechPresignRequest 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 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: Geraint, Gwyneth, Mads, Naja, Hans, Marlene, Nicole, Russell, Amy, Brian, Emma, Raveena, Ivy, Joanna, Joey, Justin, Kendra, Kimberly, Salli, Conchita, Enrique, Miguel, Penelope, Chantal, Celine, Mathieu, Dora, Karl, Carla, Giorgio, Mizuki, Liv, Lotte, Ruben, Ewa, Jacek, Jan, Maja, Ricardo, Vitoria, Cristiano, Ines, Carmen, Maxim, Tatyana, Astrid, Filiz

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(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: Geraint, Gwyneth, Mads, Naja, Hans, Marlene, Nicole, Russell, Amy, Brian, Emma, Raveena, Ivy, Joanna, Joey, Justin, Kendra, Kimberly, Salli, Conchita, Enrique, Miguel, Penelope, Chantal, Celine, Mathieu, Dora, Karl, Carla, Giorgio, Mizuki, Liv, Lotte, Ruben, Ewa, Jacek, Jan, Maja, Ricardo, Vitoria, Cristiano, Ines, Carmen, Maxim, Tatyana, Astrid, Filiz

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 SynthesizeSpeechPresignRequest withVoiceId(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: Geraint, Gwyneth, Mads, Naja, Hans, Marlene, Nicole, Russell, Amy, Brian, Emma, Raveena, Ivy, Joanna, Joey, Justin, Kendra, Kimberly, Salli, Conchita, Enrique, Miguel, Penelope, Chantal, Celine, Mathieu, Dora, Karl, Carla, Giorgio, Liv, Lotte, Ruben, Ewa, Jacek, Jan, Maja, Ricardo, Vitoria, Cristiano, Ines, Carmen, Maxim, Tatyana, Astrid, Filiz

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: Geraint, Gwyneth, Mads, Naja, Hans, Marlene, Nicole, Russell, Amy, Brian, Emma, Raveena, Ivy, Joanna, Joey, Justin, Kendra, Kimberly, Salli, Conchita, Enrique, Miguel, Penelope, Chantal, Celine, Mathieu, Dora, Karl, Carla, Giorgio, Mizuki, Liv, Lotte, Ruben, Ewa, Jacek, Jan, Maja, Ricardo, Vitoria, Cristiano, Ines, Carmen, Maxim, Tatyana, Astrid, Filiz

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 SynthesizeSpeechPresignRequest 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: Geraint, Gwyneth, Mads, Naja, Hans, Marlene, Nicole, Russell, Amy, Brian, Emma, Raveena, Ivy, Joanna, Joey, Justin, Kendra, Kimberly, Salli, Conchita, Enrique, Miguel, Penelope, Chantal, Celine, Mathieu, Dora, Karl, Carla, Giorgio, Liv, Lotte, Ruben, Ewa, Jacek, Jan, Maja, Ricardo, Vitoria, Cristiano, Ines, Carmen, Maxim, Tatyana, Astrid, Filiz

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 String toString()

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

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object