software.amazon.awssdk.services.polly.model

Interface SynthesizeSpeechRequest.Builder

All Superinterfaces:

AwsRequest.Builder, CopyableBuilder<SynthesizeSpeechRequest.Builder,SynthesizeSpeechRequest>, PollyRequest.Builder, SdkBuilder<SynthesizeSpeechRequest.Builder,SynthesizeSpeechRequest>, SdkRequest.Builder

Enclosing class:

SynthesizeSpeechRequest

public static interface SynthesizeSpeechRequest.Builder
extends PollyRequest.Builder, CopyableBuilder<SynthesizeSpeechRequest.Builder,SynthesizeSpeechRequest>

Method Summary

Modifier and Type	Method and Description
SynthesizeSpeechRequest.Builder	lexiconNames(Collection<String> lexiconNames) List of one or more pronunciation lexicon names you want the service to apply during synthesis.
SynthesizeSpeechRequest.Builder	lexiconNames(String... lexiconNames) List of one or more pronunciation lexicon names you want the service to apply during synthesis.
SynthesizeSpeechRequest.Builder	outputFormat(OutputFormat outputFormat) The format in which the returned output will be encoded.
SynthesizeSpeechRequest.Builder	outputFormat(String outputFormat) The format in which the returned output will be encoded.
SynthesizeSpeechRequest.Builder	requestOverrideConfig(AwsRequestOverrideConfig awsRequestOverrideConfig) Add an optional request override configuration.
SynthesizeSpeechRequest.Builder	requestOverrideConfig(Consumer<AwsRequestOverrideConfig.Builder> builderConsumer) Add an optional request override configuration.
SynthesizeSpeechRequest.Builder	sampleRate(String sampleRate) The audio frequency specified in Hz.
SynthesizeSpeechRequest.Builder	speechMarkTypes(Collection<String> speechMarkTypes) The type of speech marks returned for the input text.
SynthesizeSpeechRequest.Builder	speechMarkTypes(String... speechMarkTypes) The type of speech marks returned for the input text.
SynthesizeSpeechRequest.Builder	text(String text) Input text to synthesize.
SynthesizeSpeechRequest.Builder	textType(String textType) Specifies whether the input text is plain text or SSML.
SynthesizeSpeechRequest.Builder	textType(TextType textType) Specifies whether the input text is plain text or SSML.
SynthesizeSpeechRequest.Builder	voiceId(String voiceId) Voice ID to use for the synthesis.
SynthesizeSpeechRequest.Builder	voiceId(VoiceId voiceId) Voice ID to use for the synthesis.

Methods inherited from interface software.amazon.awssdk.services.polly.model.PollyRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

requestOverrideConfig

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

apply, build

Method Detail

lexiconNames

SynthesizeSpeechRequest.Builder lexiconNames(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.

lexiconNames

SynthesizeSpeechRequest.Builder lexiconNames(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.

outputFormat

SynthesizeSpeechRequest.Builder outputFormat(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, OutputFormat

outputFormat

SynthesizeSpeechRequest.Builder outputFormat(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, OutputFormat

sampleRate

SynthesizeSpeechRequest.Builder sampleRate(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.

speechMarkTypes

SynthesizeSpeechRequest.Builder speechMarkTypes(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.

speechMarkTypes

SynthesizeSpeechRequest.Builder speechMarkTypes(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.

text

SynthesizeSpeechRequest.Builder text(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.

textType

SynthesizeSpeechRequest.Builder textType(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, TextType

textType

SynthesizeSpeechRequest.Builder textType(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, TextType

voiceId

SynthesizeSpeechRequest.Builder voiceId(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, VoiceId

voiceId

SynthesizeSpeechRequest.Builder voiceId(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, VoiceId

requestOverrideConfig

SynthesizeSpeechRequest.Builder requestOverrideConfig(AwsRequestOverrideConfig awsRequestOverrideConfig)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

requestOverrideConfig in interface AwsRequest.Builder

Parameters:

awsRequestOverrideConfig - The override configuration.

Returns:

This object for method chaining.

requestOverrideConfig

SynthesizeSpeechRequest.Builder requestOverrideConfig(Consumer<AwsRequestOverrideConfig.Builder> builderConsumer)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

requestOverrideConfig in interface AwsRequest.Builder

Parameters:

builderConsumer - A Consumer to which an empty AwsRequestOverrideConfig.Builder will be given.

Returns:

This object for method chaining.