AzureTTSConfig

Defined in: src/providers/tts/azure/AzureTTS.ts:109

Configuration for the AzureTTS provider.

Remarks

Provide either apiKey (for direct API access) or proxyUrl (for a server-side proxy). At least one must be set. If both are provided, proxyUrl takes precedence and the key is not sent from the client.

In direct mode, region is required (it selects the https://<region>.tts.speech.microsoft.com endpoint) unless a custom endpoint is configured. In proxy mode the region lives server-side in the proxy configuration (azureSpeechRegion).

Authentication in direct mode defaults to the Ocp-Apim-Subscription-Key header with your Speech resource key. To use a short-lived bearer token instead (recommended for browsers), pass an async apiKey factory that fetches a token from your server (which calls Azure’s POST https://<region>.api.cognitive.microsoft.com/sts/v1.0/issueToken) — factories are sent as Authorization: Bearer automatically. Set authType explicitly to override either default.

Example

// Direct API access with a resource key
const config: AzureTTSConfig = {
  apiKey: 'your-speech-resource-key',
  region: 'eastus',
  voiceName: 'en-US-AriaNeural',
  outputFormat: 'audio-24khz-48kbitrate-mono-mp3',
};

// Via proxy server (recommended for production)
const proxyConfig: AzureTTSConfig = {
  proxyUrl: 'http://localhost:3001/api/proxy/azure-tts',
  voiceName: 'en-US-AriaNeural',
};

See

AzureTTSOutputFormat - Available audio format options.

Extends

• TTSProviderConfig

Properties