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

Interface StartSpeechSynthesisTaskRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<StartSpeechSynthesisTaskRequest.Builder,StartSpeechSynthesisTaskRequest>, PollyRequest.Builder, SdkBuilder<StartSpeechSynthesisTaskRequest.Builder,StartSpeechSynthesisTaskRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
StartSpeechSynthesisTaskRequest
public static interface StartSpeechSynthesisTaskRequest.Builder extends PollyRequest.Builder, SdkPojo, CopyableBuilder<StartSpeechSynthesisTaskRequest.Builder,StartSpeechSynthesisTaskRequest>

  • Method Details

    • engine

      StartSpeechSynthesisTaskRequest.Builder engine(String engine)

      Specifies the engine (standard, neural, long-form or generative) 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, long-form or generative) 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

      StartSpeechSynthesisTaskRequest.Builder engine(Engine engine)

      Specifies the engine (standard, neural, long-form or generative) 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, long-form or generative) 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:

    • languageCode

      StartSpeechSynthesisTaskRequest.Builder languageCode(String 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 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 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 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

      StartSpeechSynthesisTaskRequest.Builder languageCode(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 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 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 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:

    • lexiconNames

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

      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

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

      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

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

      StartSpeechSynthesisTaskRequest.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:

    • outputS3BucketName

      StartSpeechSynthesisTaskRequest.Builder outputS3BucketName(String outputS3BucketName)

      Amazon S3 bucket name to which the output file will be saved.

      Parameters:
      outputS3BucketName - Amazon S3 bucket name to which the output file will be saved.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • outputS3KeyPrefix

      StartSpeechSynthesisTaskRequest.Builder outputS3KeyPrefix(String outputS3KeyPrefix)

      The Amazon S3 key prefix for the output speech file.

      Parameters:
      outputS3KeyPrefix - The Amazon S3 key prefix for the output speech file.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • sampleRate

      StartSpeechSynthesisTaskRequest.Builder sampleRate(String 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". The default value for generative 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". The default value for generative 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.

    • snsTopicArn

      StartSpeechSynthesisTaskRequest.Builder snsTopicArn(String 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.

    • speechMarkTypesWithStrings

      StartSpeechSynthesisTaskRequest.Builder speechMarkTypesWithStrings(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.

    • speechMarkTypesWithStrings

      StartSpeechSynthesisTaskRequest.Builder speechMarkTypesWithStrings(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

      StartSpeechSynthesisTaskRequest.Builder speechMarkTypes(Collection<SpeechMarkType> 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

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

      StartSpeechSynthesisTaskRequest.Builder text(String text)

      The input text to synthesize. If you specify ssml as the TextType, follow the SSML format for the input text.

      Parameters:
      text - The 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

      StartSpeechSynthesisTaskRequest.Builder textType(String 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

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

      StartSpeechSynthesisTaskRequest.Builder voiceId(String 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

      StartSpeechSynthesisTaskRequest.Builder voiceId(VoiceId 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:

    • overrideConfiguration

      StartSpeechSynthesisTaskRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      StartSpeechSynthesisTaskRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.