AWS SDK for C++  1.9.123
AWS SDK for C++
Public Member Functions | Protected Member Functions | List of all members
Aws::Polly::Model::SynthesizeSpeechRequest Class Reference

#include <SynthesizeSpeechRequest.h>

+ Inheritance diagram for Aws::Polly::Model::SynthesizeSpeechRequest:

Public Member Functions

 SynthesizeSpeechRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
const EngineGetEngine () const
 
bool EngineHasBeenSet () const
 
void SetEngine (const Engine &value)
 
void SetEngine (Engine &&value)
 
SynthesizeSpeechRequestWithEngine (const Engine &value)
 
SynthesizeSpeechRequestWithEngine (Engine &&value)
 
const LanguageCodeGetLanguageCode () const
 
bool LanguageCodeHasBeenSet () const
 
void SetLanguageCode (const LanguageCode &value)
 
void SetLanguageCode (LanguageCode &&value)
 
SynthesizeSpeechRequestWithLanguageCode (const LanguageCode &value)
 
SynthesizeSpeechRequestWithLanguageCode (LanguageCode &&value)
 
const Aws::Vector< Aws::String > & GetLexiconNames () const
 
bool LexiconNamesHasBeenSet () const
 
void SetLexiconNames (const Aws::Vector< Aws::String > &value)
 
void SetLexiconNames (Aws::Vector< Aws::String > &&value)
 
SynthesizeSpeechRequestWithLexiconNames (const Aws::Vector< Aws::String > &value)
 
SynthesizeSpeechRequestWithLexiconNames (Aws::Vector< Aws::String > &&value)
 
SynthesizeSpeechRequestAddLexiconNames (const Aws::String &value)
 
SynthesizeSpeechRequestAddLexiconNames (Aws::String &&value)
 
SynthesizeSpeechRequestAddLexiconNames (const char *value)
 
const OutputFormatGetOutputFormat () const
 
bool OutputFormatHasBeenSet () const
 
void SetOutputFormat (const OutputFormat &value)
 
void SetOutputFormat (OutputFormat &&value)
 
SynthesizeSpeechRequestWithOutputFormat (const OutputFormat &value)
 
SynthesizeSpeechRequestWithOutputFormat (OutputFormat &&value)
 
const Aws::StringGetSampleRate () const
 
bool SampleRateHasBeenSet () const
 
void SetSampleRate (const Aws::String &value)
 
void SetSampleRate (Aws::String &&value)
 
void SetSampleRate (const char *value)
 
SynthesizeSpeechRequestWithSampleRate (const Aws::String &value)
 
SynthesizeSpeechRequestWithSampleRate (Aws::String &&value)
 
SynthesizeSpeechRequestWithSampleRate (const char *value)
 
const Aws::Vector< SpeechMarkType > & GetSpeechMarkTypes () const
 
bool SpeechMarkTypesHasBeenSet () const
 
void SetSpeechMarkTypes (const Aws::Vector< SpeechMarkType > &value)
 
void SetSpeechMarkTypes (Aws::Vector< SpeechMarkType > &&value)
 
SynthesizeSpeechRequestWithSpeechMarkTypes (const Aws::Vector< SpeechMarkType > &value)
 
SynthesizeSpeechRequestWithSpeechMarkTypes (Aws::Vector< SpeechMarkType > &&value)
 
SynthesizeSpeechRequestAddSpeechMarkTypes (const SpeechMarkType &value)
 
SynthesizeSpeechRequestAddSpeechMarkTypes (SpeechMarkType &&value)
 
const Aws::StringGetText () const
 
bool TextHasBeenSet () const
 
void SetText (const Aws::String &value)
 
void SetText (Aws::String &&value)
 
void SetText (const char *value)
 
SynthesizeSpeechRequestWithText (const Aws::String &value)
 
SynthesizeSpeechRequestWithText (Aws::String &&value)
 
SynthesizeSpeechRequestWithText (const char *value)
 
const TextTypeGetTextType () const
 
bool TextTypeHasBeenSet () const
 
void SetTextType (const TextType &value)
 
void SetTextType (TextType &&value)
 
SynthesizeSpeechRequestWithTextType (const TextType &value)
 
SynthesizeSpeechRequestWithTextType (TextType &&value)
 
const VoiceIdGetVoiceId () const
 
