From a6ba2ed1d0ebf7321dca9ae2f9013ae9e038994a Mon Sep 17 00:00:00 2001 From: Paul Brossier Date: Mon, 19 Sep 2016 20:13:44 +0200 Subject: [PATCH] src/effects/pitchshift.h: improve documentation --- src/effects/pitchshift.h | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/src/effects/pitchshift.h b/src/effects/pitchshift.h index ee4d079d..cd9ac83e 100644 --- a/src/effects/pitchshift.h +++ b/src/effects/pitchshift.h @@ -86,7 +86,7 @@ uint_t aubio_pitchshift_get_latency (aubio_pitchshift_t * o); */ uint_t aubio_pitchshift_set_pitchscale (aubio_pitchshift_t * o, smpl_t pitchscale); -/** set the pitchscale of the pitch shifting object +/** get the pitchscale of the pitch shifting object \param o pitch shifting object as returned by ::new_aubio_pitchshift() @@ -95,21 +95,22 @@ uint_t aubio_pitchshift_set_pitchscale (aubio_pitchshift_t * o, smpl_t pitchscal */ smpl_t aubio_pitchshift_get_pitchscale (aubio_pitchshift_t * o); -/** set the transposition of the pitch shifting object +/** set the transposition of the pitch shifting object, in semitones \param o pitch shifting object as returned by new_aubio_pitchshift() - \param transpose new pitch transposition of the pitch shifting object + \param transpose new pitch transposition of the pitch shifting object, expressed + in semitones (should be in the range [-24;+24]) \return 0 if successfull, non-zero otherwise */ uint_t aubio_pitchshift_set_transpose (aubio_pitchshift_t * o, smpl_t transpose); -/** set the transposition of the pitch shifting object +/** get the transposition of the pitch shifting object, in semitones \param o pitch shifting object as returned by ::new_aubio_pitchshift() - \return transposition of the pitch shifting object + \return transposition of the pitch shifting object, in semitones */ smpl_t aubio_pitchshift_get_transpose (aubio_pitchshift_t * o); -- 2.11.0