mickeyf.docs
    Preparing search index...
    PitchResult:
        | {
            changed: boolean;
            fractionalDistance: number;
            hz: number;
            kind: "pitch";
            midi: number;
            pitchClass: number;
        }
        | { kind: "silence"; silenceMs: number }

    Result of a PitchHysteresis.update step.

    Type Declaration

    • {
          changed: boolean;
          fractionalDistance: number;
          hz: number;
          kind: "pitch";
          midi: number;
          pitchClass: number;
      }
      • changed: boolean

        true only when a new pitch-class commit occurs (event-like).

      • fractionalDistance: number

        Fractional distance from the nearest semitone, in semitones (clamped).

      • hz: number

        Smoothed pitch estimate in Hz.

      • kind: "pitch"
      • midi: number

        Continuous MIDI note number (can be fractional).

      • pitchClass: number

        Committed pitch class in [0, 11].

    • { kind: "silence"; silenceMs: number }
      • kind: "silence"
      • silenceMs: number

        Accumulated time without a valid pitch, in milliseconds.