AzureSTTConfig

Defined in: src/providers/stt/azure/AzureSTT.ts:78

Configuration options for the AzureSTT provider.

Remarks

Extends STTProviderConfig with Azure-specific settings. You must provide either apiKey (for direct browser-to-Azure connections) or proxyUrl (for a server-side proxy that injects the key). If both are provided, proxyUrl takes precedence. In direct mode, region is required.

Browsers cannot set WebSocket headers, so in direct mode the credential travels as a query parameter (as the official Azure JS SDK does): a string apiKey is sent as Ocp-Apim-Subscription-Key=<key>, while an async apiKey factory is assumed to return a short-lived bearer token (from Azure’s POST https://<region>.api.cognitive.microsoft.com/sts/v1.0/issueToken) and is sent as Authorization=Bearer <token>. Set authType explicitly to override either default.

Example

// Direct connection with a server-issued 10-minute token
const config: AzureSTTConfig = {
  region: 'eastus',
  apiKey: async () => {
    const res = await fetch('/api/azure-speech-token');
    const { token } = await res.json();
    return token;
  },
};

// Proxy connection (recommended for production)
const proxyConfig: AzureSTTConfig = {
  proxyUrl: 'http://localhost:3001/api/proxy/azure-stt',
  language: 'en-US',
};

See

AzureSTT for the provider class

Extends

• STTProviderConfig

Properties