@Generated(value="software.amazon.awssdk:codegen") public final class StartSpeechSynthesisTaskRequest extends PollyRequest implements ToCopyableBuilder<StartSpeechSynthesisTaskRequest.Builder,StartSpeechSynthesisTaskRequest>
Modifier and Type | Class and Description |
---|---|
static interface |
StartSpeechSynthesisTaskRequest.Builder |
Modifier and Type | Method and Description |
---|---|
static StartSpeechSynthesisTaskRequest.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() |
LanguageCode |
languageCode()
Optional language code for the Speech Synthesis request.
|
String |
languageCodeAsString()
Optional language code for the Speech Synthesis request.
|
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 |
outputFormatAsString()
The format in which the returned output will be encoded.
|
String |
outputS3BucketName()
Amazon S3 bucket name to which the output file will be saved.
|
String |
outputS3KeyPrefix()
The Amazon S3 key prefix for the output speech file.
|
String |
sampleRate()
The audio frequency specified in Hz.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends StartSpeechSynthesisTaskRequest.Builder> |
serializableBuilderClass() |
String |
snsTopicArn()
ARN for the SNS topic optionally used for providing status notification for a speech synthesis task.
|
List<SpeechMarkType> |
speechMarkTypes()
The type of speech marks returned for the input text.
|
List<String> |
speechMarkTypesAsStrings()
The type of speech marks returned for the input text.
|
String |
text()
The input text to synthesize.
|
TextType |
textType()
Specifies whether the input text is plain text or SSML.
|
String |
textTypeAsString()
Specifies whether the input text is plain text or SSML.
|
StartSpeechSynthesisTaskRequest.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 |
voiceIdAsString()
Voice ID to use for the synthesis.
|
overrideConfiguration
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.
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
outputFormatAsString()
.
OutputFormat
public String outputFormatAsString()
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
outputFormatAsString()
.
OutputFormat
public String outputS3BucketName()
Amazon S3 bucket name to which the output file will be saved.
public String outputS3KeyPrefix()
The Amazon S3 key prefix for the output speech file.
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 String snsTopicArn()
ARN for the SNS topic optionally used for providing status notification for a speech synthesis task.
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> speechMarkTypesAsStrings()
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()
The input text to synthesize. If you specify 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.
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
textTypeAsString()
.
TextType
public String textTypeAsString()
Specifies whether the input text is plain text or SSML. The default value is plain text.
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
textTypeAsString()
.
TextType
public VoiceId voiceId()
Voice ID to use for the synthesis.
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
voiceIdAsString()
.
VoiceId
public String voiceIdAsString()
Voice ID to use for the synthesis.
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
voiceIdAsString()
.
VoiceId
public LanguageCode languageCode()
Optional language code for the Speech Synthesis 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 will use 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.
If the service returns an enum value that is not available in the current SDK version, languageCode
will
return LanguageCode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
languageCodeAsString()
.
If a bilingual voice is used and no language code is specified, Amazon Polly will use 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.
LanguageCode
public String languageCodeAsString()
Optional language code for the Speech Synthesis 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 will use 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.
If the service returns an enum value that is not available in the current SDK version, languageCode
will
return LanguageCode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
languageCodeAsString()
.
If a bilingual voice is used and no language code is specified, Amazon Polly will use 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.
LanguageCode
public StartSpeechSynthesisTaskRequest.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<StartSpeechSynthesisTaskRequest.Builder,StartSpeechSynthesisTaskRequest>
toBuilder
in class PollyRequest
public static StartSpeechSynthesisTaskRequest.Builder builder()
public static Class<? extends StartSpeechSynthesisTaskRequest.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.