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

    Interface PhonemeOptions

    Configuration options for phoneme elements.

    Provides exact phonetic pronunciation using standard phonetic alphabets. Essential for proper names, technical terms, or words with ambiguous pronunciation.

    // IPA pronunciation
    const ipaPhoneme: PhonemeOptions = {
    alphabet: 'ipa',
    ph: 'təˈmeɪtoʊ' // Tomato
    };

    // SAPI pronunciation
    const sapiPhoneme: PhonemeOptions = {
    alphabet: 'sapi',
    ph: 't ah m ey t ow'
    };
    interface PhonemeOptions {
        alphabet: PhonemeAlphabet;
        ph: string;
    }
    Index

    Properties

    Properties

    alphabet: PhonemeAlphabet

    Phonetic alphabet used for transcription. (Required)

    Available alphabets:

    • ipa: International Phonetic Alphabet (universal standard)
    • sapi: Microsoft SAPI phonemes (English-focused)
    • ups: Universal Phone Set (Microsoft's unified system)
    "ipa"
    
    "sapi"
    
    ph: string

    Phonetic transcription of the word. (Required)

    The exact phonetic representation in the specified alphabet. Must be valid according to the chosen alphabet's rules.

    "ˈʃɛdjuːl" - IPA for "schedule" (British)
    
    "s k eh jh uw l" - SAPI for "schedule" (American)