AWS SDK for C++  1.9.107
AWS SDK for C++
SynthesizeSpeechRequest.h
Go to the documentation of this file.
1 
6 #pragma once
17 #include <utility>
18 
19 namespace Aws
20 {
21 namespace Polly
22 {
23 namespace Model
24 {
25 
29  {
30  public:
32 
33  // Service request name is the Operation name which will send this request out,
34  // each operation should has unique request name, so that we can get operation's name from this request.
35  // Note: this is not true for response, multiple operations may have the same response name,
36  // so we can not get operation's name from response.
37  inline virtual const char* GetServiceRequestName() const override { return "SynthesizeSpeech"; }
38 
39  Aws::String SerializePayload() const override;
40 
41  protected:
42  void DumpBodyToUrl(Aws::Http::URI& uri ) const override;
43 
44  public:
45 
62  inline const Engine& GetEngine() const{ return m_engine; }
63 
80  inline bool EngineHasBeenSet() const { return m_engineHasBeenSet; }
81 
98  inline void SetEngine(const Engine& value) { m_engineHasBeenSet = true; m_engine = value; }
99 
116  inline void SetEngine(Engine&& value) { m_engineHasBeenSet = true; m_engine = std::move(value); }
117 
134  inline SynthesizeSpeechRequest& WithEngine(const Engine& value) { SetEngine(value); return *this;}
135 
152  inline SynthesizeSpeechRequest& WithEngine(Engine&& value) { SetEngine(std::move(value)); return *this;}
153 
154 
166  inline const LanguageCode& GetLanguageCode() const{ return m_languageCode; }
167 
179  inline bool LanguageCodeHasBeenSet() const { return m_languageCodeHasBeenSet; }
180 
192  inline void SetLanguageCode(const LanguageCode& value) { m_languageCodeHasBeenSet = true; m_languageCode = value; }
193 
205  inline void SetLanguageCode(LanguageCode&& value) { m_languageCodeHasBeenSet = true; m_languageCode = std::move(value); }
206 
218  inline SynthesizeSpeechRequest& WithLanguageCode(const LanguageCode& value) { SetLanguageCode(value); return *this;}
219 
231  inline SynthesizeSpeechRequest& WithLanguageCode(LanguageCode&& value) { SetLanguageCode(std::move(value)); return *this;}
232 
233 
241  inline const Aws::Vector<Aws::String>& GetLexiconNames() const{ return m_lexiconNames; }
242 
250  inline bool LexiconNamesHasBeenSet() const { return m_lexiconNamesHasBeenSet; }
251 
259  inline void SetLexiconNames(const Aws::Vector<Aws::String>& value) { m_lexiconNamesHasBeenSet = true; m_lexiconNames = value; }
260 
268  inline void SetLexiconNames(Aws::Vector<Aws::String>&& value) { m_lexiconNamesHasBeenSet = true; m_lexiconNames = std::move(value); }
269 
277  inline SynthesizeSpeechRequest& WithLexiconNames(const Aws::Vector<Aws::String>& value) { SetLexiconNames(value); return *this;}
278 
286  inline SynthesizeSpeechRequest& WithLexiconNames(Aws::Vector<Aws::String>&& value) { SetLexiconNames(std::move(value)); return *this;}
287 
295  inline SynthesizeSpeechRequest& AddLexiconNames(const Aws::String& value) { m_lexiconNamesHasBeenSet = true; m_lexiconNames.push_back(value); return *this; }
296 
304  inline SynthesizeSpeechRequest& AddLexiconNames(Aws::String&& value) { m_lexiconNamesHasBeenSet = true; m_lexiconNames.push_back(std::move(value)); return *this; }
305 
313  inline SynthesizeSpeechRequest& AddLexiconNames(const char* value) { m_lexiconNamesHasBeenSet = true; m_lexiconNames.push_back(value); return *this; }
314 
315 
322  inline const OutputFormat& GetOutputFormat() const{ return m_outputFormat; }
323 
330  inline bool OutputFormatHasBeenSet() const { return m_outputFormatHasBeenSet; }
331 
338  inline void SetOutputFormat(const OutputFormat& value) { m_outputFormatHasBeenSet = true; m_outputFormat = value; }
339 
346  inline void SetOutputFormat(OutputFormat&& value) { m_outputFormatHasBeenSet = true; m_outputFormat = std::move(value); }
347 
354  inline SynthesizeSpeechRequest& WithOutputFormat(const OutputFormat& value) { SetOutputFormat(value); return *this;}
355 
362  inline SynthesizeSpeechRequest& WithOutputFormat(OutputFormat&& value) { SetOutputFormat(std::move(value)); return *this;}
363 
364 
372  inline const Aws::String& GetSampleRate() const{ return m_sampleRate; }
373 
381  inline bool SampleRateHasBeenSet() const { return m_sampleRateHasBeenSet; }
382 
390  inline void SetSampleRate(const Aws::String& value) { m_sampleRateHasBeenSet = true; m_sampleRate = value; }
391 
399  inline void SetSampleRate(Aws::String&& value) { m_sampleRateHasBeenSet = true; m_sampleRate = std::move(value); }
400 
408  inline void SetSampleRate(const char* value) { m_sampleRateHasBeenSet = true; m_sampleRate.assign(value); }
409 
417  inline SynthesizeSpeechRequest& WithSampleRate(const Aws::String& value) { SetSampleRate(value); return *this;}
418 
426  inline SynthesizeSpeechRequest& WithSampleRate(Aws::String&& value) { SetSampleRate(std::move(value)); return *this;}
427 
435  inline SynthesizeSpeechRequest& WithSampleRate(const char* value) { SetSampleRate(value); return *this;}
436 
437 
441  inline const Aws::Vector<SpeechMarkType>& GetSpeechMarkTypes() const{ return m_speechMarkTypes; }
442 
446  inline bool SpeechMarkTypesHasBeenSet() const { return m_speechMarkTypesHasBeenSet; }
447 
451  inline void SetSpeechMarkTypes(const Aws::Vector<SpeechMarkType>& value) { m_speechMarkTypesHasBeenSet = true; m_speechMarkTypes = value; }
452 
456  inline void SetSpeechMarkTypes(Aws::Vector<SpeechMarkType>&& value) { m_speechMarkTypesHasBeenSet = true; m_speechMarkTypes = std::move(value); }
457 
461  inline SynthesizeSpeechRequest& WithSpeechMarkTypes(const Aws::Vector<SpeechMarkType>& value) { SetSpeechMarkTypes(value); return *this;}
462 
466  inline SynthesizeSpeechRequest& WithSpeechMarkTypes(Aws::Vector<SpeechMarkType>&& value) { SetSpeechMarkTypes(std::move(value)); return *this;}
467 
471  inline SynthesizeSpeechRequest& AddSpeechMarkTypes(const SpeechMarkType& value) { m_speechMarkTypesHasBeenSet = true; m_speechMarkTypes.push_back(value); return *this; }
472 
476  inline SynthesizeSpeechRequest& AddSpeechMarkTypes(SpeechMarkType&& value) { m_speechMarkTypesHasBeenSet = true; m_speechMarkTypes.push_back(std::move(value)); return *this; }
477 
478 
483  inline const Aws::String& GetText() const{ return m_text; }
484 
489  inline bool TextHasBeenSet() const { return m_textHasBeenSet; }
490 
495  inline void SetText(const Aws::String& value) { m_textHasBeenSet = true; m_text = value; }
496 
501  inline void SetText(Aws::String&& value) { m_textHasBeenSet = true; m_text = std::move(value); }
502 
507  inline void SetText(const char* value) { m_textHasBeenSet = true; m_text.assign(value); }
508 
513  inline SynthesizeSpeechRequest& WithText(const Aws::String& value) { SetText(value); return *this;}
514 
519  inline SynthesizeSpeechRequest& WithText(Aws::String&& value) { SetText(std::move(value)); return *this;}
520 
525  inline SynthesizeSpeechRequest& WithText(const char* value) { SetText(value); return *this;}
526 
527 
533  inline const TextType& GetTextType() const{ return m_textType; }
534 
540  inline bool TextTypeHasBeenSet() const { return m_textTypeHasBeenSet; }
541 
547  inline void SetTextType(const TextType& value) { m_textTypeHasBeenSet = true; m_textType = value; }
548 
554  inline void SetTextType(TextType&& value) { m_textTypeHasBeenSet = true; m_textType = std::move(value); }
555 
561  inline SynthesizeSpeechRequest& WithTextType(const TextType& value) { SetTextType(value); return *this;}
562 
568  inline SynthesizeSpeechRequest& WithTextType(TextType&& value) { SetTextType(std::move(value)); return *this;}
569 
570 
577  inline const VoiceId& GetVoiceId() const{ return m_voiceId; }
578 
585  inline bool VoiceIdHasBeenSet() const { return m_voiceIdHasBeenSet; }
586 
593  inline void SetVoiceId(const VoiceId& value) { m_voiceIdHasBeenSet = true; m_voiceId = value; }
594 
601  inline void SetVoiceId(VoiceId&& value) { m_voiceIdHasBeenSet = true; m_voiceId = std::move(value); }
602 
609  inline SynthesizeSpeechRequest& WithVoiceId(const VoiceId& value) { SetVoiceId(value); return *this;}
610 
617  inline SynthesizeSpeechRequest& WithVoiceId(VoiceId&& value) { SetVoiceId(std::move(value)); return *this;}
618 
619  private:
620 
621  Engine m_engine;
622  bool m_engineHasBeenSet;
623 
624  LanguageCode m_languageCode;
625  bool m_languageCodeHasBeenSet;
626 
627  Aws::Vector<Aws::String> m_lexiconNames;
628  bool m_lexiconNamesHasBeenSet;
629 
630  OutputFormat m_outputFormat;
631  bool m_outputFormatHasBeenSet;
632 
633  Aws::String m_sampleRate;
634  bool m_sampleRateHasBeenSet;
635 
636  Aws::Vector<SpeechMarkType> m_speechMarkTypes;
637  bool m_speechMarkTypesHasBeenSet;
638 
639  Aws::String m_text;
640  bool m_textHasBeenSet;
641 
642  TextType m_textType;
643  bool m_textTypeHasBeenSet;
644 
645  VoiceId m_voiceId;
646  bool m_voiceIdHasBeenSet;
647  };
648 
649 } // namespace Model
650 } // namespace Polly
651 } // namespace Aws
Aws::Polly::Model::SynthesizeSpeechRequest::AddSpeechMarkTypes
SynthesizeSpeechRequest & AddSpeechMarkTypes(SpeechMarkType &&value)
Definition: SynthesizeSpeechRequest.h:476
Aws::Polly::Model::SynthesizeSpeechRequest::WithText
SynthesizeSpeechRequest & WithText(Aws::String &&value)
Definition: SynthesizeSpeechRequest.h:519
Aws::Polly::Model::SynthesizeSpeechRequest::WithLanguageCode
SynthesizeSpeechRequest & WithLanguageCode(const LanguageCode &value)
Definition: SynthesizeSpeechRequest.h:218
Aws::Polly::Model::SynthesizeSpeechRequest::SetTextType
void SetTextType(const TextType &value)
Definition: SynthesizeSpeechRequest.h:547
Aws::Polly::Model::SynthesizeSpeechRequest::DumpBodyToUrl
void DumpBodyToUrl(Aws::Http::URI &uri) const override
Aws::Http::URI
Definition: URI.h:32
Aws::Polly::Model::SynthesizeSpeechRequest::SetVoiceId
void SetVoiceId(const VoiceId &value)
Definition: SynthesizeSpeechRequest.h:593
Aws::Polly::Model::SynthesizeSpeechRequest::AddLexiconNames
SynthesizeSpeechRequest & AddLexiconNames(const char *value)
Definition: SynthesizeSpeechRequest.h:313
Aws::Polly::Model::SynthesizeSpeechRequest::WithEngine
SynthesizeSpeechRequest & WithEngine(Engine &&value)
Definition: SynthesizeSpeechRequest.h:152
Aws::Polly::Model::SynthesizeSpeechRequest::WithVoiceId
SynthesizeSpeechRequest & WithVoiceId(const VoiceId &value)
Definition: SynthesizeSpeechRequest.h:609
Aws::Polly::Model::SynthesizeSpeechRequest::WithEngine
SynthesizeSpeechRequest & WithEngine(const Engine &value)
Definition: SynthesizeSpeechRequest.h:134
Aws::Polly::Model::SynthesizeSpeechRequest::AddLexiconNames
SynthesizeSpeechRequest & AddLexiconNames(const Aws::String &value)
Definition: SynthesizeSpeechRequest.h:295
Aws::Polly::Model::SynthesizeSpeechRequest::SetLanguageCode
void SetLanguageCode(const LanguageCode &value)
Definition: SynthesizeSpeechRequest.h:192
Aws::Polly::Model::SpeechMarkType
SpeechMarkType
Definition: SpeechMarkType.h:17
Aws::Polly::Model::SynthesizeSpeechRequest::GetTextType
const TextType & GetTextType() const
Definition: SynthesizeSpeechRequest.h:533
Polly_EXPORTS.h
Aws::Polly::Model::SynthesizeSpeechRequest::SetOutputFormat
void SetOutputFormat(OutputFormat &&value)
Definition: SynthesizeSpeechRequest.h:346
AWS_POLLY_API
#define AWS_POLLY_API
Definition: Polly_EXPORTS.h:28
Aws::Polly::Model::SynthesizeSpeechRequest::WithSpeechMarkTypes
SynthesizeSpeechRequest & WithSpeechMarkTypes(const Aws::Vector< SpeechMarkType > &value)
Definition: SynthesizeSpeechRequest.h:461
Aws::Polly::Model::SynthesizeSpeechRequest::WithLanguageCode
SynthesizeSpeechRequest & WithLanguageCode(LanguageCode &&value)
Definition: SynthesizeSpeechRequest.h:231
Aws::Polly::Model::SynthesizeSpeechRequest::WithSampleRate
SynthesizeSpeechRequest & WithSampleRate(const Aws::String &value)
Definition: SynthesizeSpeechRequest.h:417
Aws::Vector
std::vector< T, Aws::Allocator< T > > Vector
Definition: AWSVector.h:17
Aws::Polly::Model::SynthesizeSpeechRequest::WithSampleRate
SynthesizeSpeechRequest & WithSampleRate(const char *value)
Definition: SynthesizeSpeechRequest.h:435
Aws::Polly::Model::SynthesizeSpeechRequest::SetTextType
void SetTextType(TextType &&value)
Definition: SynthesizeSpeechRequest.h:554
Engine.h
Aws::Polly::Model::SynthesizeSpeechRequest::WithLexiconNames
SynthesizeSpeechRequest & WithLexiconNames(Aws::Vector< Aws::String > &&value)
Definition: SynthesizeSpeechRequest.h:286
Aws::Polly::Model::SynthesizeSpeechRequest::SetLexiconNames
void SetLexiconNames(Aws::Vector< Aws::String > &&value)
Definition: SynthesizeSpeechRequest.h:268
LanguageCode.h
AWSVector.h
Aws::Polly::Model::SynthesizeSpeechRequest::SetSampleRate
void SetSampleRate(const Aws::String &value)
Definition: SynthesizeSpeechRequest.h:390
Aws::Polly::Model::SynthesizeSpeechRequest::AddLexiconNames
SynthesizeSpeechRequest & AddLexiconNames(Aws::String &&value)
Definition: SynthesizeSpeechRequest.h:304
Aws::Polly::Model::SynthesizeSpeechRequest::GetSpeechMarkTypes
const Aws::Vector< SpeechMarkType > & GetSpeechMarkTypes() const
Definition: SynthesizeSpeechRequest.h:441
Aws::Polly::Model::SynthesizeSpeechRequest::AddSpeechMarkTypes
SynthesizeSpeechRequest & AddSpeechMarkTypes(const SpeechMarkType &value)
Definition: SynthesizeSpeechRequest.h:471
Aws::Polly::Model::SynthesizeSpeechRequest::WithVoiceId
SynthesizeSpeechRequest & WithVoiceId(VoiceId &&value)
Definition: SynthesizeSpeechRequest.h:617
Aws::Polly::Model::SynthesizeSpeechRequest::WithSpeechMarkTypes
SynthesizeSpeechRequest & WithSpeechMarkTypes(Aws::Vector< SpeechMarkType > &&value)
Definition: SynthesizeSpeechRequest.h:466
Aws::Polly::Model::SynthesizeSpeechRequest::SetText
void SetText(const char *value)
Definition: SynthesizeSpeechRequest.h:507
Aws::Polly::Model::SynthesizeSpeechRequest::SetEngine
void SetEngine(const Engine &value)
Definition: SynthesizeSpeechRequest.h:98
Aws::Polly::Model::SynthesizeSpeechRequest::SetOutputFormat
void SetOutputFormat(const OutputFormat &value)
Definition: SynthesizeSpeechRequest.h:338
Aws::Polly::Model::SynthesizeSpeechRequest::SpeechMarkTypesHasBeenSet
bool SpeechMarkTypesHasBeenSet() const
Definition: SynthesizeSpeechRequest.h:446
OutputFormat.h
Aws::Polly::Model::SynthesizeSpeechRequest::OutputFormatHasBeenSet
bool OutputFormatHasBeenSet() const
Definition: SynthesizeSpeechRequest.h:330
Aws::Polly::Model::SynthesizeSpeechRequest::GetServiceRequestName
virtual const char * GetServiceRequestName() const override
Definition: SynthesizeSpeechRequest.h:37
Aws::Polly::Model::SynthesizeSpeechRequest::SetSpeechMarkTypes
void SetSpeechMarkTypes(const Aws::Vector< SpeechMarkType > &value)
Definition: SynthesizeSpeechRequest.h:451
Aws::Polly::Model::VoiceId
VoiceId
Definition: VoiceId.h:17
Aws::Polly::PollyRequest
Definition: PollyRequest.h:17
VoiceId.h
Aws::Polly::Model::SynthesizeSpeechRequest::TextTypeHasBeenSet
bool TextTypeHasBeenSet() const
Definition: SynthesizeSpeechRequest.h:540
Aws::Polly::Model::TextType
TextType
Definition: TextType.h:17
Aws::Polly::Model::SynthesizeSpeechRequest::GetOutputFormat
const OutputFormat & GetOutputFormat() const
Definition: SynthesizeSpeechRequest.h:322
Aws::Polly::Model::SynthesizeSpeechRequest::LexiconNamesHasBeenSet
bool LexiconNamesHasBeenSet() const
Definition: SynthesizeSpeechRequest.h:250
Aws::Polly::Model::SynthesizeSpeechRequest::SetLanguageCode
void SetLanguageCode(LanguageCode &&value)
Definition: SynthesizeSpeechRequest.h:205
AWSString.h
Aws::Polly::Model::SynthesizeSpeechRequest::SetSampleRate
void SetSampleRate(const char *value)
Definition: SynthesizeSpeechRequest.h:408
Aws::Polly::Model::SynthesizeSpeechRequest::SetSpeechMarkTypes
void SetSpeechMarkTypes(Aws::Vector< SpeechMarkType > &&value)
Definition: SynthesizeSpeechRequest.h:456
SpeechMarkType.h
Aws::Polly::Model::SynthesizeSpeechRequest::GetEngine
const Engine & GetEngine() const
Definition: SynthesizeSpeechRequest.h:62
Aws::Polly::Model::SynthesizeSpeechRequest::GetVoiceId
const VoiceId & GetVoiceId() const
Definition: SynthesizeSpeechRequest.h:577
Aws::Polly::Model::SynthesizeSpeechRequest::SetSampleRate
void SetSampleRate(Aws::String &&value)
Definition: SynthesizeSpeechRequest.h:399
Aws::Polly::Model::SynthesizeSpeechRequest::SetText
void SetText(Aws::String &&value)
Definition: SynthesizeSpeechRequest.h:501
Aws::Polly::Model::SynthesizeSpeechRequest::GetText
const Aws::String & GetText() const
Definition: SynthesizeSpeechRequest.h:483
Aws::Polly::Model::SynthesizeSpeechRequest::VoiceIdHasBeenSet
bool VoiceIdHasBeenSet() const
Definition: SynthesizeSpeechRequest.h:585
Aws::Polly::Model::SynthesizeSpeechRequest::SerializePayload
Aws::String SerializePayload() const override
Aws::Polly::Model::SynthesizeSpeechRequest::WithOutputFormat
SynthesizeSpeechRequest & WithOutputFormat(const OutputFormat &value)
Definition: SynthesizeSpeechRequest.h:354
Aws::Polly::Model::SynthesizeSpeechRequest::GetLexiconNames
const Aws::Vector< Aws::String > & GetLexiconNames() const
Definition: SynthesizeSpeechRequest.h:241
Aws::Polly::Model::SynthesizeSpeechRequest::GetSampleRate
const Aws::String & GetSampleRate() const
Definition: SynthesizeSpeechRequest.h:372
Aws::Polly::Model::SynthesizeSpeechRequest::WithText
SynthesizeSpeechRequest & WithText(const char *value)
Definition: SynthesizeSpeechRequest.h:525
Aws::Polly::Model::OutputFormat
OutputFormat
Definition: OutputFormat.h:17
Aws
Definition: AccessManagementClient.h:15
Aws::Polly::Model::SynthesizeSpeechRequest::SetEngine
void SetEngine(Engine &&value)
Definition: SynthesizeSpeechRequest.h:116
Aws::Polly::Model::SynthesizeSpeechRequest::LanguageCodeHasBeenSet
bool LanguageCodeHasBeenSet() const
Definition: SynthesizeSpeechRequest.h:179
Aws::Polly::Model::SynthesizeSpeechRequest::TextHasBeenSet
bool TextHasBeenSet() const
Definition: SynthesizeSpeechRequest.h:489
Aws::Polly::Model::SynthesizeSpeechRequest::SynthesizeSpeechRequest
SynthesizeSpeechRequest()
Aws::Polly::Model::SynthesizeSpeechRequest::SetLexiconNames
void SetLexiconNames(const Aws::Vector< Aws::String > &value)
Definition: SynthesizeSpeechRequest.h:259
TextType.h
Aws::Polly::Model::SynthesizeSpeechRequest::SetText
void SetText(const Aws::String &value)
Definition: SynthesizeSpeechRequest.h:495
Aws::Polly::Model::SynthesizeSpeechRequest::EngineHasBeenSet
bool EngineHasBeenSet() const
Definition: SynthesizeSpeechRequest.h:80
Aws::String
std::basic_string< char, std::char_traits< char >, Aws::Allocator< char > > String
Definition: AWSString.h:97
Aws::Polly::Model::SynthesizeSpeechRequest::WithLexiconNames
SynthesizeSpeechRequest & WithLexiconNames(const Aws::Vector< Aws::String > &value)
Definition: SynthesizeSpeechRequest.h:277
Aws::Polly::Model::SynthesizeSpeechRequest
Definition: SynthesizeSpeechRequest.h:29
Aws::Polly::Model::SynthesizeSpeechRequest::WithOutputFormat
SynthesizeSpeechRequest & WithOutputFormat(OutputFormat &&value)
Definition: SynthesizeSpeechRequest.h:362
Aws::Polly::Model::SynthesizeSpeechRequest::SampleRateHasBeenSet
bool SampleRateHasBeenSet() const
Definition: SynthesizeSpeechRequest.h:381
Aws::Polly::Model::SynthesizeSpeechRequest::GetLanguageCode
const LanguageCode & GetLanguageCode() const
Definition: SynthesizeSpeechRequest.h:166
Aws::Polly::Model::LanguageCode
LanguageCode
Definition: LanguageCode.h:17
Aws::Polly::Model::SynthesizeSpeechRequest::WithTextType
SynthesizeSpeechRequest & WithTextType(TextType &&value)
Definition: SynthesizeSpeechRequest.h:568
Aws::Polly::Model::SynthesizeSpeechRequest::SetVoiceId
void SetVoiceId(VoiceId &&value)
Definition: SynthesizeSpeechRequest.h:601
PollyRequest.h
Aws::Polly::Model::SynthesizeSpeechRequest::WithText
SynthesizeSpeechRequest & WithText(const Aws::String &value)
Definition: SynthesizeSpeechRequest.h:513
Aws::Polly::Model::Engine
Engine
Definition: Engine.h:17
Aws::Polly::Model::SynthesizeSpeechRequest::WithTextType
SynthesizeSpeechRequest & WithTextType(const TextType &value)
Definition: SynthesizeSpeechRequest.h:561
Aws::Polly::Model::SynthesizeSpeechRequest::WithSampleRate
SynthesizeSpeechRequest & WithSampleRate(Aws::String &&value)
Definition: SynthesizeSpeechRequest.h:426