analyze

fun analyze(breathFunction: BreathFunction, reference: BreathFunction? = null, config: BreathConfig = BreathConfig.DEFAULT): BreathMetrics

Analyze a recording: control score + phrase structure, optionally with reference alignment.

Parameters

breathFunction

Pre-computed breath function from computeBreathFunction

reference

Optional reference breath function. When provided, the result's alignmentScore is populated; null otherwise.

config

Breath analysis configuration


fun analyze(contour: PitchContour, reference: PitchContour? = null, config: BreathConfig = BreathConfig.DEFAULT): BreathMetrics

Analyze a recording directly from a pitch contour.

Parameters

contour

Student pitch contour (must have at least 2 samples)

reference

Optional reference contour. When provided, the result's alignmentScore is populated; null otherwise.

config

Breath analysis configuration