@Generated(value="software.amazon.awssdk:codegen") public class SynthesizeSpeechRequest extends PollyRequest implements ToCopyableBuilder<SynthesizeSpeechRequest.Builder,SynthesizeSpeechRequest>
Modifier and Type | Class and Description |
---|---|
static interface |
SynthesizeSpeechRequest.Builder |
Modifier and Type | Method and Description |
---|---|
static SynthesizeSpeechRequest.Builder |
builder() |
boolean |
equals(Object obj) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz)
Used to retrieve the value of a field from any class that extends
SdkRequest . |
int |
hashCode() |
List<String> |
lexiconNames()
List of one or more pronunciation lexicon names you want the service to apply during synthesis.
|
OutputFormat |
outputFormat()
The format in which the returned output will be encoded.
|
String |
outputFormatString()
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<SpeechMarkType> |
speechMarkTypes()
The type of speech marks returned for the input text.
|
List<String> |
speechMarkTypesStrings()
The type of speech marks returned for the input text.
|
String |
text()
Input text to synthesize.
|
TextType |
textType()
Specifies whether the input text is plain text or SSML.
|
String |
textTypeString()
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() |
VoiceId |
voiceId()
Voice ID to use for the synthesis.
|
String |
voiceIdString()
Voice ID to use for the synthesis.
|
requestOverrideConfig
copy
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.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
public 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.
If the service returns an enum value that is not available in the current SDK version, outputFormat
will
return OutputFormat.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
outputFormatString()
.
OutputFormat
public String outputFormatString()
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.
If the service returns an enum value that is not available in the current SDK version, outputFormat
will
return OutputFormat.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
outputFormatString()
.
OutputFormat
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".
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".
public List<SpeechMarkType> speechMarkTypes()
The type of speech marks returned for the input text.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
public List<String> speechMarkTypesStrings()
The type of speech marks returned for the input text.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
public String text()
Input text to synthesize. If you specify ssml
as the TextType
, follow the SSML format
for the input text.
ssml
as the TextType
, follow the SSML
format for the input text.public TextType textType()
Specifies whether the input text is plain text or SSML. The default value is plain text. For more information, see Using SSML.
If the service returns an enum value that is not available in the current SDK version, textType
will
return TextType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
textTypeString()
.
TextType
public String textTypeString()
Specifies whether the input text is plain text or SSML. The default value is plain text. For more information, see Using SSML.
If the service returns an enum value that is not available in the current SDK version, textType
will
return TextType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
textTypeString()
.
TextType
public VoiceId voiceId()
Voice ID to use for the synthesis. You can get a list of available voice IDs by calling the DescribeVoices operation.
If the service returns an enum value that is not available in the current SDK version, voiceId
will
return VoiceId.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
voiceIdString()
.
VoiceId
public String voiceIdString()
Voice ID to use for the synthesis. You can get a list of available voice IDs by calling the DescribeVoices operation.
If the service returns an enum value that is not available in the current SDK version, voiceId
will
return VoiceId.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
voiceIdString()
.
VoiceId
public SynthesizeSpeechRequest.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<SynthesizeSpeechRequest.Builder,SynthesizeSpeechRequest>
toBuilder
in class PollyRequest
public static SynthesizeSpeechRequest.Builder builder()
public static Class<? extends SynthesizeSpeechRequest.Builder> serializableBuilderClass()
public <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkRequest
SdkRequest
. The field name
specified should match the member name from the corresponding service-2.json model specified in the
codegen-resources folder for a given service. The class specifies what class to cast the returned value to.
If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class)
method will
again be available.getValueForField
in class SdkRequest
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.