be.tarsos.sampled.pitch

Interface PitchDetector

All Known Implementing Classes:

CachingDetector, IPEMPitchDetection, Polyphon, Swipe, SwipeOctave, TarsosPitchDetection, VampPitchDetection

public interface PitchDetector

A PitchDetector is able to annotate a song with pitches.

Author:

Joren Six

Method Summary

Modifier and Type	Method and Description
java.util.List<Annotation>	executePitchDetection() Execute the pitch detection process.
java.util.List<Annotation>	getAnnotations()
java.lang.String	getName()
double	progress() Calculate and return an indicator for progress.

Method Detail

executePitchDetection

java.util.List<Annotation> executePitchDetection()

Execute the pitch detection process.

Returns:

Returns a list of detected pitches, encapsulated in an annotation object.

progress

double progress()

Calculate and return an indicator for progress.

Returns:

A value between 0.0 and 100. Indicating the progress made in percentage. Or -1 if the task has an indeterminate duration.

getAnnotations

java.util.List<Annotation> getAnnotations()

Returns:

a list of annotated samples

getName

java.lang.String getName()

Returns:

the name of the detector possibly with parameters e.g. aubio_YIN