AmazonPollyOptions
Options & Configuration · AiDotNet.TextToSpeech.ProprietaryAPI
Options for the Amazon Polly client (SynthesizeSpeech, POST /v1/speech).
Inheritance: CloudTtsOptions → AmazonPollyOptions
For Beginners
Set AccessKeyId and SecretAccessKey to an IAM user’s keys with
the polly:SynthesizeSpeech permission.
How It Works
Defaults: region us-east-1, the neural engine, the voice Joanna, plain-text input and 16 kHz PCM (Polly returns PCM at 8 or 16 kHz only). Requests are signed with AWS Signature Version 4 from the access key, the secret key and, for temporary credentials, the session token. Polly accepts at most 3,000 billed characters per request.
Constructors
| Constructor | Summary |
|---|---|
AmazonPollyOptions() |
Creates the default options. |
AmazonPollyOptions(AmazonPollyOptions other) |
Initializes a new instance by copying from another instance. |
Properties
| Property | Summary |
|---|---|
bool UseSsml { get; set; } |
Gets or sets whether the text is SSML rather than plain text. |
string AccessKeyId { get; set; } |
Gets or sets the AWS access key id. |
string Engine { get; set; } |
Gets or sets the engine: standard, neural, long-form or generative (neural). |
string LanguageCode { get; set; } |
Gets or sets the language of a bilingual voice, or null for the voice’s default. |
string Region { get; set; } |
Gets or sets the AWS region (us-east-1). |
string SecretAccessKey { get; set; } |
Gets or sets the AWS secret access key. |
string SessionToken { get; set; } |
Gets or sets the session token of temporary credentials, or null. |