Interface SynthesisTask.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<SynthesisTask.Builder,
,SynthesisTask> SdkBuilder<SynthesisTask.Builder,
,SynthesisTask> SdkPojo
- Enclosing class:
SynthesisTask
-
Method Summary
Modifier and TypeMethodDescriptioncreationTime
(Instant creationTime) Timestamp for the time the synthesis task was started.Specifies the engine (standard
,neural
orlong-form
) for Amazon Polly to use when processing input text for speech synthesis.Specifies the engine (standard
,neural
orlong-form
) for Amazon Polly to use when processing input text for speech synthesis.languageCode
(String languageCode) Optional language code for a synthesis task.languageCode
(LanguageCode languageCode) Optional language code for a synthesis task.lexiconNames
(String... lexiconNames) List of one or more pronunciation lexicon names you want the service to apply during synthesis.lexiconNames
(Collection<String> lexiconNames) List of one or more pronunciation lexicon names you want the service to apply during synthesis.outputFormat
(String outputFormat) The format in which the returned output will be encoded.outputFormat
(OutputFormat outputFormat) The format in which the returned output will be encoded.Pathway for the output speech file.requestCharacters
(Integer requestCharacters) Number of billable characters synthesized.sampleRate
(String sampleRate) The audio frequency specified in Hz.snsTopicArn
(String snsTopicArn) ARN for the SNS topic optionally used for providing status notification for a speech synthesis task.speechMarkTypes
(Collection<SpeechMarkType> speechMarkTypes) The type of speech marks returned for the input text.speechMarkTypes
(SpeechMarkType... speechMarkTypes) The type of speech marks returned for the input text.speechMarkTypesWithStrings
(String... speechMarkTypes) The type of speech marks returned for the input text.speechMarkTypesWithStrings
(Collection<String> speechMarkTypes) The type of speech marks returned for the input text.The Amazon Polly generated identifier for a speech synthesis task.taskStatus
(String taskStatus) Current status of the individual speech synthesis task.taskStatus
(TaskStatus taskStatus) Current status of the individual speech synthesis task.taskStatusReason
(String taskStatusReason) Reason for the current status of a specific speech synthesis task, including errors if the task has failed.Specifies whether the input text is plain text or SSML.Specifies whether the input text is plain text or SSML.Voice ID to use for the synthesis.Voice ID to use for the synthesis.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
engine
Specifies the engine (
standard
,neural
orlong-form
) for Amazon Polly to use when processing input text for speech synthesis. Using a voice that is not supported for the engine selected will result in an error.- Parameters:
engine
- Specifies the engine (standard
,neural
orlong-form
) for Amazon Polly to use when processing input text for speech synthesis. Using a voice that is not supported for the engine selected will result in an error.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
engine
Specifies the engine (
standard
,neural
orlong-form
) for Amazon Polly to use when processing input text for speech synthesis. Using a voice that is not supported for the engine selected will result in an error.- Parameters:
engine
- Specifies the engine (standard
,neural
orlong-form
) for Amazon Polly to use when processing input text for speech synthesis. Using a voice that is not supported for the engine selected will result in an error.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
taskId
The Amazon Polly generated identifier for a speech synthesis task.
- Parameters:
taskId
- The Amazon Polly generated identifier for a speech synthesis task.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
taskStatus
Current status of the individual speech synthesis task.
- Parameters:
taskStatus
- Current status of the individual speech synthesis task.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
taskStatus
Current status of the individual speech synthesis task.
- Parameters:
taskStatus
- Current status of the individual speech synthesis task.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
taskStatusReason
Reason for the current status of a specific speech synthesis task, including errors if the task has failed.
- Parameters:
taskStatusReason
- Reason for the current status of a specific speech synthesis task, including errors if the task has failed.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
outputUri
Pathway for the output speech file.
- Parameters:
outputUri
- Pathway for the output speech file.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
creationTime
Timestamp for the time the synthesis task was started.
- Parameters:
creationTime
- Timestamp for the time the synthesis task was started.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
requestCharacters
Number of billable characters synthesized.
- Parameters:
requestCharacters
- Number of billable characters synthesized.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
snsTopicArn
ARN for the SNS topic optionally used for providing status notification for a speech synthesis task.
- Parameters:
snsTopicArn
- ARN for the SNS topic optionally used for providing status notification for a speech synthesis task.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
- 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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
- 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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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
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:
-
sampleRate
The audio frequency specified in Hz.
The valid values for mp3 and ogg_vorbis are "8000", "16000", "22050", and "24000". The default value for standard voices is "22050". The default value for neural voices is "24000". The default value for long-form voices is "24000".
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", "22050", and "24000". The default value for standard voices is "22050". The default value for neural voices is "24000". The default value for long-form voices is "24000".
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.
-
speechMarkTypesWithStrings
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.
-
speechMarkTypesWithStrings
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.
-
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.
-
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.
-
textType
Specifies whether the input text is plain text or SSML. The default value is plain text.
- Parameters:
textType
- Specifies whether the input text is plain text or SSML. The default value is plain text.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
textType
Specifies whether the input text is plain text or SSML. The default value is plain text.
- Parameters:
textType
- Specifies whether the input text is plain text or SSML. The default value is plain text.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
voiceId
Voice ID to use for the synthesis.
- Parameters:
voiceId
- Voice ID to use for the synthesis.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
voiceId
Voice ID to use for the synthesis.
- Parameters:
voiceId
- Voice ID to use for the synthesis.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
languageCode
Optional language code for a synthesis task. 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 uses 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.- Parameters:
languageCode
- Optional language code for a synthesis task. 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 uses 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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
languageCode
Optional language code for a synthesis task. 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 uses 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.- Parameters:
languageCode
- Optional language code for a synthesis task. 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 uses 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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-