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

Interface SynthesizeSpeechRequest.Builder

    • Method Detail

      • engine

        SynthesizeSpeechRequest.Builder engine​(String engine)

        Specifies the engine (standard, neural or long-form) for Amazon Polly to use when processing input text for speech synthesis. For information on Amazon Polly voices and which voices are available for each engine, see Available Voices.

        NTTS-only voices

        When using NTTS-only voices such as Kevin (en-US), this parameter is required and must be set to neural. If the engine is not specified, or is set to standard, this will result in an error.

        long-form-only voices

        When using long-form-only voices such as Danielle (en-US), this parameter is required and must be set to long-form. If the engine is not specified, or is set to standard or neural, this will result in an error.

        Type: String

        Valid Values: standard | neural | long-form

        Required: Yes

        Standard voices

        For standard voices, this is not required; the engine parameter defaults to standard. If the engine is not specified, or is set to standard and an NTTS-only voice is selected, this will result in an error.

        Parameters:
        engine - Specifies the engine (standard, neural or long-form) for Amazon Polly to use when processing input text for speech synthesis. For information on Amazon Polly voices and which voices are available for each engine, see Available Voices.

        NTTS-only voices

        When using NTTS-only voices such as Kevin (en-US), this parameter is required and must be set to neural. If the engine is not specified, or is set to standard, this will result in an error.

        long-form-only voices

        When using long-form-only voices such as Danielle (en-US), this parameter is required and must be set to long-form. If the engine is not specified, or is set to standard or neural, this will result in an error.

        Type: String

        Valid Values: standard | neural | long-form

        Required: Yes

        Standard voices

        For standard voices, this is not required; the engine parameter defaults to standard. If the engine is not specified, or is set to standard and an NTTS-only voice is selected, this will result in an error.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        Engine, Engine

      • engine

        SynthesizeSpeechRequest.Builder engine​(Engine engine)

        Specifies the engine (standard, neural or long-form) for Amazon Polly to use when processing input text for speech synthesis. For information on Amazon Polly voices and which voices are available for each engine, see Available Voices.

        NTTS-only voices

        When using NTTS-only voices such as Kevin (en-US), this parameter is required and must be set to neural. If the engine is not specified, or is set to standard, this will result in an error.

        long-form-only voices

        When using long-form-only voices such as Danielle (en-US), this parameter is required and must be set to long-form. If the engine is not specified, or is set to standard or neural, this will result in an error.

        Type: String

        Valid Values: standard | neural | long-form

        Required: Yes

        Standard voices

        For standard voices, this is not required; the engine parameter defaults to standard. If the engine is not specified, or is set to standard and an NTTS-only voice is selected, this will result in an error.

        Parameters:
        engine - Specifies the engine (standard, neural or long-form) for Amazon Polly to use when processing input text for speech synthesis. For information on Amazon Polly voices and which voices are available for each engine, see Available Voices.

        NTTS-only voices

        When using NTTS-only voices such as Kevin (en-US), this parameter is required and must be set to neural. If the engine is not specified, or is set to standard, this will result in an error.

        long-form-only voices

        When using long-form-only voices such as Danielle (en-US), this parameter is required and must be set to long-form. If the engine is not specified, or is set to standard or neural, this will result in an error.

        Type: String

        Valid Values: standard | neural | long-form

        Required: Yes

        Standard voices

        For standard voices, this is not required; the engine parameter defaults to standard. If the engine is not specified, or is set to standard and an NTTS-only voice is selected, this will result in an error.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        Engine, Engine

      • languageCode

        SynthesizeSpeechRequest.Builder languageCode​(String languageCode)

        Optional language code for the Synthesize Speech 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 Synthesize Speech 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, LanguageCode

      • languageCode

        SynthesizeSpeechRequest.Builder languageCode​(LanguageCode languageCode)

        Optional language code for the Synthesize Speech 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 Synthesize Speech 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, LanguageCode

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

        When pcm is used, the content returned is audio/pcm in a signed 16-bit, 1 channel (mono), little-endian format.

        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.

        When pcm is used, the content returned is audio/pcm in a signed 16-bit, 1 channel (mono), little-endian format.

        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.

        When pcm is used, the content returned is audio/pcm in a signed 16-bit, 1 channel (mono), little-endian format.

        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.

        When pcm is used, the content returned is audio/pcm in a signed 16-bit, 1 channel (mono), little-endian format.

        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", "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

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

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

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

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

        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