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

    Interface MergedLiveSessionOptions

    LiveSessionOptions with every nested default filled in.

    interface MergedLiveSessionOptions {
        analysis: AnalyzeTakeAudioOptions & Required<
            Pick<
                AnalyzeTakeAudioOptions,
                "windowSize"
                | "maxFlatness"
                | "readOffsetsMs",
            >,
        >;
        chordWindowMs: number;
        follower: Required<LiveFollowerOptions>;
        fromQuarters?: number;
        onError?: (error: Error) => void;
        onUpdate?: (update: LiveUpdate) => void;
        provisional: false | Required<LiveProvisionalOptions>;
        sampleRate?: number;
        tempo?: Required<Omit<LiveTempo, "click">> & Pick<LiveTempo, "click">;
        toQuarters?: number;
    }

    Hierarchy (View Summary)

    Index

    Properties

    analysis chordWindowMs follower fromQuarters? onError? onUpdate? provisional sampleRate? tempo? toQuarters?

    Properties

    analysis: AnalyzeTakeAudioOptions & Required<
        Pick<
            AnalyzeTakeAudioOptions,
            "windowSize"
            | "maxFlatness"
            | "readOffsetsMs",
        >,
    >

    Attack detection and pitch verification for the final verdict (the analyzeTakeAudio settings)

    chordWindowMs: number

    MIDI note-ons closer than this are one chord (default: 50)

    follower: Required<LiveFollowerOptions>
    fromQuarters?: number

    Only follow from this point, in quarter notes

    onError?: (error: Error) => void
    onUpdate?: (update: LiveUpdate) => void
    provisional: false | Required<LiveProvisionalOptions>

    The quick first look at each attack; false to wait for the final verdict only

    sampleRate?: number

    Sample rate of the audio given to pushAudio; omit for a MIDI-only session

    tempo?: Required<Omit<LiveTempo, "click">> & Pick<LiveTempo, "click">

    The set tempo with its default filled in; the click stays optional — there is none through headphones or without a metronome

    toQuarters?: number

    Only follow before this point, in quarter notes

    Settings

    Member Visibility

    On This Page

    Properties