IPollySynthesisTask

Interface in AWS.Polly

Interface for SynthesisTask.

Properties

CreationTime

property CreationTime: TOptional<TDateTime>

Provides the date and time the synthesis task was started.

Engine

property Engine: string

Provides the Engine used for the synthesis job.

LanguageCode

property LanguageCode: string

Provides the language code used for the synthesis task.

LexiconNames

property LexiconNames: TList<string>

Provides a list of lexicon names to be applied during synthesis.

OutputFormat

property OutputFormat: string

Provides the format in which the output will be encoded.

Valid values: json | mp3 | ogg_vorbis | pcm. For audio stream, this will be mp3, ogg_vorbis, or pcm. For speech marks, this will be json.

OutputUri

property OutputUri: string

Provides the output URI for the speech output.

RequestCharacters

property RequestCharacters: TOptional<Integer>

Provides the number of billable characters synthesized.

SampleRate

property SampleRate: string

Provides the audio frequency in Hz.

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

property SnsTopicArn: TARN

Provides the Amazon Resource Name (ARN) for the SNS topic optionally used for providing status notifications for a speech synthesis.

SpeechMarkTypes

property SpeechMarkTypes: TList<string>

Provides a list of types of speech marks returned for the output text.

Valid values: sentence | ssml | viseme | word.

TaskId

property TaskId: string

Provides the Amazon Polly generated identifier for the speech synthesis task.

TaskStatus

property TaskStatus: string

Provides the current status of the individual speech synthesis task.

Valid values: scheduled | inProgress | completed | failed.

TaskStatusReason

property TaskStatusReason: string

Provides the reason for the current status of the task.

Will include errors if the task is failed.

TextType

property TextType: string

Specifies whether the input text is provided in plain text or SSML.

Valid values: ssml | text. Default value is text.

VoiceId

property VoiceId: string

Provides the Voice ID used by the task for synthesis.

Properties​

CreationTime​

Engine​

LanguageCode​

LexiconNames​

OutputFormat​

OutputUri​

RequestCharacters​

SampleRate​

SnsTopicArn​

SpeechMarkTypes​

TaskId​

TaskStatus​

TaskStatusReason​

TextType​

VoiceId​