src/tempo/beattracking.h: improve documentation

[aubio.git] / src / tempo / beattracking.h

diff --git a/src/tempo/beattracking.h b/src/tempo/beattracking.h
index af19b00..06d4196 100644 (file)
--- a/src/tempo/beattracking.h
+++ b/src/tempo/beattracking.h
@@ -32,6 +32,8 @@
   Matthew E. P. Davies, Paul Brossier, and Mark D. Plumbley. Beat tracking
   towards automatic musical accompaniment. In Proceedings of the Audio
   Engeeniring Society 118th Convention, Barcelona, Spain, May 2005.
+
+  \example tempo/test-beattracking.c
   
 */
 #ifndef BEATTRACKING_H
@@ -46,11 +48,13 @@ typedef struct _aubio_beattracking_t aubio_beattracking_t;
 
 /** create beat tracking object
 
+  \param winlen length of the onset detection window
   \param hop_size number of onset detection samples [512] 
-  \param channels number (not functionnal) [1]
+  \param samplerate samplerate of the input signal
 
 */
-aubio_beattracking_t * new_aubio_beattracking(uint_t hop_size, uint_t channels);
+aubio_beattracking_t * new_aubio_beattracking(uint_t winlen, uint_t hop_size,
+    uint_t samplerate);
 
 /** track the beat