better-french-tts/com.github.kvnpetit.betterfrenchtts.dsl/SpeechBuilder

SpeechBuilder

class SpeechBuilder

Kotlin DSL builder for constructing structured speech with automatic SSML generation.

This builder provides a type-safe, readable way to compose complex speech sequences including pauses, prosody changes, emphasis, spell-out, and structured say-as interpretations.

Basic usage

tts.speak {
    text("Bonjour.")
    pause(400)
    slow { text("Ceci est important.") }
}

Rich example

tts.speak {
    paragraph {
        sentence { text("Bienvenue sur notre application.") }
        sentence {
            text("Votre code est ")
            spellOut("AB12")
            text(".")
        }
    }
    pause(600)
    withPreset(SpeechPreset.CALM) {
        text("Merci et à bientôt.")
    }
}

See also

BetterFrenchTts.speak

Constructors

constructor()

Functions

fun date(content: String, format: String = "dmy")

Reads content as a date.

fun emphasis(level: String = "moderate", block: SpeechBuilder.() -> Unit)

Wraps content in an SSML <emphasis> tag.

fun fast(block: SpeechBuilder.() -> Unit)

Wraps content with rate="fast".

fun highPitch(block: SpeechBuilder.() -> Unit)

Wraps content with pitch="+3st" (higher).

fun loud(block: SpeechBuilder.() -> Unit)

Wraps content with volume="loud".

fun lowPitch(block: SpeechBuilder.() -> Unit)

Wraps content with pitch="-3st" (lower).

fun number(content: String)

Reads content as a cardinal number (e.g. "1500" → "mille cinq cents").

fun ordinal(content: String)

Reads content as an ordinal number (e.g. "3" → "troisième").

fun paragraph(block: SpeechBuilder.() -> Unit)

Wraps content in an SSML <p> (paragraph) tag.

fun pause(timeMs: Int)

Inserts a silence pause.

fun phoneme(content: String, ipa: String)

Provides exact phonetic pronunciation using the International Phonetic Alphabet (IPA).

fun pitch(semitones: Int, block: SpeechBuilder.() -> Unit)

Sets pitch in semitones relative to default.

fun prosody(rate: String? = null, pitch: String? = null, volume: String? = null, block: SpeechBuilder.() -> Unit)

Wraps content in an SSML <prosody> tag with optional rate, pitch, and volume.

fun rate(percent: Int, block: SpeechBuilder.() -> Unit)

Sets rate as a percentage of normal speed.

fun reduced(block: SpeechBuilder.() -> Unit)

Shortcut for emphasis(level = "reduced").

fun sayAs(interpretAs: String, content: String)

Generates an SSML <say-as> element with a custom interpretation type.

fun sentence(block: SpeechBuilder.() -> Unit)

Wraps content in an SSML <s> (sentence) tag.

fun slow(block: SpeechBuilder.() -> Unit)

Wraps content with rate="slow".

fun soft(block: SpeechBuilder.() -> Unit)

Wraps content with volume="soft".

fun spellOut(content: String, pauseMs: Int = 150)

Spells out content character by character with French pronunciation.

fun strong(block: SpeechBuilder.() -> Unit)

Shortcut for emphasis(level = "strong").

fun sub(content: String, alias: String)

Substitutes content with alias for pronunciation.

fun telephone(content: String)

Reads content as a telephone number with appropriate digit grouping.

fun text(content: String)

Adds plain text to the speech output.

fun withPreset(preset: SpeechPreset, block: SpeechBuilder.() -> Unit)

Applies a SpeechPreset's prosody (rate, pitch, volume) to the enclosed content.

fun xFast(block: SpeechBuilder.() -> Unit)

Wraps content with rate="x-fast".

fun xLoud(block: SpeechBuilder.() -> Unit)

Wraps content with volume="x-loud".

fun xSlow(block: SpeechBuilder.() -> Unit)

Wraps content with rate="x-slow".

fun xSoft(block: SpeechBuilder.() -> Unit)

Wraps content with volume="x-soft".