SSML Builder Documentation - v1.0.1
    Preparing search index...

    Interface VoiceOptions

    Configuration options for voice elements.

    Defines the voice to use for speech synthesis and optional effects that can be applied to modify the voice output.

    const voice: VoiceOptions = {
      name: 'en-US-AvaNeural',
      effect: 'eq_telecomhp8k'  // Phone call effect
    };

    https://docs.microsoft.com/azure/cognitive-services/speech-service/language-support#neural-voices Available Neural Voices

    interface VoiceOptions {
        effect?: string;
        name: string;
    }
    Index

    Properties

    effect? name

    Properties

    effect?: string

    Optional audio effect to apply to the voice.

    Modifies the voice output to simulate different audio environments or transmission methods.

    Available effects:

    • eq_car: Optimized for car speakers
    • eq_telecomhp8k: Telephone quality (8kHz sampling)
    • eq_telecomhp3k: Lower quality telephone (3kHz sampling)
    "eq_telecomhp8k" - Phone call sound

    "eq_car" - Car speaker optimization
    name: string

    Voice identifier for text-to-speech synthesis. (Required)

    Must be a valid voice name supported by the speech service. Format typically: language-REGION-NameNeural

    Common voices:

    • English: en-US-AvaNeural, en-US-AndrewNeural, en-US-EmmaNeural
    • Spanish: es-ES-ElviraNeural, es-ES-AlvaroNeural
    • French: fr-FR-DeniseNeural, fr-FR-HenriNeural
    • Multilingual: en-US-AvaMultilingualNeural, en-US-AndrewMultilingualNeural
    "en-US-AvaNeural"

    "en-US-AndrewMultilingualNeural"

    "es-ES-ElviraNeural"

    Settings

    Member Visibility

    On This Page

    Properties