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

#include <SynthesisTask.h>

Public Member Functions

 SynthesisTask ()
 
 SynthesisTask (Aws::Utils::Json::JsonView jsonValue)
 
SynthesisTaskoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const EngineGetEngine () const
 
bool EngineHasBeenSet () const
 
void SetEngine (const Engine &value)
 
void SetEngine (Engine &&value)
 
SynthesisTaskWithEngine (const Engine &value)
 
SynthesisTaskWithEngine (Engine &&value)
 
const Aws::StringGetTaskId () const
 
bool TaskIdHasBeenSet () const
 
void SetTaskId (const Aws::String &value)
 
void SetTaskId (Aws::String &&value)
 
void SetTaskId (const char *value)
 
SynthesisTaskWithTaskId (const Aws::String &value)
 
SynthesisTaskWithTaskId (Aws::String &&value)
 
SynthesisTaskWithTaskId (const char *value)
 
const TaskStatusGetTaskStatus () const
 
bool TaskStatusHasBeenSet () const
 
void SetTaskStatus (const TaskStatus &value)
 
void SetTaskStatus (TaskStatus &&value)
 
SynthesisTaskWithTaskStatus (const TaskStatus &value)
 
SynthesisTaskWithTaskStatus (TaskStatus &&value)
 
const Aws::StringGetTaskStatusReason () const
 
bool TaskStatusReasonHasBeenSet () const
 
void SetTaskStatusReason (const Aws::String &value)
 
void SetTaskStatusReason (Aws::String &&value)
 
void SetTaskStatusReason (const char *value)
 
SynthesisTaskWithTaskStatusReason (const Aws::String &value)
 
SynthesisTaskWithTaskStatusReason (Aws::String &&value)
 
SynthesisTaskWithTaskStatusReason (const char *value)
 
const Aws::StringGetOutputUri () const
 
bool OutputUriHasBeenSet () const
 
void SetOutputUri (const Aws::String &value)
 
void SetOutputUri (Aws::String &&value)
 
void SetOutputUri (const char *value)
 
SynthesisTaskWithOutputUri (const Aws::String &value)
 
SynthesisTaskWithOutputUri (Aws::String &&value)
 
SynthesisTaskWithOutputUri (const char *value)
 
const Aws::Utils::DateTimeGetCreationTime () const
 
bool CreationTimeHasBeenSet () const
 
void SetCreationTime (const Aws::Utils::DateTime &value)
 
void SetCreationTime (Aws::Utils::DateTime &&value)
 
SynthesisTaskWithCreationTime (const Aws::Utils::DateTime &value)
 
SynthesisTaskWithCreationTime (Aws::Utils::DateTime &&value)
 
int GetRequestCharacters () const
 
bool RequestCharactersHasBeenSet () const
 
void SetRequestCharacters (int value)
 
SynthesisTaskWithRequestCharacters (int value)
 
const Aws::StringGetSnsTopicArn () const
 
bool SnsTopicArnHasBeenSet () const
 
void SetSnsTopicArn (const Aws::String &value)
 
void SetSnsTopicArn (Aws::String &&value)
 
void SetSnsTopicArn (const char *value)
 
SynthesisTaskWithSnsTopicArn (const Aws::String &value)
 
SynthesisTaskWithSnsTopicArn (Aws::String &&value)
 
SynthesisTaskWithSnsTopicArn (const char *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)
 
SynthesisTaskWithLexiconNames (const Aws::Vector< Aws::String > &value)
 
SynthesisTaskWithLexiconNames (Aws::Vector< Aws::String > &&value)
 
SynthesisTaskAddLexiconNames (const Aws::String &value)
 
SynthesisTaskAddLexiconNames (Aws::String &&value)
 
SynthesisTaskAddLexiconNames (const char *value)
 
const OutputFormatGetOutputFormat () const
 
bool OutputFormatHasBeenSet () const
 
void SetOutputFormat (const OutputFormat &value)
 
void SetOutputFormat (OutputFormat &&value)
 
SynthesisTaskWithOutputFormat (const OutputFormat &value)
 
SynthesisTaskWithOutputFormat (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)
 
SynthesisTaskWithSampleRate (const Aws::String &value)
 
SynthesisTaskWithSampleRate (Aws::String &&value)
 
SynthesisTaskWithSampleRate (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)
 
SynthesisTaskWithSpeechMarkTypes (const Aws::Vector< SpeechMarkType > &value)
 
SynthesisTaskWithSpeechMarkTypes (Aws::Vector< SpeechMarkType > &&value)
 
