<!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.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>aubio: utils/parameter.h File 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>
<script type="text/x-mathjax-config">
MathJax.Hub.Config({
extensions: ["tex2jax.js"],
jax: ["input/TeX","output/HTML-CSS"],
});
</script><script type="text/javascript" src="http://cdn.mathjax.org/mathjax/latest/MathJax.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">aubio
 <span id="projectnumber">0.4.2~alpha</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<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 id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_cbdb8362360e11eafe2fa3bc74cf0ffd.html">utils</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#typedef-members">Typedefs</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">parameter.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Parameter with linear interpolation.
<a href="#details">More...</a></p>
<p><a href="parameter_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:ace945eedce3aba770931ff2da6ad972e"><td class="memItemLeft" align="right" valign="top"><a id="ace945eedce3aba770931ff2da6ad972e"></a>
typedef struct _aubio_parameter_t </td><td class="memItemRight" valign="bottom"><a class="el" href="parameter_8h.html#ace945eedce3aba770931ff2da6ad972e">aubio_parameter_t</a></td></tr>
<tr class="memdesc:ace945eedce3aba770931ff2da6ad972e"><td class="mdescLeft"> </td><td class="mdescRight">parameter object <br /></td></tr>
<tr class="separator:ace945eedce3aba770931ff2da6ad972e"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a867621907de149640055259a653f6650"><td class="memItemLeft" align="right" valign="top"><a class="el" href="parameter_8h.html#ace945eedce3aba770931ff2da6ad972e">aubio_parameter_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="parameter_8h.html#a867621907de149640055259a653f6650">new_aubio_parameter</a> (<a class="el" href="types_8h.html#a5d7119468d78a1dc35cf76d0adfb1436">smpl_t</a> min_value, <a class="el" href="types_8h.html#a5d7119468d78a1dc35cf76d0adfb1436">smpl_t</a> max_value, <a class="el" href="types_8h.html#a12a1e9b3ce141648783a82445d02b58d">uint_t</a> steps)</td></tr>
<tr class="memdesc:a867621907de149640055259a653f6650"><td class="mdescLeft"> </td><td class="mdescRight">create new parameter object <a href="#a867621907de149640055259a653f6650">More...</a><br /></td></tr>
<tr class="separator:a867621907de149640055259a653f6650"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0645e9a5f490340a1053efe4485bad18"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#a12a1e9b3ce141648783a82445d02b58d">uint_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="parameter_8h.html#a0645e9a5f490340a1053efe4485bad18">aubio_parameter_set_target_value</a> (<a class="el" href="parameter_8h.html#ace945eedce3aba770931ff2da6ad972e">aubio_parameter_t</a> *param, <a class="el" href="types_8h.html#a5d7119468d78a1dc35cf76d0adfb1436">smpl_t</a> value)</td></tr>
<tr class="memdesc:a0645e9a5f490340a1053efe4485bad18"><td class="mdescLeft"> </td><td class="mdescRight">set target value of the parameter <a href="#a0645e9a5f490340a1053efe4485bad18">More...</a><br /></td></tr>
<tr class="separator:a0645e9a5f490340a1053efe4485bad18"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:abb96bae188242955a0ec4c8e99aa4254"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#a5d7119468d78a1dc35cf76d0adfb1436">smpl_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="parameter_8h.html#abb96bae188242955a0ec4c8e99aa4254">aubio_parameter_get_next_value</a> (<a class="el" href="parameter_8h.html#ace945eedce3aba770931ff2da6ad972e">aubio_parameter_t</a> *param)</td></tr>
<tr class="memdesc:abb96bae188242955a0ec4c8e99aa4254"><td class="mdescLeft"> </td><td class="mdescRight">get next parameter <a href="#abb96bae188242955a0ec4c8e99aa4254">More...</a><br /></td></tr>
<tr class="separator:abb96bae188242955a0ec4c8e99aa4254"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae4eb26f6d5c5cf210526f9b1c614a3e3"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#a5d7119468d78a1dc35cf76d0adfb1436">smpl_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="parameter_8h.html#ae4eb26f6d5c5cf210526f9b1c614a3e3">aubio_parameter_get_current_value</a> (<a class="el" href="parameter_8h.html#ace945eedce3aba770931ff2da6ad972e">aubio_parameter_t</a> *param)</td></tr>
<tr class="memdesc:ae4eb26f6d5c5cf210526f9b1c614a3e3"><td class="mdescLeft"> </td><td class="mdescRight">get current parameter value, without interpolation <a href="#ae4eb26f6d5c5cf210526f9b1c614a3e3">More...</a><br /></td></tr>
<tr class="separator:ae4eb26f6d5c5cf210526f9b1c614a3e3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0e84ec646b0188996b748946c46b9c40"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#a12a1e9b3ce141648783a82445d02b58d">uint_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="parameter_8h.html#a0e84ec646b0188996b748946c46b9c40">aubio_parameter_set_current_value</a> (<a class="el" href="parameter_8h.html#ace945eedce3aba770931ff2da6ad972e">aubio_parameter_t</a> *param, <a class="el" href="types_8h.html#a5d7119468d78a1dc35cf76d0adfb1436">smpl_t</a> value)</td></tr>
<tr class="memdesc:a0e84ec646b0188996b748946c46b9c40"><td class="mdescLeft"> </td><td class="mdescRight">set current parameter value, skipping interpolation <a href="#a0e84ec646b0188996b748946c46b9c40">More...</a><br /></td></tr>
<tr class="separator:a0e84ec646b0188996b748946c46b9c40"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a00be4e7bca7617402245a9712398dfa9"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#a12a1e9b3ce141648783a82445d02b58d">uint_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="parameter_8h.html#a00be4e7bca7617402245a9712398dfa9">aubio_parameter_set_steps</a> (<a class="el" href="parameter_8h.html#ace945eedce3aba770931ff2da6ad972e">aubio_parameter_t</a> *param, <a class="el" href="types_8h.html#a12a1e9b3ce141648783a82445d02b58d">uint_t</a> steps)</td></tr>
<tr class="memdesc:a00be4e7bca7617402245a9712398dfa9"><td class="mdescLeft"> </td><td class="mdescRight">set number of steps used for interpolation <a href="#a00be4e7bca7617402245a9712398dfa9">More...</a><br /></td></tr>
<tr class="separator:a00be4e7bca7617402245a9712398dfa9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aaad93d8200196e01499bcefce4c2a3d5"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#a12a1e9b3ce141648783a82445d02b58d">uint_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="parameter_8h.html#aaad93d8200196e01499bcefce4c2a3d5">aubio_parameter_get_steps</a> (<a class="el" href="parameter_8h.html#ace945eedce3aba770931ff2da6ad972e">aubio_parameter_t</a> *param)</td></tr>
<tr class="memdesc:aaad93d8200196e01499bcefce4c2a3d5"><td class="mdescLeft"> </td><td class="mdescRight">get number of steps of this parameter <a href="#aaad93d8200196e01499bcefce4c2a3d5">More...</a><br /></td></tr>
<tr class="separator:aaad93d8200196e01499bcefce4c2a3d5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a43f83067c7c6630e16b9b5d1ebecc897"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#a12a1e9b3ce141648783a82445d02b58d">uint_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="parameter_8h.html#a43f83067c7c6630e16b9b5d1ebecc897">aubio_parameter_set_min_value</a> (<a class="el" href="parameter_8h.html#ace945eedce3aba770931ff2da6ad972e">aubio_parameter_t</a> *param, <a class="el" href="types_8h.html#a5d7119468d78a1dc35cf76d0adfb1436">smpl_t</a> min_value)</td></tr>
<tr class="memdesc:a43f83067c7c6630e16b9b5d1ebecc897"><td class="mdescLeft"> </td><td class="mdescRight">set minimum value of this parameter <a href="#a43f83067c7c6630e16b9b5d1ebecc897">More...</a><br /></td></tr>
<tr class="separator:a43f83067c7c6630e16b9b5d1ebecc897"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab311cb4215fc3d5b764462a41ca00cb2"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#a5d7119468d78a1dc35cf76d0adfb1436">smpl_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="parameter_8h.html#ab311cb4215fc3d5b764462a41ca00cb2">aubio_parameter_get_min_value</a> (<a class="el" href="parameter_8h.html#ace945eedce3aba770931ff2da6ad972e">aubio_parameter_t</a> *param)</td></tr>
<tr class="memdesc:ab311cb4215fc3d5b764462a41ca00cb2"><td class="mdescLeft"> </td><td class="mdescRight">get minimum value of this parameter <a href="#ab311cb4215fc3d5b764462a41ca00cb2">More...</a><br /></td></tr>
<tr class="separator:ab311cb4215fc3d5b764462a41ca00cb2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a89b05c1ae1734a812b092c9deccc556a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#a12a1e9b3ce141648783a82445d02b58d">uint_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="parameter_8h.html#a89b05c1ae1734a812b092c9deccc556a">aubio_parameter_set_max_value</a> (<a class="el" href="parameter_8h.html#ace945eedce3aba770931ff2da6ad972e">aubio_parameter_t</a> *param, <a class="el" href="types_8h.html#a5d7119468d78a1dc35cf76d0adfb1436">smpl_t</a> max_value)</td></tr>
<tr class="memdesc:a89b05c1ae1734a812b092c9deccc556a"><td class="mdescLeft"> </td><td class="mdescRight">set maximum value of this parameter <a href="#a89b05c1ae1734a812b092c9deccc556a">More...</a><br /></td></tr>
<tr class="separator:a89b05c1ae1734a812b092c9deccc556a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae6ffd23d6cf61b240d459c60b5cb3ef6"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#a5d7119468d78a1dc35cf76d0adfb1436">smpl_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="parameter_8h.html#ae6ffd23d6cf61b240d459c60b5cb3ef6">aubio_parameter_get_max_value</a> (<a class="el" href="parameter_8h.html#ace945eedce3aba770931ff2da6ad972e">aubio_parameter_t</a> *param)</td></tr>
<tr class="memdesc:ae6ffd23d6cf61b240d459c60b5cb3ef6"><td class="mdescLeft"> </td><td class="mdescRight">get maximum value of this parameter <a href="#ae6ffd23d6cf61b240d459c60b5cb3ef6">More...</a><br /></td></tr>
<tr class="separator:ae6ffd23d6cf61b240d459c60b5cb3ef6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae116d85a65785002cbbf41ee6381fde0"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="parameter_8h.html#ae116d85a65785002cbbf41ee6381fde0">del_aubio_parameter</a> (<a class="el" href="parameter_8h.html#ace945eedce3aba770931ff2da6ad972e">aubio_parameter_t</a> *param)</td></tr>
<tr class="memdesc:ae116d85a65785002cbbf41ee6381fde0"><td class="mdescLeft"> </td><td class="mdescRight">destroy <a class="el" href="parameter_8h.html#ace945eedce3aba770931ff2da6ad972e" title="parameter object ">aubio_parameter_t</a> object <a href="#ae116d85a65785002cbbf41ee6381fde0">More...</a><br /></td></tr>
<tr class="separator:ae116d85a65785002cbbf41ee6381fde0"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Parameter with linear interpolation. </p>
<p>This object manages a parameter, with minimum and maximum values, and a number of steps to compute linear interpolation between two values. </p>
<p class="definition">Definition in file <a class="el" href="parameter_8h_source.html">parameter.h</a>.</p>
</div><h2 class="groupheader">Function Documentation</h2>
<a id="ae4eb26f6d5c5cf210526f9b1c614a3e3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae4eb26f6d5c5cf210526f9b1c614a3e3">◆ </a></span>aubio_parameter_get_current_value()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="types_8h.html#a5d7119468d78a1dc35cf76d0adfb1436">smpl_t</a> aubio_parameter_get_current_value </td>
<td>(</td>
<td class="paramtype"><a class="el" href="parameter_8h.html#ace945eedce3aba770931ff2da6ad972e">aubio_parameter_t</a> * </td>
<td class="paramname"><em>param</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>get current parameter value, without interpolation </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">param</td><td>parameter, created by <a class="el" href="parameter_8h.html#a867621907de149640055259a653f6650" title="create new parameter object ">new_aubio_parameter</a></td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>current value </dd></dl>
<dl><dt><b>Examples: </b></dt><dd><a class="el" href="utils_2test-parameter_8c-example.html#a3">utils/test-parameter.c</a>.</dd>
</dl>
</div>
</div>
<a id="ae6ffd23d6cf61b240d459c60b5cb3ef6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae6ffd23d6cf61b240d459c60b5cb3ef6">◆ </a></span>aubio_parameter_get_max_value()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="types_8h.html#a5d7119468d78a1dc35cf76d0adfb1436">smpl_t</a> aubio_parameter_get_max_value </td>
<td>(</td>
<td class="paramtype"><a class="el" href="parameter_8h.html#ace945eedce3aba770931ff2da6ad972e">aubio_parameter_t</a> * </td>
<td class="paramname"><em>param</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>get maximum value of this parameter </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">param</td><td>parameter, created by <a class="el" href="parameter_8h.html#a867621907de149640055259a653f6650" title="create new parameter object ">new_aubio_parameter</a></td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>maximum value </dd></dl>
</div>
</div>
<a id="ab311cb4215fc3d5b764462a41ca00cb2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab311cb4215fc3d5b764462a41ca00cb2">◆ </a></span>aubio_parameter_get_min_value()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="types_8h.html#a5d7119468d78a1dc35cf76d0adfb1436">smpl_t</a> aubio_parameter_get_min_value </td>
<td>(</td>
<td class="paramtype"><a class="el" href="parameter_8h.html#ace945eedce3aba770931ff2da6ad972e">aubio_parameter_t</a> * </td>
<td class="paramname"><em>param</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>get minimum value of this parameter </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">param</td><td>parameter, created by <a class="el" href="parameter_8h.html#a867621907de149640055259a653f6650" title="create new parameter object ">new_aubio_parameter</a></td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>minimum value </dd></dl>
</div>
</div>
<a id="abb96bae188242955a0ec4c8e99aa4254"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abb96bae188242955a0ec4c8e99aa4254">◆ </a></span>aubio_parameter_get_next_value()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="types_8h.html#a5d7119468d78a1dc35cf76d0adfb1436">smpl_t</a> aubio_parameter_get_next_value </td>
<td>(</td>
<td class="paramtype"><a class="el" href="parameter_8h.html#ace945eedce3aba770931ff2da6ad972e">aubio_parameter_t</a> * </td>
<td class="paramname"><em>param</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>get next parameter </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">param</td><td>parameter, created by <a class="el" href="parameter_8h.html#a867621907de149640055259a653f6650" title="create new parameter object ">new_aubio_parameter</a></td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>new interpolated parameter value </dd></dl>
<dl><dt><b>Examples: </b></dt><dd><a class="el" href="utils_2test-parameter_8c-example.html#a1">utils/test-parameter.c</a>.</dd>
</dl>
</div>
</div>
<a id="aaad93d8200196e01499bcefce4c2a3d5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aaad93d8200196e01499bcefce4c2a3d5">◆ </a></span>aubio_parameter_get_steps()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="types_8h.html#a12a1e9b3ce141648783a82445d02b58d">uint_t</a> aubio_parameter_get_steps </td>
<td>(</td>
<td class="paramtype"><a class="el" href="parameter_8h.html#ace945eedce3aba770931ff2da6ad972e">aubio_parameter_t</a> * </td>
<td class="paramname"><em>param</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>get number of steps of this parameter </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">param</td><td>parameter, created by <a class="el" href="parameter_8h.html#a867621907de149640055259a653f6650" title="create new parameter object ">new_aubio_parameter</a></td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>number of steps </dd></dl>
<dl><dt><b>Examples: </b></dt><dd><a class="el" href="utils_2test-parameter_8c-example.html#a0">utils/test-parameter.c</a>.</dd>
</dl>
</div>
</div>
<a id="a0e84ec646b0188996b748946c46b9c40"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0e84ec646b0188996b748946c46b9c40">◆ </a></span>aubio_parameter_set_current_value()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="types_8h.html#a12a1e9b3ce141648783a82445d02b58d">uint_t</a> aubio_parameter_set_current_value </td>
<td>(</td>
<td class="paramtype"><a class="el" href="parameter_8h.html#ace945eedce3aba770931ff2da6ad972e">aubio_parameter_t</a> * </td>
<td class="paramname"><em>param</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="types_8h.html#a5d7119468d78a1dc35cf76d0adfb1436">smpl_t</a> </td>
<td class="paramname"><em>value</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>set current parameter value, skipping interpolation </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">param</td><td>parameter, created by <a class="el" href="parameter_8h.html#a867621907de149640055259a653f6650" title="create new parameter object ">new_aubio_parameter</a> </td></tr>
<tr><td class="paramname">value</td><td>new parameter value</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 if successful, 1 otherwise </dd></dl>
<dl><dt><b>Examples: </b></dt><dd><a class="el" href="utils_2test-parameter_8c-example.html#a6">utils/test-parameter.c</a>.</dd>
</dl>
</div>
</div>
<a id="a89b05c1ae1734a812b092c9deccc556a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a89b05c1ae1734a812b092c9deccc556a">◆ </a></span>aubio_parameter_set_max_value()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="types_8h.html#a12a1e9b3ce141648783a82445d02b58d">uint_t</a> aubio_parameter_set_max_value </td>
<td>(</td>
<td class="paramtype"><a class="el" href="parameter_8h.html#ace945eedce3aba770931ff2da6ad972e">aubio_parameter_t</a> * </td>
<td class="paramname"><em>param</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="types_8h.html#a5d7119468d78a1dc35cf76d0adfb1436">smpl_t</a> </td>
<td class="paramname"><em>max_value</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>set maximum value of this parameter </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">param</td><td>parameter, created by <a class="el" href="parameter_8h.html#a867621907de149640055259a653f6650" title="create new parameter object ">new_aubio_parameter</a> </td></tr>
<tr><td class="paramname">max_value</td><td>new maximum value</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 if successful, 1 otherwise </dd></dl>
<dl><dt><b>Examples: </b></dt><dd><a class="el" href="utils_2test-parameter_8c-example.html#a8">utils/test-parameter.c</a>.</dd>
</dl>
</div>
</div>
<a id="a43f83067c7c6630e16b9b5d1ebecc897"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a43f83067c7c6630e16b9b5d1ebecc897">◆ </a></span>aubio_parameter_set_min_value()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="types_8h.html#a12a1e9b3ce141648783a82445d02b58d">uint_t</a> aubio_parameter_set_min_value </td>
<td>(</td>
<td class="paramtype"><a class="el" href="parameter_8h.html#ace945eedce3aba770931ff2da6ad972e">aubio_parameter_t</a> * </td>
<td class="paramname"><em>param</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="types_8h.html#a5d7119468d78a1dc35cf76d0adfb1436">smpl_t</a> </td>
<td class="paramname"><em>min_value</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>set minimum value of this parameter </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">param</td><td>parameter, created by <a class="el" href="parameter_8h.html#a867621907de149640055259a653f6650" title="create new parameter object ">new_aubio_parameter</a> </td></tr>
<tr><td class="paramname">min_value</td><td>new minimum value</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 if successful, 1 otherwise </dd></dl>
<dl><dt><b>Examples: </b></dt><dd><a class="el" href="utils_2test-parameter_8c-example.html#a7">utils/test-parameter.c</a>.</dd>
</dl>
</div>
</div>
<a id="a00be4e7bca7617402245a9712398dfa9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a00be4e7bca7617402245a9712398dfa9">◆ </a></span>aubio_parameter_set_steps()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="types_8h.html#a12a1e9b3ce141648783a82445d02b58d">uint_t</a> aubio_parameter_set_steps </td>
<td>(</td>
<td class="paramtype"><a class="el" href="parameter_8h.html#ace945eedce3aba770931ff2da6ad972e">aubio_parameter_t</a> * </td>
<td class="paramname"><em>param</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="types_8h.html#a12a1e9b3ce141648783a82445d02b58d">uint_t</a> </td>
<td class="paramname"><em>steps</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>set number of steps used for interpolation </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">param</td><td>parameter, created by <a class="el" href="parameter_8h.html#a867621907de149640055259a653f6650" title="create new parameter object ">new_aubio_parameter</a> </td></tr>
<tr><td class="paramname">steps</td><td>new number of steps</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 if successful, 1 otherwise </dd></dl>
<dl><dt><b>Examples: </b></dt><dd><a class="el" href="utils_2test-parameter_8c-example.html#a5">utils/test-parameter.c</a>.</dd>
</dl>
</div>
</div>
<a id="a0645e9a5f490340a1053efe4485bad18"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0645e9a5f490340a1053efe4485bad18">◆ </a></span>aubio_parameter_set_target_value()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="types_8h.html#a12a1e9b3ce141648783a82445d02b58d">uint_t</a> aubio_parameter_set_target_value </td>
<td>(</td>
<td class="paramtype"><a class="el" href="parameter_8h.html#ace945eedce3aba770931ff2da6ad972e">aubio_parameter_t</a> * </td>
<td class="paramname"><em>param</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="types_8h.html#a5d7119468d78a1dc35cf76d0adfb1436">smpl_t</a> </td>
<td class="paramname"><em>value</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>set target value of the parameter </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">param</td><td>parameter, created by <a class="el" href="parameter_8h.html#a867621907de149640055259a653f6650" title="create new parameter object ">new_aubio_parameter</a> </td></tr>
<tr><td class="paramname">value</td><td>new target value</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 if successful, 1 otherwise </dd></dl>
<dl><dt><b>Examples: </b></dt><dd><a class="el" href="utils_2test-parameter_8c-example.html#a4">utils/test-parameter.c</a>.</dd>
</dl>
</div>
</div>
<a id="ae116d85a65785002cbbf41ee6381fde0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae116d85a65785002cbbf41ee6381fde0">◆ </a></span>del_aubio_parameter()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void del_aubio_parameter </td>
<td>(</td>
<td class="paramtype"><a class="el" href="parameter_8h.html#ace945eedce3aba770931ff2da6ad972e">aubio_parameter_t</a> * </td>
<td class="paramname"><em>param</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>destroy <a class="el" href="parameter_8h.html#ace945eedce3aba770931ff2da6ad972e" title="parameter object ">aubio_parameter_t</a> object </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">param</td><td>parameter, created by <a class="el" href="parameter_8h.html#a867621907de149640055259a653f6650" title="create new parameter object ">new_aubio_parameter</a> </td></tr>
</table>
</dd>
</dl>
<dl><dt><b>Examples: </b></dt><dd><a class="el" href="utils_2test-parameter_8c-example.html#a9">utils/test-parameter.c</a>.</dd>
</dl>
</div>
</div>
<a id="a867621907de149640055259a653f6650"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a867621907de149640055259a653f6650">◆ </a></span>new_aubio_parameter()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="parameter_8h.html#ace945eedce3aba770931ff2da6ad972e">aubio_parameter_t</a>* new_aubio_parameter </td>
<td>(</td>
<td class="paramtype"><a class="el" href="types_8h.html#a5d7119468d78a1dc35cf76d0adfb1436">smpl_t</a> </td>
<td class="paramname"><em>min_value</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="types_8h.html#a5d7119468d78a1dc35cf76d0adfb1436">smpl_t</a> </td>
<td class="paramname"><em>max_value</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="types_8h.html#a12a1e9b3ce141648783a82445d02b58d">uint_t</a> </td>
<td class="paramname"><em>steps</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>create new parameter object </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">min_value</td><td>the minimum value of the new parameter </td></tr>
<tr><td class="paramname">max_value</td><td>the maximum value of the new parameter </td></tr>
<tr><td class="paramname">steps</td><td>the number of steps to interpolate from the old value to the target value</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the newly created <a class="el" href="parameter_8h.html#ace945eedce3aba770931ff2da6ad972e" title="parameter object ">aubio_parameter_t</a> </dd></dl>
<dl><dt><b>Examples: </b></dt><dd><a class="el" href="utils_2test-parameter_8c-example.html#a2">utils/test-parameter.c</a>.</dd>
</dl>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.13
</small></address>
</body>
</html>