bool VoiceIdHasBeenSet () const
 
void SetVoiceId (const VoiceId &value)
 
void SetVoiceId (VoiceId &&value)
 
SynthesizeSpeechRequestWithVoiceId (const VoiceId &value)
 
SynthesizeSpeechRequestWithVoiceId (VoiceId &&value)
 
- Public Member Functions inherited from Aws::Polly::PollyRequest
virtual ~PollyRequest ()
 
void AddParametersToRequest (Aws::Http::HttpRequest &httpRequest) const
 
Aws::Http::HeaderValueCollection GetHeaders () const override
 
- Public Member Functions inherited from Aws::AmazonSerializableWebServiceRequest
 AmazonSerializableWebServiceRequest ()
 
virtual ~AmazonSerializableWebServiceRequest ()
 
std::shared_ptr< Aws::IOStreamGetBody () const override
 
- Public Member Functions inherited from Aws::AmazonWebServiceRequest
 AmazonWebServiceRequest ()
 
virtual ~AmazonWebServiceRequest ()=default
 
virtual void AddQueryStringParameters (Aws::Http::URI &uri) const
 
virtual void PutToPresignedUrl (Aws::Http::URI &uri) const
 
virtual bool IsStreaming () const
 
virtual bool IsEventStreamRequest () const
 
virtual bool SignBody () const
 
virtual bool IsChunked () const
 
virtual void SetRequestSignedHandler (const RequestSignedHandler &handler)
 
virtual const RequestSignedHandlerGetRequestSignedHandler () const
 
const Aws::IOStreamFactoryGetResponseStreamFactory () const
 
void SetResponseStreamFactory (const Aws::IOStreamFactory &factory)
 
