Changeset 98861c6


Ignore:
Timestamp:
Mar 12, 2017, 3:12:48 PM (3 years ago)
Author:
Paul Brossier <piem@piem.org>
Branches:
sampler
Children:
3d650a7
Parents:
75d1f9b
Message:

src/synth/sampler.h: improve documentation

File:
1 edited

Legend:

Unmodified
Added
Removed
  • src/synth/sampler.h

    r75d1f9b r98861c6  
    9797  \param o sampler, created by new_aubio_sampler()
    9898  \param output output of the sampler
    99   \param read number of samples actually read
     99  \param read will be set to then number of samples actually read
    100100
    101101  This function get new samples from the sampler and store them into output.
     
    110110  \param o sampler, created by new_aubio_sampler()
    111111  \param output output of the sampler
     112  \param read will be set to the number of samples actually read
    112113
    113114  This function is identical to aubio_sampler_do(), but for a multi-channel source.
     
    135136uint_t aubio_sampler_set_playing ( aubio_sampler_t * o, uint_t playing );
    136137
     138/** get current looping state
     139
     140  \param o sampler, created by new_aubio_sampler()
     141
     142  \return 0 if not looping , 1 if looping
     143
     144*/
    137145uint_t aubio_sampler_get_loop(aubio_sampler_t * o);
    138146
     
    140148
    141149  \param o sampler, created by new_aubio_sampler()
    142   \param looping 0 for not looping, 1 for looping
     150  \param loop 0 for not looping, 1 for looping
    143151
    144152  \return 0 if successful, 1 otherwise
Note: See TracChangeset for help on using the changeset viewer.