SynthesisTaskAddSpeechMarkTypes (const SpeechMarkType &value)
 
SynthesisTaskAddSpeechMarkTypes (SpeechMarkType &&value)
 
const TextTypeGetTextType () const
 
bool TextTypeHasBeenSet () const
 
void SetTextType (const TextType &value)
 
void SetTextType (TextType &&value)
 
SynthesisTaskWithTextType (const TextType &value)
 
SynthesisTaskWithTextType (TextType &&value)
 
const VoiceIdGetVoiceId () const
 
bool VoiceIdHasBeenSet () const
 
void SetVoiceId (const VoiceId &value)
 
void SetVoiceId (VoiceId &&value)
 
SynthesisTaskWithVoiceId (const VoiceId &value)
 
SynthesisTaskWithVoiceId (VoiceId &&value)
 
const LanguageCodeGetLanguageCode () const
 
bool LanguageCodeHasBeenSet () const
 
void SetLanguageCode (const LanguageCode &value)
 
void SetLanguageCode (LanguageCode &&value)
 
SynthesisTaskWithLanguageCode (const LanguageCode &value)
 
SynthesisTaskWithLanguageCode (LanguageCode &&value)
 

Detailed Description

SynthesisTask object that provides information about a speech synthesis task.

See Also:

AWS API Reference

Definition at line 41 of file SynthesisTask.h.

Constructor & Destructor Documentation

◆ SynthesisTask() [1/2]

Aws::Polly::Model::SynthesisTask::SynthesisTask ( )

◆ SynthesisTask() [2/2]

Aws::Polly::Model::SynthesisTask::SynthesisTask ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ AddLexiconNames() [1/3]

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

◆ AddLexiconNames() [2/3]

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

◆ AddLexiconNames() [3/3]

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

◆ AddSpeechMarkTypes() [1/2]

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

The type of speech marks returned for the input text.

Definition at line 563 of file SynthesisTask.h.

◆ AddSpeechMarkTypes() [2/2]

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

The type of speech marks returned for the input text.

Definition at line 568 of file SynthesisTask.h.

◆ CreationTimeHasBeenSet()

bool Aws::Polly::Model::SynthesisTask::CreationTimeHasBeenSet ( ) const
inline

Timestamp for the time the synthesis task was started.

Definition at line 263 of file SynthesisTask.h.

◆ EngineHasBeenSet()

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

◆ GetCreationTime()

const Aws::Utils::DateTime& Aws::Polly::Model::SynthesisTask::GetCreationTime ( ) const
inline

Timestamp for the time the synthesis task was started.

Definition at line 258 of file SynthesisTask.h.

◆ GetEngine()

const Engine& Aws::Polly::Model::SynthesisTask::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 55 of file SynthesisTask.h.

◆ GetLanguageCode()

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

Optional language code for a synthesis task. 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 649 of file SynthesisTask.h.

◆ GetLexiconNames()

const Aws::Vector<Aws::String>& Aws::Polly::Model::SynthesisTask::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 361 of file SynthesisTask.h.

◆ GetOutputFormat()

const OutputFormat& Aws::Polly::Model::SynthesisTask::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 424 of file SynthesisTask.h.

◆ GetOutputUri()

const Aws::String& Aws::Polly::Model::SynthesisTask::GetOutputUri ( ) const
inline

Pathway for the output speech file.

Definition at line 217 of file SynthesisTask.h.

◆ GetRequestCharacters()

int Aws::Polly::Model::SynthesisTask::GetRequestCharacters ( ) const
inline

Number of billable characters synthesized.

Definition at line 289 of file SynthesisTask.h.

◆ GetSampleRate()

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

◆ GetSnsTopicArn()

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

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

Definition at line 311 of file SynthesisTask.h.

◆ GetSpeechMarkTypes()

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

The type of speech marks returned for the input text.

Definition at line 533 of file SynthesisTask.h.

◆ GetTaskId()

const Aws::String& Aws::Polly::Model::SynthesisTask::GetTaskId ( ) const
inline

The Amazon Polly generated identifier for a speech synthesis task.

Definition at line 96 of file SynthesisTask.h.

◆ GetTaskStatus()

const TaskStatus& Aws::Polly::Model::SynthesisTask::GetTaskStatus ( ) const
inline

Current status of the individual speech synthesis task.

Definition at line 137 of file SynthesisTask.h.

◆ GetTaskStatusReason()

const Aws::String& Aws::Polly::Model::SynthesisTask::GetTaskStatusReason ( ) const
inline

