Added documentation on the public API constructor
detailing the default sample rate and block size
This commit is contained in:
parent
71c1b468ce
commit
58dd788891
2 changed files with 9 additions and 1 deletions
|
|
@ -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*
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -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();
|
||||
/**
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue