class Aws::Polly::Types::SynthesisTask
SynthesisTask
object that provides information about a speech synthesis task.
@!attribute [rw] engine
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. @return [String]
@!attribute [rw] task_id
The Amazon Polly generated identifier for a speech synthesis task. @return [String]
@!attribute [rw] task_status
Current status of the individual speech synthesis task. @return [String]
@!attribute [rw] task_status_reason
Reason for the current status of a specific speech synthesis task, including errors if the task has failed. @return [String]
@!attribute [rw] output_uri
Pathway for the output speech file. @return [String]
@!attribute [rw] creation_time
Timestamp for the time the synthesis task was started. @return [Time]
@!attribute [rw] request_characters
Number of billable characters synthesized. @return [Integer]
@!attribute [rw] sns_topic_arn
ARN for the SNS topic optionally used for providing status notification for a speech synthesis task. @return [String]
@!attribute [rw] lexicon_names
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. @return [Array<String>]
@!attribute [rw] output_format
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. @return [String]
@!attribute [rw] sample_rate
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". @return [String]
@!attribute [rw] speech_mark_types
The type of speech marks returned for the input text. @return [Array<String>]
@!attribute [rw] text_type
Specifies whether the input text is plain text or SSML. The default value is plain text. @return [String]
@!attribute [rw] voice_id
Voice ID to use for the synthesis. @return [String]
@!attribute [rw] language_code
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][1] operation for the `LanguageCode` parameter. For example, if no language code is specified, Aditi will use Indian English rather than Hindi. [1]: https://docs.aws.amazon.com/polly/latest/dg/API_DescribeVoices.html @return [String]
@see docs.aws.amazon.com/goto/WebAPI/polly-2016-06-10/SynthesisTask AWS API Documentation
Constants
- SENSITIVE