MAIDR JavaScript API
    Preparing search index...

    Interface GeneralSettings

    General application settings for audio, visual, and accessibility features.

    interface GeneralSettings {
        language: LanguageSetting;
        volume: number;
        echoCount: number;
        echoVolume: number;
        echoDuration: number;
        highlightColor: string;
        highContrastMode: boolean;
        highContrastLevels: number;
        highContrastLightColor: string;
        highContrastDarkColor: string;
        brailleDisplaySize: number;
        brailleDisplayLines: number;
        brailleDisplayKind: "single" | "multi" | "manual";
        brailleDisplayPresetId: string | null;
        tactileDisplayDeviceId: string | null;
        minFrequency: number;
        maxFrequency: number;
        autoplayDuration: number;
        ariaMode: AriaMode;
        hoverMode: HoverMode;
    }
    Index

    Properties

    language: LanguageSetting

    The language MAIDR speaks and shows: every announcement, dialog, and setting label. auto follows the browser's language, falling back to English when the browser asks for a language MAIDR does not have.

    volume: number
    echoCount: number

    Maximum number of echoes for 3D charts. A point with z = zMax produces this many echoes; lower z values produce proportionally fewer. 0 disables echoes.

    echoVolume: number

    Volume of the final echo as a percentage (0–100) of the main tone's volume. Echo volumes lerp from 100% (the original tone) down to this value at the Nth echo, so each echo position has a fixed volume regardless of how many actually play.

    echoDuration: number

    Delay between successive echoes, in seconds.

    highlightColor: string
    highContrastMode: boolean
    highContrastLevels: number
    highContrastLightColor: string
    highContrastDarkColor: string
    brailleDisplaySize: number
    brailleDisplayLines: number
    brailleDisplayKind: "single" | "multi" | "manual"
    brailleDisplayPresetId: string | null
    tactileDisplayDeviceId: string | null

    Which tactile graphics display MAIDR drives over Bluetooth, or null when the reader has not chosen one. Separate from the braille-display preset: that one sizes the braille panel, this one names a device with a pin area to draw the chart onto.

    minFrequency: number
    maxFrequency: number
    autoplayDuration: number
    ariaMode: AriaMode
    hoverMode: HoverMode