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

    Interface LiveSessionOptions

    Options for LiveSession.

    interface LiveSessionOptions {
        analysis?: AnalyzeTakeAudioOptions;
        chordWindowMs?: number;
        follower?: LiveFollowerOptions;
        fromQuarters?: number;
        onError?: (error: Error) => void;
        onUpdate?: (update: LiveUpdate) => void;
        provisional?: false | LiveProvisionalOptions;
        sampleRate?: number;
        tempo?: LiveTempo;
        toQuarters?: number;
    }

    Hierarchy (View Summary)

    Index

    Properties

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

    Properties

    analysis?: AnalyzeTakeAudioOptions

    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?: LiveFollowerOptions
    fromQuarters?: number

    Only follow from this point, in quarter notes

    onError?: (error: Error) => void
    onUpdate?: (update: LiveUpdate) => void
    provisional?: false | 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?: LiveTempo

    Judge against a set tempo; omit to follow the performer's own

    toQuarters?: number

    Only follow before this point, in quarter notes

    Settings

    Member Visibility

    On This Page

    Properties