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

    Everything a live session knows at one moment.

    interface LiveSnapshot {
        attacks: readonly LiveAttack[];
        clickOffsetMs: number | null;
        clockQuarters: number | null;
        committedCursor: number;
        complete: boolean;
        current: ScoreEvent | null;
        cursor: number;
        extras: readonly LiveExtra[];
        finished: boolean;
        next: ScoreEvent | null;
        nextPredictedMs: number | null;
        nextStable: ScoreEvent | null;
        positionQuarters: number;
        streamTimeMs: number;
        tempoBpm: number | null;
        verdicts: ReadonlyMap<string, LiveNoteVerdict>;
    }
    Index

    Properties

    attacks: readonly LiveAttack[]
    clickOffsetMs: number | null

    How late the metronome's clicks reach the microphone, once the count-in has shown it — they are being taken out of the audio, and the beat is judged that much later, where the microphone hears it; null when there is no click to look for, or none was heard (headphones)

    clockQuarters: number | null

    Where the set tempo's clock stands now, in quarter notes (negative during a count-in); null without a set tempo

    committedCursor: number

    Index of the last event placed for good; provisional placements may run ahead of it, or behind it, until confirmed

    complete: boolean

    The last event of the region has been matched

    current: ScoreEvent | null

    The last matched event

    cursor: number

    Index of the last matched event in the session's events; −1 before the first

    extras: readonly LiveExtra[]
    finished: boolean

    finish() has been called

    next: ScoreEvent | null

    The event the performer is expected to play next

    nextPredictedMs: number | null

    When the running tempo predicts the next event, on the stream clock

    nextStable: ScoreEvent | null

    The event to point at: the one after the last confirmed placement, or one further when a provisional placement has moved on by a step. A provisional skip, jump or step back does not move it until confirmed, so it does not leap about on a wrong note.

    positionQuarters: number

    Position of the last matched event, or the start of the region

    streamTimeMs: number
    tempoBpm: number | null

    Tempo the performer is holding, from the recent matched events — or the set tempo

    verdicts: ReadonlyMap<string, LiveNoteVerdict>

    Verdicts by score-note id; notes not yet reached have none