MAIDR Documentation - v3.39.0
    Preparing search index...

    Interface AudioState

    Audio state containing frequency mapping and current value for sonification.

    interface AudioState {
        freq: { min: number; max: number; raw: number | number[] };
        panning: { y: number; x: number; rows: number; cols: number };
        group?: number;
        isContinuous?: boolean;
        trend?: CandlestickTrend;
        volumeMultiplier?: number;
        volumeScale?: number;
    }
    Index

    Properties

    freq panning group? isContinuous? trend? volumeMultiplier? volumeScale?

    Properties

    freq: { min: number; max: number; raw: number | number[] }
    panning: { y: number; x: number; rows: number; cols: number }
    group?: number

    Group index for multiclass plots. Used to determine which audio palette entry to use. If undefined, defaults to 0 (single group).

    isContinuous?: boolean

    Indicates whether the audio is continuous. If true, the audio plays without interruption. If false or undefined, the audio may have discrete segments.

    trend?: CandlestickTrend

    Candlestick trend information for audio palette selection. Used by AudioService to determine appropriate audio characteristics. Only applicable for candlestick traces.

    volumeMultiplier?: number

    Volume multiplier for dynamic volume control. Used to scale audio volume based on data characteristics (e.g., violin plot width). If undefined, defaults to 1.0 (no volume scaling). Range should typically be between 0.0 and 1.0, but can exceed 1.0 for emphasis.

    volumeScale?: number

    Volume scale for dynamic volume control (0-1 range). Used to scale audio volume based on density values (e.g., violin plot density). If undefined, defaults to 1.0 (no volume scaling). Range is 0.0 to 1.0, where 0.0 = quietest and 1.0 = loudest.

    Settings

    Member Visibility

    On This Page

    Properties