Reason for the current status of a specific speech synthesis task, including errors if the task has failed.

Definition at line 169 of file SynthesisTask.h.

◆ GetTextType()

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

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

Definition at line 575 of file SynthesisTask.h.

◆ GetVoiceId()

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

Voice ID to use for the synthesis.

Definition at line 611 of file SynthesisTask.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::Polly::Model::SynthesisTask::Jsonize ( ) const

◆ LanguageCodeHasBeenSet()

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

Optional language code for a synthesis task. 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 661 of file SynthesisTask.h.

◆ LexiconNamesHasBeenSet()

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

◆ operator=()

SynthesisTask& Aws::Polly::Model::SynthesisTask::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ OutputFormatHasBeenSet()

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

◆ OutputUriHasBeenSet()

bool Aws::Polly::Model::SynthesisTask::OutputUriHasBeenSet ( ) const
inline

Pathway for the output speech file.

Definition at line 222 of file SynthesisTask.h.

◆ RequestCharactersHasBeenSet()

bool Aws::Polly::Model::SynthesisTask::RequestCharactersHasBeenSet ( ) const
inline

Number of billable characters synthesized.

Definition at line 294 of file SynthesisTask.h.

◆ SampleRateHasBeenSet()

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

◆ SetCreationTime() [1/2]

void Aws::Polly::Model::SynthesisTask::SetCreationTime ( Aws::Utils::DateTime &&  value)
inline

Timestamp for the time the synthesis task was started.

Definition at line 273 of file SynthesisTask.h.

◆ SetCreationTime() [2/2]

void Aws::Polly::Model::SynthesisTask::SetCreationTime ( const Aws::Utils::DateTime value)
inline

Timestamp for the time the synthesis task was started.

Definition at line 268 of file SynthesisTask.h.

◆ SetEngine() [1/2]

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

◆ SetEngine() [2/2]

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

◆ SetLanguageCode() [1/2]

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

Optional language code for a synthesis task. 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 673 of file SynthesisTask.h.

◆ SetLanguageCode() [2/2]

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

Optional language code for a synthesis task. 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 685 of file SynthesisTask.h.

◆ SetLexiconNames() [1/2]

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

◆ SetLexiconNames() [2/2]

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

◆ SetOutputFormat() [1/2]

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

◆ SetOutputFormat() [2/2]

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

◆ SetOutputUri() [1/3]

void Aws::Polly::Model::SynthesisTask::SetOutputUri ( Aws::String &&  value)
inline

Pathway for the output speech file.

Definition at line 232 of file SynthesisTask.h.

◆ SetOutputUri() [2/3]

void Aws::Polly::Model::SynthesisTask::SetOutputUri ( const Aws::String value)
inline

Pathway for the output speech file.

Definition at line 227 of file SynthesisTask.h.

◆ SetOutputUri() [3/3]

void Aws::Polly::Model::SynthesisTask::SetOutputUri ( const char *  value)
inline

Pathway for the output speech file.

Definition at line 237 of file SynthesisTask.h.

◆ SetRequestCharacters()

void Aws::Polly::Model::SynthesisTask::SetRequestCharacters ( int  value)
inline

Number of billable characters synthesized.

Definition at line 299 of file SynthesisTask.h.

◆ SetSampleRate() [1/3]

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

◆ SetSampleRate() [2/3]

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

◆ SetSampleRate() [3/3]

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

◆ SetSnsTopicArn() [1/3]

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

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

Definition at line 329 of file SynthesisTask.h.

◆ SetSnsTopicArn() [2/3]

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

◆ SetSnsTopicArn() [3/3]

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

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

Definition at line 335 of file SynthesisTask.h.

◆ SetSpeechMarkTypes() [1/2]

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

The type of speech marks returned for the input text.

Definition at line 548 of file SynthesisTask.h.

◆ SetSpeechMarkTypes() [2/2]

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

The type of speech marks returned for the input text.

Definition at line 543 of file SynthesisTask.h.

◆ SetTaskId() [1/3]

void Aws::Polly::Model::SynthesisTask::SetTaskId ( Aws::String &&  value)
inline

The Amazon Polly generated identifier for a speech synthesis task.

Definition at line 111 of file SynthesisTask.h.

◆ SetTaskId() [2/3]

void Aws::Polly::Model::SynthesisTask::SetTaskId ( const Aws::String value)
inline

The Amazon Polly generated identifier for a speech synthesis task.

Definition at line 106 of file SynthesisTask.h.

◆ SetTaskId() [3/3]

