AWS SDK for C++  1.9.20
AWS SDK for C++
Public Member Functions | List of all members
Aws::Polly::Model::StartSpeechSynthesisTaskRequest Class Reference

#include <StartSpeechSynthesisTaskRequest.h>

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

Public Member Functions

 StartSpeechSynthesisTaskRequest ()
 
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)
 
StartSpeechSynthesisTaskRequestWithEngine (const Engine &value)
 
StartSpeechSynthesisTaskRequestWithEngine (Engine &&value)
 
const LanguageCodeGetLanguageCode () const
 
bool LanguageCodeHasBeenSet () const
 
void SetLanguageCode (const LanguageCode &value)
 
void SetLanguageCode (LanguageCode &&value)
 
StartSpeechSynthesisTaskRequestWithLanguageCode (const LanguageCode &value)
 
StartSpeechSynthesisTaskRequestWithLanguageCode (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)
 
StartSpeechSynthesisTaskRequestWithLexiconNames (const Aws::Vector< Aws::String > &value)
 
StartSpeechSynthesisTaskRequestWithLexiconNames (Aws::Vector< Aws::String > &&value)
 
StartSpeechSynthesisTaskRequestAddLexiconNames (const Aws::String &value)
 
StartSpeechSynthesisTaskRequestAddLexiconNames (Aws::String &&value)
 
StartSpeechSynthesisTaskRequestAddLexiconNames (const char *value)
 
const OutputFormatGetOutputFormat () const
 
bool OutputFormatHasBeenSet () const
 
void SetOutputFormat (const OutputFormat &value)
 
void SetOutputFormat (OutputFormat &&value)
 
StartSpeechSynthesisTaskRequestWithOutputFormat (const OutputFormat &value)
 
StartSpeechSynthesisTaskRequestWithOutputFormat (OutputFormat &&value)
 
const Aws::StringGetOutputS3BucketName () const
 
bool OutputS3BucketNameHasBeenSet () const
 
void SetOutputS3BucketName (const Aws::String &value)
 
void SetOutputS3BucketName (Aws::String &&value)
 
void SetOutputS3BucketName (const char *value)
 
StartSpeechSynthesisTaskRequestWithOutputS3BucketName (const Aws::String &value)
 
StartSpeechSynthesisTaskRequestWithOutputS3BucketName (Aws::String &&value)
 
StartSpeechSynthesisTaskRequestWithOutputS3BucketName (const char *value)
 
const Aws::StringGetOutputS3KeyPrefix () const
 
bool OutputS3KeyPrefixHasBeenSet () const
 
void SetOutputS3KeyPrefix (const Aws::String &value)
 
void SetOutputS3KeyPrefix (Aws::String &&value)
 
void SetOutputS3KeyPrefix (const char *value)
 
StartSpeechSynthesisTaskRequestWithOutputS3KeyPrefix (const Aws::String &value)
 
StartSpeechSynthesisTaskRequestWithOutputS3KeyPrefix (Aws::String &&value)
 
StartSpeechSynthesisTaskRequestWithOutputS3KeyPrefix (const char *value)
 
const Aws::StringGetSampleRate () const
 
bool SampleRateHasBeenSet () const
 
void SetSampleRate (const Aws::String &value)
 
void SetSampleRate (Aws::String &&value)
 
void SetSampleRate (const char *value)
 
StartSpeechSynthesisTaskRequestWithSampleRate (const Aws::String &value)
 
StartSpeechSynthesisTaskRequestWithSampleRate (Aws::String &&value)
 
StartSpeechSynthesisTaskRequestWithSampleRate (const char *value)
 
const Aws::StringGetSnsTopicArn () const
 
bool SnsTopicArnHasBeenSet () const
 
void SetSnsTopicArn (const Aws::String &value)
 
void SetSnsTopicArn (Aws::String &&value)
 
void SetSnsTopicArn (const char *value)
 
StartSpeechSynthesisTaskRequestWithSnsTopicArn (const Aws::String &value)
 
StartSpeechSynthesisTaskRequestWithSnsTopicArn (Aws::String &&value)
 
StartSpeechSynthesisTaskRequestWithSnsTopicArn (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)
 
