@jambonz/sdk
    Preparing search index...

    Interface Synthesizer

    Text-to-speech synthesis configuration.

    interface Synthesizer {
        vendor: string;
        label?: string;
        language?: string;
        voice?: string | Record<string, unknown>;
        fallbackVendor?: string;
        fallbackLabel?: string;
        fallbackLanguage?: string;
        fallbackVoice?: string | Record<string, unknown>;
        engine?: "standard" | "neural" | "generative" | "long-form";
        gender?: "MALE" | "FEMALE" | "NEUTRAL";
        options?: Record<string, unknown>;
    }
    Index

    Properties

    vendor label? language? voice? fallbackVendor? fallbackLabel? fallbackLanguage? fallbackVoice? engine? gender? options?

    Properties

    vendor: string

    The TTS vendor to use (e.g. 'google', 'aws', 'elevenlabs', 'cartesia', 'deepgram').

    label?: string

    Label identifying a specific credential set for this vendor.

    language?: string

    Language code in BCP-47 format (e.g. 'en-US').

    voice?: string | Record<string, unknown>

    Voice name or configuration object.

    fallbackVendor?: string

    Backup TTS vendor if the primary fails.

    fallbackLabel?: string

    Credential label for the fallback vendor.

    fallbackLanguage?: string

    Language code for the fallback vendor.

    fallbackVoice?: string | Record<string, unknown>

    Voice for the fallback vendor.

    engine?: "standard" | "neural" | "generative" | "long-form"

    Synthesis engine tier.

    gender?: "MALE" | "FEMALE" | "NEUTRAL"

    Preferred voice gender.

    options?: Record<string, unknown>

    Vendor-specific options passed through to the TTS provider.

    Settings

    Member Visibility

    On This Page

    Properties