kiteplayer-audioviz/io.github.yuroyami.kiteplayer.audioviz/RhythmEstimate

RhythmEstimate

Causal pulse estimates. Support values are heuristic scores, not probabilities of correctness. A usable beat phase does not establish meter, a downbeat or a phrase boundary.

Properties

alternativeBpm

val alternativeBpm: Float

A supported half/double-time interpretation, or 0 when none is supported.

alternativeSupport

val alternativeSupport: Float

Unweighted evidence for alternativeBpm, 0..1.

availableMicros

val availableMicros: Long

Media time through which input was consumed to obtain this evidence.

beatInSeconds

val beatInSeconds: Float

Media seconds to the next predicted pulse, or -1 when the phase is unavailable.

beatPhase

val beatPhase: Float

Position between pulse instants, 0..1. Meaningful for motion only while usable.

beatSupport

val beatSupport: Float

Alignment support for this particular beat phase, 0..1.

bpm

val bpm: Float

Candidate pulse rate in BPM, diagnostic even when usable is false.

ptsMicros

val ptsMicros: Long

Media time described by beatPhase.

revision

val revision: Long

Changes when a conflicting pulse rate replaces the old hypothesis.

tempoSupport

val tempoSupport: Float

Periodicity and detected-event support, 0..1.

usable

val usable: Boolean

Entry/exit hysteresis and evidence expiry have accepted this phase for continuous motion.

validUntilMicros

val validUntilMicros: Long

Last media time for which this evidence may support a predicted beat.