You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::Polly::Types::SynthesisTask

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

SynthesisTask object that provides information about a speech synthesis task.

Returned by:

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#creation_time ⇒ Time

Timestamp for the time the synthesis task was started.

Returns:

  • (Time) —

    Timestamp for the time the synthesis task was started.

#engine ⇒ String

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.

Possible values:

  • standard
  • neural

Returns:

  • (String) —

    Specifies the engine (standard or neural) for Amazon Polly to use when processing input text for speech synthesis.

#language_code ⇒ String

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 operation for the LanguageCode parameter. For example, if no language code is specified, Aditi will use Indian English rather than Hindi.

Returns:

  • (String) —

    Optional language code for a synthesis task.

#lexicon_names ⇒ Array<String>

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.

Returns:

  • (Array<String>) —

    List of one or more pronunciation lexicon names you want the service to apply during synthesis.

#output_format ⇒ String

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.

Possible values:

  • json
  • mp3
  • ogg_vorbis
  • pcm

Returns:

  • (String) —

    The format in which the returned output will be encoded.

#output_uri ⇒ String

Pathway for the output speech file.

Returns:

  • (String) —

    Pathway for the output speech file.

#request_characters ⇒ Integer

Number of billable characters synthesized.

Returns:

  • (Integer) —

    Number of billable characters synthesized.

#sample_rate ⇒ String

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

Returns:

  • (String) —

    The audio frequency specified in Hz.

#sns_topic_arn ⇒ String

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

Returns:

  • (String) —

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

#speech_mark_types ⇒ Array<String>

The type of speech marks returned for the input text.

Returns:

  • (Array<String>) —

    The type of speech marks returned for the input text.

#task_id ⇒ String

The Amazon Polly generated identifier for a speech synthesis task.

Returns:

  • (String) —

    The Amazon Polly generated identifier for a speech synthesis task.

#task_status ⇒ String

Current status of the individual speech synthesis task.

Possible values:

  • scheduled
  • inProgress
  • completed
  • failed

Returns:

  • (String) —

    Current status of the individual speech synthesis task.

#task_status_reason ⇒ String

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

Returns:

  • (String) —

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

#text_type ⇒ String

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

Possible values:

  • ssml
  • text

Returns:

  • (String) —

    Specifies whether the input text is plain text or SSML.

#voice_id ⇒ String

Voice ID to use for the synthesis.

Possible values:

  • Aditi
  • Amy
  • Astrid
  • Bianca
  • Brian
  • Camila
  • Carla
  • Carmen
  • Celine
  • Chantal
  • Conchita
  • Cristiano
  • Dora
  • Emma
  • Enrique
  • Ewa
  • Filiz
  • Geraint
  • Giorgio
  • Gwyneth
  • Hans
  • Ines
  • Ivy
  • Jacek
  • Jan
  • Joanna
  • Joey
  • Justin
  • Karl
  • Kendra
  • Kevin
  • Kimberly
  • Lea
  • Liv
  • Lotte
  • Lucia
  • Lupe
  • Mads
  • Maja
  • Marlene
  • Mathieu
  • Matthew
  • Maxim
  • Mia
  • Miguel
  • Mizuki
  • Naja
  • Nicole
  • Olivia
  • Penelope
  • Raveena
  • Ricardo
  • Ruben
  • Russell
  • Salli
  • Seoyeon
  • Takumi
  • Tatyana
  • Vicki
  • Vitoria
  • Zeina
  • Zhiyu

Returns:

  • (String) —

    Voice ID to use for the synthesis.