virtual void SetDataReceivedEventHandler (const Aws::Http::DataReceivedEventHandler &dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (const Aws::Http::DataSentEventHandler &dataSentEventHandler)
 
virtual void SetContinueRequestHandler (const Aws::Http::ContinueRequestHandler &continueRequestHandler)
 
virtual void SetDataReceivedEventHandler (Aws::Http::DataReceivedEventHandler &&dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (Aws::Http::DataSentEventHandler &&dataSentEventHandler)
 
virtual void SetContinueRequestHandler (Aws::Http::ContinueRequestHandler &&continueRequestHandler)
 
virtual void SetRequestRetryHandler (const RequestRetryHandler &handler)
 
virtual void SetRequestRetryHandler (RequestRetryHandler &&handler)
 
virtual const Aws::Http::DataReceivedEventHandlerGetDataReceivedEventHandler () const
 
virtual const Aws::Http::DataSentEventHandlerGetDataSentEventHandler () const
 
virtual const Aws::Http::ContinueRequestHandlerGetContinueRequestHandler () const
 
virtual const RequestRetryHandlerGetRequestRetryHandler () const
 
virtual bool ShouldComputeContentMd5 () const
 

Protected Member Functions

void DumpBodyToUrl (Aws::Http::URI &uri) const override
 
- Protected Member Functions inherited from Aws::Polly::PollyRequest
virtual Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const
 

Detailed Description

Definition at line 28 of file SynthesizeSpeechRequest.h.

Constructor & Destructor Documentation

◆ SynthesizeSpeechRequest()

Aws::Polly::Model::SynthesizeSpeechRequest::SynthesizeSpeechRequest ( )

Member Function Documentation

◆ AddLexiconNames() [1/3]

SynthesizeSpeechRequest& Aws::Polly::Model::SynthesizeSpeechRequest::AddLexiconNames ( Aws::String &&  value)
inline

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.

Definition at line 304 of file SynthesizeSpeechRequest.h.

◆ AddLexiconNames() [2/3]

SynthesizeSpeechRequest& Aws::Polly::Model::SynthesizeSpeechRequest::AddLexiconNames ( const Aws::String value)
inline

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.

Definition at line 295 of file SynthesizeSpeechRequest.h.

◆ AddLexiconNames() [3/3]

SynthesizeSpeechRequest& Aws::Polly::Model::SynthesizeSpeechRequest::AddLexiconNames ( const char *  value)
inline

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.

Definition at line 313 of file SynthesizeSpeechRequest.h.

◆ AddSpeechMarkTypes() [1/2]

SynthesizeSpeechRequest& Aws::Polly::Model::SynthesizeSpeechRequest::AddSpeechMarkTypes ( const SpeechMarkType value)
inline

The type of speech marks returned for the input text.

Definition at line 471 of file SynthesizeSpeechRequest.h.

◆ AddSpeechMarkTypes() [2/2]

SynthesizeSpeechRequest& Aws::Polly::Model::SynthesizeSpeechRequest::AddSpeechMarkTypes ( SpeechMarkType &&  value)
inline

The type of speech marks returned for the input text.

Definition at line 476 of file SynthesizeSpeechRequest.h.

◆ DumpBodyToUrl()

void Aws::Polly::Model::SynthesizeSpeechRequest::DumpBodyToUrl ( Aws::Http::URI uri) const
overrideprotectedvirtual

Default does nothing. Override this to convert what would otherwise be the payload of the request to a query string format.

Reimplemented from Aws::AmazonWebServiceRequest.

◆ EngineHasBeenSet()

bool Aws::Polly::Model::SynthesizeSpeechRequest::EngineHasBeenSet ( ) const
inline

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.

Definition at line 80 of file SynthesizeSpeechRequest.h.

◆ GetEngine()

const Engine& Aws::Polly::Model::SynthesizeSpeechRequest::GetEngine ( ) const
inline

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.

Definition at line 62 of file SynthesizeSpeechRequest.h.

◆ GetLanguageCode()

const LanguageCode& Aws::Polly::Model::SynthesizeSpeechRequest::GetLanguageCode ( ) const
inline

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.

Definition at line 166 of file SynthesizeSpeechRequest.h.

◆ GetLexiconNames()

const Aws::Vector<Aws::String>& Aws::Polly::Model::SynthesizeSpeechRequest::GetLexiconNames ( ) const
inline

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.

Definition at line 241 of file SynthesizeSpeechRequest.h.

◆ GetOutputFormat()

const OutputFormat& Aws::Polly::Model::SynthesizeSpeechRequest::GetOutputFormat ( ) const
inline

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.

Definition at line 322 of file SynthesizeSpeechRequest.h.

◆ GetSampleRate()

const Aws::String& Aws::Polly::Model::SynthesizeSpeechRequest::GetSampleRate ( ) const
inline

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

Definition at line 372 of file SynthesizeSpeechRequest.h.

◆ GetServiceRequestName()

virtual const char* Aws::Polly::Model::SynthesizeSpeechRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 37 of file SynthesizeSpeechRequest.h.

◆ GetSpeechMarkTypes()

const Aws::Vector<SpeechMarkType>& Aws::Polly::Model::SynthesizeSpeechRequest::GetSpeechMarkTypes ( ) const
inline

The type of speech marks returned for the input text.

Definition at line 441 of file SynthesizeSpeechRequest.h.

◆ GetText()

const Aws::String& Aws::Polly::Model::SynthesizeSpeechRequest::GetText ( ) const
inline

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

Definition at line 483 of file SynthesizeSpeechRequest.h.

◆ GetTextType()

const TextType& Aws::Polly::Model::SynthesizeSpeechRequest::GetTextType ( ) const
inline

Specifies whether the input text is plain text or SSML. The default value is plain text. For more information, see Using SSML.

Definition at line 533 of file SynthesizeSpeechRequest.h.

◆ GetVoiceId()

const VoiceId& Aws::Polly::Model::SynthesizeSpeechRequest::GetVoiceId ( ) const
inline

Voice ID to use for the synthesis. You can get a list of available voice IDs by calling the DescribeVoices operation.

Definition at line 577 of file SynthesizeSpeechRequest.h.

◆ LanguageCodeHasBeenSet()

bool Aws::Polly::Model::SynthesizeSpeechRequest::LanguageCodeHasBeenSet ( ) const
inline

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.

Definition at line 179 of file SynthesizeSpeechRequest.h.

◆ LexiconNamesHasBeenSet()

bool Aws::Polly::Model::SynthesizeSpeechRequest::LexiconNamesHasBeenSet ( ) const
inline

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.

Definition at line 250 of file SynthesizeSpeechRequest.h.

◆ OutputFormatHasBeenSet()

bool Aws::Polly::Model::SynthesizeSpeechRequest::OutputFormatHasBeenSet ( ) const
inline

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.

Definition at line 330 of file SynthesizeSpeechRequest.h.

◆ SampleRateHasBeenSet()

bool Aws::Polly::Model::SynthesizeSpeechRequest::SampleRateHasBeenSet ( ) const
inline

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

Definition at line 381 of file SynthesizeSpeechRequest.h.

◆ SerializePayload()

Aws::String Aws::Polly::Model::SynthesizeSpeechRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetEngine() [1/2]

void Aws::Polly::Model::SynthesizeSpeechRequest::SetEngine ( const Engine value)
inline

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.

Definition at line 98 of file SynthesizeSpeechRequest.h.

◆ SetEngine() [2/2]

void Aws::Polly::Model::SynthesizeSpeechRequest::SetEngine ( Engine &&  value)
inline

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.

Definition at line 116 of file SynthesizeSpeechRequest.h.

◆ SetLanguageCode() [1/2]

void Aws::Polly::Model::SynthesizeSpeechRequest::SetLanguageCode ( const LanguageCode value)
inline

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.

Definition at line 192 of file SynthesizeSpeechRequest.h.

◆ SetLanguageCode() [2/2]

void Aws::Polly::Model::SynthesizeSpeechRequest::SetLanguageCode ( LanguageCode &&  value)
inline

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.

Definition at line 205 of file SynthesizeSpeechRequest.h.

◆ SetLexiconNames() [1/2]

void Aws::Polly::Model::SynthesizeSpeechRequest::SetLexiconNames ( Aws::Vector< Aws::String > &&  value)
inline

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.

Definition at line 268 of file SynthesizeSpeechRequest.h.

◆ SetLexiconNames() [2/2]

void Aws::Polly::Model::SynthesizeSpeechRequest::SetLexiconNames ( const Aws::Vector< Aws::String > &  value)
inline

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.

Definition at line 259 of file SynthesizeSpeechRequest.h.

◆ SetOutputFormat() [1/2]

void Aws::Polly::Model::SynthesizeSpeechRequest::SetOutputFormat ( const OutputFormat value)
inline

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.

Definition at line 338 of file SynthesizeSpeechRequest.h.

◆ SetOutputFormat() [2/2]

void Aws::Polly::Model::SynthesizeSpeechRequest::SetOutputFormat ( OutputFormat &&  value)
inline

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.

Definition at line 346 of file SynthesizeSpeechRequest.h.

◆ SetSampleRate() [1/3]

void Aws::Polly::Model::SynthesizeSpeechRequest::SetSampleRate ( Aws::String &&  value)
inline

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

Definition at line 399 of file SynthesizeSpeechRequest.h.

◆ SetSampleRate() [2/3]

void Aws::Polly::Model::SynthesizeSpeechRequest::SetSampleRate ( const Aws::String value)
inline

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

Definition at line 390 of file SynthesizeSpeechRequest.h.

◆ SetSampleRate() [3/3]

void Aws::Polly::Model::SynthesizeSpeechRequest::SetSampleRate ( const char *  value)
inline

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

Definition at line 408 of file SynthesizeSpeechRequest.h.

◆ SetSpeechMarkTypes() [1/2]

void Aws::Polly::Model::SynthesizeSpeechRequest::SetSpeechMarkTypes ( Aws::Vector< SpeechMarkType > &&  value)
inline

The type of speech marks returned for the input text.

Definition at line 456 of file SynthesizeSpeechRequest.h.

◆ SetSpeechMarkTypes() [2/2]

void Aws::Polly::Model::SynthesizeSpeechRequest::SetSpeechMarkTypes ( const Aws::Vector< SpeechMarkType > &  value)
inline

The type of speech marks returned for the input text.

Definition at line 451 of file SynthesizeSpeechRequest.h.

◆ SetText() [1/3]

void Aws::Polly::Model::SynthesizeSpeechRequest::SetText ( Aws::String &&  value)
inline

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

Definition at line 501 of file SynthesizeSpeechRequest.h.

◆ SetText() [2/3]

void Aws::Polly::Model::SynthesizeSpeechRequest::SetText ( const Aws::String value)
inline

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

Definition at line 495 of file SynthesizeSpeechRequest.h.

◆ SetText() [3/3]

void Aws::Polly::Model::SynthesizeSpeechRequest::SetText ( const char *  value)
inline

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

Definition at line 507 of file SynthesizeSpeechRequest.h.

◆ SetTextType() [1/2]

void Aws::Polly::Model::SynthesizeSpeechRequest::SetTextType ( const TextType value)
inline

Specifies whether the input text is plain text or SSML. The default value is plain text. For more information, see Using SSML.

Definition at line 547 of file SynthesizeSpeechRequest.h.

◆ SetTextType() [2/2]

void Aws::Polly::Model::SynthesizeSpeechRequest::SetTextType ( TextType &&  value)
inline

Specifies whether the input text is plain text or SSML. The default value is plain text. For more information, see Using SSML.

Definition at line 554 of file SynthesizeSpeechRequest.h.

◆ SetVoiceId() [1/2]

void Aws::Polly::Model::SynthesizeSpeechRequest::SetVoiceId ( const VoiceId value)
inline

Voice ID to use for the synthesis. You can get a list of available voice IDs by calling the DescribeVoices operation.

Definition at line 593 of file SynthesizeSpeechRequest.h.

◆ SetVoiceId() [2/2]

void Aws::Polly::Model::SynthesizeSpeechRequest::SetVoiceId ( VoiceId &&  value)
inline

Voice ID to use for the synthesis. You can get a list of available voice IDs by calling the DescribeVoices operation.

Definition at line 601 of file SynthesizeSpeechRequest.h.

◆ SpeechMarkTypesHasBeenSet()

bool Aws::Polly::Model::SynthesizeSpeechRequest::SpeechMarkTypesHasBeenSet ( ) const
inline

The type of speech marks returned for the input text.

Definition at line 446 of file SynthesizeSpeechRequest.h.

◆ TextHasBeenSet()

bool Aws::Polly::Model::SynthesizeSpeechRequest::TextHasBeenSet ( ) const
inline

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

Definition at line 489 of file SynthesizeSpeechRequest.h.

◆ TextTypeHasBeenSet()

bool Aws::Polly::Model::SynthesizeSpeechRequest::TextTypeHasBeenSet ( ) const
inline

Specifies whether the input text is plain text or SSML. The default value is plain text. For more information, see Using SSML.

Definition at line 540 of file SynthesizeSpeechRequest.h.

◆ VoiceIdHasBeenSet()

bool Aws::Polly::Model::SynthesizeSpeechRequest::VoiceIdHasBeenSet ( ) const
inline

Voice ID to use for the synthesis. You can get a list of available voice IDs by calling the DescribeVoices operation.

Definition at line 585 of file SynthesizeSpeechRequest.h.

◆ WithEngine() [1/2]

SynthesizeSpeechRequest& Aws::Polly::Model::SynthesizeSpeechRequest::WithEngine ( const Engine value)
inline

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.

Definition at line 134 of file SynthesizeSpeechRequest.h.

◆ WithEngine() [2/2]

SynthesizeSpeechRequest& Aws::Polly::Model::SynthesizeSpeechRequest::WithEngine ( Engine &&  value)
inline

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.

Definition at line 152 of file SynthesizeSpeechRequest.h.

◆ WithLanguageCode() [1/2]

SynthesizeSpeechRequest& Aws::Polly::Model::SynthesizeSpeechRequest::WithLanguageCode ( const LanguageCode value)
inline

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.

Definition at line 218 of file SynthesizeSpeechRequest.h.

◆ WithLanguageCode() [2/2]

SynthesizeSpeechRequest& Aws::Polly::Model::SynthesizeSpeechRequest::WithLanguageCode ( LanguageCode &&  value)
inline

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.

Definition at line 231 of file SynthesizeSpeechRequest.h.

◆ WithLexiconNames() [1/2]

SynthesizeSpeechRequest& Aws::Polly::Model::SynthesizeSpeechRequest::WithLexiconNames ( Aws::Vector< Aws::String > &&  value)
inline

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.

Definition at line 286 of file SynthesizeSpeechRequest.h.

◆ WithLexiconNames() [2/2]

SynthesizeSpeechRequest& Aws::Polly::Model::SynthesizeSpeechRequest::WithLexiconNames ( const Aws::Vector< Aws::String > &  value)
inline

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.

Definition at line 277 of file SynthesizeSpeechRequest.h.

◆ WithOutputFormat() [1/2]

SynthesizeSpeechRequest& Aws::Polly::Model::SynthesizeSpeechRequest::WithOutputFormat ( const OutputFormat value)
inline

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.

Definition at line 354 of file SynthesizeSpeechRequest.h.

◆ WithOutputFormat() [2/2]

SynthesizeSpeechRequest& Aws::Polly::Model::SynthesizeSpeechRequest::WithOutputFormat ( OutputFormat &&  value)
inline

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.

Definition at line 362 of file SynthesizeSpeechRequest.h.

◆ WithSampleRate() [1/3]

SynthesizeSpeechRequest& Aws::Polly::Model::SynthesizeSpeechRequest::WithSampleRate ( Aws::String &&  value)
inline

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

Definition at line 426 of file SynthesizeSpeechRequest.h.

◆ WithSampleRate() [2/3]

SynthesizeSpeechRequest& Aws::Polly::Model::SynthesizeSpeechRequest::WithSampleRate ( const Aws::String value)
inline

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

Definition at line 417 of file SynthesizeSpeechRequest.h.

◆ WithSampleRate() [3/3]

SynthesizeSpeechRequest& Aws::Polly::Model::SynthesizeSpeechRequest::WithSampleRate ( const char *  value)
inline

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

Definition at line 435 of file SynthesizeSpeechRequest.h.

◆ WithSpeechMarkTypes() [1/2]

SynthesizeSpeechRequest& Aws::Polly::Model::SynthesizeSpeechRequest::WithSpeechMarkTypes ( Aws::Vector< SpeechMarkType > &&  value)
inline

The type of speech marks returned for the input text.

Definition at line 466 of file SynthesizeSpeechRequest.h.

◆ WithSpeechMarkTypes() [2/2]

SynthesizeSpeechRequest& Aws::Polly::Model::SynthesizeSpeechRequest::WithSpeechMarkTypes ( const Aws::Vector< SpeechMarkType > &  value)
inline

The type of speech marks returned for the input text.

Definition at line 461 of file SynthesizeSpeechRequest.h.

◆ WithText() [1/3]

SynthesizeSpeechRequest& Aws::Polly::Model::SynthesizeSpeechRequest::WithText ( Aws::String &&  value)
inline

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

Definition at line 519 of file SynthesizeSpeechRequest.h.

◆ WithText() [2/3]

SynthesizeSpeechRequest& Aws::Polly::Model::SynthesizeSpeechRequest::WithText ( const Aws::String value)
inline

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

Definition at line 513 of file SynthesizeSpeechRequest.h.

◆ WithText() [3/3]

SynthesizeSpeechRequest& Aws::Polly::Model::SynthesizeSpeechRequest::WithText ( const char *  value)
inline

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

Definition at line 525 of file SynthesizeSpeechRequest.h.

◆ WithTextType() [1/2]

SynthesizeSpeechRequest& Aws::Polly::Model::SynthesizeSpeechRequest::WithTextType ( const TextType value)
inline

Specifies whether the input text is plain text or SSML. The default value is plain text. For more information, see Using SSML.

Definition at line 561 of file SynthesizeSpeechRequest.h.

◆ WithTextType() [2/2]

SynthesizeSpeechRequest& Aws::Polly::Model::SynthesizeSpeechRequest::WithTextType ( TextType &&  value)
inline

Specifies whether the input text is plain text or SSML. The default value is plain text. For more information, see Using SSML.

Definition at line 568 of file SynthesizeSpeechRequest.h.

◆ WithVoiceId() [1/2]

SynthesizeSpeechRequest& Aws::Polly::Model::SynthesizeSpeechRequest::WithVoiceId ( const VoiceId value)
inline

Voice ID to use for the synthesis. You can get a list of available voice IDs by calling the DescribeVoices operation.

Definition at line 609 of file SynthesizeSpeechRequest.h.

◆ WithVoiceId() [2/2]

SynthesizeSpeechRequest& Aws::Polly::Model::SynthesizeSpeechRequest::WithVoiceId ( VoiceId &&  value)
inline

Voice ID to use for the synthesis. You can get a list of available voice IDs by calling the DescribeVoices operation.

Definition at line 617 of file SynthesizeSpeechRequest.h.


The documentation for this class was generated from the following file: