sam/sfizz
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Added documentation on the public API constructor

Browse source 
detailing the default sample rate and block size
This commit is contained in:
Paul Fd 2020-03-11 18:44:03 +01:00
parent 71c1b468ce
commit 58dd788891
2 changed files with 9 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
src/sfizz.h
View file

@ -36,7 +36,9 @@ typedef enum {
/** /**
* @brief Creates a sfizz synth. This object has to be freed by the caller * @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* * @return sfizz_synth_t*
*/ */

6
src/sfizz.hpp
View file

@ -24,6 +24,12 @@ class Synth;
class SFIZZ_EXPORTED_API Sfizz class SFIZZ_EXPORTED_API Sfizz
{ {
public: 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();
~Sfizz(); ~Sfizz();
/** /**