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

    Interface UseLivePerformanceOptions

    Options for useLivePerformance.

    interface UseLivePerformanceOptions {
        fromQuarters?: number;
        onError?: (error: Error) => void;
        onUpdate?: (update: LiveUpdate) => void;
        score: Score | null;
        session?: Pick<
            LiveSessionOptions,
            "analysis"
            | "provisional"
            | "follower"
            | "chordWindowMs",
        >;
        source?: LiveSource;
        strictSequence?: boolean;
        toQuarters?: number;
    }
    Index

    Properties

    fromQuarters? onError? onUpdate? score session? source? strictSequence? toQuarters?

    Properties

    fromQuarters?: number

    Only follow from this point, in quarter notes

    onError?: (error: Error) => void

    Called when an update listener throws

    onUpdate?: (update: LiveUpdate) => void

    Every change, with the attack concerned and a full snapshot

    score: Score | null

    The score to follow; nothing happens until one is set

    session?: Pick<
        LiveSessionOptions,
        "analysis"
        | "provisional"
        | "follower"
        | "chordWindowMs",
    >

    Analysis, quick-look, follower and chord-window settings for the session

    source?: LiveSource

    Whether attacks come from the microphone (pushAudio) or from a MIDI instrument (pushMidi) (default: 'audio'). Input of the other kind is ignored, so a take recorded with both is never counted twice.

    strictSequence?: boolean

    Without a set tempo, compare every note with the next one written and move on, right or wrong — no skips or jumps, nothing held for the next note; a rolled chord is one chord (default: true). Under a set tempo the follower always searches, so a performer who stops is picked up at the beat they rejoin.

    toQuarters?: number

    Only follow before this point, in quarter notes

    Settings

    Member Visibility

    On This Page

    Properties