Package software.amazon.awssdk.services.polly.model

Class SynthesizeSpeechRequest

java.lang.Object

software.amazon.awssdk.AmazonWebServiceRequest

software.amazon.awssdk.services.polly.model.SynthesizeSpeechRequest

All Implemented Interfaces:

Cloneable, ReadLimitInfo, ToCopyableBuilder<SynthesizeSpeechRequest.Builder,SynthesizeSpeechRequest>

@Generated("software.amazon.awssdk:codegen")
public class SynthesizeSpeechRequest
extends AmazonWebServiceRequest
implements ToCopyableBuilder<SynthesizeSpeechRequest.Builder,SynthesizeSpeechRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	SynthesizeSpeechRequest.Builder

Field Summary

Fields inherited from class software.amazon.awssdk.AmazonWebServiceRequest

NOOP

Method Summary

Modifier and Type	Method	Description
static SynthesizeSpeechRequest.Builder	builder()
boolean	equals(Object obj)
int	hashCode()
List<String>	lexiconNames()	List of one or more pronunciation lexicon names you want the service to apply during synthesis.
String	outputFormat()	The format in which the returned output will be encoded.
String	sampleRate()	The audio frequency specified in Hz.
static Class<? extends SynthesizeSpeechRequest.Builder>	serializableBuilderClass()
List<String>	speechMarkTypes()	The type of speech marks returned for the input text.
String	text()	Input text to synthesize.
String	textType()	Specifies whether the input text is plain text or SSML.
SynthesizeSpeechRequest.Builder	toBuilder()	Take this object and create a builder that contains all of the current property values of this object.
String	toString()
String	voiceId()	Voice ID to use for the synthesis.

Methods inherited from class software.amazon.awssdk.AmazonWebServiceRequest

clone, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

lexiconNames

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

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.

outputFormat

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

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

sampleRate

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

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

speechMarkTypes

public List<String> speechMarkTypes()

The type of speech marks returned for the input text.

Returns:

The type of speech marks returned for the input text.

See Also:

SpeechMarkType

text

public String text()

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.

textType

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

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

voiceId

public String voiceId()

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

toBuilder

public SynthesizeSpeechRequest.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<SynthesizeSpeechRequest.Builder,SynthesizeSpeechRequest>

Returns:

a builder for type T

builder

public static SynthesizeSpeechRequest.Builder builder()

serializableBuilderClass

public static Class<? extends SynthesizeSpeechRequest.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object