StartSpeechSynthesisTaskRequestWithSpeechMarkTypes (const Aws::Vector< SpeechMarkType > &value)
 
StartSpeechSynthesisTaskRequestWithSpeechMarkTypes (Aws::Vector< SpeechMarkType > &&value)
 
StartSpeechSynthesisTaskRequestAddSpeechMarkTypes (const SpeechMarkType &value)
 
StartSpeechSynthesisTaskRequestAddSpeechMarkTypes (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)
 
StartSpeechSynthesisTaskRequestWithText (const Aws::String &value)
 
StartSpeechSynthesisTaskRequestWithText (Aws::String &&value)
 
StartSpeechSynthesisTaskRequestWithText (const char *value)
 
const TextTypeGetTextType () const
 
bool TextTypeHasBeenSet () const
 
void SetTextType (const TextType &value)
 
void SetTextType (TextType &&value)
 
StartSpeechSynthesisTaskRequestWithTextType (const TextType &value)
 
StartSpeechSynthesisTaskRequestWithTextType (TextType &&value)
 
const VoiceIdGetVoiceId () const
 
bool VoiceIdHasBeenSet () const
 
void SetVoiceId (const VoiceId &value)
 
void SetVoiceId (VoiceId &&value)
 
StartSpeechSynthesisTaskRequestWithVoiceId (const VoiceId &value)
 
