/usr/share/doc/libjuce/apiref/classAudioParameterFloat.html is in libjuce-doc 4.3.0~repack-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 | <!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"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.12"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>JUCE: AudioParameterFloat Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">JUCE
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.12 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pub-attribs">Public Attributes</a> |
<a href="classAudioParameterFloat-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">AudioParameterFloat Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>A subclass of <a class="el" href="classAudioProcessorParameter.html" title="An abstract base class for parameter objects that can be added to an AudioProcessor. ">AudioProcessorParameter</a> that provides an easy way to create a parameter which maps onto a given <a class="el" href="classNormalisableRange.html" title="Represents a mapping between an arbitrary range of values and a normalised 0->1 range. ">NormalisableRange</a>.
<a href="classAudioParameterFloat.html#details">More...</a></p>
<div id="dynsection-0" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
<img id="dynsection-0-trigger" src="closed.png" alt="+"/> Inheritance diagram for AudioParameterFloat:</div>
<div id="dynsection-0-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-0-content" class="dyncontent" style="display:none;">
<div class="center">
<img src="classAudioParameterFloat.png" usemap="#AudioParameterFloat_map" alt=""/>
<map id="AudioParameterFloat_map" name="AudioParameterFloat_map">
<area href="classAudioProcessorParameterWithID.html" title="This abstract base class is used by some AudioProcessorParameter helper classes. " alt="AudioProcessorParameterWithID" shape="rect" coords="0,56,197,80"/>
<area href="classAudioProcessorParameter.html" title="An abstract base class for parameter objects that can be added to an AudioProcessor. " alt="AudioProcessorParameter" shape="rect" coords="0,0,197,24"/>
</map>
</div></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:ad73605e2ffbdea9534ce9d07acadea2b"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classAudioParameterFloat.html#ad73605e2ffbdea9534ce9d07acadea2b">AudioParameterFloat</a> (<a class="el" href="classString.html">String</a> parameterID, <a class="el" href="classString.html">String</a> <a class="el" href="classAudioProcessorParameterWithID.html#a26e3f108f8a3fabf92bb942518f9fd39">name</a>, <a class="el" href="classNormalisableRange.html">NormalisableRange</a>< float > normalisableRange, float defaultValue)</td></tr>
<tr class="memdesc:ad73605e2ffbdea9534ce9d07acadea2b"><td class="mdescLeft"> </td><td class="mdescRight">Creates a <a class="el" href="classAudioParameterFloat.html" title="A subclass of AudioProcessorParameter that provides an easy way to create a parameter which maps onto...">AudioParameterFloat</a> with an ID, name, and range. <a href="#ad73605e2ffbdea9534ce9d07acadea2b">More...</a><br /></td></tr>
<tr class="separator:ad73605e2ffbdea9534ce9d07acadea2b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:affbd6b7716d9ea098b5bcead7c3e5a89"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classAudioParameterFloat.html#affbd6b7716d9ea098b5bcead7c3e5a89">AudioParameterFloat</a> (<a class="el" href="classString.html">String</a> parameterID, <a class="el" href="classString.html">String</a> <a class="el" href="classAudioProcessorParameterWithID.html#a26e3f108f8a3fabf92bb942518f9fd39">name</a>, float minValue, float maxValue, float defaultValue)</td></tr>
<tr class="memdesc:affbd6b7716d9ea098b5bcead7c3e5a89"><td class="mdescLeft"> </td><td class="mdescRight">Creates a <a class="el" href="classAudioParameterFloat.html" title="A subclass of AudioProcessorParameter that provides an easy way to create a parameter which maps onto...">AudioParameterFloat</a> with an ID, name, and range. <a href="#affbd6b7716d9ea098b5bcead7c3e5a89">More...</a><br /></td></tr>
<tr class="separator:affbd6b7716d9ea098b5bcead7c3e5a89"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a506f108d60273f9af854852b25bd4598"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classAudioParameterFloat.html#a506f108d60273f9af854852b25bd4598">~AudioParameterFloat</a> ()</td></tr>
<tr class="memdesc:a506f108d60273f9af854852b25bd4598"><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#a506f108d60273f9af854852b25bd4598">More...</a><br /></td></tr>
<tr class="separator:a506f108d60273f9af854852b25bd4598"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5dfe7c0b452beac16f139029d83106c5"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="classAudioParameterFloat.html#a5dfe7c0b452beac16f139029d83106c5">get</a> () const noexcept</td></tr>
<tr class="memdesc:a5dfe7c0b452beac16f139029d83106c5"><td class="mdescLeft"> </td><td class="mdescRight">Returns the parameter's current value. <a href="#a5dfe7c0b452beac16f139029d83106c5">More...</a><br /></td></tr>
<tr class="separator:a5dfe7c0b452beac16f139029d83106c5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aebdc357fc8e777d8070149e721d78132"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classAudioParameterFloat.html#aebdc357fc8e777d8070149e721d78132">operator float</a> () const noexcept</td></tr>
<tr class="memdesc:aebdc357fc8e777d8070149e721d78132"><td class="mdescLeft"> </td><td class="mdescRight">Returns the parameter's current value. <a href="#aebdc357fc8e777d8070149e721d78132">More...</a><br /></td></tr>
<tr class="separator:aebdc357fc8e777d8070149e721d78132"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a76a147ac794e800cc6b8f8f34987a659"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classAudioParameterFloat.html">AudioParameterFloat</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classAudioParameterFloat.html#a76a147ac794e800cc6b8f8f34987a659">operator=</a> (float newValue)</td></tr>
<tr class="memdesc:a76a147ac794e800cc6b8f8f34987a659"><td class="mdescLeft"> </td><td class="mdescRight">Changes the parameter's current value. <a href="#a76a147ac794e800cc6b8f8f34987a659">More...</a><br /></td></tr>
<tr class="separator:a76a147ac794e800cc6b8f8f34987a659"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="inherit_header pub_methods_classAudioProcessorParameterWithID"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classAudioProcessorParameterWithID')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classAudioProcessorParameterWithID.html">AudioProcessorParameterWithID</a></td></tr>
<tr class="memitem:a26d780f6300ec2ff6433c95b3493fb17 inherit pub_methods_classAudioProcessorParameterWithID"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classAudioProcessorParameterWithID.html#a26d780f6300ec2ff6433c95b3493fb17">AudioProcessorParameterWithID</a> (<a class="el" href="classString.html">String</a> parameterID, <a class="el" href="classString.html">String</a> <a class="el" href="classAudioProcessorParameterWithID.html#a26e3f108f8a3fabf92bb942518f9fd39">name</a>)</td></tr>
<tr class="memdesc:a26d780f6300ec2ff6433c95b3493fb17 inherit pub_methods_classAudioProcessorParameterWithID"><td class="mdescLeft"> </td><td class="mdescRight">Creation of this object requires providing a name and ID which will be constant for its lifetime. <a href="classAudioProcessorParameterWithID.html#a26d780f6300ec2ff6433c95b3493fb17">More...</a><br /></td></tr>
<tr class="separator:a26d780f6300ec2ff6433c95b3493fb17 inherit pub_methods_classAudioProcessorParameterWithID"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6382be17ef344cdd6b6a8b839fdc0909 inherit pub_methods_classAudioProcessorParameterWithID"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classAudioProcessorParameterWithID.html#a6382be17ef344cdd6b6a8b839fdc0909">~AudioProcessorParameterWithID</a> ()</td></tr>
<tr class="memdesc:a6382be17ef344cdd6b6a8b839fdc0909 inherit pub_methods_classAudioProcessorParameterWithID"><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="classAudioProcessorParameterWithID.html#a6382be17ef344cdd6b6a8b839fdc0909">More...</a><br /></td></tr>
<tr class="separator:a6382be17ef344cdd6b6a8b839fdc0909 inherit pub_methods_classAudioProcessorParameterWithID"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="inherit_header pub_methods_classAudioProcessorParameter"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classAudioProcessorParameter')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classAudioProcessorParameter.html">AudioProcessorParameter</a></td></tr>
<tr class="memitem:a3df493838d2f048ff182fef75f535729 inherit pub_methods_classAudioProcessorParameter"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classAudioProcessorParameter.html#a3df493838d2f048ff182fef75f535729">AudioProcessorParameter</a> () noexcept</td></tr>
<tr class="separator:a3df493838d2f048ff182fef75f535729 inherit pub_methods_classAudioProcessorParameter"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a30e812a7e141bb25f509980d7d11d27b inherit pub_methods_classAudioProcessorParameter"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classAudioProcessorParameter.html#a30e812a7e141bb25f509980d7d11d27b">~AudioProcessorParameter</a> ()</td></tr>
<tr class="memdesc:a30e812a7e141bb25f509980d7d11d27b inherit pub_methods_classAudioProcessorParameter"><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="classAudioProcessorParameter.html#a30e812a7e141bb25f509980d7d11d27b">More...</a><br /></td></tr>
<tr class="separator:a30e812a7e141bb25f509980d7d11d27b inherit pub_methods_classAudioProcessorParameter"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac9b67f35339db50d2bd9a026d89390e1 inherit pub_methods_classAudioProcessorParameter"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classAudioProcessorParameter.html#ac9b67f35339db50d2bd9a026d89390e1">setValueNotifyingHost</a> (float newValue)</td></tr>
<tr class="memdesc:ac9b67f35339db50d2bd9a026d89390e1 inherit pub_methods_classAudioProcessorParameter"><td class="mdescLeft"> </td><td class="mdescRight">Your filter can call this when it needs to change one of its parameters. <a href="classAudioProcessorParameter.html#ac9b67f35339db50d2bd9a026d89390e1">More...</a><br /></td></tr>
<tr class="separator:ac9b67f35339db50d2bd9a026d89390e1 inherit pub_methods_classAudioProcessorParameter"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aae70f0cce34b664206323bc277096ddc inherit pub_methods_classAudioProcessorParameter"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classAudioProcessorParameter.html#aae70f0cce34b664206323bc277096ddc">beginChangeGesture</a> ()</td></tr>
<tr class="memdesc:aae70f0cce34b664206323bc277096ddc inherit pub_methods_classAudioProcessorParameter"><td class="mdescLeft"> </td><td class="mdescRight">Sends a signal to the host to tell it that the user is about to start changing this parameter. <a href="classAudioProcessorParameter.html#aae70f0cce34b664206323bc277096ddc">More...</a><br /></td></tr>
<tr class="separator:aae70f0cce34b664206323bc277096ddc inherit pub_methods_classAudioProcessorParameter"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a50c2a826a7aa77dbe0e55e77a93d061e inherit pub_methods_classAudioProcessorParameter"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classAudioProcessorParameter.html#a50c2a826a7aa77dbe0e55e77a93d061e">endChangeGesture</a> ()</td></tr>
<tr class="memdesc:a50c2a826a7aa77dbe0e55e77a93d061e inherit pub_methods_classAudioProcessorParameter"><td class="mdescLeft"> </td><td class="mdescRight">Tells the host that the user has finished changing this parameter. <a href="classAudioProcessorParameter.html#a50c2a826a7aa77dbe0e55e77a93d061e">More...</a><br /></td></tr>
<tr class="separator:a50c2a826a7aa77dbe0e55e77a93d061e inherit pub_methods_classAudioProcessorParameter"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aca91257a6bd003f3541a907f028142e3 inherit pub_methods_classAudioProcessorParameter"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classAudioProcessorParameter.html#aca91257a6bd003f3541a907f028142e3">isOrientationInverted</a> () const</td></tr>
<tr class="memdesc:aca91257a6bd003f3541a907f028142e3 inherit pub_methods_classAudioProcessorParameter"><td class="mdescLeft"> </td><td class="mdescRight">This can be overridden to tell the host that this parameter operates in the reverse direction. <a href="classAudioProcessorParameter.html#aca91257a6bd003f3541a907f028142e3">More...</a><br /></td></tr>
<tr class="separator:aca91257a6bd003f3541a907f028142e3 inherit pub_methods_classAudioProcessorParameter"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:abcb70fe341ff9e30c7e1c5f6f9dae447 inherit pub_methods_classAudioProcessorParameter"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classAudioProcessorParameter.html#abcb70fe341ff9e30c7e1c5f6f9dae447">isAutomatable</a> () const</td></tr>
<tr class="memdesc:abcb70fe341ff9e30c7e1c5f6f9dae447 inherit pub_methods_classAudioProcessorParameter"><td class="mdescLeft"> </td><td class="mdescRight">Returns true if the host can automate this parameter. <a href="classAudioProcessorParameter.html#abcb70fe341ff9e30c7e1c5f6f9dae447">More...</a><br /></td></tr>
<tr class="separator:abcb70fe341ff9e30c7e1c5f6f9dae447 inherit pub_methods_classAudioProcessorParameter"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4e415c0f716226806880acf93d4237e6 inherit pub_methods_classAudioProcessorParameter"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classAudioProcessorParameter.html#a4e415c0f716226806880acf93d4237e6">isMetaParameter</a> () const</td></tr>
<tr class="memdesc:a4e415c0f716226806880acf93d4237e6 inherit pub_methods_classAudioProcessorParameter"><td class="mdescLeft"> </td><td class="mdescRight">Should return true if this parameter is a "meta" parameter. <a href="classAudioProcessorParameter.html#a4e415c0f716226806880acf93d4237e6">More...</a><br /></td></tr>
<tr class="separator:a4e415c0f716226806880acf93d4237e6 inherit pub_methods_classAudioProcessorParameter"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a35b9c23ce77721f84bc4686e217d76f7 inherit pub_methods_classAudioProcessorParameter"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classAudioProcessorParameter.html#a35b9c23ce77721f84bc4686e217d76f7">getParameterIndex</a> () const noexcept</td></tr>
<tr class="memdesc:a35b9c23ce77721f84bc4686e217d76f7 inherit pub_methods_classAudioProcessorParameter"><td class="mdescLeft"> </td><td class="mdescRight">Returns the index of this parameter in its parent processor's parameter list. <a href="classAudioProcessorParameter.html#a35b9c23ce77721f84bc4686e217d76f7">More...</a><br /></td></tr>
<tr class="separator:a35b9c23ce77721f84bc4686e217d76f7 inherit pub_methods_classAudioProcessorParameter"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:a7e860466dbc1319bc064cd6e7db382e3"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classNormalisableRange.html">NormalisableRange</a>< float > </td><td class="memItemRight" valign="bottom"><a class="el" href="classAudioParameterFloat.html#a7e860466dbc1319bc064cd6e7db382e3">range</a></td></tr>
<tr class="memdesc:a7e860466dbc1319bc064cd6e7db382e3"><td class="mdescLeft"> </td><td class="mdescRight">Provides access to the parameter's range. <a href="#a7e860466dbc1319bc064cd6e7db382e3">More...</a><br /></td></tr>
<tr class="separator:a7e860466dbc1319bc064cd6e7db382e3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="inherit_header pub_attribs_classAudioProcessorParameterWithID"><td colspan="2" onclick="javascript:toggleInherit('pub_attribs_classAudioProcessorParameterWithID')"><img src="closed.png" alt="-"/> Public Attributes inherited from <a class="el" href="classAudioProcessorParameterWithID.html">AudioProcessorParameterWithID</a></td></tr>
<tr class="memitem:a09fd779999685889367257e36ff648da inherit pub_attribs_classAudioProcessorParameterWithID"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classString.html">String</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classAudioProcessorParameterWithID.html#a09fd779999685889367257e36ff648da">paramID</a></td></tr>
<tr class="memdesc:a09fd779999685889367257e36ff648da inherit pub_attribs_classAudioProcessorParameterWithID"><td class="mdescLeft"> </td><td class="mdescRight">Provides access to the parameter's ID string. <a href="classAudioProcessorParameterWithID.html#a09fd779999685889367257e36ff648da">More...</a><br /></td></tr>
<tr class="separator:a09fd779999685889367257e36ff648da inherit pub_attribs_classAudioProcessorParameterWithID"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a26e3f108f8a3fabf92bb942518f9fd39 inherit pub_attribs_classAudioProcessorParameterWithID"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classString.html">String</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classAudioProcessorParameterWithID.html#a26e3f108f8a3fabf92bb942518f9fd39">name</a></td></tr>
<tr class="memdesc:a26e3f108f8a3fabf92bb942518f9fd39 inherit pub_attribs_classAudioProcessorParameterWithID"><td class="mdescLeft"> </td><td class="mdescRight">Provides access to the parameter's name. <a href="classAudioProcessorParameterWithID.html#a26e3f108f8a3fabf92bb942518f9fd39">More...</a><br /></td></tr>
<tr class="separator:a26e3f108f8a3fabf92bb942518f9fd39 inherit pub_attribs_classAudioProcessorParameterWithID"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac9e5aa7e602b64e78fda51972375579c inherit pub_attribs_classAudioProcessorParameterWithID"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classString.html">String</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classAudioProcessorParameterWithID.html#ac9e5aa7e602b64e78fda51972375579c">label</a></td></tr>
<tr class="memdesc:ac9e5aa7e602b64e78fda51972375579c inherit pub_attribs_classAudioProcessorParameterWithID"><td class="mdescLeft"> </td><td class="mdescRight">Provides access to the parameter's label. <a href="classAudioProcessorParameterWithID.html#ac9e5aa7e602b64e78fda51972375579c">More...</a><br /></td></tr>
<tr class="separator:ac9e5aa7e602b64e78fda51972375579c inherit pub_attribs_classAudioProcessorParameterWithID"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>A subclass of <a class="el" href="classAudioProcessorParameter.html" title="An abstract base class for parameter objects that can be added to an AudioProcessor. ">AudioProcessorParameter</a> that provides an easy way to create a parameter which maps onto a given <a class="el" href="classNormalisableRange.html" title="Represents a mapping between an arbitrary range of values and a normalised 0->1 range. ">NormalisableRange</a>. </p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classAudioParameterInt.html" title="Provides a class of AudioProcessorParameter that can be used as an integer value with a given range...">AudioParameterInt</a>, <a class="el" href="classAudioParameterBool.html" title="Provides a class of AudioProcessorParameter that can be used as a boolean value. ">AudioParameterBool</a>, <a class="el" href="classAudioParameterChoice.html" title="Provides a class of AudioProcessorParameter that can be used to select an indexed, named choice from a list. ">AudioParameterChoice</a> </dd></dl>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a id="ad73605e2ffbdea9534ce9d07acadea2b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad73605e2ffbdea9534ce9d07acadea2b">§ </a></span>AudioParameterFloat() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">AudioParameterFloat::AudioParameterFloat </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classString.html">String</a> </td>
<td class="paramname"><em>parameterID</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classString.html">String</a> </td>
<td class="paramname"><em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classNormalisableRange.html">NormalisableRange</a>< float > </td>
<td class="paramname"><em>normalisableRange</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float </td>
<td class="paramname"><em>defaultValue</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Creates a <a class="el" href="classAudioParameterFloat.html" title="A subclass of AudioProcessorParameter that provides an easy way to create a parameter which maps onto...">AudioParameterFloat</a> with an ID, name, and range. </p>
<p>On creation, its value is set to the default value. </p>
</div>
</div>
<a id="affbd6b7716d9ea098b5bcead7c3e5a89"></a>
<h2 class="memtitle"><span class="permalink"><a href="#affbd6b7716d9ea098b5bcead7c3e5a89">§ </a></span>AudioParameterFloat() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">AudioParameterFloat::AudioParameterFloat </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classString.html">String</a> </td>
<td class="paramname"><em>parameterID</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classString.html">String</a> </td>
<td class="paramname"><em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float </td>
<td class="paramname"><em>minValue</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float </td>
<td class="paramname"><em>maxValue</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float </td>
<td class="paramname"><em>defaultValue</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Creates a <a class="el" href="classAudioParameterFloat.html" title="A subclass of AudioProcessorParameter that provides an easy way to create a parameter which maps onto...">AudioParameterFloat</a> with an ID, name, and range. </p>
<p>On creation, its value is set to the default value. For control over skew factors, you can use the other constructor and provide a <a class="el" href="classNormalisableRange.html" title="Represents a mapping between an arbitrary range of values and a normalised 0->1 range. ">NormalisableRange</a>. </p>
</div>
</div>
<a id="a506f108d60273f9af854852b25bd4598"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a506f108d60273f9af854852b25bd4598">§ </a></span>~AudioParameterFloat()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">AudioParameterFloat::~AudioParameterFloat </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Destructor. </p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a5dfe7c0b452beac16f139029d83106c5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5dfe7c0b452beac16f139029d83106c5">§ </a></span>get()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">float AudioParameterFloat::get </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the parameter's current value. </p>
</div>
</div>
<a id="aebdc357fc8e777d8070149e721d78132"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aebdc357fc8e777d8070149e721d78132">§ </a></span>operator float()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">AudioParameterFloat::operator float </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the parameter's current value. </p>
</div>
</div>
<a id="a76a147ac794e800cc6b8f8f34987a659"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a76a147ac794e800cc6b8f8f34987a659">§ </a></span>operator=()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classAudioParameterFloat.html">AudioParameterFloat</a>& AudioParameterFloat::operator= </td>
<td>(</td>
<td class="paramtype">float </td>
<td class="paramname"><em>newValue</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Changes the parameter's current value. </p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="a7e860466dbc1319bc064cd6e7db382e3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7e860466dbc1319bc064cd6e7db382e3">§ </a></span>range</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classNormalisableRange.html">NormalisableRange</a><float> AudioParameterFloat::range</td>
</tr>
</table>
</div><div class="memdoc">
<p>Provides access to the parameter's range. </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="juce__AudioParameterFloat_8h.html">juce_AudioParameterFloat.h</a></li>
</ul>
</div><!-- contents -->
<hr class="footer"/>
<address class="footer"><small>All content © ROLI Ltd.</small></address><br/>
</body>
</html>
|