TranscribeSTTConfig

Defined in: src/providers/stt/transcribe/TranscribeSTT.ts:64

Configuration options for the TranscribeSTT provider.

Remarks

Extends STTProviderConfig with Amazon Transcribe-specific settings. You must provide either credentials + region (for direct connections via a SigV4-presigned URL) or proxyUrl (for a server-side proxy that presigns the upstream URL). If both are provided, proxyUrl takes precedence.

For direct browser connections, use temporary credentials (STS/Cognito) fetched from your backend via an async credentials factory — never embed long-lived AWS keys in client code.

Example

// Direct connection with a temporary-credentials factory
const config: TranscribeSTTConfig = {
  credentials: async () => {
    const res = await fetch('/api/aws-temp-credentials');
    return res.json(); // { accessKeyId, secretAccessKey, sessionToken }
  },
  region: 'us-east-1',
  languageCode: 'en-US',
};

// Proxy connection (recommended for production)
const proxyConfig: TranscribeSTTConfig = {
  proxyUrl: 'http://localhost:3001/api/proxy/transcribe',
  languageCode: 'en-US',
};

See

TranscribeSTT for the provider class

Extends

• STTProviderConfig

Properties