com.amazonaws.services.polly.model

Class SynthesizeSpeechRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.polly.model.SynthesizeSpeechRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class SynthesizeSpeechRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
SynthesizeSpeechRequest()

Method Summary

Modifier and Type	Method and Description
SynthesizeSpeechRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
List<String>	getLexiconNames() List of one or more pronunciation lexicon names you want the service to apply during synthesis.
String	getOutputFormat() The format in which the returned output will be encoded.
String	getSampleRate() The audio frequency specified in Hz.
List<String>	getSpeechMarkTypes() The type of speech marks returned for the input text.
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	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 format in which the returned output will be encoded.
void	setOutputFormat(String outputFormat) The format in which the returned output will be encoded.
void	setSampleRate(String sampleRate) The audio frequency specified in Hz.
void	setSpeechMarkTypes(Collection<String> speechMarkTypes) The type of speech marks returned for the input text.
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.
SynthesizeSpeechRequest	withLexiconNames(Collection<String> lexiconNames) List of one or more pronunciation lexicon names you want the service to apply during synthesis.
SynthesizeSpeechRequest	withLexiconNames(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(String outputFormat) The format in which the returned output will be encoded.
SynthesizeSpeechRequest	withSampleRate(String sampleRate) The audio frequency specified in Hz.
SynthesizeSpeechRequest	withSpeechMarkTypes(Collection<String> speechMarkTypes) The type of speech marks returned for the input text.
SynthesizeSpeechRequest	withSpeechMarkTypes(SpeechMarkType... speechMarkTypes) The type of speech marks returned for the input text.
SynthesizeSpeechRequest	withSpeechMarkTypes(String... speechMarkTypes) The type of speech marks returned for the input text.
SynthesizeSpeechRequest	withText(String text) Input text to synthesize.
SynthesizeSpeechRequest	withTextType(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(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

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

SynthesizeSpeechRequest

public SynthesizeSpeechRequest()

Method Detail

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.

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

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

NOTE: This method appends the values to the existing list (if any). Use setLexiconNames(java.util.Collection) or withLexiconNames(java.util.Collection) if you want to override the existing values.

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:

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

withLexiconNames

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

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:

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

setOutputFormat

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

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.

See Also:

OutputFormat

getOutputFormat

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

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.

See Also:

OutputFormat

withOutputFormat

public SynthesizeSpeechRequest withOutputFormat(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.

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.

Returns:

Returns a reference to this 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.

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.

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.

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.

Returns:

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

See Also:

OutputFormat

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".

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".

withSampleRate

public SynthesizeSpeechRequest 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".

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:

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

getSpeechMarkTypes

public List<String> getSpeechMarkTypes()

The type of speech marks returned for the input text.

Returns:

The type of speech marks returned for the input text.

See Also:

SpeechMarkType

setSpeechMarkTypes

public void setSpeechMarkTypes(Collection<String> speechMarkTypes)

The type of speech marks returned for the input text.

Parameters:

speechMarkTypes - The type of speech marks returned for the input text.

See Also:

SpeechMarkType

withSpeechMarkTypes

public SynthesizeSpeechRequest withSpeechMarkTypes(String... speechMarkTypes)

The type of speech marks returned for the input text.

NOTE: This method appends the values to the existing list (if any). Use setSpeechMarkTypes(java.util.Collection) or withSpeechMarkTypes(java.util.Collection) if you want to override the existing values.

Parameters:

speechMarkTypes - The type of speech marks returned for the input text.

Returns:

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

See Also:

SpeechMarkType

withSpeechMarkTypes

public SynthesizeSpeechRequest withSpeechMarkTypes(Collection<String> speechMarkTypes)

The type of speech marks returned for the input text.

Parameters:

speechMarkTypes - The type of speech marks returned for the input text.

Returns:

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

See Also:

SpeechMarkType

withSpeechMarkTypes

public SynthesizeSpeechRequest withSpeechMarkTypes(SpeechMarkType... speechMarkTypes)

The type of speech marks returned for the input text.

Parameters:

speechMarkTypes - The type of speech marks returned for the input text.

Returns:

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

See Also:

SpeechMarkType

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.

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.

withText

public SynthesizeSpeechRequest withText(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.

Returns:

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

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.

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

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.

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

withTextType

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

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:

Returns a reference to this 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.

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.

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:

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

See Also:

TextType

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.

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

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.

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

withVoiceId

public SynthesizeSpeechRequest withVoiceId(String voiceId)

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

Parameters:

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

Returns:

Returns a reference to this 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.

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.

Parameters:

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

Returns:

Returns a reference to this 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()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public SynthesizeSpeechRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()