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

Add value constraints in API spec [ci skip]

Browse source
This commit is contained in:
Jean Pierre Cimalando 2021-04-15 22:36:13 +02:00
parent 34f9754a99
commit 416e558c0b
2 changed files with 28 additions and 28 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

28
src/sfizz.h
View file

@ -339,8 +339,8 @@ SFIZZ_EXPORTED_API void sfizz_set_sample_rate(sfizz_synth_t* synth, float sample
*
* @param synth The synth.
* @param delay The delay of the event in the block, in samples.
* @param note_number The MIDI note number.
* @param velocity The MIDI velocity.
* @param note_number The MIDI note number, in domain 0 to 127.
* @param velocity The MIDI velocity, in domain 0 to 127.
*
* @par Thread-safety constraints
* - @b RT: the function must be invoked from the Real-time thread
@ -357,7 +357,7 @@ SFIZZ_EXPORTED_API void sfizz_send_note_on(sfizz_synth_t* synth, int delay, int
*
* @param synth The synth.
* @param delay The delay of the event in the block, in samples.
* @param note_number The MIDI note number.
* @param note_number The MIDI note number, in domain 0 to 127.
* @param velocity The normalized MIDI velocity, in domain 0 to 1.
*
* @par Thread-safety constraints
@ -378,8 +378,8 @@ SFIZZ_EXPORTED_API void sfizz_send_hd_note_on(sfizz_synth_t* synth, int delay, i
*
* @param synth The synth.
* @param delay The delay of the event in the block, in samples.
* @param note_number The MIDI note number.
* @param velocity The MIDI velocity.
* @param note_number The MIDI note number, in domain 0 to 127.
* @param velocity The MIDI velocity, in domain 0 to 127.
*
* @par Thread-safety constraints
* - @b RT: the function must be invoked from the Real-time thread
@ -399,7 +399,7 @@ SFIZZ_EXPORTED_API void sfizz_send_note_off(sfizz_synth_t* synth, int delay, int
*
* @param synth The synth.
* @param delay The delay of the event in the block, in samples.
* @param note_number The MIDI note number.
* @param note_number The MIDI note number, in domain 0 to 127.
* @param velocity The normalized MIDI velocity, in domain 0 to 1.
*
* @par Thread-safety constraints
@ -417,8 +417,8 @@ SFIZZ_EXPORTED_API void sfizz_send_hd_note_off(sfizz_synth_t* synth, int delay,
*
* @param synth The synth.
* @param delay The delay of the event in the block, in samples.
* @param cc_number The MIDI CC number.
* @param cc_value The MIDI CC value.
* @param cc_number The MIDI CC number, in domain 0 to 127.
* @param cc_value The MIDI CC value, in domain 0 to 127.
*
* @par Thread-safety constraints
* - @b RT: the function must be invoked from the Real-time thread
@ -435,7 +435,7 @@ SFIZZ_EXPORTED_API void sfizz_send_cc(sfizz_synth_t* synth, int delay, int cc_nu
*
* @param synth The synth.
* @param delay The delay of the event in the block, in samples.
* @param cc_number The MIDI CC number.
* @param cc_number The MIDI CC number, in domain 0 to 127.
* @param norm_value The normalized CC value, in domain 0 to 1.
*
* @par Thread-safety constraints
@ -456,7 +456,7 @@ SFIZZ_EXPORTED_API void sfizz_send_hdcc(sfizz_synth_t* synth, int delay, int cc_
*
* @param synth The synth.
* @param delay The delay of the event in the block, in samples.
* @param cc_number The MIDI CC number.
* @param cc_number The MIDI CC number, in domain 0 to 127.
* @param norm_value The normalized CC value, in domain 0 to 1.
*
* @par Thread-safety constraints
@ -509,7 +509,7 @@ SFIZZ_EXPORTED_API void sfizz_send_hd_pitch_wheel(sfizz_synth_t* synth, int dela
* @param synth The synth.
* @param delay The delay at which the event occurs; this should be lower
* than the size of the block in the next call to renderBlock().
* @param aftertouch The aftertouch value.
* @param aftertouch The aftertouch value, in domain 0 to 127.
*
* @par Thread-safety constraints
* - @b RT: the function must be invoked from the Real-time thread
@ -546,8 +546,8 @@ SFIZZ_EXPORTED_API void sfizz_send_hd_aftertouch(sfizz_synth_t* synth, int delay
* @param synth The synth.
* @param delay The delay at which the event occurs; this should be lower
* than the size of the block in the next call to renderBlock().
* @param note_number The note number.
* @param aftertouch The aftertouch value.
* @param note_number The note number, in domain 0 to 127.
* @param aftertouch The aftertouch value, in domain 0 to 127.
*
* @par Thread-safety constraints
* - @b RT: the function must be invoked from the Real-time thread
@ -566,7 +566,7 @@ SFIZZ_EXPORTED_API void sfizz_send_poly_aftertouch(sfizz_synth_t* synth, int del
* @param synth The synth.
* @param delay The delay at which the event occurs; this should be lower
* than the size of the block in the next call to renderBlock().
* @param note_number The note number.
* @param note_number The note number, in domain 0 to 127.
* @param aftertouch The normalized aftertouch value, in domain 0 to 1.
*
* @par Thread-safety constraints

28
src/sfizz.hpp
View file

@ -381,8 +381,8 @@ public:
*
* @param delay the delay at which the event occurs; this should be lower
* than the size of the block in the next call to renderBlock().
* @param noteNumber the midi note number.
* @param velocity the midi note velocity.
* @param noteNumber the midi note number, in domain 0 to 127.
* @param velocity the midi note velocity, in domain 0 to 127.
*
* @par Thread-safety constraints
* - @b RT: the function must be invoked from the Real-time thread
@ -399,7 +399,7 @@ public:
*
* @param delay the delay at which the event occurs; this should be lower
* than the size of the block in the next call to renderBlock().
* @param noteNumber the midi note number.
* @param noteNumber the midi note number, in domain 0 to 127.
* @param velocity the normalized midi note velocity, in domain 0 to 1.
*
* @par Thread-safety constraints
@ -417,8 +417,8 @@ public:
*
* @param delay the delay at which the event occurs; this should be lower
* than the size of the block in the next call to renderBlock().
* @param noteNumber the midi note number.
* @param velocity the midi note velocity.
* @param noteNumber the midi note number, in domain 0 to 127.
* @param velocity the midi note velocity, in domain 0 to 127.
*
* @par Thread-safety constraints
* - @b RT: the function must be invoked from the Real-time thread
@ -435,7 +435,7 @@ public:
*
* @param delay the delay at which the event occurs; this should be lower
* than the size of the block in the next call to renderBlock().
* @param noteNumber the midi note number.
* @param noteNumber the midi note number, in domain 0 to 127.
* @param velocity the normalized midi note velocity, in domain 0 to 1.
*
* @par Thread-safety constraints
@ -453,8 +453,8 @@ public:
*
* @param delay the delay at which the event occurs; this should be lower
* than the size of the block in the next call to renderBlock().
* @param ccNumber the cc number.
* @param ccValue the cc value.
* @param ccNumber the cc number, in domain 0 to 127.
* @param ccValue the cc value, in domain 0 to 127.
*
* @par Thread-safety constraints
* - @b RT: the function must be invoked from the Real-time thread
@ -471,7 +471,7 @@ public:
*
* @param delay the delay at which the event occurs; this should be lower
* than the size of the block in the next call to renderBlock().
* @param ccNumber the cc number.
* @param ccNumber the cc number, in domain 0 to 127.
* @param normValue the normalized cc value, in domain 0 to 1.
*
* @par Thread-safety constraints
@ -493,7 +493,7 @@ public:
*
* @param delay the delay at which the event occurs; this should be lower
* than the size of the block in the next call to renderBlock().
* @param ccNumber the cc number.
* @param ccNumber the cc number, in domain 0 to 127.
* @param normValue the normalized cc value, in domain 0 to 1.
*
* @par Thread-safety constraints
@ -548,7 +548,7 @@ public:
*
* @param delay the delay at which the event occurs; this should be lower
* than the size of the block in the next call to renderBlock().
* @param aftertouch the aftertouch value.
* @param aftertouch the aftertouch value, in domain 0 to 127.
*
* @par Thread-safety constraints
* - @b RT: the function must be invoked from the Real-time thread
@ -585,8 +585,8 @@ public:
*
* @param delay the delay at which the event occurs; this should be lower
* than the size of the block in the next call to renderBlock().
* @param noteNumber the note number.
* @param aftertouch the aftertouch value.
* @param noteNumber the note number, in domain 0 to 127.
* @param aftertouch the aftertouch value, in domain 0 to 127.
*
* @par Thread-safety constraints
* - @b RT: the function must be invoked from the Real-time thread
@ -605,7 +605,7 @@ public:
*
* @param delay the delay at which the event occurs; this should be lower
* than the size of the block in the next call to renderBlock().
* @param noteNumber the note number.
* @param noteNumber the note number, in domain 0 to 127.
* @param aftertouch the normalized aftertouch value, in domain 0 to 1.
*
* @par Thread-safety constraints