void Aws::Polly::Model::SynthesisTask::SetTaskId ( const char *  value)
inline

The Amazon Polly generated identifier for a speech synthesis task.

Definition at line 116 of file SynthesisTask.h.

◆ SetTaskStatus() [1/2]

void Aws::Polly::Model::SynthesisTask::SetTaskStatus ( const TaskStatus value)
inline

Current status of the individual speech synthesis task.

Definition at line 147 of file SynthesisTask.h.

◆ SetTaskStatus() [2/2]

void Aws::Polly::Model::SynthesisTask::SetTaskStatus ( TaskStatus &&  value)
inline

Current status of the individual speech synthesis task.

Definition at line 152 of file SynthesisTask.h.

◆ SetTaskStatusReason() [1/3]

void Aws::Polly::Model::SynthesisTask::SetTaskStatusReason ( Aws::String &&  value)
inline

Reason for the current status of a specific speech synthesis task, including errors if the task has failed.

Definition at line 187 of file SynthesisTask.h.

◆ SetTaskStatusReason() [2/3]

void Aws::Polly::Model::SynthesisTask::SetTaskStatusReason ( const Aws::String value)
inline

Reason for the current status of a specific speech synthesis task, including errors if the task has failed.

Definition at line 181 of file SynthesisTask.h.

◆ SetTaskStatusReason() [3/3]

void Aws::Polly::Model::SynthesisTask::SetTaskStatusReason ( const char *  value)
inline

Reason for the current status of a specific speech synthesis task, including errors if the task has failed.

Definition at line 193 of file SynthesisTask.h.

◆ SetTextType() [1/2]

