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

    Interface SSMLOptions

    Configuration options for the SSML document root.

    Defines the basic settings for an SSML document including version, language, and XML namespace declarations required for proper parsing by speech synthesis services.

    const options: SSMLOptions = {
      lang: 'en-US',
      version: '1.0',
      xmlns: 'http://www.w3.org/2001/10/synthesis',
      xmlnsMstts: 'https://www.w3.org/2001/mstts'
    };

    https://docs.microsoft.com/azure/cognitive-services/speech-service/speech-synthesis-markup#speak-root-element Speak Element Documentation

    interface SSMLOptions {
        lang: string;
        version?: string;
        xmlns?: string;
        xmlnsMstts?: string;
    }
    Index

    Properties

    lang version? xmlns? xmlnsMstts?

    Properties

    lang: string

    Primary language/locale for the SSML document. (Required)

    Sets the default language for all content. Can be overridden using the lang element for multilingual content.

    Format: language-REGION (e.g., en-US, es-ES, fr-FR, zh-CN)

    "en-US" - English (United States)

    "es-ES" - Spanish (Spain)

    "fr-FR" - French (France)

    "zh-CN" - Chinese (Simplified, China)

    https://docs.microsoft.com/azure/cognitive-services/speech-service/language-support Supported Languages

    version?: string

    SSML specification version.

    Currently only version "1.0" is supported by the W3C specification and Azure Speech Service. This is typically set automatically.

    "1.0"

    "1.0"
    xmlns?: string

    XML namespace for SSML elements.

    The standard W3C namespace for SSML. This should not be changed unless you have specific requirements.

    "http://www.w3.org/2001/10/synthesis"

    "http://www.w3.org/2001/10/synthesis"
    xmlnsMstts?: string

    Microsoft Text-to-Speech namespace for Azure-specific features.

    Required for using Azure Speech Service extensions like express-as, backgroundaudio, and other mstts elements.

    "https://www.w3.org/2001/mstts"

    "https://www.w3.org/2001/mstts"

    Settings

    Member Visibility

    On This Page

    Properties