/** * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * SPDX-License-Identifier: Apache-2.0. */ #pragma once #include #include #include #include #include #include #include #include #include #include #include namespace Aws { namespace Polly { namespace Model { /** */ class SynthesizeSpeechRequest : public PollyRequest { public: AWS_POLLY_API SynthesizeSpeechRequest(); // Service request name is the Operation name which will send this request out, // each operation should has unique request name, so that we can get operation's name from this request. // Note: this is not true for response, multiple operations may have the same response name, // so we can not get operation's name from response. inline virtual const char* GetServiceRequestName() const override { return "SynthesizeSpeech"; } AWS_POLLY_API Aws::String SerializePayload() const override; protected: AWS_POLLY_API void DumpBodyToUrl(Aws::Http::URI& uri ) const override; public: /** *

Specifies the engine (standard or neural) for * Amazon Polly to use when processing input text for speech synthesis. For * information on Amazon Polly voices and which voices are available in * standard-only, NTTS-only, and both standard and NTTS formats, 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.

Type: String

Valid Values: standard | neural

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.

*/ inline const Engine& GetEngine() const{ return m_engine; } /** *

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.

Type: String

Valid Values: standard | neural

Required: * Yes

Standard voices

*/ inline bool EngineHasBeenSet() const { return m_engineHasBeenSet; } /** *

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.

Type: String

Valid Values: standard | neural

Required: * Yes

Standard voices

*/ inline void SetEngine(const Engine& value) { m_engineHasBeenSet = true; m_engine = value; } /** *

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.

Type: String

Valid Values: standard | neural

Required: * Yes

Standard voices

*/ inline void SetEngine(Engine&& value) { m_engineHasBeenSet = true; m_engine = std::move(value); } /** *

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.

Type: String

Valid Values: standard | neural

Required: * Yes

Standard voices

*/ inline SynthesizeSpeechRequest& WithEngine(const Engine& value) { SetEngine(value); return *this;} /** *

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.

Type: String

Valid Values: standard | neural

Required: * Yes

Standard voices

*/ inline SynthesizeSpeechRequest& WithEngine(Engine&& value) { SetEngine(std::move(value)); return *this;} /** *

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.

*/ inline const LanguageCode& GetLanguageCode() const{ return m_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).

*/ inline bool LanguageCodeHasBeenSet() const { return m_languageCodeHasBeenSet; } /** *

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

*/ inline void SetLanguageCode(const LanguageCode& value) { m_languageCodeHasBeenSet = true; m_languageCode = value; } /** *

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

*/ inline void SetLanguageCode(LanguageCode&& value) { m_languageCodeHasBeenSet = true; m_languageCode = std::move(value); } /** *

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

*/ inline SynthesizeSpeechRequest& WithLanguageCode(const LanguageCode& value) { SetLanguageCode(value); return *this;} /** *

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

*/ inline SynthesizeSpeechRequest& WithLanguageCode(LanguageCode&& value) { SetLanguageCode(std::move(value)); return *this;} /** *

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.

*/ inline const Aws::Vector& GetLexiconNames() const{ return m_lexiconNames; } /** *

*/ inline bool LexiconNamesHasBeenSet() const { return m_lexiconNamesHasBeenSet; } /** *

*/ inline void SetLexiconNames(const Aws::Vector& value) { m_lexiconNamesHasBeenSet = true; m_lexiconNames = value; } /** *

*/ inline void SetLexiconNames(Aws::Vector&& value) { m_lexiconNamesHasBeenSet = true; m_lexiconNames = std::move(value); } /** *

*/ inline SynthesizeSpeechRequest& WithLexiconNames(const Aws::Vector& value) { SetLexiconNames(value); return *this;} /** *

*/ inline SynthesizeSpeechRequest& WithLexiconNames(Aws::Vector&& value) { SetLexiconNames(std::move(value)); return *this;} /** *

*/ inline SynthesizeSpeechRequest& AddLexiconNames(const Aws::String& value) { m_lexiconNamesHasBeenSet = true; m_lexiconNames.push_back(value); return *this; } /** *

*/ inline SynthesizeSpeechRequest& AddLexiconNames(Aws::String&& value) { m_lexiconNamesHasBeenSet = true; m_lexiconNames.push_back(std::move(value)); return *this; } /** *

*/ inline SynthesizeSpeechRequest& AddLexiconNames(const char* value) { m_lexiconNamesHasBeenSet = true; m_lexiconNames.push_back(value); return *this; } /** *

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.

*/ inline const OutputFormat& GetOutputFormat() const{ return m_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.

*/ inline bool OutputFormatHasBeenSet() const { return m_outputFormatHasBeenSet; } /** *

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.

*/ inline void SetOutputFormat(const OutputFormat& value) { m_outputFormatHasBeenSet = true; m_outputFormat = value; } /** *

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.

*/ inline void SetOutputFormat(OutputFormat&& value) { m_outputFormatHasBeenSet = true; m_outputFormat = std::move(value); } /** *

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.

*/ inline SynthesizeSpeechRequest& WithOutputFormat(const OutputFormat& value) { SetOutputFormat(value); return *this;} /** *

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.

*/ inline SynthesizeSpeechRequest& WithOutputFormat(OutputFormat&& value) { SetOutputFormat(std::move(value)); return *this;} /** *

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

Valid values for pcm are "8000" and "16000" The default value is "16000". *

*/ inline const Aws::String& GetSampleRate() const{ return m_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".

Valid values for pcm are "8000" and "16000" The default value is "16000". *

*/ inline bool SampleRateHasBeenSet() const { return m_sampleRateHasBeenSet; } /** *

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

Valid values for pcm are "8000" and "16000" The default value is "16000". *

*/ inline void SetSampleRate(const Aws::String& value) { m_sampleRateHasBeenSet = true; m_sampleRate = value; } /** *

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

Valid values for pcm are "8000" and "16000" The default value is "16000". *

*/ inline void SetSampleRate(Aws::String&& value) { m_sampleRateHasBeenSet = true; m_sampleRate = std::move(value); } /** *

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

Valid values for pcm are "8000" and "16000" The default value is "16000". *

*/ inline void SetSampleRate(const char* value) { m_sampleRateHasBeenSet = true; m_sampleRate.assign(value); } /** *

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

Valid values for pcm are "8000" and "16000" The default value is "16000". *

*/ inline SynthesizeSpeechRequest& WithSampleRate(const Aws::String& value) { SetSampleRate(value); return *this;} /** *

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

Valid values for pcm are "8000" and "16000" The default value is "16000". *

*/ inline SynthesizeSpeechRequest& WithSampleRate(Aws::String&& value) { SetSampleRate(std::move(value)); return *this;} /** *

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

Valid values for pcm are "8000" and "16000" The default value is "16000". *

*/ inline SynthesizeSpeechRequest& WithSampleRate(const char* value) { SetSampleRate(value); return *this;} /** *