shithub: aubio

Info  •  Files  •  Log  •  Branches

src/pitch/pitch.h: add basic description of unit modes

--- a/src/pitch/pitch.h

+++ b/src/pitch/pitch.h

@@ -150,6 +150,8 @@

   \param o pitch detection object as returned by new_aubio_pitch()

   \param mode set pitch units for output

+  mode can be one of "Hz", "midi", "cent", or "bin". Defaults to "Hz".

+

   \return 0 if successfull, non-zero otherwise

 */