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

Correct documentation

Browse source
This commit is contained in:
Paul Fd 2020-04-08 14:00:40 +02:00 • committed by Jean Pierre Cimalando
parent 25353e78ff
commit b7f336e243
2 changed files with 12 additions and 16 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

24
src/sfizz.h
View file

@ -398,50 +398,46 @@ SFIZZ_EXPORTED_API void sfizz_clear_external_definitions(sfizz_synth_t* synth);
/**
* @brief Get the number of note labels registered in the current sfz file
* @version 0.4.0-dev
* @since 0.4.0-dev
*/
SFIZZ_EXPORTED_API unsigned int sfizz_get_num_note_labels(sfizz_synth_t* synth);
/**
* @brief Get the note number for the label registered at index label_index.
* @version 0.4.0-dev
* @since 0.4.0-dev
*
* @returns SFIZZ_OUT_OF_BOUNDS_LABEL_INDEX if the index is out of bounds.
* @returns the number
* @returns the number or SFIZZ_OUT_OF_BOUNDS_LABEL_INDEX if the index is out of bounds.
*/
SFIZZ_EXPORTED_API int sfizz_get_note_label_number(sfizz_synth_t* synth, int label_index);
/**
* @brief Get the note text for the label registered at index label_index.
* @version 0.4.0-dev
* @since 0.4.0-dev
*
* @returns NULL if the index is out of bounds.
* @returns the label
* @returns the label or NULL if the index is out of bounds.
*/
SFIZZ_EXPORTED_API const char * sfizz_get_note_label_text(sfizz_synth_t* synth, int label_index);
/**
* @brief Get the number of note labels registered in the current sfz file
* @version 0.4.0-dev
* @since 0.4.0-dev
*
*/
SFIZZ_EXPORTED_API unsigned int sfizz_get_num_cc_labels(sfizz_synth_t* synth);
/**
* @brief Get the CC number for the label registered at index label_index.
* @version 0.4.0-dev
* @since 0.4.0-dev
*
* @returns SFIZZ_OUT_OF_BOUNDS_LABEL_INDEX if the index is out of bounds.
* @returns the number
* @returns the number or SFIZZ_OUT_OF_BOUNDS_LABEL_INDEX if the index is out of bounds.
*/
SFIZZ_EXPORTED_API int sfizz_get_cc_label_number(sfizz_synth_t* synth, int label_index);
/**
* @brief Get the CC text for the label registered at index label_index.
* @version 0.4.0-dev
* @since 0.4.0-dev
*
* @returns NULL if the index is out of bounds.
* @returns the label
* @returns the label or NULL if the index is out of bounds.
*/
SFIZZ_EXPORTED_API const char * sfizz_get_cc_label_text(sfizz_synth_t* synth, int label_index);

4
src/sfizz.hpp
View file

@ -316,13 +316,13 @@ public:
/**
* @brief Get the note labels, if any
* @version 0.4.0-dev
* @since 0.4.0-dev
*
*/
const std::vector<std::pair<uint8_t, std::string>>& getNoteLabels() const noexcept;
/**
* @brief Get the CC labels, if any
* @version 0.4.0-dev
* @since 0.4.0-dev
*
*/
const std::vector<std::pair<uint16_t, std::string>>& getCCLabels() const noexcept;