Changeset f651625 for src

Timestamp:

Mar 17, 2017, 6:23:50 PM (8 years ago)

Author:

Paul Brossier <piem@piem.org>

Branches:

sampler

Children:

389f903

Parents:

f8bdcb2

Message:

src/synth/sampler.h: improve documentation

File:

• src/synth/sampler.h (modified) (3 diffs)

src/synth/sampler.h

@@ -33 +33 @@
 TODO:
   - add _preset_threaded(level)
-  - add _set_stretch
-  - add _set_pitch
+  - rename _set_loop/_get_loop to _set_looping/_get_looping
+  - add option to pass a callback to signal eof
 
   \example synth/test-sampler.c
@@ -155 +155 @@
 uint_t aubio_sampler_set_loop(aubio_sampler_t * o, uint_t loop);
 
-/** play sample from start
+/** play sample
 
   \param o sampler, created by new_aubio_sampler()
@@ -204 +204 @@
   \param o sampler, created by new_aubio_sampler()
 
-  \return 1 when the eof is being reached, 0 otherwise
+  \return 1 when end of file has been reached, 0 otherwise
 
 */