NAME

Paws::Polly::SynthesisTask

USAGE

This class represents one of two things:

Arguments in a call to a service

Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. Each attribute should be used as a named argument in the calls that expect this type of object.

As an example, if Att1 is expected to be a Paws::Polly::SynthesisTask object:

$service_obj->Method(Att1 => { CreationTime => $value, ..., VoiceId => $value  });

Results returned from an API call

Use accessors for each attribute. If Att1 is expected to be an Paws::Polly::SynthesisTask object:

$result = $service_obj->Method(...);
$result->Att1->CreationTime

DESCRIPTION

SynthesisTask object that provides information about a speech synthesis task.

ATTRIBUTES

CreationTime => Str

Timestamp for the time the synthesis task was started.

Engine => Str

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.

LanguageCode => Str

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 will use the default language of the bilingual voice. The default language for any voice is the one returned by the DescribeVoices (https://docs.aws.amazon.com/polly/latest/dg/API_DescribeVoices.html) operation for the LanguageCode parameter. For example, if no language code is specified, Aditi will use Indian English rather than Hindi.

LexiconNames => ArrayRef[Str|Undef]

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.

OutputFormat => Str

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.

OutputUri => Str

Pathway for the output speech file.

RequestCharacters => Int

Number of billable characters synthesized.

SampleRate => Str

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

SnsTopicArn => Str

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

SpeechMarkTypes => ArrayRef[Str|Undef]

The type of speech marks returned for the input text.

TaskId => Str

The Amazon Polly generated identifier for a speech synthesis task.

TaskStatus => Str

Current status of the individual speech synthesis task.

TaskStatusReason => Str

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

TextType => Str

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

VoiceId => Str

Voice ID to use for the synthesis.

SEE ALSO

This class forms part of Paws, describing an object used in Paws::Polly

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues