SynthesisTask¶
Structure Class¶
dataclass
¶
SynthesisTask object that provides information about a speech synthesis task.
Attributes¶
class-attribute
instance-attribute
¶
creation_time: datetime | None = None
Timestamp for the time the synthesis task was started.
class-attribute
instance-attribute
¶
engine: Engine | None = None
Specifies the engine (standard, neural, long-form or generative)
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.
class-attribute
instance-attribute
¶
language_code: LanguageCode | None = None
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.
class-attribute
instance-attribute
¶
lexicon_names: list[str] | None = None
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.
class-attribute
instance-attribute
¶
output_format: OutputFormat | None = None
The format in which the returned output will be encoded. For audio stream, this will be mp3, ogg_vorbis, ogg_opus, mu-law, a-law, or pcm. For speech marks, this will be json.
class-attribute
instance-attribute
¶
output_uri: str | None = None
Pathway for the output speech file.
class-attribute
instance-attribute
¶
request_characters: int = 0
Number of billable characters synthesized.
class-attribute
instance-attribute
¶
sample_rate: str | None = None
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". The default value for long-form voices is "24000". The default value for generative voices is "24000".
Valid values for pcm are "8000" and "16000" The default value is "16000".
Valid value for ogg_opus is "48000".
Valid value for mu-law and a-law is "8000".
class-attribute
instance-attribute
¶
sns_topic_arn: str | None = None
ARN for the SNS topic optionally used for providing status notification for a speech synthesis task.
class-attribute
instance-attribute
¶
speech_mark_types: list[SpeechMarkType] | None = None
The type of speech marks returned for the input text.
class-attribute
instance-attribute
¶
task_id: str | None = None
The Amazon Polly generated identifier for a speech synthesis task.
class-attribute
instance-attribute
¶
task_status: TaskStatus | None = None
Current status of the individual speech synthesis task.
class-attribute
instance-attribute
¶
task_status_reason: str | None = None
Reason for the current status of a specific speech synthesis task, including errors if the task has failed.