AzureNeuralTTSOptions
Options & Configuration · AiDotNet.TextToSpeech.ProprietaryAPI
Options for the Azure AI Speech text-to-speech client (POST /cognitiveservices/v1).
Inheritance: CloudTtsOptions → AzureNeuralTTSOptions
For Beginners
Set ApiKey to your Speech resource key and
Region to its region.
How It Works
Defaults: region eastus (endpoint https://eastus.tts.speech.microsoft.com), the voice en-US-JennyNeural, and
24 kHz raw 16-bit mono PCM (raw-24khz-16bit-mono-pcm; 8, 16, 22.05, 24, 44.1 and 48 kHz are offered). The
resource key goes in Ocp-Apim-Subscription-Key; a bearer token can be used instead. A response is at most ten
minutes of audio.
Constructors
| Constructor | Summary |
|---|---|
AzureNeuralTTSOptions() |
Creates the default options. |
AzureNeuralTTSOptions(AzureNeuralTTSOptions other) |
Initializes a new instance by copying from another instance. |
Properties
| Property | Summary |
|---|---|
bool TextIsSsml { get; set; } |
Gets or sets whether the text is a complete SSML document rather than plain text. |
string BearerToken { get; set; } |
Gets or sets a bearer token used instead of the resource key, or null. |
string Region { get; set; } |
Gets or sets the resource’s region (eastus). |
string UserAgent { get; set; } |
Gets or sets the application name sent as User-Agent (required by the service). |