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

    Interface BreakOptions

    Configuration options for break/pause elements.

    Defines pauses in speech either by strength (semantic) or explicit duration. If both are specified, time takes precedence.

    // Using strength
    const breakByStrength: BreakOptions = {
    strength: 'medium' // 750ms pause
    };

    // Using explicit time
    const breakByTime: BreakOptions = {
    time: '500ms'
    };
    interface BreakOptions {
        strength?: BreakStrength;
        time?: string;
    }
    Index

    Properties

    Properties

    strength?: BreakStrength

    Semantic strength of the pause.

    Each strength corresponds to a typical pause duration:

    • x-weak: 250ms (very short)
    • weak: 500ms (short, like a comma)
    • medium: 750ms (default, like a period)
    • strong: 1000ms (long, like paragraph break)
    • x-strong: 1250ms (very long, for emphasis)

    Ignored if time is specified.

    "medium"
    
    "strong"
    
    time?: string

    Explicit duration of the pause.

    Specified in milliseconds (ms) or seconds (s). Valid range: 0-20000ms (20 seconds max) Values above 20000ms are capped at 20000ms.

    Takes precedence over strength if both are specified.

    "500ms" - Half second
    
    "2s" - 2 seconds
    
    "1500ms" - 1.5 seconds