aboutsummaryrefslogtreecommitdiff
path: root/xtract/xtract_vector.h
diff options
context:
space:
mode:
Diffstat (limited to 'xtract/xtract_vector.h')
-rw-r--r--xtract/xtract_vector.h2
1 files changed, 2 insertions, 0 deletions
diff --git a/xtract/xtract_vector.h b/xtract/xtract_vector.h
index e758f10..07bf176 100644
--- a/xtract/xtract_vector.h
+++ b/xtract/xtract_vector.h
@@ -43,6 +43,8 @@ extern "C" {
*
* The magnitude/power coefficients are scaled to the range 0-1 so that for a given coefficient x, 0 <= x <= 1
*
+ * \note Before calling xtract_spectrum(), the FFT must be initialised by calling xtract_init_fft(N, XTRACT_SPECTRUM)
+ *
*/
int xtract_spectrum(const float *data, const int N, const void *argv, float *result);