From 58dd78889119ba46e5740419e5912a32c94446b1 Mon Sep 17 00:00:00 2001 From: Paul Fd Date: Wed, 11 Mar 2020 18:44:03 +0100 Subject: [PATCH] Added documentation on the public API constructor detailing the default sample rate and block size --- src/sfizz.h | 4 +++- src/sfizz.hpp | 6 ++++++ 2 files changed, 9 insertions(+), 1 deletion(-) diff --git a/src/sfizz.h b/src/sfizz.h index 68c9a9e7..54558b0b 100644 --- a/src/sfizz.h +++ b/src/sfizz.h @@ -36,7 +36,9 @@ typedef enum { /** * @brief Creates a sfizz synth. This object has to be freed by the caller - * using sfizz_free(). + * using sfizz_free(). The synth by default is set at 48 kHz + * and a maximum block size of 1024. You should change these values + * if they are not correct for your application. * * @return sfizz_synth_t* */ diff --git a/src/sfizz.hpp b/src/sfizz.hpp index e7f0f63d..25d2e932 100644 --- a/src/sfizz.hpp +++ b/src/sfizz.hpp @@ -24,6 +24,12 @@ class Synth; class SFIZZ_EXPORTED_API Sfizz { public: + /** + * @brief Construct a new Sfizz object. The synth by default is set at 48 kHz + * and a block size of 1024. You should change these values if they are not + * suited to your application. + * + */ Sfizz(); ~Sfizz(); /**