void Aws::Polly::Model::SynthesisTask::SetTextType ( 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 SynthesisTask.h.

◆ SetTextType() [2/2]

void Aws::Polly::Model::SynthesisTask::SetTextType ( 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 SynthesisTask.h.

◆ SetVoiceId() [1/2]

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

Voice ID to use for the synthesis.

Definition at line 621 of file SynthesisTask.h.

◆ SetVoiceId() [2/2]

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

Voice ID to use for the synthesis.

Definition at line 626 of file SynthesisTask.h.

◆ SnsTopicArnHasBeenSet()

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

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

Definition at line 317 of file SynthesisTask.h.

◆ SpeechMarkTypesHasBeenSet()

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

The type of speech marks returned for the input text.

Definition at line 538 of file SynthesisTask.h.

◆ TaskIdHasBeenSet()

bool Aws::Polly::Model::SynthesisTask::TaskIdHasBeenSet ( ) const
inline

The Amazon Polly generated identifier for a speech synthesis task.

Definition at line 101 of file SynthesisTask.h.

◆ TaskStatusHasBeenSet()

bool Aws::Polly::Model::SynthesisTask::TaskStatusHasBeenSet ( ) const
inline

Current status of the individual speech synthesis task.

Definition at line 142 of file SynthesisTask.h.

◆ TaskStatusReasonHasBeenSet()

bool Aws::Polly::Model::SynthesisTask::TaskStatusReasonHasBeenSet ( ) const
inline

Reason for the current status of a specific speech synthesis task, including errors if the task has failed.

Definition at line 175 of file SynthesisTask.h.

◆ TextTypeHasBeenSet()

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

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

Definition at line 581 of file SynthesisTask.h.

◆ VoiceIdHasBeenSet()

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

Voice ID to use for the synthesis.

Definition at line 616 of file SynthesisTask.h.

◆ WithCreationTime() [1/2]

SynthesisTask& Aws::Polly::Model::SynthesisTask::WithCreationTime ( Aws::Utils::DateTime &&  value)
inline

Timestamp for the time the synthesis task was started.

Definition at line 283 of file SynthesisTask.h.

◆ WithCreationTime() [2/2]

SynthesisTask& Aws::Polly::Model::SynthesisTask::WithCreationTime ( const Aws::Utils::DateTime value)
inline

Timestamp for the time the synthesis task was started.

Definition at line 278 of file SynthesisTask.h.

◆ WithEngine() [1/2]

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

◆ WithEngine() [2/2]

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

◆ WithLanguageCode() [1/2]

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

Optional language code for a synthesis task. 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 697 of file SynthesisTask.h.

◆ WithLanguageCode() [2/2]

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

Optional language code for a synthesis task. 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 709 of file SynthesisTask.h.

◆ WithLexiconNames() [1/2]

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

◆ WithLexiconNames() [2/2]

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

◆ WithOutputFormat() [1/2]

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

◆ WithOutputFormat() [2/2]

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

◆ WithOutputUri() [1/3]

SynthesisTask& Aws::Polly::Model::SynthesisTask::WithOutputUri ( Aws::String &&  value)
inline

Pathway for the output speech file.

Definition at line 247 of file SynthesisTask.h.

◆ WithOutputUri() [2/3]

SynthesisTask& Aws::Polly::Model::SynthesisTask::WithOutputUri ( const Aws::String value)
inline

Pathway for the output speech file.

Definition at line 242 of file SynthesisTask.h.

◆ WithOutputUri() [3/3]

SynthesisTask& Aws::Polly::Model::SynthesisTask::WithOutputUri ( const char *  value)
inline

Pathway for the output speech file.

Definition at line 252 of file SynthesisTask.h.

◆ WithRequestCharacters()

SynthesisTask& Aws::Polly::Model::SynthesisTask::WithRequestCharacters ( int  value)
inline

Number of billable characters synthesized.

Definition at line 304 of file SynthesisTask.h.

◆ WithSampleRate() [1/3]

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

◆ WithSampleRate() [2/3]

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

◆ WithSampleRate() [3/3]

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

◆ WithSnsTopicArn() [1/3]

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

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

Definition at line 347 of file SynthesisTask.h.

◆ WithSnsTopicArn() [2/3]

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

◆ WithSnsTopicArn() [3/3]

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

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

Definition at line 353 of file SynthesisTask.h.

◆ WithSpeechMarkTypes() [1/2]

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

The type of speech marks returned for the input text.

Definition at line 558 of file SynthesisTask.h.

◆ WithSpeechMarkTypes() [2/2]

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

The type of speech marks returned for the input text.

Definition at line 553 of file SynthesisTask.h.

◆ WithTaskId() [1/3]

SynthesisTask& Aws::Polly::Model::SynthesisTask::WithTaskId ( Aws::String &&  value)
inline

The Amazon Polly generated identifier for a speech synthesis task.

Definition at line 126 of file SynthesisTask.h.

◆ WithTaskId() [2/3]

SynthesisTask& Aws::Polly::Model::SynthesisTask::WithTaskId ( const Aws::String value)
inline

The Amazon Polly generated identifier for a speech synthesis task.

Definition at line 121 of file SynthesisTask.h.

◆ WithTaskId() [3/3]

SynthesisTask& Aws::Polly::Model::SynthesisTask::WithTaskId ( const char *  value)
inline

The Amazon Polly generated identifier for a speech synthesis task.

Definition at line 131 of file SynthesisTask.h.

◆ WithTaskStatus() [1/2]

SynthesisTask& Aws::Polly::Model::SynthesisTask::WithTaskStatus ( const TaskStatus value)
inline

Current status of the individual speech synthesis task.

Definition at line 157 of file SynthesisTask.h.

◆ WithTaskStatus() [2/2]

SynthesisTask& Aws::Polly::Model::SynthesisTask::WithTaskStatus ( TaskStatus &&  value)
inline

Current status of the individual speech synthesis task.

Definition at line 162 of file SynthesisTask.h.

◆ WithTaskStatusReason() [1/3]

SynthesisTask& Aws::Polly::Model::SynthesisTask::WithTaskStatusReason ( Aws::String &&  value)
inline

Reason for the current status of a specific speech synthesis task, including errors if the task has failed.

Definition at line 205 of file SynthesisTask.h.

◆ WithTaskStatusReason() [2/3]

SynthesisTask& Aws::Polly::Model::SynthesisTask::WithTaskStatusReason ( const Aws::String value)
inline

Reason for the current status of a specific speech synthesis task, including errors if the task has failed.

Definition at line 199 of file SynthesisTask.h.

◆ WithTaskStatusReason() [3/3]

SynthesisTask& Aws::Polly::Model::SynthesisTask::WithTaskStatusReason ( const char *  value)
inline

Reason for the current status of a specific speech synthesis task, including errors if the task has failed.

Definition at line 211 of file SynthesisTask.h.

◆ WithTextType() [1/2]

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

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

Definition at line 599 of file SynthesisTask.h.

◆ WithTextType() [2/2]

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

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

Definition at line 605 of file SynthesisTask.h.

◆ WithVoiceId() [1/2]

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

Voice ID to use for the synthesis.

Definition at line 631 of file SynthesisTask.h.

◆ WithVoiceId() [2/2]

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

Voice ID to use for the synthesis.

Definition at line 636 of file SynthesisTask.h.


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