Skip to main content

IPollyStartSpeechSynthesisTaskRequest

Interface in AWS.Polly

Interface for StartSpeechSynthesisTask requests.

Ancestors

Properties

Engine

property Engine: string

Specify the engine used by Amazon Polly when processing input text for speech synthesis.

Valid values: standard | neural.

LanguageCode

property LanguageCode: string

Optionally, specify the language code for the synthesis request. This is only necessary if using a bilingual voice. If a bilingual voice is specified without the language code, the default language for the voice will be used.

The language identification tag is made up of an ISO 639 code for the language and an ISO 3166 country code. Valid values: arb | cmn-CN | cy-GB | da-DK | de-DE | en-AU | en-GB | en-GB-WLS | en-IN | en-US | es-ES | es-MX | es-US | fr-CA | fr-FR | is-IS | it-IT | ja-JP | hi-IN | ko-KR | nb-NO | nl-NL | pl-PL | pt-BR | pt-PT | ro-RO | ru-RU | sv-SE | tr-TR | en-NZ | en-ZA.

LexiconNames

property LexiconNames: TList<string>

Specifies a list of pronunciation lexicon names to apply during synthesis.

Lexicons are only applied if the language of the lexicon is the same as the language of the voice. NOTE: Use AddLexiconName to populate this list.

OutputFormat

property OutputFormat: string

Specify the format for the output.

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.

OutputS3BucketName

property OutputS3BucketName: string

Specify the name of an Amazon S3 bucket to store to output file.

OutputS3KeyPrefix

property OutputS3KeyPrefix: string

Specify an Amazon S3 key prefix for the output file.

SampleRate

property SampleRate: string

Specify 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

Specify an Amazon Resource Name (ARN) of an SNS topic to provide status notifications for a speech sythesis task.

SpeechMarkTypes

property SpeechMarkTypes: TList<string>

Specifies the type of speech marks returned for the input text.

Valid values: sentence | ssml | viseme | word. NOTE: User AddSpeechMarkType to populate this list.

Text

property Text: string

Specify the input text to synthesize.

TextType

property TextType: string

Specify the format of the input text in Text. The default is plain text.

Valid values: ssml | text.

VoiceId

property VoiceId: string

Specify the voice to use for synthesis.

Valid values: Aditi | Amy | Astrid | Bianca | Brian | Camila | Carla | Carmen | Celine | Chantal | Conchita | Cristiano | Dora | Emma | Enrique | Ewa | Filiz | Gabrielle | 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 | Aria | Ayanda.

Methods

AddLexiconName

procedure AddLexiconName(const ALexiconName: string);

Add a lexicon name to LexiconNames.

Parameters

NameDescription
ALexiconNameA lexicon name to add to LexiconNames.

AddSpeechMarkType

procedure AddSpeechMarkType(const ASpeechMarkType: string);

Add a speech mark type to SpeechMarkTypes.

Valid values: sentence | ssml | viseme | word.

Parameters

NameDescription
ASpeechMarkTypeSpecify a speech mark type to add to SpeechMarkTypes.