StartSpeechSynthesisTaskRequestWithVoiceId (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
 

Additional Inherited Members

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

Detailed Description

Definition at line 28 of file StartSpeechSynthesisTaskRequest.h.

Constructor & Destructor Documentation

◆ StartSpeechSynthesisTaskRequest()

Aws::Polly::Model::StartSpeechSynthesisTaskRequest::StartSpeechSynthesisTaskRequest ( )

Member Function Documentation

◆ AddLexiconNames() [1/3]

StartSpeechSynthesisTaskRequest& Aws::Polly::Model::StartSpeechSynthesisTaskRequest::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.

Definition at line 218 of file StartSpeechSynthesisTaskRequest.h.

◆ AddLexiconNames() [2/3]

StartSpeechSynthesisTaskRequest& Aws::Polly::Model::StartSpeechSynthesisTaskRequest::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.

Definition at line 211 of file StartSpeechSynthesisTaskRequest.h.

◆ AddLexiconNames() [3/3]

StartSpeechSynthesisTaskRequest& Aws::Polly::Model::StartSpeechSynthesisTaskRequest::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.

Definition at line 225 of file StartSpeechSynthesisTaskRequest.h.

◆ AddSpeechMarkTypes() [1/2]

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

The type of speech marks returned for the input text.

Definition at line 502 of file StartSpeechSynthesisTaskRequest.h.

◆ AddSpeechMarkTypes() [2/2]

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

The type of speech marks returned for the input text.

Definition at line 507 of file StartSpeechSynthesisTaskRequest.h.

◆ EngineHasBeenSet()

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

Specifies the engine (standard or neural) 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.

Definition at line 54 of file StartSpeechSynthesisTaskRequest.h.

◆ GetEngine()

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

Specifies the engine (standard or neural) 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.

Definition at line 47 of file StartSpeechSynthesisTaskRequest.h.

◆ GetLanguageCode()

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

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 will use 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 96 of file StartSpeechSynthesisTaskRequest.h.

◆ GetLexiconNames()

const Aws::Vector<Aws::String>& Aws::Polly::Model::StartSpeechSynthesisTaskRequest::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.

Definition at line 169 of file StartSpeechSynthesisTaskRequest.h.

◆ GetOutputFormat()

const OutputFormat& Aws::Polly::Model::StartSpeechSynthesisTaskRequest::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.

Definition at line 232 of file StartSpeechSynthesisTaskRequest.h.

◆ GetOutputS3BucketName()

const Aws::String& Aws::Polly::Model::StartSpeechSynthesisTaskRequest::GetOutputS3BucketName ( ) const
inline

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

Definition at line 268 of file StartSpeechSynthesisTaskRequest.h.

◆ GetOutputS3KeyPrefix()

const Aws::String& Aws::Polly::Model::StartSpeechSynthesisTaskRequest::GetOutputS3KeyPrefix ( ) const
inline

The Amazon S3 key prefix for the output speech file.

Definition at line 309 of file StartSpeechSynthesisTaskRequest.h.

◆ GetSampleRate()

const Aws::String& Aws::Polly::Model::StartSpeechSynthesisTaskRequest::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 354 of file StartSpeechSynthesisTaskRequest.h.

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 37 of file StartSpeechSynthesisTaskRequest.h.

◆ GetSnsTopicArn()

const Aws::String& Aws::Polly::Model::StartSpeechSynthesisTaskRequest::GetSnsTopicArn ( ) const
inline

ARN for the SNS topic optionally used for providing status notification for a speech synthesis task.

Definition at line 424 of file StartSpeechSynthesisTaskRequest.h.

◆ GetSpeechMarkTypes()

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

The type of speech marks returned for the input text.

Definition at line 472 of file StartSpeechSynthesisTaskRequest.h.

◆ GetText()

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

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

Definition at line 514 of file StartSpeechSynthesisTaskRequest.h.

◆ GetTextType()

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

Specifies whether the input text is plain text or SSML. The default value is plain text.

Definition at line 563 of file StartSpeechSynthesisTaskRequest.h.

◆ GetVoiceId()

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

Voice ID to use for the synthesis.

Definition at line 599 of file StartSpeechSynthesisTaskRequest.h.

◆ LanguageCodeHasBeenSet()

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

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 will use 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 109 of file StartSpeechSynthesisTaskRequest.h.

◆ LexiconNamesHasBeenSet()

bool Aws::Polly::Model::StartSpeechSynthesisTaskRequest::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.

Definition at line 176 of file StartSpeechSynthesisTaskRequest.h.

◆ OutputFormatHasBeenSet()

bool Aws::Polly::Model::StartSpeechSynthesisTaskRequest::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.

Definition at line 238 of file StartSpeechSynthesisTaskRequest.h.

◆ OutputS3BucketNameHasBeenSet()

bool Aws::Polly::Model::StartSpeechSynthesisTaskRequest::OutputS3BucketNameHasBeenSet ( ) const
inline

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

Definition at line 273 of file StartSpeechSynthesisTaskRequest.h.

◆ OutputS3KeyPrefixHasBeenSet()

bool Aws::Polly::Model::StartSpeechSynthesisTaskRequest::OutputS3KeyPrefixHasBeenSet ( ) const
inline

The Amazon S3 key prefix for the output speech file.

Definition at line 314 of file StartSpeechSynthesisTaskRequest.h.

◆ SampleRateHasBeenSet()

bool Aws::Polly::Model::StartSpeechSynthesisTaskRequest::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 363 of file StartSpeechSynthesisTaskRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetEngine() [1/2]

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

Specifies the engine (standard or neural) 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.

Definition at line 61 of file StartSpeechSynthesisTaskRequest.h.

◆ SetEngine() [2/2]

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

Specifies the engine (standard or neural) 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.

Definition at line 68 of file StartSpeechSynthesisTaskRequest.h.

◆ SetLanguageCode() [1/2]

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

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 will use 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 122 of file StartSpeechSynthesisTaskRequest.h.

◆ SetLanguageCode() [2/2]

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

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 will use 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 135 of file StartSpeechSynthesisTaskRequest.h.

◆ SetLexiconNames() [1/2]

void Aws::Polly::Model::StartSpeechSynthesisTaskRequest::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.

Definition at line 190 of file StartSpeechSynthesisTaskRequest.h.

◆ SetLexiconNames() [2/2]

void Aws::Polly::Model::StartSpeechSynthesisTaskRequest::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.

Definition at line 183 of file StartSpeechSynthesisTaskRequest.h.

◆ SetOutputFormat() [1/2]

void Aws::Polly::Model::StartSpeechSynthesisTaskRequest::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.

Definition at line 244 of file StartSpeechSynthesisTaskRequest.h.

◆ SetOutputFormat() [2/2]

void Aws::Polly::Model::StartSpeechSynthesisTaskRequest::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.

Definition at line 250 of file StartSpeechSynthesisTaskRequest.h.

◆ SetOutputS3BucketName() [1/3]

void Aws::Polly::Model::StartSpeechSynthesisTaskRequest::SetOutputS3BucketName ( Aws::String &&  value)
inline

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

Definition at line 283 of file StartSpeechSynthesisTaskRequest.h.

◆ SetOutputS3BucketName() [2/3]

void Aws::Polly::Model::StartSpeechSynthesisTaskRequest::SetOutputS3BucketName ( const Aws::String value)
inline

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

Definition at line 278 of file StartSpeechSynthesisTaskRequest.h.

◆ SetOutputS3BucketName() [3/3]

void Aws::Polly::Model::StartSpeechSynthesisTaskRequest::SetOutputS3BucketName ( const char *  value)
inline

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

Definition at line 288 of file StartSpeechSynthesisTaskRequest.h.

◆ SetOutputS3KeyPrefix() [1/3]

void Aws::Polly::Model::StartSpeechSynthesisTaskRequest::SetOutputS3KeyPrefix ( Aws::String &&  value)
inline

The Amazon S3 key prefix for the output speech file.

Definition at line 324 of file StartSpeechSynthesisTaskRequest.h.

◆ SetOutputS3KeyPrefix() [2/3]

void Aws::Polly::Model::StartSpeechSynthesisTaskRequest::SetOutputS3KeyPrefix ( const Aws::String value)
inline

The Amazon S3 key prefix for the output speech file.

Definition at line 319 of file StartSpeechSynthesisTaskRequest.h.

◆ SetOutputS3KeyPrefix() [3/3]

void Aws::Polly::Model::StartSpeechSynthesisTaskRequest::SetOutputS3KeyPrefix ( const char *  value)
inline

The Amazon S3 key prefix for the output speech file.

Definition at line 329 of file StartSpeechSynthesisTaskRequest.h.

◆ SetSampleRate() [1/3]

void Aws::Polly::Model::StartSpeechSynthesisTaskRequest::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 381 of file StartSpeechSynthesisTaskRequest.h.

◆ SetSampleRate() [2/3]

void Aws::Polly::Model::StartSpeechSynthesisTaskRequest::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 372 of file StartSpeechSynthesisTaskRequest.h.

◆ SetSampleRate() [3/3]

void Aws::Polly::Model::StartSpeechSynthesisTaskRequest::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 390 of file StartSpeechSynthesisTaskRequest.h.

◆ SetSnsTopicArn() [1/3]

void Aws::Polly::Model::StartSpeechSynthesisTaskRequest::SetSnsTopicArn ( Aws::String &&  value)
inline

ARN for the SNS topic optionally used for providing status notification for a speech synthesis task.

Definition at line 442 of file StartSpeechSynthesisTaskRequest.h.

◆ SetSnsTopicArn() [2/3]

void Aws::Polly::Model::StartSpeechSynthesisTaskRequest::SetSnsTopicArn ( const Aws::String value)
inline

ARN for the SNS topic optionally used for providing status notification for a speech synthesis task.

Definition at line 436 of file StartSpeechSynthesisTaskRequest.h.

◆ SetSnsTopicArn() [3/3]

void Aws::Polly::Model::StartSpeechSynthesisTaskRequest::SetSnsTopicArn ( const char *  value)
inline

ARN for the SNS topic optionally used for providing status notification for a speech synthesis task.

Definition at line 448 of file StartSpeechSynthesisTaskRequest.h.

◆ SetSpeechMarkTypes() [1/2]

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

The type of speech marks returned for the input text.

Definition at line 487 of file StartSpeechSynthesisTaskRequest.h.

◆ SetSpeechMarkTypes() [2/2]

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

The type of speech marks returned for the input text.

Definition at line 482 of file StartSpeechSynthesisTaskRequest.h.

◆ SetText() [1/3]

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

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

Definition at line 532 of file StartSpeechSynthesisTaskRequest.h.

◆ SetText() [2/3]

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

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

Definition at line 526 of file StartSpeechSynthesisTaskRequest.h.

◆ SetText() [3/3]

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

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

Definition at line 538 of file StartSpeechSynthesisTaskRequest.h.

◆ SetTextType() [1/2]

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

Specifies whether the input text is plain text or SSML. The default value is plain text.

Definition at line 575 of file StartSpeechSynthesisTaskRequest.h.

◆ SetTextType() [2/2]

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

Specifies whether the input text is plain text or SSML. The default value is plain text.

Definition at line 581 of file StartSpeechSynthesisTaskRequest.h.

◆ SetVoiceId() [1/2]

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

Voice ID to use for the synthesis.

Definition at line 609 of file StartSpeechSynthesisTaskRequest.h.

◆ SetVoiceId() [2/2]

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

Voice ID to use for the synthesis.

Definition at line 614 of file StartSpeechSynthesisTaskRequest.h.

◆ SnsTopicArnHasBeenSet()

bool Aws::Polly::Model::StartSpeechSynthesisTaskRequest::SnsTopicArnHasBeenSet ( ) const
inline

ARN for the SNS topic optionally used for providing status notification for a speech synthesis task.

Definition at line 430 of file StartSpeechSynthesisTaskRequest.h.

◆ SpeechMarkTypesHasBeenSet()

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

The type of speech marks returned for the input text.

Definition at line 477 of file StartSpeechSynthesisTaskRequest.h.

◆ TextHasBeenSet()

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

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

Definition at line 520 of file StartSpeechSynthesisTaskRequest.h.

◆ TextTypeHasBeenSet()

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

Specifies whether the input text is plain text or SSML. The default value is plain text.

Definition at line 569 of file StartSpeechSynthesisTaskRequest.h.

◆ VoiceIdHasBeenSet()

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

Voice ID to use for the synthesis.

Definition at line 604 of file StartSpeechSynthesisTaskRequest.h.

◆ WithEngine() [1/2]

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

Specifies the engine (standard or neural) 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.

Definition at line 75 of file StartSpeechSynthesisTaskRequest.h.

◆ WithEngine() [2/2]

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

Specifies the engine (standard or neural) 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.

Definition at line 82 of file StartSpeechSynthesisTaskRequest.h.

◆ WithLanguageCode() [1/2]

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

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 will use 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 148 of file StartSpeechSynthesisTaskRequest.h.

◆ WithLanguageCode() [2/2]

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

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 will use 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 161 of file StartSpeechSynthesisTaskRequest.h.

◆ WithLexiconNames() [1/2]

StartSpeechSynthesisTaskRequest& Aws::Polly::Model::StartSpeechSynthesisTaskRequest::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.

Definition at line 204 of file StartSpeechSynthesisTaskRequest.h.

◆ WithLexiconNames() [2/2]

StartSpeechSynthesisTaskRequest& Aws::Polly::Model::StartSpeechSynthesisTaskRequest::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.

Definition at line 197 of file StartSpeechSynthesisTaskRequest.h.

◆ WithOutputFormat() [1/2]

StartSpeechSynthesisTaskRequest& Aws::Polly::Model::StartSpeechSynthesisTaskRequest::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.

Definition at line 256 of file StartSpeechSynthesisTaskRequest.h.

◆ WithOutputFormat() [2/2]

StartSpeechSynthesisTaskRequest& Aws::Polly::Model::StartSpeechSynthesisTaskRequest::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.

Definition at line 262 of file StartSpeechSynthesisTaskRequest.h.

◆ WithOutputS3BucketName() [1/3]

StartSpeechSynthesisTaskRequest& Aws::Polly::Model::StartSpeechSynthesisTaskRequest::WithOutputS3BucketName ( Aws::String &&  value)
inline

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

Definition at line 298 of file StartSpeechSynthesisTaskRequest.h.

◆ WithOutputS3BucketName() [2/3]

StartSpeechSynthesisTaskRequest& Aws::Polly::Model::StartSpeechSynthesisTaskRequest::WithOutputS3BucketName ( const Aws::String value)
inline

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

Definition at line 293 of file StartSpeechSynthesisTaskRequest.h.

◆ WithOutputS3BucketName() [3/3]

StartSpeechSynthesisTaskRequest& Aws::Polly::Model::StartSpeechSynthesisTaskRequest::WithOutputS3BucketName ( const char *  value)
inline

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

Definition at line 303 of file StartSpeechSynthesisTaskRequest.h.

◆ WithOutputS3KeyPrefix() [1/3]

StartSpeechSynthesisTaskRequest& Aws::Polly::Model::StartSpeechSynthesisTaskRequest::WithOutputS3KeyPrefix ( Aws::String &&  value)
inline

The Amazon S3 key prefix for the output speech file.

Definition at line 339 of file StartSpeechSynthesisTaskRequest.h.

◆ WithOutputS3KeyPrefix() [2/3]

StartSpeechSynthesisTaskRequest& Aws::Polly::Model::StartSpeechSynthesisTaskRequest::WithOutputS3KeyPrefix ( const Aws::String value)
inline

The Amazon S3 key prefix for the output speech file.

Definition at line 334 of file StartSpeechSynthesisTaskRequest.h.

◆ WithOutputS3KeyPrefix() [3/3]

StartSpeechSynthesisTaskRequest& Aws::Polly::Model::StartSpeechSynthesisTaskRequest::WithOutputS3KeyPrefix ( const char *  value)
inline

The Amazon S3 key prefix for the output speech file.

Definition at line 344 of file StartSpeechSynthesisTaskRequest.h.

◆ WithSampleRate() [1/3]

StartSpeechSynthesisTaskRequest& Aws::Polly::Model::StartSpeechSynthesisTaskRequest::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 408 of file StartSpeechSynthesisTaskRequest.h.

◆ WithSampleRate() [2/3]

StartSpeechSynthesisTaskRequest& Aws::Polly::Model::StartSpeechSynthesisTaskRequest::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 399 of file StartSpeechSynthesisTaskRequest.h.

◆ WithSampleRate() [3/3]

StartSpeechSynthesisTaskRequest& Aws::Polly::Model::StartSpeechSynthesisTaskRequest::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 417 of file StartSpeechSynthesisTaskRequest.h.

◆ WithSnsTopicArn() [1/3]

StartSpeechSynthesisTaskRequest& Aws::Polly::Model::StartSpeechSynthesisTaskRequest::WithSnsTopicArn ( Aws::String &&  value)
inline

ARN for the SNS topic optionally used for providing status notification for a speech synthesis task.

Definition at line 460 of file StartSpeechSynthesisTaskRequest.h.

◆ WithSnsTopicArn() [2/3]

StartSpeechSynthesisTaskRequest& Aws::Polly::Model::StartSpeechSynthesisTaskRequest::WithSnsTopicArn ( const Aws::String value)
inline

ARN for the SNS topic optionally used for providing status notification for a speech synthesis task.

Definition at line 454 of file StartSpeechSynthesisTaskRequest.h.

◆ WithSnsTopicArn() [3/3]

StartSpeechSynthesisTaskRequest& Aws::Polly::Model::StartSpeechSynthesisTaskRequest::WithSnsTopicArn ( const char *  value)
inline

ARN for the SNS topic optionally used for providing status notification for a speech synthesis task.

Definition at line 466 of file StartSpeechSynthesisTaskRequest.h.

◆ WithSpeechMarkTypes() [1/2]

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

The type of speech marks returned for the input text.

Definition at line 497 of file StartSpeechSynthesisTaskRequest.h.

◆ WithSpeechMarkTypes() [2/2]

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

The type of speech marks returned for the input text.

Definition at line 492 of file StartSpeechSynthesisTaskRequest.h.

◆ WithText() [1/3]

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

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

Definition at line 550 of file StartSpeechSynthesisTaskRequest.h.

◆ WithText() [2/3]

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

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

Definition at line 544 of file StartSpeechSynthesisTaskRequest.h.

◆ WithText() [3/3]

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

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

Definition at line 556 of file StartSpeechSynthesisTaskRequest.h.

◆ WithTextType() [1/2]

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

Specifies whether the input text is plain text or SSML. The default value is plain text.

Definition at line 587 of file StartSpeechSynthesisTaskRequest.h.

◆ WithTextType() [2/2]

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

Specifies whether the input text is plain text or SSML. The default value is plain text.

Definition at line 593 of file StartSpeechSynthesisTaskRequest.h.

◆ WithVoiceId() [1/2]

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

Voice ID to use for the synthesis.

Definition at line 619 of file StartSpeechSynthesisTaskRequest.h.

◆ WithVoiceId() [2/2]

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

Voice ID to use for the synthesis.

Definition at line 624 of file StartSpeechSynthesisTaskRequest.h.


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