Universal Music Theory Library - v0.12.0
    Preparing search index...

    Type Alias FretboardVoicingOptions

    Options for voicing and scale position generation.

    type FretboardVoicingOptions = {
        maxFret?: number;
        maxStretch?: number;
        stringOffset?: number[];
        windowSize?: number;
    }
    Index

    Properties

    maxFret? maxStretch? stringOffset? windowSize?

    Properties

    maxFret?: number

    Highest fret to search. Default: 12.

    maxStretch?: number

    Maximum fret span (stretch) in a single voicing. Default: 4.

    stringOffset?: number[]

    Per-string fret offset: the physical fret number where each string's nut sits. 0 (default) for normal strings. Use 5 for the 5-string banjo drone (index 0 with BANJO_OPEN_G). When provided, output fret values are shifted by this amount so they match absolute fret positions on the instrument.

    getFretboardVoicings(chord, BANJO_OPEN_G, { stringOffset: [5, 0, 0, 0, 0] })
    windowSize?: number

    Fret window size for getFretboardScalePositions. Default: 4.

    Settings

    Member Visibility

    On This Page

    Properties