Hiyve Components - v1.0.0
    Preparing search index...

    Options for useNoteSynth.

    interface UseNoteSynthOptions {
        durationMs?: number;
        gain?: number;
        onError?: (error: Error) => void;
        samples?: SampleSource;
        sampleWaitMs?: number;
    }
    Index

    Properties

    durationMs?: number

    How long a note rings unless told otherwise, in milliseconds (default: 900)

    gain?: number

    Loudness, 0–1 (default: 0.5)

    onError?: (error: Error) => void

    The sound could not start

    samples?: SampleSource

    Recorded samples to play instead of the built-in voice — a host laid out like midi-js-soundfonts. The SDK ships none: you choose the host, and that set's licence applies

    sampleWaitMs?: number

    How long a note may wait for its sample before the built-in voice plays it instead, in milliseconds (default: 1200)