Changeset 6cc2d9d for src/synth/sampler.h

Timestamp:

Oct 8, 2016, 7:55:44 PM (8 years ago)

Author:

Paul Brossier <piem@piem.org>

Branches:

sampler

Children:

1b86a8b

Parents:

b959a8f

Message:

src/synth/sampler.h: improve documentation

File:

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

src/synth/sampler.h

@@ -64 +64 @@
   \return 0 if successful, non-zero otherwise
 
+  This function attempts to load a new source, swaps the current one with the
+  newly loaded one (or NULL if loading failed), then delete the old one.
+
 */
 uint_t aubio_sampler_load( aubio_sampler_t * o, const char_t * uri );
@@ -74 +77 @@
   \return 0 if successfully queued, non-zero otherwise
 
+  This function is identical to aubio_sampler_load(), except it will be called
+  in its own thread to avoid blocking calls to aubio_sampler_do().
+
 */
 uint_t aubio_sampler_queue(aubio_sampler_t * o, const char_t * uri );
@@ -81 +87 @@
   \param o sampler, created by new_aubio_sampler()
   \param output output of the sampler
-
-This function get new samples from the playing source into output.
+  \param read number of samples actually read
+
+  This function get new samples from the sampler and store them into output.
+
+  The output vector will be completed with 0 if too few samples are available.
 
 */