<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>libfluidsynth: settings.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.7.1 -->
<script type="text/javascript">
function hasClass(ele,cls) {
return ele.className.match(new RegExp('(\\s|^)'+cls+'(\\s|$)'));
}
function addClass(ele,cls) {
if (!this.hasClass(ele,cls)) ele.className += " "+cls;
}
function removeClass(ele,cls) {
if (hasClass(ele,cls)) {
var reg = new RegExp('(\\s|^)'+cls+'(\\s|$)');
ele.className=ele.className.replace(reg,' ');
}
}
function toggleVisibility(linkObj) {
var base = linkObj.getAttribute('id');
var summary = document.getElementById(base + '-summary');
var content = document.getElementById(base + '-content');
var trigger = document.getElementById(base + '-trigger');
if ( hasClass(linkObj,'closed') ) {
summary.style.display = 'none';
content.style.display = 'block';
trigger.src = 'open.png';
removeClass(linkObj,'closed');
addClass(linkObj,'opened');
} else if ( hasClass(linkObj,'opened') ) {
summary.style.display = 'block';
content.style.display = 'none';
trigger.src = 'closed.png';
removeClass(linkObj,'opened');
addClass(linkObj,'closed');
}
return false;
}
</script>
<div class="navigation" id="top">
<div class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
<li><a href="examples.html"><span>Examples</span></a></li>
</ul>
</div>
<div class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>Globals</span></a></li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#define-members">Defines</a> |
<a href="#typedef-members">Typedefs</a> |
<a href="#enum-members">Enumerations</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<h1>settings.h File Reference</h1> </div>
</div>
<div class="contents">
<p>Synthesizer settings.
<a href="#_details">More...</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="define-members"></a>
Defines</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="settings_8h.html#a164b85b99eb8a6d13c3e7554f7d88bae">FLUID_HINT_BOUNDED_BELOW</a> 0x1</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Hint FLUID_HINT_BOUNDED_BELOW indicates that the LowerBound field of the FLUID_PortRangeHint should be considered meaningful. <a href="#a164b85b99eb8a6d13c3e7554f7d88bae"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="settings_8h.html#a8f09ee7b4dd3f700e571b8b6f44c2adb">FLUID_HINT_BOUNDED_ABOVE</a> 0x2</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Hint FLUID_HINT_BOUNDED_ABOVE indicates that the UpperBound field of the FLUID_PortRangeHint should be considered meaningful. <a href="#a8f09ee7b4dd3f700e571b8b6f44c2adb"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="settings_8h.html#a3a8898f5a93139fbc35f5dfe39ed9f5a">FLUID_HINT_TOGGLED</a> 0x4</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Hint FLUID_HINT_TOGGLED indicates that the data item should be considered a Boolean toggle. <a href="#a3a8898f5a93139fbc35f5dfe39ed9f5a"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="settings_8h.html#a0990a5c599b514d3cd3e294fe423a512">FLUID_HINT_SAMPLE_RATE</a> 0x8</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Hint FLUID_HINT_SAMPLE_RATE indicates that any bounds specified should be interpreted as multiples of the sample rate. <a href="#a0990a5c599b514d3cd3e294fe423a512"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="settings_8h.html#ae6f73030de9b962eab8caf292676c528">FLUID_HINT_LOGARITHMIC</a> 0x10</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Hint FLUID_HINT_LOGARITHMIC indicates that it is likely that the user will find it more intuitive to view values using a logarithmic scale. <a href="#ae6f73030de9b962eab8caf292676c528"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="settings_8h.html#a21bdf64fc45834507a750886e06df889">FLUID_HINT_INTEGER</a> 0x20</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Hint FLUID_HINT_INTEGER indicates that a user interface would probably wish to provide a stepped control taking only integer values. <a href="#a21bdf64fc45834507a750886e06df889"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac013bcd190250828af51b08de37d014e"></a><!-- doxytag: member="settings.h::FLUID_HINT_FILENAME" ref="ac013bcd190250828af51b08de37d014e" args="" -->
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="settings_8h.html#ac013bcd190250828af51b08de37d014e">FLUID_HINT_FILENAME</a> 0x01</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">String setting is a file name. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae386fb0005b1896194458f15c27e3dc8"></a><!-- doxytag: member="settings.h::FLUID_HINT_OPTIONLIST" ref="ae386fb0005b1896194458f15c27e3dc8" args="" -->
#define </td><td class="memItemRight" valign="bottom"><a class="el" href="settings_8h.html#ae386fb0005b1896194458f15c27e3dc8">FLUID_HINT_OPTIONLIST</a> 0x02</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Setting is a list of string options. <br/></td></tr>
<tr><td colspan="2"><h2><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">typedef void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="settings_8h.html#a9c6a4524a78623468a7d606d6155c960">fluid_settings_foreach_option_t</a> )(void *data, char *name, char *option)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Callback function type used with <a class="el" href="settings_8h.html#aa9d54c924145af95e66a695230b8df71" title="Iterate the available options for a named string setting, calling the provided callback function for ...">fluid_settings_foreach_option()</a>. <a href="#a9c6a4524a78623468a7d606d6155c960"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">typedef void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="settings_8h.html#a5918e70fee2233ea645cfb1b36dc4fdb">fluid_settings_foreach_t</a> )(void *data, char *name, int type)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Callback function type used with <a class="el" href="settings_8h.html#a2b39a52c967caca6074905500ab19b93" title="Iterate the existing settings defined in a settings object, calling the provided callback function fo...">fluid_settings_foreach()</a>. <a href="#a5918e70fee2233ea645cfb1b36dc4fdb"></a><br/></td></tr>
<tr><td colspan="2"><h2><a name="enum-members"></a>
Enumerations</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">enum </td><td class="memItemRight" valign="bottom"><a class="el" href="settings_8h.html#a3f81ecae0f6b147ca8a7f3be4f24a07a">fluid_types_enum</a> { <br/>
<a class="el" href="settings_8h.html#a3f81ecae0f6b147ca8a7f3be4f24a07aa7afc1bed56f3d4269b22e58a47e59136">FLUID_NO_TYPE</a> = -1,
<a class="el" href="settings_8h.html#a3f81ecae0f6b147ca8a7f3be4f24a07aa5fd6d4d56917aa1225b0c713ab17a088">FLUID_NUM_TYPE</a>,
<a class="el" href="settings_8h.html#a3f81ecae0f6b147ca8a7f3be4f24a07aaac101015b18e0600245d930c16619659">FLUID_INT_TYPE</a>,
<a class="el" href="settings_8h.html#a3f81ecae0f6b147ca8a7f3be4f24a07aa5fb9826b74428753caccfe01091d1000">FLUID_STR_TYPE</a>,
<br/>
<a class="el" href="settings_8h.html#a3f81ecae0f6b147ca8a7f3be4f24a07aa50b8a4a854bda93a6f59b425e8f4acad">FLUID_SET_TYPE</a>
<br/>
}</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight"><p>Settings type. </p>
<a href="settings_8h.html#a3f81ecae0f6b147ca8a7f3be4f24a07a">More...</a><br/></td></tr>
<tr><td colspan="2"><h2><a name="func-members"></a>
Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">FLUIDSYNTH_API <a class="el" href="types_8h.html#aa363402d3c77333b0f070ba531d034ba">fluid_settings_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="settings_8h.html#ad7ab9269a28c2b5852d512ffe3546949">new_fluid_settings</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create a new settings object. <a href="#ad7ab9269a28c2b5852d512ffe3546949"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">FLUIDSYNTH_API void </td><td class="memItemRight" valign="bottom"><a class="el" href="settings_8h.html#a550270f09e4f3c645cbe9e6d3c514ca4">delete_fluid_settings</a> (<a class="el" href="types_8h.html#aa363402d3c77333b0f070ba531d034ba">fluid_settings_t</a> *settings)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Delete the provided settings object. <a href="#a550270f09e4f3c645cbe9e6d3c514ca4"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">FLUIDSYNTH_API int </td><td class="memItemRight" valign="bottom"><a class="el" href="settings_8h.html#a85ddf7b499ae6176f8d8918f44c3d5b1">fluid_settings_get_type</a> (<a class="el" href="types_8h.html#aa363402d3c77333b0f070ba531d034ba">fluid_settings_t</a> *settings, const char *name)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the type of the setting with the given name. <a href="#a85ddf7b499ae6176f8d8918f44c3d5b1"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">FLUIDSYNTH_API int </td><td class="memItemRight" valign="bottom"><a class="el" href="settings_8h.html#a8550a36775af6877f7165fce253c419d">fluid_settings_get_hints</a> (<a class="el" href="types_8h.html#aa363402d3c77333b0f070ba531d034ba">fluid_settings_t</a> *settings, const char *name)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the hints for the named setting as an integer bitmap. <a href="#a8550a36775af6877f7165fce253c419d"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">FLUIDSYNTH_API int </td><td class="memItemRight" valign="bottom"><a class="el" href="settings_8h.html#aac1bb5af4ee2b1c6944f6a4824b0f92f">fluid_settings_is_realtime</a> (<a class="el" href="types_8h.html#aa363402d3c77333b0f070ba531d034ba">fluid_settings_t</a> *settings, const char *name)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Ask whether the setting is changeable in real-time. <a href="#aac1bb5af4ee2b1c6944f6a4824b0f92f"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">FLUIDSYNTH_API int </td><td class="memItemRight" valign="bottom"><a class="el" href="settings_8h.html#a855e6038c9946b206156eb1947746032">fluid_settings_setstr</a> (<a class="el" href="types_8h.html#aa363402d3c77333b0f070ba531d034ba">fluid_settings_t</a> *settings, const char *name, const char *str)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set a string value for a named setting. <a href="#a855e6038c9946b206156eb1947746032"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">FLUIDSYNTH_API int </td><td class="memItemRight" valign="bottom"><a class="el" href="settings_8h.html#ab77b24ccdb7d1eeb96f5933eb6099346">fluid_settings_copystr</a> (<a class="el" href="types_8h.html#aa363402d3c77333b0f070ba531d034ba">fluid_settings_t</a> *settings, const char *name, char *str, int len)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Copy the value of a string setting. <a href="#ab77b24ccdb7d1eeb96f5933eb6099346"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">FLUIDSYNTH_API int </td><td class="memItemRight" valign="bottom"><a class="el" href="settings_8h.html#aa2cf8ed808a4ce5fcfdfb208ea77811b">fluid_settings_dupstr</a> (<a class="el" href="types_8h.html#aa363402d3c77333b0f070ba531d034ba">fluid_settings_t</a> *settings, const char *name, char **str)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Duplicate the value of a string setting. <a href="#aa2cf8ed808a4ce5fcfdfb208ea77811b"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">FLUIDSYNTH_API int </td><td class="memItemRight" valign="bottom"><a class="el" href="settings_8h.html#a137266ba457d0b540b3d28cd084f4049">fluid_settings_getstr</a> (<a class="el" href="types_8h.html#aa363402d3c77333b0f070ba531d034ba">fluid_settings_t</a> *settings, const char *name, char **str)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the value of a string setting. <a href="#a137266ba457d0b540b3d28cd084f4049"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">FLUIDSYNTH_API char * </td><td class="memItemRight" valign="bottom"><a class="el" href="settings_8h.html#a9cfe000758040d2115c071b47d0fb8a2">fluid_settings_getstr_default</a> (<a class="el" href="types_8h.html#aa363402d3c77333b0f070ba531d034ba">fluid_settings_t</a> *settings, const char *name)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the default value of a string setting. <a href="#a9cfe000758040d2115c071b47d0fb8a2"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">FLUIDSYNTH_API int </td><td class="memItemRight" valign="bottom"><a class="el" href="settings_8h.html#a2646edb018c961162845f1711503b597">fluid_settings_str_equal</a> (<a class="el" href="types_8h.html#aa363402d3c77333b0f070ba531d034ba">fluid_settings_t</a> *settings, const char *name, const char *value)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Test a string setting for some value. <a href="#a2646edb018c961162845f1711503b597"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">FLUIDSYNTH_API int </td><td class="memItemRight" valign="bottom"><a class="el" href="settings_8h.html#a2a31fd030256303d4076df5abdd603e7">fluid_settings_setnum</a> (<a class="el" href="types_8h.html#aa363402d3c77333b0f070ba531d034ba">fluid_settings_t</a> *settings, const char *name, double val)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set a numeric value for a named setting. <a href="#a2a31fd030256303d4076df5abdd603e7"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">FLUIDSYNTH_API int </td><td class="memItemRight" valign="bottom"><a class="el" href="settings_8h.html#a619c930e119a4a3889131d67293e2089">fluid_settings_getnum</a> (<a class="el" href="types_8h.html#aa363402d3c77333b0f070ba531d034ba">fluid_settings_t</a> *settings, const char *name, double *val)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the numeric value of a named setting. <a href="#a619c930e119a4a3889131d67293e2089"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">FLUIDSYNTH_API double </td><td class="memItemRight" valign="bottom"><a class="el" href="settings_8h.html#ade9248b7161578e723116ebbbfd1903d">fluid_settings_getnum_default</a> (<a class="el" href="types_8h.html#aa363402d3c77333b0f070ba531d034ba">fluid_settings_t</a> *settings, const char *name)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the default value of a named numeric (double) setting. <a href="#ade9248b7161578e723116ebbbfd1903d"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">FLUIDSYNTH_API void </td><td class="memItemRight" valign="bottom"><a class="el" href="settings_8h.html#ae3359fe58cbe618faf9f5e561ed1e886">fluid_settings_getnum_range</a> (<a class="el" href="types_8h.html#aa363402d3c77333b0f070ba531d034ba">fluid_settings_t</a> *settings, const char *name, double *min, double *max)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the range of values of a numeric setting. <a href="#ae3359fe58cbe618faf9f5e561ed1e886"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">FLUIDSYNTH_API int </td><td class="memItemRight" valign="bottom"><a class="el" href="settings_8h.html#a26e4192ab084382492589f2c5d8b2e2f">fluid_settings_setint</a> (<a class="el" href="types_8h.html#aa363402d3c77333b0f070ba531d034ba">fluid_settings_t</a> *settings, const char *name, int val)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set an integer value for a setting. <a href="#a26e4192ab084382492589f2c5d8b2e2f"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">FLUIDSYNTH_API int </td><td class="memItemRight" valign="bottom"><a class="el" href="settings_8h.html#a4a570095ef3de25e77f4dd9c574bc56c">fluid_settings_getint</a> (<a class="el" href="types_8h.html#aa363402d3c77333b0f070ba531d034ba">fluid_settings_t</a> *settings, const char *name, int *val)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get an integer value setting. <a href="#a4a570095ef3de25e77f4dd9c574bc56c"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">FLUIDSYNTH_API int </td><td class="memItemRight" valign="bottom"><a class="el" href="settings_8h.html#a3468c4156fcd8022411689f82d22f7fb">fluid_settings_getint_default</a> (<a class="el" href="types_8h.html#aa363402d3c77333b0f070ba531d034ba">fluid_settings_t</a> *settings, const char *name)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the default value of an integer setting. <a href="#a3468c4156fcd8022411689f82d22f7fb"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">FLUIDSYNTH_API void </td><td class="memItemRight" valign="bottom"><a class="el" href="settings_8h.html#afd0ad70fbfaea69051e52b41f7df040f">fluid_settings_getint_range</a> (<a class="el" href="types_8h.html#aa363402d3c77333b0f070ba531d034ba">fluid_settings_t</a> *settings, const char *name, int *min, int *max)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the range of values of an integer setting. <a href="#afd0ad70fbfaea69051e52b41f7df040f"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">FLUIDSYNTH_API void </td><td class="memItemRight" valign="bottom"><a class="el" href="settings_8h.html#aa9d54c924145af95e66a695230b8df71">fluid_settings_foreach_option</a> (<a class="el" href="types_8h.html#aa363402d3c77333b0f070ba531d034ba">fluid_settings_t</a> *settings, const char *name, void *data, <a class="el" href="settings_8h.html#a9c6a4524a78623468a7d606d6155c960">fluid_settings_foreach_option_t</a> func)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Iterate the available options for a named string setting, calling the provided callback function for each existing option. <a href="#aa9d54c924145af95e66a695230b8df71"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">FLUIDSYNTH_API int </td><td class="memItemRight" valign="bottom"><a class="el" href="settings_8h.html#a2b0f4f5c31f722633b20e9f2aae45fcc">fluid_settings_option_count</a> (<a class="el" href="types_8h.html#aa363402d3c77333b0f070ba531d034ba">fluid_settings_t</a> *settings, const char *name)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Count option string values for a string setting. <a href="#a2b0f4f5c31f722633b20e9f2aae45fcc"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">FLUIDSYNTH_API char * </td><td class="memItemRight" valign="bottom"><a class="el" href="settings_8h.html#a7c78d673d39c3463339612f7a508cda4">fluid_settings_option_concat</a> (<a class="el" href="types_8h.html#aa363402d3c77333b0f070ba531d034ba">fluid_settings_t</a> *settings, const char *name, const char *separator)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Concatenate options for a string setting together with a separator between. <a href="#a7c78d673d39c3463339612f7a508cda4"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">FLUIDSYNTH_API void </td><td class="memItemRight" valign="bottom"><a class="el" href="settings_8h.html#a2b39a52c967caca6074905500ab19b93">fluid_settings_foreach</a> (<a class="el" href="types_8h.html#aa363402d3c77333b0f070ba531d034ba">fluid_settings_t</a> *settings, void *data, <a class="el" href="settings_8h.html#a5918e70fee2233ea645cfb1b36dc4fdb">fluid_settings_foreach_t</a> func)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Iterate the existing settings defined in a settings object, calling the provided callback function for each setting. <a href="#a2b39a52c967caca6074905500ab19b93"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Synthesizer settings. </p>
<hr/><h2>Define Documentation</h2>
<a class="anchor" id="a164b85b99eb8a6d13c3e7554f7d88bae"></a><!-- doxytag: member="settings.h::FLUID_HINT_BOUNDED_BELOW" ref="a164b85b99eb8a6d13c3e7554f7d88bae" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define FLUID_HINT_BOUNDED_BELOW 0x1</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Hint FLUID_HINT_BOUNDED_BELOW indicates that the LowerBound field of the FLUID_PortRangeHint should be considered meaningful. </p>
<p>The value in this field should be considered the (inclusive) lower bound of the valid range. If FLUID_HINT_SAMPLE_RATE is also specified then the value of LowerBound should be multiplied by the sample rate. </p>
</div>
</div>
<a class="anchor" id="a8f09ee7b4dd3f700e571b8b6f44c2adb"></a><!-- doxytag: member="settings.h::FLUID_HINT_BOUNDED_ABOVE" ref="a8f09ee7b4dd3f700e571b8b6f44c2adb" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define FLUID_HINT_BOUNDED_ABOVE 0x2</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Hint FLUID_HINT_BOUNDED_ABOVE indicates that the UpperBound field of the FLUID_PortRangeHint should be considered meaningful. </p>
<p>The value in this field should be considered the (inclusive) upper bound of the valid range. If FLUID_HINT_SAMPLE_RATE is also specified then the value of UpperBound should be multiplied by the sample rate. </p>
</div>
</div>
<a class="anchor" id="a3a8898f5a93139fbc35f5dfe39ed9f5a"></a><!-- doxytag: member="settings.h::FLUID_HINT_TOGGLED" ref="a3a8898f5a93139fbc35f5dfe39ed9f5a" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define FLUID_HINT_TOGGLED 0x4</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Hint FLUID_HINT_TOGGLED indicates that the data item should be considered a Boolean toggle. </p>
<p>Data less than or equal to zero should be considered `off' or `false,' and data above zero should be considered `on' or `true.' FLUID_HINT_TOGGLED may not be used in conjunction with any other hint. </p>
<p>Referenced by <a class="el" href="settings_8h.html#ab77b24ccdb7d1eeb96f5933eb6099346">fluid_settings_copystr()</a>, <a class="el" href="settings_8h.html#aa2cf8ed808a4ce5fcfdfb208ea77811b">fluid_settings_dupstr()</a>, <a class="el" href="settings_8h.html#a137266ba457d0b540b3d28cd084f4049">fluid_settings_getstr()</a>, <a class="el" href="settings_8h.html#a9cfe000758040d2115c071b47d0fb8a2">fluid_settings_getstr_default()</a>, <a class="el" href="settings_8h.html#a855e6038c9946b206156eb1947746032">fluid_settings_setstr()</a>, and <a class="el" href="settings_8h.html#a2646edb018c961162845f1711503b597">fluid_settings_str_equal()</a>.</p>
</div>
</div>
<a class="anchor" id="a0990a5c599b514d3cd3e294fe423a512"></a><!-- doxytag: member="settings.h::FLUID_HINT_SAMPLE_RATE" ref="a0990a5c599b514d3cd3e294fe423a512" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define FLUID_HINT_SAMPLE_RATE 0x8</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Hint FLUID_HINT_SAMPLE_RATE indicates that any bounds specified should be interpreted as multiples of the sample rate. </p>
<p>For instance, a frequency range from 0Hz to the Nyquist frequency (half the sample rate) could be requested by this hint in conjunction with LowerBound = 0 and UpperBound = 0.5. Hosts that support bounds at all must support this hint to retain meaning. </p>
</div>
</div>
<a class="anchor" id="ae6f73030de9b962eab8caf292676c528"></a><!-- doxytag: member="settings.h::FLUID_HINT_LOGARITHMIC" ref="ae6f73030de9b962eab8caf292676c528" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define FLUID_HINT_LOGARITHMIC 0x10</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Hint FLUID_HINT_LOGARITHMIC indicates that it is likely that the user will find it more intuitive to view values using a logarithmic scale. </p>
<p>This is particularly useful for frequencies and gains. </p>
</div>
</div>
<a class="anchor" id="a21bdf64fc45834507a750886e06df889"></a><!-- doxytag: member="settings.h::FLUID_HINT_INTEGER" ref="a21bdf64fc45834507a750886e06df889" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define FLUID_HINT_INTEGER 0x20</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Hint FLUID_HINT_INTEGER indicates that a user interface would probably wish to provide a stepped control taking only integer values. </p>
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000001">Deprecated:</a></b></dt><dd></dd></dl>
<p>As there is an integer setting type, this hint is not used. </p>
</div>
</div>
<hr/><h2>Typedef Documentation</h2>
<a class="anchor" id="a9c6a4524a78623468a7d606d6155c960"></a><!-- doxytag: member="settings.h::fluid_settings_foreach_option_t" ref="a9c6a4524a78623468a7d606d6155c960" args=")(void *data, char *name, char *option)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef void(* <a class="el" href="settings_8h.html#a9c6a4524a78623468a7d606d6155c960">fluid_settings_foreach_option_t</a>)(void *data, char *name, char *option)</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Callback function type used with <a class="el" href="settings_8h.html#aa9d54c924145af95e66a695230b8df71" title="Iterate the available options for a named string setting, calling the provided callback function for ...">fluid_settings_foreach_option()</a>. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>data</em> </td><td>User defined data pointer </td></tr>
<tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>Setting name </td></tr>
<tr><td valign="top"></td><td valign="top"><em>option</em> </td><td>A string option for this setting (iterates through the list) </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a5918e70fee2233ea645cfb1b36dc4fdb"></a><!-- doxytag: member="settings.h::fluid_settings_foreach_t" ref="a5918e70fee2233ea645cfb1b36dc4fdb" args=")(void *data, char *name, int type)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef void(* <a class="el" href="settings_8h.html#a5918e70fee2233ea645cfb1b36dc4fdb">fluid_settings_foreach_t</a>)(void *data, char *name, int type)</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Callback function type used with <a class="el" href="settings_8h.html#a2b39a52c967caca6074905500ab19b93" title="Iterate the existing settings defined in a settings object, calling the provided callback function fo...">fluid_settings_foreach()</a>. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>data</em> </td><td>User defined data pointer </td></tr>
<tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>Setting name </td></tr>
<tr><td valign="top"></td><td valign="top"><em>type</em> </td><td>Setting type (<a class="el" href="settings_8h.html#a3f81ecae0f6b147ca8a7f3be4f24a07a" title="Settings type.">fluid_types_enum</a>) </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/><h2>Enumeration Type Documentation</h2>
<a class="anchor" id="a3f81ecae0f6b147ca8a7f3be4f24a07a"></a><!-- doxytag: member="settings.h::fluid_types_enum" ref="a3f81ecae0f6b147ca8a7f3be4f24a07a" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="settings_8h.html#a3f81ecae0f6b147ca8a7f3be4f24a07a">fluid_types_enum</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Settings type. </p>
<p>Each setting has a defined type: numeric (double), integer, string or a set of values. The type of each setting can be retrieved using the function <a class="el" href="settings_8h.html#a85ddf7b499ae6176f8d8918f44c3d5b1" title="Get the type of the setting with the given name.">fluid_settings_get_type()</a> </p>
<dl><dt><b>Enumerator: </b></dt><dd><table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><em><a class="anchor" id="a3f81ecae0f6b147ca8a7f3be4f24a07aa7afc1bed56f3d4269b22e58a47e59136"></a><!-- doxytag: member="FLUID_NO_TYPE" ref="a3f81ecae0f6b147ca8a7f3be4f24a07aa7afc1bed56f3d4269b22e58a47e59136" args="" -->FLUID_NO_TYPE</em> </td><td>
<p>Undefined type. </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="a3f81ecae0f6b147ca8a7f3be4f24a07aa5fd6d4d56917aa1225b0c713ab17a088"></a><!-- doxytag: member="FLUID_NUM_TYPE" ref="a3f81ecae0f6b147ca8a7f3be4f24a07aa5fd6d4d56917aa1225b0c713ab17a088" args="" -->FLUID_NUM_TYPE</em> </td><td>
<p>Numeric (double). </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="a3f81ecae0f6b147ca8a7f3be4f24a07aaac101015b18e0600245d930c16619659"></a><!-- doxytag: member="FLUID_INT_TYPE" ref="a3f81ecae0f6b147ca8a7f3be4f24a07aaac101015b18e0600245d930c16619659" args="" -->FLUID_INT_TYPE</em> </td><td>
<p>Integer. </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="a3f81ecae0f6b147ca8a7f3be4f24a07aa5fb9826b74428753caccfe01091d1000"></a><!-- doxytag: member="FLUID_STR_TYPE" ref="a3f81ecae0f6b147ca8a7f3be4f24a07aa5fb9826b74428753caccfe01091d1000" args="" -->FLUID_STR_TYPE</em> </td><td>
<p>String. </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="a3f81ecae0f6b147ca8a7f3be4f24a07aa50b8a4a854bda93a6f59b425e8f4acad"></a><!-- doxytag: member="FLUID_SET_TYPE" ref="a3f81ecae0f6b147ca8a7f3be4f24a07aa50b8a4a854bda93a6f59b425e8f4acad" args="" -->FLUID_SET_TYPE</em> </td><td>
<p>Set of values. </p>
</td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/><h2>Function Documentation</h2>
<a class="anchor" id="ad7ab9269a28c2b5852d512ffe3546949"></a><!-- doxytag: member="settings.h::new_fluid_settings" ref="ad7ab9269a28c2b5852d512ffe3546949" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">FLUIDSYNTH_API <a class="el" href="types_8h.html#aa363402d3c77333b0f070ba531d034ba">fluid_settings_t</a>* new_fluid_settings </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Create a new settings object. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>the pointer to the settings object </dd></dl>
<dl><dt><b>Examples: </b></dt><dd><a class="el" href="example_8c-example.html#a0">example.c</a>, <a class="el" href="fluidsynth__arpeggio_8c-example.html#a8">fluidsynth_arpeggio.c</a>, <a class="el" href="fluidsynth__fx_8c-example.html#a1">fluidsynth_fx.c</a>, <a class="el" href="fluidsynth__metronome_8c-example.html#a7">fluidsynth_metronome.c</a>, and <a class="el" href="fluidsynth__simple_8c-example.html#a0">fluidsynth_simple.c</a>.</dd>
</dl>
<p>References <a class="el" href="settings_8h.html#ad7ab9269a28c2b5852d512ffe3546949">new_fluid_settings()</a>.</p>
<p>Referenced by <a class="el" href="settings_8h.html#ad7ab9269a28c2b5852d512ffe3546949">new_fluid_settings()</a>.</p>
</div>
</div>
<a class="anchor" id="a550270f09e4f3c645cbe9e6d3c514ca4"></a><!-- doxytag: member="settings.h::delete_fluid_settings" ref="a550270f09e4f3c645cbe9e6d3c514ca4" args="(fluid_settings_t *settings)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">FLUIDSYNTH_API void delete_fluid_settings </td>
<td>(</td>
<td class="paramtype"><a class="el" href="types_8h.html#aa363402d3c77333b0f070ba531d034ba">fluid_settings_t</a> * </td>
<td class="paramname"> <em>settings</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Delete the provided settings object. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>settings</em> </td><td>a settings object </td></tr>
</table>
</dd>
</dl>
<dl><dt><b>Examples: </b></dt><dd><a class="el" href="example_8c-example.html#a8">example.c</a>, <a class="el" href="fluidsynth__arpeggio_8c-example.html#a19">fluidsynth_arpeggio.c</a>, <a class="el" href="fluidsynth__fx_8c-example.html#a8">fluidsynth_fx.c</a>, <a class="el" href="fluidsynth__metronome_8c-example.html#a18">fluidsynth_metronome.c</a>, and <a class="el" href="fluidsynth__simple_8c-example.html#a7">fluidsynth_simple.c</a>.</dd>
</dl>
<p>References <a class="el" href="settings_8h.html#a550270f09e4f3c645cbe9e6d3c514ca4">delete_fluid_settings()</a>.</p>
<p>Referenced by <a class="el" href="settings_8h.html#a550270f09e4f3c645cbe9e6d3c514ca4">delete_fluid_settings()</a>.</p>
</div>
</div>
<a class="anchor" id="a85ddf7b499ae6176f8d8918f44c3d5b1"></a><!-- doxytag: member="settings.h::fluid_settings_get_type" ref="a85ddf7b499ae6176f8d8918f44c3d5b1" args="(fluid_settings_t *settings, const char *name)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">FLUIDSYNTH_API int fluid_settings_get_type </td>
<td>(</td>
<td class="paramtype"><a class="el" href="types_8h.html#aa363402d3c77333b0f070ba531d034ba">fluid_settings_t</a> * </td>
<td class="paramname"> <em>settings</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>name</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get the type of the setting with the given name. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>settings</em> </td><td>a settings object </td></tr>
<tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>a setting's name </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>the type for the named setting, or <a class="el" href="settings_8h.html#a3f81ecae0f6b147ca8a7f3be4f24a07aa7afc1bed56f3d4269b22e58a47e59136" title="Undefined type.">FLUID_NO_TYPE</a> when it does not exist </dd></dl>
<p>References <a class="el" href="settings_8h.html#a3f81ecae0f6b147ca8a7f3be4f24a07aa7afc1bed56f3d4269b22e58a47e59136">FLUID_NO_TYPE</a>, and <a class="el" href="settings_8h.html#a85ddf7b499ae6176f8d8918f44c3d5b1">fluid_settings_get_type()</a>.</p>
<p>Referenced by <a class="el" href="settings_8h.html#a85ddf7b499ae6176f8d8918f44c3d5b1">fluid_settings_get_type()</a>.</p>
</div>
</div>
<a class="anchor" id="a8550a36775af6877f7165fce253c419d"></a><!-- doxytag: member="settings.h::fluid_settings_get_hints" ref="a8550a36775af6877f7165fce253c419d" args="(fluid_settings_t *settings, const char *name)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">FLUIDSYNTH_API int fluid_settings_get_hints </td>
<td>(</td>
<td class="paramtype"><a class="el" href="types_8h.html#aa363402d3c77333b0f070ba531d034ba">fluid_settings_t</a> * </td>
<td class="paramname"> <em>settings</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>name</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get the hints for the named setting as an integer bitmap. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>settings</em> </td><td>a settings object </td></tr>
<tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>a setting's name </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>the hints associated to the named setting if it exists, zero otherwise </dd></dl>
<p>References <a class="el" href="settings_8h.html#a3f81ecae0f6b147ca8a7f3be4f24a07aaac101015b18e0600245d930c16619659">FLUID_INT_TYPE</a>, <a class="el" href="settings_8h.html#a3f81ecae0f6b147ca8a7f3be4f24a07aa5fd6d4d56917aa1225b0c713ab17a088">FLUID_NUM_TYPE</a>, <a class="el" href="settings_8h.html#a8550a36775af6877f7165fce253c419d">fluid_settings_get_hints()</a>, and <a class="el" href="settings_8h.html#a3f81ecae0f6b147ca8a7f3be4f24a07aa5fb9826b74428753caccfe01091d1000">FLUID_STR_TYPE</a>.</p>
<p>Referenced by <a class="el" href="settings_8h.html#a8550a36775af6877f7165fce253c419d">fluid_settings_get_hints()</a>.</p>
</div>
</div>
<a class="anchor" id="aac1bb5af4ee2b1c6944f6a4824b0f92f"></a><!-- doxytag: member="settings.h::fluid_settings_is_realtime" ref="aac1bb5af4ee2b1c6944f6a4824b0f92f" args="(fluid_settings_t *settings, const char *name)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">FLUIDSYNTH_API int fluid_settings_is_realtime </td>
<td>(</td>
<td class="paramtype"><a class="el" href="types_8h.html#aa363402d3c77333b0f070ba531d034ba">fluid_settings_t</a> * </td>
<td class="paramname"> <em>settings</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>name</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Ask whether the setting is changeable in real-time. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>settings</em> </td><td>a settings object </td></tr>
<tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>a setting's name </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>non zero if the setting is changeable in real-time </dd></dl>
<p>References <a class="el" href="settings_8h.html#a3f81ecae0f6b147ca8a7f3be4f24a07aaac101015b18e0600245d930c16619659">FLUID_INT_TYPE</a>, <a class="el" href="settings_8h.html#a3f81ecae0f6b147ca8a7f3be4f24a07aa5fd6d4d56917aa1225b0c713ab17a088">FLUID_NUM_TYPE</a>, <a class="el" href="settings_8h.html#aac1bb5af4ee2b1c6944f6a4824b0f92f">fluid_settings_is_realtime()</a>, and <a class="el" href="settings_8h.html#a3f81ecae0f6b147ca8a7f3be4f24a07aa5fb9826b74428753caccfe01091d1000">FLUID_STR_TYPE</a>.</p>
<p>Referenced by <a class="el" href="settings_8h.html#aac1bb5af4ee2b1c6944f6a4824b0f92f">fluid_settings_is_realtime()</a>.</p>
</div>
</div>
<a class="anchor" id="a855e6038c9946b206156eb1947746032"></a><!-- doxytag: member="settings.h::fluid_settings_setstr" ref="a855e6038c9946b206156eb1947746032" args="(fluid_settings_t *settings, const char *name, const char *str)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">FLUIDSYNTH_API int fluid_settings_setstr </td>
<td>(</td>
<td class="paramtype"><a class="el" href="types_8h.html#aa363402d3c77333b0f070ba531d034ba">fluid_settings_t</a> * </td>
<td class="paramname"> <em>settings</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>str</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set a string value for a named setting. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>settings</em> </td><td>a settings object </td></tr>
<tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>a setting's name </td></tr>
<tr><td valign="top"></td><td valign="top"><em>str</em> </td><td>new string value </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>1 if the value has been set, 0 otherwise </dd></dl>
<p>References <a class="el" href="settings_8h.html#a3a8898f5a93139fbc35f5dfe39ed9f5a">FLUID_HINT_TOGGLED</a>, <a class="el" href="settings_8h.html#a3f81ecae0f6b147ca8a7f3be4f24a07aaac101015b18e0600245d930c16619659">FLUID_INT_TYPE</a>, <a class="el" href="settings_8h.html#a855e6038c9946b206156eb1947746032">fluid_settings_setstr()</a>, and <a class="el" href="settings_8h.html#a3f81ecae0f6b147ca8a7f3be4f24a07aa5fb9826b74428753caccfe01091d1000">FLUID_STR_TYPE</a>.</p>
<p>Referenced by <a class="el" href="settings_8h.html#a855e6038c9946b206156eb1947746032">fluid_settings_setstr()</a>.</p>
</div>
</div>
<a class="anchor" id="ab77b24ccdb7d1eeb96f5933eb6099346"></a><!-- doxytag: member="settings.h::fluid_settings_copystr" ref="ab77b24ccdb7d1eeb96f5933eb6099346" args="(fluid_settings_t *settings, const char *name, char *str, int len)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">FLUIDSYNTH_API int fluid_settings_copystr </td>
<td>(</td>
<td class="paramtype"><a class="el" href="types_8h.html#aa363402d3c77333b0f070ba531d034ba">fluid_settings_t</a> * </td>
<td class="paramname"> <em>settings</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char * </td>
<td class="paramname"> <em>str</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>len</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Copy the value of a string setting. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>settings</em> </td><td>a settings object </td></tr>
<tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>a setting's name </td></tr>
<tr><td valign="top"></td><td valign="top"><em>str</em> </td><td>Caller supplied buffer to copy string value to </td></tr>
<tr><td valign="top"></td><td valign="top"><em>len</em> </td><td>Size of 'str' buffer (no more than len bytes will be written, which will always include a zero terminator) </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>1 if the value exists, 0 otherwise </dd></dl>
<dl class="since"><dt><b>Since:</b></dt><dd>1.1.0</dd></dl>
<p>Like <a class="el" href="settings_8h.html#a137266ba457d0b540b3d28cd084f4049" title="Get the value of a string setting.">fluid_settings_getstr()</a> but is thread safe. A size of 256 should be more than sufficient for the string buffer. </p>
<p>References <a class="el" href="settings_8h.html#a3a8898f5a93139fbc35f5dfe39ed9f5a">FLUID_HINT_TOGGLED</a>, <a class="el" href="settings_8h.html#a3f81ecae0f6b147ca8a7f3be4f24a07aaac101015b18e0600245d930c16619659">FLUID_INT_TYPE</a>, <a class="el" href="settings_8h.html#ab77b24ccdb7d1eeb96f5933eb6099346">fluid_settings_copystr()</a>, and <a class="el" href="settings_8h.html#a3f81ecae0f6b147ca8a7f3be4f24a07aa5fb9826b74428753caccfe01091d1000">FLUID_STR_TYPE</a>.</p>
<p>Referenced by <a class="el" href="settings_8h.html#ab77b24ccdb7d1eeb96f5933eb6099346">fluid_settings_copystr()</a>.</p>
</div>
</div>
<a class="anchor" id="aa2cf8ed808a4ce5fcfdfb208ea77811b"></a><!-- doxytag: member="settings.h::fluid_settings_dupstr" ref="aa2cf8ed808a4ce5fcfdfb208ea77811b" args="(fluid_settings_t *settings, const char *name, char **str)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">FLUIDSYNTH_API int fluid_settings_dupstr </td>
<td>(</td>
<td class="paramtype"><a class="el" href="types_8h.html#aa363402d3c77333b0f070ba531d034ba">fluid_settings_t</a> * </td>
<td class="paramname"> <em>settings</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char ** </td>
<td class="paramname"> <em>str</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Duplicate the value of a string setting. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>settings</em> </td><td>a settings object </td></tr>
<tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>a setting's name </td></tr>
<tr><td valign="top"></td><td valign="top"><em>str</em> </td><td>Location to store pointer to allocated duplicate string </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>1 if the value exists and was successfully duplicated, 0 otherwise </dd></dl>
<dl class="since"><dt><b>Since:</b></dt><dd>1.1.0</dd></dl>
<p>Like <a class="el" href="settings_8h.html#ab77b24ccdb7d1eeb96f5933eb6099346" title="Copy the value of a string setting.">fluid_settings_copystr()</a> but allocates a new copy of the string. Caller owns the string and should free it with free() when done using it. </p>
<p>References <a class="el" href="log_8h.html#aa341232c15addd9c336131984840ed9eabc0ff48d192b3b0fc721946ccf095d25">FLUID_ERR</a>, <a class="el" href="settings_8h.html#a3a8898f5a93139fbc35f5dfe39ed9f5a">FLUID_HINT_TOGGLED</a>, <a class="el" href="settings_8h.html#a3f81ecae0f6b147ca8a7f3be4f24a07aaac101015b18e0600245d930c16619659">FLUID_INT_TYPE</a>, <a class="el" href="settings_8h.html#aa2cf8ed808a4ce5fcfdfb208ea77811b">fluid_settings_dupstr()</a>, and <a class="el" href="settings_8h.html#a3f81ecae0f6b147ca8a7f3be4f24a07aa5fb9826b74428753caccfe01091d1000">FLUID_STR_TYPE</a>.</p>
<p>Referenced by <a class="el" href="settings_8h.html#aa2cf8ed808a4ce5fcfdfb208ea77811b">fluid_settings_dupstr()</a>, <a class="el" href="audio_8h.html#a4ad51317b10b89bfe94ade5db345864b">new_fluid_audio_driver()</a>, <a class="el" href="audio_8h.html#a3959d8add1dea97e507a5ea2c802c0bc">new_fluid_audio_driver2()</a>, and <a class="el" href="audio_8h.html#a9d9338a870c5f71ba6fad6db7d17a93e">new_fluid_file_renderer()</a>.</p>
</div>
</div>
<a class="anchor" id="a137266ba457d0b540b3d28cd084f4049"></a><!-- doxytag: member="settings.h::fluid_settings_getstr" ref="a137266ba457d0b540b3d28cd084f4049" args="(fluid_settings_t *settings, const char *name, char **str)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">FLUIDSYNTH_API int fluid_settings_getstr </td>
<td>(</td>
<td class="paramtype"><a class="el" href="types_8h.html#aa363402d3c77333b0f070ba531d034ba">fluid_settings_t</a> * </td>
<td class="paramname"> <em>settings</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char ** </td>
<td class="paramname"> <em>str</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get the value of a string setting. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>settings</em> </td><td>a settings object </td></tr>
<tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>a setting's name </td></tr>
<tr><td valign="top"></td><td valign="top"><em>str</em> </td><td>Location to store pointer to the settings string value </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>1 if the value exists, 0 otherwise </dd></dl>
<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000003">Deprecated:</a></b></dt><dd></dd></dl>
<p>If the value does not exists, 'str' is set to NULL. Otherwise, 'str' will point to the value. The application does not own the returned value and it is valid only until a new value is assigned to the setting of the given name.</p>
<p>NOTE: In a multi-threaded environment, caller must ensure that the setting being read by <a class="el" href="settings_8h.html#a137266ba457d0b540b3d28cd084f4049" title="Get the value of a string setting.">fluid_settings_getstr()</a> is not assigned during the duration of callers use of the setting's value. Use <a class="el" href="settings_8h.html#ab77b24ccdb7d1eeb96f5933eb6099346" title="Copy the value of a string setting.">fluid_settings_copystr()</a> or <a class="el" href="settings_8h.html#aa2cf8ed808a4ce5fcfdfb208ea77811b" title="Duplicate the value of a string setting.">fluid_settings_dupstr()</a> which does not have this restriction. </p>
<p>References <a class="el" href="settings_8h.html#a3a8898f5a93139fbc35f5dfe39ed9f5a">FLUID_HINT_TOGGLED</a>, <a class="el" href="settings_8h.html#a3f81ecae0f6b147ca8a7f3be4f24a07aaac101015b18e0600245d930c16619659">FLUID_INT_TYPE</a>, <a class="el" href="settings_8h.html#a137266ba457d0b540b3d28cd084f4049">fluid_settings_getstr()</a>, and <a class="el" href="settings_8h.html#a3f81ecae0f6b147ca8a7f3be4f24a07aa5fb9826b74428753caccfe01091d1000">FLUID_STR_TYPE</a>.</p>
<p>Referenced by <a class="el" href="settings_8h.html#a137266ba457d0b540b3d28cd084f4049">fluid_settings_getstr()</a>.</p>
</div>
</div>
<a class="anchor" id="a9cfe000758040d2115c071b47d0fb8a2"></a><!-- doxytag: member="settings.h::fluid_settings_getstr_default" ref="a9cfe000758040d2115c071b47d0fb8a2" args="(fluid_settings_t *settings, const char *name)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">FLUIDSYNTH_API char* fluid_settings_getstr_default </td>
<td>(</td>
<td class="paramtype"><a class="el" href="types_8h.html#aa363402d3c77333b0f070ba531d034ba">fluid_settings_t</a> * </td>
<td class="paramname"> <em>settings</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>name</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get the default value of a string setting. </p>
<p>Note that the returned string is not owned by the caller and should not be modified or freed.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>settings</em> </td><td>a settings object </td></tr>
<tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>a setting's name </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>the default string value of the setting if it exists, NULL otherwise </dd></dl>
<p>References <a class="el" href="settings_8h.html#a3a8898f5a93139fbc35f5dfe39ed9f5a">FLUID_HINT_TOGGLED</a>, <a class="el" href="settings_8h.html#a3f81ecae0f6b147ca8a7f3be4f24a07aaac101015b18e0600245d930c16619659">FLUID_INT_TYPE</a>, <a class="el" href="settings_8h.html#a9cfe000758040d2115c071b47d0fb8a2">fluid_settings_getstr_default()</a>, and <a class="el" href="settings_8h.html#a3f81ecae0f6b147ca8a7f3be4f24a07aa5fb9826b74428753caccfe01091d1000">FLUID_STR_TYPE</a>.</p>
<p>Referenced by <a class="el" href="settings_8h.html#a9cfe000758040d2115c071b47d0fb8a2">fluid_settings_getstr_default()</a>.</p>
</div>
</div>
<a class="anchor" id="a2646edb018c961162845f1711503b597"></a><!-- doxytag: member="settings.h::fluid_settings_str_equal" ref="a2646edb018c961162845f1711503b597" args="(fluid_settings_t *settings, const char *name, const char *value)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">FLUIDSYNTH_API int fluid_settings_str_equal </td>
<td>(</td>
<td class="paramtype"><a class="el" href="types_8h.html#aa363402d3c77333b0f070ba531d034ba">fluid_settings_t</a> * </td>
<td class="paramname"> <em>settings</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>s</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Test a string setting for some value. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>settings</em> </td><td>a settings object </td></tr>
<tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>a setting's name </td></tr>
<tr><td valign="top"></td><td valign="top"><em>s</em> </td><td>a string to be tested </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>1 if the value exists and is equal to 's', 0 otherwise </dd></dl>
<p>References <a class="el" href="settings_8h.html#a3a8898f5a93139fbc35f5dfe39ed9f5a">FLUID_HINT_TOGGLED</a>, <a class="el" href="settings_8h.html#a3f81ecae0f6b147ca8a7f3be4f24a07aaac101015b18e0600245d930c16619659">FLUID_INT_TYPE</a>, <a class="el" href="settings_8h.html#a2646edb018c961162845f1711503b597">fluid_settings_str_equal()</a>, and <a class="el" href="settings_8h.html#a3f81ecae0f6b147ca8a7f3be4f24a07aa5fb9826b74428753caccfe01091d1000">FLUID_STR_TYPE</a>.</p>
<p>Referenced by <a class="el" href="settings_8h.html#a2646edb018c961162845f1711503b597">fluid_settings_str_equal()</a>, <a class="el" href="audio_8h.html#a4ad51317b10b89bfe94ade5db345864b">new_fluid_audio_driver()</a>, <a class="el" href="audio_8h.html#a3959d8add1dea97e507a5ea2c802c0bc">new_fluid_audio_driver2()</a>, <a class="el" href="midi_8h.html#ad0971af69fb51398d468b151cba70bee">new_fluid_midi_driver()</a>, <a class="el" href="midi_8h.html#a6a8628edc77c83c6865fde4b1c296773">new_fluid_player()</a>, and <a class="el" href="synth_8h.html#a344f7369c0f57d30f72702d0c88e6178">new_fluid_synth()</a>.</p>
</div>
</div>
<a class="anchor" id="a2a31fd030256303d4076df5abdd603e7"></a><!-- doxytag: member="settings.h::fluid_settings_setnum" ref="a2a31fd030256303d4076df5abdd603e7" args="(fluid_settings_t *settings, const char *name, double val)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">FLUIDSYNTH_API int fluid_settings_setnum </td>
<td>(</td>
<td class="paramtype"><a class="el" href="types_8h.html#aa363402d3c77333b0f070ba531d034ba">fluid_settings_t</a> * </td>
<td class="paramname"> <em>settings</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double </td>
<td class="paramname"> <em>val</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set a numeric value for a named setting. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>settings</em> </td><td>a settings object </td></tr>
<tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>a setting's name </td></tr>
<tr><td valign="top"></td><td valign="top"><em>val</em> </td><td>new setting's value </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>1 if the value has been set, 0 otherwise </dd></dl>
<p>References <a class="el" href="settings_8h.html#a3f81ecae0f6b147ca8a7f3be4f24a07aa5fd6d4d56917aa1225b0c713ab17a088">FLUID_NUM_TYPE</a>, and <a class="el" href="settings_8h.html#a2a31fd030256303d4076df5abdd603e7">fluid_settings_setnum()</a>.</p>
<p>Referenced by <a class="el" href="settings_8h.html#a2a31fd030256303d4076df5abdd603e7">fluid_settings_setnum()</a>.</p>
</div>
</div>
<a class="anchor" id="a619c930e119a4a3889131d67293e2089"></a><!-- doxytag: member="settings.h::fluid_settings_getnum" ref="a619c930e119a4a3889131d67293e2089" args="(fluid_settings_t *settings, const char *name, double *val)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">FLUIDSYNTH_API int fluid_settings_getnum </td>
<td>(</td>
<td class="paramtype"><a class="el" href="types_8h.html#aa363402d3c77333b0f070ba531d034ba">fluid_settings_t</a> * </td>
<td class="paramname"> <em>settings</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double * </td>
<td class="paramname"> <em>val</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get the numeric value of a named setting. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>settings</em> </td><td>a settings object </td></tr>
<tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>a setting's name </td></tr>
<tr><td valign="top"></td><td valign="top"><em>val</em> </td><td>variable pointer to receive the setting's numeric value </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>1 if the value exists, 0 otherwise </dd></dl>
<p>References <a class="el" href="settings_8h.html#a3f81ecae0f6b147ca8a7f3be4f24a07aa5fd6d4d56917aa1225b0c713ab17a088">FLUID_NUM_TYPE</a>, and <a class="el" href="settings_8h.html#a619c930e119a4a3889131d67293e2089">fluid_settings_getnum()</a>.</p>
<p>Referenced by <a class="el" href="settings_8h.html#a619c930e119a4a3889131d67293e2089">fluid_settings_getnum()</a>, <a class="el" href="audio_8h.html#a9d9338a870c5f71ba6fad6db7d17a93e">new_fluid_file_renderer()</a>, and <a class="el" href="synth_8h.html#a344f7369c0f57d30f72702d0c88e6178">new_fluid_synth()</a>.</p>
</div>
</div>
<a class="anchor" id="ade9248b7161578e723116ebbbfd1903d"></a><!-- doxytag: member="settings.h::fluid_settings_getnum_default" ref="ade9248b7161578e723116ebbbfd1903d" args="(fluid_settings_t *settings, const char *name)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">FLUIDSYNTH_API double fluid_settings_getnum_default </td>
<td>(</td>
<td class="paramtype"><a class="el" href="types_8h.html#aa363402d3c77333b0f070ba531d034ba">fluid_settings_t</a> * </td>
<td class="paramname"> <em>settings</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>name</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get the default value of a named numeric (double) setting. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>settings</em> </td><td>a settings object </td></tr>
<tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>a setting's name </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>the default value if the named setting exists, 0.0f otherwise </dd></dl>
<p>References <a class="el" href="settings_8h.html#a3f81ecae0f6b147ca8a7f3be4f24a07aa5fd6d4d56917aa1225b0c713ab17a088">FLUID_NUM_TYPE</a>, and <a class="el" href="settings_8h.html#ade9248b7161578e723116ebbbfd1903d">fluid_settings_getnum_default()</a>.</p>
<p>Referenced by <a class="el" href="settings_8h.html#ade9248b7161578e723116ebbbfd1903d">fluid_settings_getnum_default()</a>.</p>
</div>
</div>
<a class="anchor" id="ae3359fe58cbe618faf9f5e561ed1e886"></a><!-- doxytag: member="settings.h::fluid_settings_getnum_range" ref="ae3359fe58cbe618faf9f5e561ed1e886" args="(fluid_settings_t *settings, const char *name, double *min, double *max)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">FLUIDSYNTH_API void fluid_settings_getnum_range </td>
<td>(</td>
<td class="paramtype"><a class="el" href="types_8h.html#aa363402d3c77333b0f070ba531d034ba">fluid_settings_t</a> * </td>
<td class="paramname"> <em>settings</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double * </td>
<td class="paramname"> <em>min</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double * </td>
<td class="paramname"> <em>max</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get the range of values of a numeric setting. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>settings</em> </td><td>a settings object </td></tr>
<tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>a setting's name </td></tr>
<tr><td valign="top"></td><td valign="top"><em>min</em> </td><td>setting's range lower limit </td></tr>
<tr><td valign="top"></td><td valign="top"><em>max</em> </td><td>setting's range upper limit </td></tr>
</table>
</dd>
</dl>
<p>References <a class="el" href="settings_8h.html#a3f81ecae0f6b147ca8a7f3be4f24a07aa5fd6d4d56917aa1225b0c713ab17a088">FLUID_NUM_TYPE</a>, and <a class="el" href="settings_8h.html#ae3359fe58cbe618faf9f5e561ed1e886">fluid_settings_getnum_range()</a>.</p>
<p>Referenced by <a class="el" href="settings_8h.html#ae3359fe58cbe618faf9f5e561ed1e886">fluid_settings_getnum_range()</a>.</p>
</div>
</div>
<a class="anchor" id="a26e4192ab084382492589f2c5d8b2e2f"></a><!-- doxytag: member="settings.h::fluid_settings_setint" ref="a26e4192ab084382492589f2c5d8b2e2f" args="(fluid_settings_t *settings, const char *name, int val)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">FLUIDSYNTH_API int fluid_settings_setint </td>
<td>(</td>
<td class="paramtype"><a class="el" href="types_8h.html#aa363402d3c77333b0f070ba531d034ba">fluid_settings_t</a> * </td>
<td class="paramname"> <em>settings</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>val</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set an integer value for a setting. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>settings</em> </td><td>a settings object </td></tr>
<tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>a setting's name </td></tr>
<tr><td valign="top"></td><td valign="top"><em>val</em> </td><td>new setting's integer value </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>1 if the value has been set, 0 otherwise </dd></dl>
<p>References <a class="el" href="settings_8h.html#a3f81ecae0f6b147ca8a7f3be4f24a07aaac101015b18e0600245d930c16619659">FLUID_INT_TYPE</a>, and <a class="el" href="settings_8h.html#a26e4192ab084382492589f2c5d8b2e2f">fluid_settings_setint()</a>.</p>
<p>Referenced by <a class="el" href="settings_8h.html#a26e4192ab084382492589f2c5d8b2e2f">fluid_settings_setint()</a>, and <a class="el" href="synth_8h.html#a344f7369c0f57d30f72702d0c88e6178">new_fluid_synth()</a>.</p>
</div>
</div>
<a class="anchor" id="a4a570095ef3de25e77f4dd9c574bc56c"></a><!-- doxytag: member="settings.h::fluid_settings_getint" ref="a4a570095ef3de25e77f4dd9c574bc56c" args="(fluid_settings_t *settings, const char *name, int *val)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">FLUIDSYNTH_API int fluid_settings_getint </td>
<td>(</td>
<td class="paramtype"><a class="el" href="types_8h.html#aa363402d3c77333b0f070ba531d034ba">fluid_settings_t</a> * </td>
<td class="paramname"> <em>settings</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int * </td>
<td class="paramname"> <em>val</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get an integer value setting. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>settings</em> </td><td>a settings object </td></tr>
<tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>a setting's name </td></tr>
<tr><td valign="top"></td><td valign="top"><em>val</em> </td><td>pointer to a variable to receive the setting's integer value </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>1 if the value exists, 0 otherwise </dd></dl>
<p>References <a class="el" href="settings_8h.html#a3f81ecae0f6b147ca8a7f3be4f24a07aaac101015b18e0600245d930c16619659">FLUID_INT_TYPE</a>, and <a class="el" href="settings_8h.html#a4a570095ef3de25e77f4dd9c574bc56c">fluid_settings_getint()</a>.</p>
<p>Referenced by <a class="el" href="settings_8h.html#a4a570095ef3de25e77f4dd9c574bc56c">fluid_settings_getint()</a>, <a class="el" href="synth_8h.html#ab614bfeafc8b8b632cf1433f8dfce85a">fluid_synth_set_sample_rate()</a>, <a class="el" href="audio_8h.html#a9d9338a870c5f71ba6fad6db7d17a93e">new_fluid_file_renderer()</a>, <a class="el" href="midi_8h.html#ae28ddf804fa5ba108a65c24fcf6e9813">new_fluid_midi_router()</a>, <a class="el" href="midi_8h.html#a6a8628edc77c83c6865fde4b1c296773">new_fluid_player()</a>, <a class="el" href="shell_8h.html#a9c3112867149e88cef2e24acef57a4d3">new_fluid_server()</a>, and <a class="el" href="synth_8h.html#a344f7369c0f57d30f72702d0c88e6178">new_fluid_synth()</a>.</p>
</div>
</div>
<a class="anchor" id="a3468c4156fcd8022411689f82d22f7fb"></a><!-- doxytag: member="settings.h::fluid_settings_getint_default" ref="a3468c4156fcd8022411689f82d22f7fb" args="(fluid_settings_t *settings, const char *name)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">FLUIDSYNTH_API int fluid_settings_getint_default </td>
<td>(</td>
<td class="paramtype"><a class="el" href="types_8h.html#aa363402d3c77333b0f070ba531d034ba">fluid_settings_t</a> * </td>
<td class="paramname"> <em>settings</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>name</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get the default value of an integer setting. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>settings</em> </td><td>a settings object </td></tr>
<tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>a setting's name </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>the setting's default integer value it it exists, zero otherwise </dd></dl>
<p>References <a class="el" href="settings_8h.html#a3f81ecae0f6b147ca8a7f3be4f24a07aaac101015b18e0600245d930c16619659">FLUID_INT_TYPE</a>, and <a class="el" href="settings_8h.html#a3468c4156fcd8022411689f82d22f7fb">fluid_settings_getint_default()</a>.</p>
<p>Referenced by <a class="el" href="settings_8h.html#a3468c4156fcd8022411689f82d22f7fb">fluid_settings_getint_default()</a>.</p>
</div>
</div>
<a class="anchor" id="afd0ad70fbfaea69051e52b41f7df040f"></a><!-- doxytag: member="settings.h::fluid_settings_getint_range" ref="afd0ad70fbfaea69051e52b41f7df040f" args="(fluid_settings_t *settings, const char *name, int *min, int *max)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">FLUIDSYNTH_API void fluid_settings_getint_range </td>
<td>(</td>
<td class="paramtype"><a class="el" href="types_8h.html#aa363402d3c77333b0f070ba531d034ba">fluid_settings_t</a> * </td>
<td class="paramname"> <em>settings</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int * </td>
<td class="paramname"> <em>min</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int * </td>
<td class="paramname"> <em>max</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get the range of values of an integer setting. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>settings</em> </td><td>a settings object </td></tr>
<tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>a setting's name </td></tr>
<tr><td valign="top"></td><td valign="top"><em>min</em> </td><td>setting's range lower limit </td></tr>
<tr><td valign="top"></td><td valign="top"><em>max</em> </td><td>setting's range upper limit </td></tr>
</table>
</dd>
</dl>
<p>References <a class="el" href="settings_8h.html#a3f81ecae0f6b147ca8a7f3be4f24a07aaac101015b18e0600245d930c16619659">FLUID_INT_TYPE</a>, and <a class="el" href="settings_8h.html#afd0ad70fbfaea69051e52b41f7df040f">fluid_settings_getint_range()</a>.</p>
<p>Referenced by <a class="el" href="settings_8h.html#afd0ad70fbfaea69051e52b41f7df040f">fluid_settings_getint_range()</a>.</p>
</div>
</div>
<a class="anchor" id="aa9d54c924145af95e66a695230b8df71"></a><!-- doxytag: member="settings.h::fluid_settings_foreach_option" ref="aa9d54c924145af95e66a695230b8df71" args="(fluid_settings_t *settings, const char *name, void *data, fluid_settings_foreach_option_t func)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">FLUIDSYNTH_API void fluid_settings_foreach_option </td>
<td>(</td>
<td class="paramtype"><a class="el" href="types_8h.html#aa363402d3c77333b0f070ba531d034ba">fluid_settings_t</a> * </td>
<td class="paramname"> <em>settings</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void * </td>
<td class="paramname"> <em>data</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="settings_8h.html#a9c6a4524a78623468a7d606d6155c960">fluid_settings_foreach_option_t</a> </td>
<td class="paramname"> <em>func</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Iterate the available options for a named string setting, calling the provided callback function for each existing option. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>settings</em> </td><td>a settings object </td></tr>
<tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>a setting's name </td></tr>
<tr><td valign="top"></td><td valign="top"><em>data</em> </td><td>any user provided pointer </td></tr>
<tr><td valign="top"></td><td valign="top"><em>func</em> </td><td>callback function to be called on each iteration</td></tr>
</table>
</dd>
</dl>
<p>NOTE: Starting with FluidSynth 1.1.0 the <em>func</em> callback is called for each option in alphabetical order. Sort order was undefined in previous versions. </p>
<p>References <a class="el" href="settings_8h.html#aa9d54c924145af95e66a695230b8df71">fluid_settings_foreach_option()</a>, and <a class="el" href="settings_8h.html#a3f81ecae0f6b147ca8a7f3be4f24a07aa5fb9826b74428753caccfe01091d1000">FLUID_STR_TYPE</a>.</p>
<p>Referenced by <a class="el" href="settings_8h.html#aa9d54c924145af95e66a695230b8df71">fluid_settings_foreach_option()</a>.</p>
</div>
</div>
<a class="anchor" id="a2b0f4f5c31f722633b20e9f2aae45fcc"></a><!-- doxytag: member="settings.h::fluid_settings_option_count" ref="a2b0f4f5c31f722633b20e9f2aae45fcc" args="(fluid_settings_t *settings, const char *name)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">FLUIDSYNTH_API int fluid_settings_option_count </td>
<td>(</td>
<td class="paramtype"><a class="el" href="types_8h.html#aa363402d3c77333b0f070ba531d034ba">fluid_settings_t</a> * </td>
<td class="paramname"> <em>settings</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>name</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Count option string values for a string setting. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>settings</em> </td><td>a settings object </td></tr>
<tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>Name of setting </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Count of options for this string setting (0 if none, -1 if not found or not a string setting) </dd></dl>
<dl class="since"><dt><b>Since:</b></dt><dd>1.1.0 </dd></dl>
<p>References <a class="el" href="settings_8h.html#a2b0f4f5c31f722633b20e9f2aae45fcc">fluid_settings_option_count()</a>, and <a class="el" href="settings_8h.html#a3f81ecae0f6b147ca8a7f3be4f24a07aa5fb9826b74428753caccfe01091d1000">FLUID_STR_TYPE</a>.</p>
<p>Referenced by <a class="el" href="settings_8h.html#a2b0f4f5c31f722633b20e9f2aae45fcc">fluid_settings_option_count()</a>.</p>
</div>
</div>
<a class="anchor" id="a7c78d673d39c3463339612f7a508cda4"></a><!-- doxytag: member="settings.h::fluid_settings_option_concat" ref="a7c78d673d39c3463339612f7a508cda4" args="(fluid_settings_t *settings, const char *name, const char *separator)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">FLUIDSYNTH_API char* fluid_settings_option_concat </td>
<td>(</td>
<td class="paramtype"><a class="el" href="types_8h.html#aa363402d3c77333b0f070ba531d034ba">fluid_settings_t</a> * </td>
<td class="paramname"> <em>settings</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>separator</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Concatenate options for a string setting together with a separator between. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>settings</em> </td><td>Settings object </td></tr>
<tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>Settings name </td></tr>
<tr><td valign="top"></td><td valign="top"><em>separator</em> </td><td>String to use between options (NULL to use ", ") </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>Newly allocated string or NULL on error (out of memory, not a valid setting <em>name</em> or not a string setting). Free the string when finished with it. </dd></dl>
<dl class="since"><dt><b>Since:</b></dt><dd>1.1.0 </dd></dl>
<p>References <a class="el" href="log_8h.html#aa341232c15addd9c336131984840ed9eabc0ff48d192b3b0fc721946ccf095d25">FLUID_ERR</a>, <a class="el" href="settings_8h.html#a7c78d673d39c3463339612f7a508cda4">fluid_settings_option_concat()</a>, and <a class="el" href="settings_8h.html#a3f81ecae0f6b147ca8a7f3be4f24a07aa5fb9826b74428753caccfe01091d1000">FLUID_STR_TYPE</a>.</p>
<p>Referenced by <a class="el" href="settings_8h.html#a7c78d673d39c3463339612f7a508cda4">fluid_settings_option_concat()</a>, <a class="el" href="audio_8h.html#a4ad51317b10b89bfe94ade5db345864b">new_fluid_audio_driver()</a>, and <a class="el" href="midi_8h.html#ad0971af69fb51398d468b151cba70bee">new_fluid_midi_driver()</a>.</p>
</div>
</div>
<a class="anchor" id="a2b39a52c967caca6074905500ab19b93"></a><!-- doxytag: member="settings.h::fluid_settings_foreach" ref="a2b39a52c967caca6074905500ab19b93" args="(fluid_settings_t *settings, void *data, fluid_settings_foreach_t func)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">FLUIDSYNTH_API void fluid_settings_foreach </td>
<td>(</td>
<td class="paramtype"><a class="el" href="types_8h.html#aa363402d3c77333b0f070ba531d034ba">fluid_settings_t</a> * </td>
<td class="paramname"> <em>settings</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void * </td>
<td class="paramname"> <em>data</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="settings_8h.html#a5918e70fee2233ea645cfb1b36dc4fdb">fluid_settings_foreach_t</a> </td>
<td class="paramname"> <em>func</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Iterate the existing settings defined in a settings object, calling the provided callback function for each setting. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>settings</em> </td><td>a settings object </td></tr>
<tr><td valign="top"></td><td valign="top"><em>data</em> </td><td>any user provided pointer </td></tr>
<tr><td valign="top"></td><td valign="top"><em>func</em> </td><td>callback function to be called on each iteration</td></tr>
</table>
</dd>
</dl>
<p>NOTE: Starting with FluidSynth 1.1.0 the <em>func</em> callback is called for each setting in alphabetical order. Sort order was undefined in previous versions. </p>
<p>References <a class="el" href="settings_8h.html#a2b39a52c967caca6074905500ab19b93">fluid_settings_foreach()</a>.</p>
<p>Referenced by <a class="el" href="settings_8h.html#a2b39a52c967caca6074905500ab19b93">fluid_settings_foreach()</a>.</p>
</div>
</div>
</div>
<hr class="footer"/><address class="footer"><small>Generated on Tue Oct 12 2010 for libfluidsynth by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.1 </small></address>
</body>
</html>
distrib
>
Fedora
>
14
>
x86_64
>
media
>
updates
>
by-pkgid
>
0a2d1da5078620d6abbc0a5e920f2a92
>
files
>
77
