Changeset 98861c6

Timestamp:

Mar 12, 2017, 3:12:48 PM (7 years ago)

Author:

Paul Brossier <piem@piem.org>

Branches:

sampler

Children:

3d650a7

Parents:

75d1f9b

Message:

src/synth/sampler.h: improve documentation

File:

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

src/synth/sampler.h

@@ -97 +97 @@
   \param o sampler, created by new_aubio_sampler()
   \param output output of the sampler
-  \param read number of samples actually read
+  \param read will be set to then number of samples actually read
 
   This function get new samples from the sampler and store them into output.
@@ -110 +110 @@
   \param o sampler, created by new_aubio_sampler()
   \param output output of the sampler
+  \param read will be set to the number of samples actually read
 
   This function is identical to aubio_sampler_do(), but for a multi-channel source.
@@ -135 +136 @@
 uint_t aubio_sampler_set_playing ( aubio_sampler_t * o, uint_t playing );
 
+/** get current looping state
+
+  \param o sampler, created by new_aubio_sampler()
+
+  \return 0 if not looping , 1 if looping
+
+*/
 uint_t aubio_sampler_get_loop(aubio_sampler_t * o);
 
@@ -140 +148 @@
 
   \param o sampler, created by new_aubio_sampler()
-  \param looping 0 for not looping, 1 for looping
+  \param loop 0 for not looping, 1 for looping
 
   \return 0 if successful, 1 otherwise