Mercurial > hg > vamp-website
diff code-doc/structVamp_1_1PluginBase_1_1ParameterDescriptor.html @ 50:8260c0f4e05b website
Update code docs for 2.3
| author | cannam |
|---|---|
| date | Tue, 04 Oct 2011 13:47:23 +0000 |
| parents | 0976232e353b |
| children |
line wrap: on
line diff
--- a/code-doc/structVamp_1_1PluginBase_1_1ParameterDescriptor.html Thu Apr 07 13:06:22 2011 +0000 +++ b/code-doc/structVamp_1_1PluginBase_1_1ParameterDescriptor.html Tue Oct 04 13:47:23 2011 +0000 @@ -1,310 +1,347 @@ -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> -<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> -<title>VampPluginSDK: Vamp::PluginBase::PluginBase::ParameterDescriptor Struct 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.5.8 --> -<div class="navigation" id="top"> - <div class="tabs"> - <ul> - <li><a href="main.html"><span>Main Page</span></a></li> +<!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>VampPluginSDK: Vamp::PluginBase::ParameterDescriptor Struct Reference</title> + +<link href="tabs.css" rel="stylesheet" type="text/css"/> +<link href="doxygen.css" rel="stylesheet" type="text/css" /> +<link href="navtree.css" rel="stylesheet" type="text/css"/> +<script type="text/javascript" src="jquery.js"></script> +<script type="text/javascript" src="resize.js"></script> +<script type="text/javascript" src="navtree.js"></script> +<script type="text/javascript"> + $(document).ready(initResizable); +</script> + + +</head> +<body> +<div id="top"><!-- do not remove this div! --> + + +<div id="titlearea"> +<table cellspacing="0" cellpadding="0"> + <tbody> + <tr style="height: 56px;"> + + + <td style="padding-left: 0.5em;"> + <div id="projectname">VampPluginSDK +  <span id="projectnumber">2.1</span> + </div> + + </td> + + + + </tr> + </tbody> +</table> +</div> + +<!-- Generated by Doxygen 1.7.5.1 --> + <div id="navrow1" class="tabs"> + <ul class="tablist"> + <li><a href="index.html"><span>Main Page</span></a></li> <li><a href="namespaces.html"><span>Namespaces</span></a></li> <li class="current"><a href="annotated.html"><span>Classes</span></a></li> <li><a href="files.html"><span>Files</span></a></li> <li><a href="dirs.html"><span>Directories</span></a></li> </ul> </div> - <div class="tabs"> - <ul> - <li><a href="annotated.html"><span>Class List</span></a></li> - <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> - <li><a href="functions.html"><span>Class Members</span></a></li> + <div id="navrow2" class="tabs2"> + <ul class="tablist"> + <li><a href="annotated.html"><span>Class List</span></a></li> + <li><a href="inherits.html"><span>Class Hierarchy</span></a></li> + <li><a href="functions.html"><span>Class Members</span></a></li> </ul> </div> - <div class="navpath"><a class="el" href="namespaceVamp.html">Vamp</a>::<a class="el" href="classVamp_1_1PluginBase.html">PluginBase</a>::<a class="el" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html">ParameterDescriptor</a> +</div> +<div id="side-nav" class="ui-resizable side-nav-resizable"> + <div id="nav-tree"> + <div id="nav-tree-contents"> + </div> + </div> + <div id="splitbar" style="-moz-user-select:none;" + class="ui-resizable-handle"> </div> </div> +<script type="text/javascript"> + initNavTree('structVamp_1_1PluginBase_1_1ParameterDescriptor.html',''); +</script> +<div id="doc-content"> +<div class="header"> + <div class="summary"> +<a href="#pub-methods">Public Member Functions</a> | +<a href="#pub-attribs">Public Attributes</a> </div> + <div class="headertitle"> +<div class="title">Vamp::PluginBase::ParameterDescriptor Struct Reference</div> </div> +</div> <div class="contents"> -<h1>Vamp::PluginBase::PluginBase::ParameterDescriptor Struct Reference</h1><!-- doxytag: class="Vamp::PluginBase::ParameterDescriptor" --><code>#include <<a class="el" href="vamp-sdk_2PluginBase_8h-source.html">PluginBase.h</a>></code> -<p> +<!-- doxytag: class="Vamp::PluginBase::ParameterDescriptor" --> +<p><code>#include <<a class="el" href="vamp-sdk_2PluginBase_8h_source.html">PluginBase.h</a>></code></p> -<p> -<a href="structVamp_1_1PluginBase_1_1ParameterDescriptor-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0"> -<tr><td></td></tr> -<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr> -<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#7759ab75c33d0f4d8bc85c755bfb10f3">ParameterDescriptor</a> ()</td></tr> - -<tr><td colspan="2"><br><h2>Public Attributes</h2></td></tr> -<tr><td class="memItemLeft" nowrap align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#b34ea7114875647281ac031021e45d06">identifier</a></td></tr> - -<tr><td class="mdescLeft"> </td><td class="mdescRight">The name of the parameter, in computer-usable form. <a href="#b34ea7114875647281ac031021e45d06"></a><br></td></tr> -<tr><td class="memItemLeft" nowrap align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#2c1000e78a6414dab6c5af5201053741">name</a></td></tr> - -<tr><td class="mdescLeft"> </td><td class="mdescRight">The human-readable name of the parameter. <a href="#2c1000e78a6414dab6c5af5201053741"></a><br></td></tr> -<tr><td class="memItemLeft" nowrap align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#0cbc8fe35b0d15fd8e19de2ade33d147">description</a></td></tr> - -<tr><td class="mdescLeft"> </td><td class="mdescRight">A human-readable short text describing the parameter. <a href="#0cbc8fe35b0d15fd8e19de2ade33d147"></a><br></td></tr> -<tr><td class="memItemLeft" nowrap align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#e0d6c74d915b99bacb55a0622e0ecb1c">unit</a></td></tr> - -<tr><td class="mdescLeft"> </td><td class="mdescRight">The unit of the parameter, in human-readable form. <a href="#e0d6c74d915b99bacb55a0622e0ecb1c"></a><br></td></tr> -<tr><td class="memItemLeft" nowrap align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#18221c4bb5c57332fe6a1393c5ec3b6d">minValue</a></td></tr> - -<tr><td class="mdescLeft"> </td><td class="mdescRight">The minimum value of the parameter. <a href="#18221c4bb5c57332fe6a1393c5ec3b6d"></a><br></td></tr> -<tr><td class="memItemLeft" nowrap align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#52e0c1f0acfc7ff8622ca1ccc97ad69d">maxValue</a></td></tr> - -<tr><td class="mdescLeft"> </td><td class="mdescRight">The maximum value of the parameter. <a href="#52e0c1f0acfc7ff8622ca1ccc97ad69d"></a><br></td></tr> -<tr><td class="memItemLeft" nowrap align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#4b36674815777f54846bb7033205bbea">defaultValue</a></td></tr> - -<tr><td class="mdescLeft"> </td><td class="mdescRight">The default value of the parameter. <a href="#4b36674815777f54846bb7033205bbea"></a><br></td></tr> -<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#6e76a119dafbdd26351521ec486550ea">isQuantized</a></td></tr> - -<tr><td class="mdescLeft"> </td><td class="mdescRight">True if the parameter values are quantized to a particular resolution. <a href="#6e76a119dafbdd26351521ec486550ea"></a><br></td></tr> -<tr><td class="memItemLeft" nowrap align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#0b84d9928f1ecce8663335f6a80ad2b1">quantizeStep</a></td></tr> - -<tr><td class="mdescLeft"> </td><td class="mdescRight">Quantization resolution of the parameter values (e.g. <a href="#0b84d9928f1ecce8663335f6a80ad2b1"></a><br></td></tr> -<tr><td class="memItemLeft" nowrap align="right" valign="top">std::vector< std::string > </td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#0a4ab495e32d7746f2c55a5a59af1adc">valueNames</a></td></tr> - -<tr><td class="mdescLeft"> </td><td class="mdescRight">Names for the quantized values. <a href="#0a4ab495e32d7746f2c55a5a59af1adc"></a><br></td></tr> +<p><a href="structVamp_1_1PluginBase_1_1ParameterDescriptor-members.html">List of all members.</a></p> +<table class="memberdecls"> +<tr><td colspan="2"><h2><a name="pub-methods"></a> +Public Member Functions</h2></td></tr> +<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#a5b793130e9746b2302317b3c9a9c1395">ParameterDescriptor</a> ()</td></tr> +<tr><td colspan="2"><h2><a name="pub-attribs"></a> +Public Attributes</h2></td></tr> +<tr><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#a116fd9f0dc94c2bc4bbc60b5443c598c">identifier</a></td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">The name of the parameter, in computer-usable form. <a href="#a116fd9f0dc94c2bc4bbc60b5443c598c"></a><br/></td></tr> +<tr><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#a0ecebb94fb4ada4aad2640e20aa57084">name</a></td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">The human-readable name of the parameter. <a href="#a0ecebb94fb4ada4aad2640e20aa57084"></a><br/></td></tr> +<tr><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#a780ddad41e433d85c82f9ea4d959cbaf">description</a></td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">A human-readable short text describing the parameter. <a href="#a780ddad41e433d85c82f9ea4d959cbaf"></a><br/></td></tr> +<tr><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#a3bc3df322e4c02e17e96bc6d44982d7b">unit</a></td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">The unit of the parameter, in human-readable form. <a href="#a3bc3df322e4c02e17e96bc6d44982d7b"></a><br/></td></tr> +<tr><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#ab3e4d84f5bc199eea8b642b27e425ec8">minValue</a></td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">The minimum value of the parameter. <a href="#ab3e4d84f5bc199eea8b642b27e425ec8"></a><br/></td></tr> +<tr><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#ab934b20dd708228a0e3c2811a3e2cec4">maxValue</a></td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">The maximum value of the parameter. <a href="#ab934b20dd708228a0e3c2811a3e2cec4"></a><br/></td></tr> +<tr><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#aec4ef77451ec02193ecc4a0856673fbc">defaultValue</a></td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">The default value of the parameter. <a href="#aec4ef77451ec02193ecc4a0856673fbc"></a><br/></td></tr> +<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#a7c556d58d552f737ee5a34efdf7f9425">isQuantized</a></td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">True if the parameter values are quantized to a particular resolution. <a href="#a7c556d58d552f737ee5a34efdf7f9425"></a><br/></td></tr> +<tr><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#a01f8387e7c853d5e4e35d4e9a37353d7">quantizeStep</a></td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">Quantization resolution of the parameter values (e.g. <a href="#a01f8387e7c853d5e4e35d4e9a37353d7"></a><br/></td></tr> +<tr><td class="memItemLeft" align="right" valign="top">std::vector< std::string > </td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#a94df96f53835980b4739965007ff222b">valueNames</a></td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">Names for the quantized values. <a href="#a94df96f53835980b4739965007ff222b"></a><br/></td></tr> </table> -<hr><a name="_details"></a><h2>Detailed Description</h2> - -<p>Definition at line <a class="el" href="vamp-sdk_2PluginBase_8h-source.html#l00130">130</a> of file <a class="el" href="vamp-sdk_2PluginBase_8h-source.html">vamp-sdk/PluginBase.h</a>.</p> -<hr><h2>Constructor & Destructor Documentation</h2> -<a class="anchor" name="7759ab75c33d0f4d8bc85c755bfb10f3"></a><!-- doxytag: member="Vamp::PluginBase::ParameterDescriptor::ParameterDescriptor" ref="7759ab75c33d0f4d8bc85c755bfb10f3" args="()" --> +<hr/><a name="details" id="details"></a><h2>Detailed Description</h2> +<div class="textblock"> +<p>Definition at line <a class="el" href="vamp-sdk_2PluginBase_8h_source.html#l00130">130</a> of file <a class="el" href="vamp-sdk_2PluginBase_8h_source.html">vamp-sdk/PluginBase.h</a>.</p> +</div><hr/><h2>Constructor & Destructor Documentation</h2> +<a class="anchor" id="a5b793130e9746b2302317b3c9a9c1395"></a><!-- doxytag: member="Vamp::PluginBase::ParameterDescriptor::ParameterDescriptor" ref="a5b793130e9746b2302317b3c9a9c1395" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> - <td class="memname">Vamp::PluginBase::PluginBase::ParameterDescriptor::ParameterDescriptor </td> + <td class="memname">Vamp::PluginBase::ParameterDescriptor::ParameterDescriptor </td> <td>(</td> - <td class="paramname"> </td> - <td> ) </td> + <td class="paramname"></td><td>)</td> <td><code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> -<p> - -<p>Definition at line <a class="el" href="vamp-sdk_2PluginBase_8h-source.html#l00199">199</a> of file <a class="el" href="vamp-sdk_2PluginBase_8h-source.html">vamp-sdk/PluginBase.h</a>.</p> +<p>Definition at line <a class="el" href="vamp-sdk_2PluginBase_8h_source.html#l00199">199</a> of file <a class="el" href="vamp-sdk_2PluginBase_8h_source.html">vamp-sdk/PluginBase.h</a>.</p> </div> -</div><p> -<hr><h2>Member Data Documentation</h2> -<a class="anchor" name="b34ea7114875647281ac031021e45d06"></a><!-- doxytag: member="Vamp::PluginBase::ParameterDescriptor::identifier" ref="b34ea7114875647281ac031021e45d06" args="" --> +</div> +<hr/><h2>Member Data Documentation</h2> +<a class="anchor" id="a116fd9f0dc94c2bc4bbc60b5443c598c"></a><!-- doxytag: member="Vamp::PluginBase::ParameterDescriptor::identifier" ref="a116fd9f0dc94c2bc4bbc60b5443c598c" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> - <td class="memname">std::string Vamp::PluginBase::PluginBase::ParameterDescriptor::identifier </td> + <td class="memname">std::string <a class="el" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#a116fd9f0dc94c2bc4bbc60b5443c598c">Vamp::PluginBase::ParameterDescriptor::identifier</a></td> </tr> </table> </div> <div class="memdoc"> -<p> -The name of the parameter, in computer-usable form. -<p> -Should be reasonably short, and may only contain the characters [a-zA-Z0-9_-]. -<p>Definition at line <a class="el" href="vamp-sdk_2PluginBase_8h-source.html#l00137">137</a> of file <a class="el" href="vamp-sdk_2PluginBase_8h-source.html">vamp-sdk/PluginBase.h</a>.</p> +<p>The name of the parameter, in computer-usable form. </p> +<p>Should be reasonably short, and may only contain the characters [a-zA-Z0-9_-]. </p> -<p>Referenced by <a class="el" href="PercussionOnsetDetector_8cpp-source.html#l00145">PercussionOnsetDetector::getParameterDescriptors()</a>, <a class="el" href="FixedTempoEstimator_8cpp-source.html#l00124">FixedTempoEstimator::FixedTempoEstimator::D::getParameterDescriptors()</a>, and <a class="el" href="AmplitudeFollower_8cpp-source.html#l00148">AmplitudeFollower::getParameterDescriptors()</a>.</p> +<p>Definition at line <a class="el" href="vamp-sdk_2PluginBase_8h_source.html#l00137">137</a> of file <a class="el" href="vamp-sdk_2PluginBase_8h_source.html">vamp-sdk/PluginBase.h</a>.</p> + +<p>Referenced by <a class="el" href="FixedTempoEstimator_8cpp_source.html#l00125">FixedTempoEstimator::D::getParameterDescriptors()</a>, <a class="el" href="PercussionOnsetDetector_8cpp_source.html#l00145">PercussionOnsetDetector::getParameterDescriptors()</a>, and <a class="el" href="AmplitudeFollower_8cpp_source.html#l00148">AmplitudeFollower::getParameterDescriptors()</a>.</p> </div> -</div><p> -<a class="anchor" name="2c1000e78a6414dab6c5af5201053741"></a><!-- doxytag: member="Vamp::PluginBase::ParameterDescriptor::name" ref="2c1000e78a6414dab6c5af5201053741" args="" --> +</div> +<a class="anchor" id="a0ecebb94fb4ada4aad2640e20aa57084"></a><!-- doxytag: member="Vamp::PluginBase::ParameterDescriptor::name" ref="a0ecebb94fb4ada4aad2640e20aa57084" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> - <td class="memname">std::string Vamp::PluginBase::PluginBase::ParameterDescriptor::name </td> + <td class="memname">std::string <a class="el" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#a0ecebb94fb4ada4aad2640e20aa57084">Vamp::PluginBase::ParameterDescriptor::name</a></td> </tr> </table> </div> <div class="memdoc"> -<p> -The human-readable name of the parameter. -<p> +<p>The human-readable name of the parameter. </p> -<p>Definition at line <a class="el" href="vamp-sdk_2PluginBase_8h-source.html#l00142">142</a> of file <a class="el" href="vamp-sdk_2PluginBase_8h-source.html">vamp-sdk/PluginBase.h</a>.</p> +<p>Definition at line <a class="el" href="vamp-sdk_2PluginBase_8h_source.html#l00142">142</a> of file <a class="el" href="vamp-sdk_2PluginBase_8h_source.html">vamp-sdk/PluginBase.h</a>.</p> -<p>Referenced by <a class="el" href="PercussionOnsetDetector_8cpp-source.html#l00145">PercussionOnsetDetector::getParameterDescriptors()</a>, <a class="el" href="FixedTempoEstimator_8cpp-source.html#l00124">FixedTempoEstimator::FixedTempoEstimator::D::getParameterDescriptors()</a>, and <a class="el" href="AmplitudeFollower_8cpp-source.html#l00148">AmplitudeFollower::getParameterDescriptors()</a>.</p> +<p>Referenced by <a class="el" href="FixedTempoEstimator_8cpp_source.html#l00125">FixedTempoEstimator::D::getParameterDescriptors()</a>, <a class="el" href="PercussionOnsetDetector_8cpp_source.html#l00145">PercussionOnsetDetector::getParameterDescriptors()</a>, and <a class="el" href="AmplitudeFollower_8cpp_source.html#l00148">AmplitudeFollower::getParameterDescriptors()</a>.</p> </div> -</div><p> -<a class="anchor" name="0cbc8fe35b0d15fd8e19de2ade33d147"></a><!-- doxytag: member="Vamp::PluginBase::ParameterDescriptor::description" ref="0cbc8fe35b0d15fd8e19de2ade33d147" args="" --> +</div> +<a class="anchor" id="a780ddad41e433d85c82f9ea4d959cbaf"></a><!-- doxytag: member="Vamp::PluginBase::ParameterDescriptor::description" ref="a780ddad41e433d85c82f9ea4d959cbaf" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> - <td class="memname">std::string Vamp::PluginBase::PluginBase::ParameterDescriptor::description </td> + <td class="memname">std::string <a class="el" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#a780ddad41e433d85c82f9ea4d959cbaf">Vamp::PluginBase::ParameterDescriptor::description</a></td> </tr> </table> </div> <div class="memdoc"> -<p> -A human-readable short text describing the parameter. -<p> -May be empty if the name has said it all already. -<p>Definition at line <a class="el" href="vamp-sdk_2PluginBase_8h-source.html#l00148">148</a> of file <a class="el" href="vamp-sdk_2PluginBase_8h-source.html">vamp-sdk/PluginBase.h</a>.</p> +<p>A human-readable short text describing the parameter. </p> +<p>May be empty if the name has said it all already. </p> -<p>Referenced by <a class="el" href="PercussionOnsetDetector_8cpp-source.html#l00145">PercussionOnsetDetector::getParameterDescriptors()</a>, <a class="el" href="FixedTempoEstimator_8cpp-source.html#l00124">FixedTempoEstimator::FixedTempoEstimator::D::getParameterDescriptors()</a>, and <a class="el" href="AmplitudeFollower_8cpp-source.html#l00148">AmplitudeFollower::getParameterDescriptors()</a>.</p> +<p>Definition at line <a class="el" href="vamp-sdk_2PluginBase_8h_source.html#l00148">148</a> of file <a class="el" href="vamp-sdk_2PluginBase_8h_source.html">vamp-sdk/PluginBase.h</a>.</p> + +<p>Referenced by <a class="el" href="FixedTempoEstimator_8cpp_source.html#l00125">FixedTempoEstimator::D::getParameterDescriptors()</a>, <a class="el" href="PercussionOnsetDetector_8cpp_source.html#l00145">PercussionOnsetDetector::getParameterDescriptors()</a>, and <a class="el" href="AmplitudeFollower_8cpp_source.html#l00148">AmplitudeFollower::getParameterDescriptors()</a>.</p> </div> -</div><p> -<a class="anchor" name="e0d6c74d915b99bacb55a0622e0ecb1c"></a><!-- doxytag: member="Vamp::PluginBase::ParameterDescriptor::unit" ref="e0d6c74d915b99bacb55a0622e0ecb1c" args="" --> +</div> +<a class="anchor" id="a3bc3df322e4c02e17e96bc6d44982d7b"></a><!-- doxytag: member="Vamp::PluginBase::ParameterDescriptor::unit" ref="a3bc3df322e4c02e17e96bc6d44982d7b" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> - <td class="memname">std::string Vamp::PluginBase::PluginBase::ParameterDescriptor::unit </td> + <td class="memname">std::string <a class="el" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#a3bc3df322e4c02e17e96bc6d44982d7b">Vamp::PluginBase::ParameterDescriptor::unit</a></td> </tr> </table> </div> <div class="memdoc"> -<p> -The unit of the parameter, in human-readable form. -<p> +<p>The unit of the parameter, in human-readable form. </p> -<p>Definition at line <a class="el" href="vamp-sdk_2PluginBase_8h-source.html#l00153">153</a> of file <a class="el" href="vamp-sdk_2PluginBase_8h-source.html">vamp-sdk/PluginBase.h</a>.</p> +<p>Definition at line <a class="el" href="vamp-sdk_2PluginBase_8h_source.html#l00153">153</a> of file <a class="el" href="vamp-sdk_2PluginBase_8h_source.html">vamp-sdk/PluginBase.h</a>.</p> -<p>Referenced by <a class="el" href="PercussionOnsetDetector_8cpp-source.html#l00145">PercussionOnsetDetector::getParameterDescriptors()</a>, <a class="el" href="FixedTempoEstimator_8cpp-source.html#l00124">FixedTempoEstimator::FixedTempoEstimator::D::getParameterDescriptors()</a>, and <a class="el" href="AmplitudeFollower_8cpp-source.html#l00148">AmplitudeFollower::getParameterDescriptors()</a>.</p> +<p>Referenced by <a class="el" href="FixedTempoEstimator_8cpp_source.html#l00125">FixedTempoEstimator::D::getParameterDescriptors()</a>, <a class="el" href="PercussionOnsetDetector_8cpp_source.html#l00145">PercussionOnsetDetector::getParameterDescriptors()</a>, and <a class="el" href="AmplitudeFollower_8cpp_source.html#l00148">AmplitudeFollower::getParameterDescriptors()</a>.</p> </div> -</div><p> -<a class="anchor" name="18221c4bb5c57332fe6a1393c5ec3b6d"></a><!-- doxytag: member="Vamp::PluginBase::ParameterDescriptor::minValue" ref="18221c4bb5c57332fe6a1393c5ec3b6d" args="" --> +</div> +<a class="anchor" id="ab3e4d84f5bc199eea8b642b27e425ec8"></a><!-- doxytag: member="Vamp::PluginBase::ParameterDescriptor::minValue" ref="ab3e4d84f5bc199eea8b642b27e425ec8" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> - <td class="memname">float Vamp::PluginBase::PluginBase::ParameterDescriptor::minValue </td> + <td class="memname">float <a class="el" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#ab3e4d84f5bc199eea8b642b27e425ec8">Vamp::PluginBase::ParameterDescriptor::minValue</a></td> </tr> </table> </div> <div class="memdoc"> -<p> -The minimum value of the parameter. -<p> +<p>The minimum value of the parameter. </p> -<p>Definition at line <a class="el" href="vamp-sdk_2PluginBase_8h-source.html#l00158">158</a> of file <a class="el" href="vamp-sdk_2PluginBase_8h-source.html">vamp-sdk/PluginBase.h</a>.</p> +<p>Definition at line <a class="el" href="vamp-sdk_2PluginBase_8h_source.html#l00158">158</a> of file <a class="el" href="vamp-sdk_2PluginBase_8h_source.html">vamp-sdk/PluginBase.h</a>.</p> -<p>Referenced by <a class="el" href="PercussionOnsetDetector_8cpp-source.html#l00145">PercussionOnsetDetector::getParameterDescriptors()</a>, <a class="el" href="FixedTempoEstimator_8cpp-source.html#l00124">FixedTempoEstimator::FixedTempoEstimator::D::getParameterDescriptors()</a>, and <a class="el" href="AmplitudeFollower_8cpp-source.html#l00148">AmplitudeFollower::getParameterDescriptors()</a>.</p> +<p>Referenced by <a class="el" href="FixedTempoEstimator_8cpp_source.html#l00125">FixedTempoEstimator::D::getParameterDescriptors()</a>, <a class="el" href="PercussionOnsetDetector_8cpp_source.html#l00145">PercussionOnsetDetector::getParameterDescriptors()</a>, and <a class="el" href="AmplitudeFollower_8cpp_source.html#l00148">AmplitudeFollower::getParameterDescriptors()</a>.</p> </div> -</div><p> -<a class="anchor" name="52e0c1f0acfc7ff8622ca1ccc97ad69d"></a><!-- doxytag: member="Vamp::PluginBase::ParameterDescriptor::maxValue" ref="52e0c1f0acfc7ff8622ca1ccc97ad69d" args="" --> +</div> +<a class="anchor" id="ab934b20dd708228a0e3c2811a3e2cec4"></a><!-- doxytag: member="Vamp::PluginBase::ParameterDescriptor::maxValue" ref="ab934b20dd708228a0e3c2811a3e2cec4" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> - <td class="memname">float Vamp::PluginBase::PluginBase::ParameterDescriptor::maxValue </td> + <td class="memname">float <a class="el" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#ab934b20dd708228a0e3c2811a3e2cec4">Vamp::PluginBase::ParameterDescriptor::maxValue</a></td> </tr> </table> </div> <div class="memdoc"> -<p> -The maximum value of the parameter. -<p> +<p>The maximum value of the parameter. </p> -<p>Definition at line <a class="el" href="vamp-sdk_2PluginBase_8h-source.html#l00163">163</a> of file <a class="el" href="vamp-sdk_2PluginBase_8h-source.html">vamp-sdk/PluginBase.h</a>.</p> +<p>Definition at line <a class="el" href="vamp-sdk_2PluginBase_8h_source.html#l00163">163</a> of file <a class="el" href="vamp-sdk_2PluginBase_8h_source.html">vamp-sdk/PluginBase.h</a>.</p> -<p>Referenced by <a class="el" href="PercussionOnsetDetector_8cpp-source.html#l00145">PercussionOnsetDetector::getParameterDescriptors()</a>, <a class="el" href="FixedTempoEstimator_8cpp-source.html#l00124">FixedTempoEstimator::FixedTempoEstimator::D::getParameterDescriptors()</a>, and <a class="el" href="AmplitudeFollower_8cpp-source.html#l00148">AmplitudeFollower::getParameterDescriptors()</a>.</p> +<p>Referenced by <a class="el" href="FixedTempoEstimator_8cpp_source.html#l00125">FixedTempoEstimator::D::getParameterDescriptors()</a>, <a class="el" href="PercussionOnsetDetector_8cpp_source.html#l00145">PercussionOnsetDetector::getParameterDescriptors()</a>, and <a class="el" href="AmplitudeFollower_8cpp_source.html#l00148">AmplitudeFollower::getParameterDescriptors()</a>.</p> </div> -</div><p> -<a class="anchor" name="4b36674815777f54846bb7033205bbea"></a><!-- doxytag: member="Vamp::PluginBase::ParameterDescriptor::defaultValue" ref="4b36674815777f54846bb7033205bbea" args="" --> +</div> +<a class="anchor" id="aec4ef77451ec02193ecc4a0856673fbc"></a><!-- doxytag: member="Vamp::PluginBase::ParameterDescriptor::defaultValue" ref="aec4ef77451ec02193ecc4a0856673fbc" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> - <td class="memname">float Vamp::PluginBase::PluginBase::ParameterDescriptor::defaultValue </td> + <td class="memname">float <a class="el" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#aec4ef77451ec02193ecc4a0856673fbc">Vamp::PluginBase::ParameterDescriptor::defaultValue</a></td> </tr> </table> </div> <div class="memdoc"> -<p> -The default value of the parameter. -<p> -The plugin should ensure that parameters have this value on initialisation (i.e. the host is not required to explicitly set parameters if it wants to use their default values). -<p>Definition at line <a class="el" href="vamp-sdk_2PluginBase_8h-source.html#l00171">171</a> of file <a class="el" href="vamp-sdk_2PluginBase_8h-source.html">vamp-sdk/PluginBase.h</a>.</p> +<p>The default value of the parameter. </p> +<p>The plugin should ensure that parameters have this value on initialisation (i.e. the host is not required to explicitly set parameters if it wants to use their default values). </p> -<p>Referenced by <a class="el" href="PercussionOnsetDetector_8cpp-source.html#l00145">PercussionOnsetDetector::getParameterDescriptors()</a>, <a class="el" href="FixedTempoEstimator_8cpp-source.html#l00124">FixedTempoEstimator::FixedTempoEstimator::D::getParameterDescriptors()</a>, and <a class="el" href="AmplitudeFollower_8cpp-source.html#l00148">AmplitudeFollower::getParameterDescriptors()</a>.</p> +<p>Definition at line <a class="el" href="vamp-sdk_2PluginBase_8h_source.html#l00171">171</a> of file <a class="el" href="vamp-sdk_2PluginBase_8h_source.html">vamp-sdk/PluginBase.h</a>.</p> + +<p>Referenced by <a class="el" href="FixedTempoEstimator_8cpp_source.html#l00125">FixedTempoEstimator::D::getParameterDescriptors()</a>, <a class="el" href="PercussionOnsetDetector_8cpp_source.html#l00145">PercussionOnsetDetector::getParameterDescriptors()</a>, and <a class="el" href="AmplitudeFollower_8cpp_source.html#l00148">AmplitudeFollower::getParameterDescriptors()</a>.</p> </div> -</div><p> -<a class="anchor" name="6e76a119dafbdd26351521ec486550ea"></a><!-- doxytag: member="Vamp::PluginBase::ParameterDescriptor::isQuantized" ref="6e76a119dafbdd26351521ec486550ea" args="" --> +</div> +<a class="anchor" id="a7c556d58d552f737ee5a34efdf7f9425"></a><!-- doxytag: member="Vamp::PluginBase::ParameterDescriptor::isQuantized" ref="a7c556d58d552f737ee5a34efdf7f9425" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> - <td class="memname">bool Vamp::PluginBase::PluginBase::ParameterDescriptor::isQuantized </td> + <td class="memname">bool <a class="el" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#a7c556d58d552f737ee5a34efdf7f9425">Vamp::PluginBase::ParameterDescriptor::isQuantized</a></td> </tr> </table> </div> <div class="memdoc"> -<p> -True if the parameter values are quantized to a particular resolution. -<p> +<p>True if the parameter values are quantized to a particular resolution. </p> -<p>Definition at line <a class="el" href="vamp-sdk_2PluginBase_8h-source.html#l00177">177</a> of file <a class="el" href="vamp-sdk_2PluginBase_8h-source.html">vamp-sdk/PluginBase.h</a>.</p> +<p>Definition at line <a class="el" href="vamp-sdk_2PluginBase_8h_source.html#l00177">177</a> of file <a class="el" href="vamp-sdk_2PluginBase_8h_source.html">vamp-sdk/PluginBase.h</a>.</p> -<p>Referenced by <a class="el" href="PercussionOnsetDetector_8cpp-source.html#l00145">PercussionOnsetDetector::getParameterDescriptors()</a>, <a class="el" href="FixedTempoEstimator_8cpp-source.html#l00124">FixedTempoEstimator::FixedTempoEstimator::D::getParameterDescriptors()</a>, and <a class="el" href="AmplitudeFollower_8cpp-source.html#l00148">AmplitudeFollower::getParameterDescriptors()</a>.</p> +<p>Referenced by <a class="el" href="FixedTempoEstimator_8cpp_source.html#l00125">FixedTempoEstimator::D::getParameterDescriptors()</a>, <a class="el" href="PercussionOnsetDetector_8cpp_source.html#l00145">PercussionOnsetDetector::getParameterDescriptors()</a>, and <a class="el" href="AmplitudeFollower_8cpp_source.html#l00148">AmplitudeFollower::getParameterDescriptors()</a>.</p> </div> -</div><p> -<a class="anchor" name="0b84d9928f1ecce8663335f6a80ad2b1"></a><!-- doxytag: member="Vamp::PluginBase::ParameterDescriptor::quantizeStep" ref="0b84d9928f1ecce8663335f6a80ad2b1" args="" --> +</div> +<a class="anchor" id="a01f8387e7c853d5e4e35d4e9a37353d7"></a><!-- doxytag: member="Vamp::PluginBase::ParameterDescriptor::quantizeStep" ref="a01f8387e7c853d5e4e35d4e9a37353d7" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> - <td class="memname">float Vamp::PluginBase::PluginBase::ParameterDescriptor::quantizeStep </td> + <td class="memname">float <a class="el" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#a01f8387e7c853d5e4e35d4e9a37353d7">Vamp::PluginBase::ParameterDescriptor::quantizeStep</a></td> </tr> </table> </div> <div class="memdoc"> -<p> -Quantization resolution of the parameter values (e.g. -<p> -1.0 if they are all integers). Undefined if isQuantized is false. -<p>Definition at line <a class="el" href="vamp-sdk_2PluginBase_8h-source.html#l00184">184</a> of file <a class="el" href="vamp-sdk_2PluginBase_8h-source.html">vamp-sdk/PluginBase.h</a>.</p> +<p>Quantization resolution of the parameter values (e.g. </p> +<p>1.0 if they are all integers). Undefined if isQuantized is false. </p> + +<p>Definition at line <a class="el" href="vamp-sdk_2PluginBase_8h_source.html#l00184">184</a> of file <a class="el" href="vamp-sdk_2PluginBase_8h_source.html">vamp-sdk/PluginBase.h</a>.</p> </div> -</div><p> -<a class="anchor" name="0a4ab495e32d7746f2c55a5a59af1adc"></a><!-- doxytag: member="Vamp::PluginBase::ParameterDescriptor::valueNames" ref="0a4ab495e32d7746f2c55a5a59af1adc" args="" --> +</div> +<a class="anchor" id="a94df96f53835980b4739965007ff222b"></a><!-- doxytag: member="Vamp::PluginBase::ParameterDescriptor::valueNames" ref="a94df96f53835980b4739965007ff222b" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> - <td class="memname">std::vector<std::string> Vamp::PluginBase::PluginBase::ParameterDescriptor::valueNames </td> + <td class="memname">std::vector<std::string> <a class="el" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html#a94df96f53835980b4739965007ff222b">Vamp::PluginBase::ParameterDescriptor::valueNames</a></td> </tr> </table> </div> <div class="memdoc"> -<p> -Names for the quantized values. -<p> -If isQuantized is true, this may either be empty or contain one string for each of the quantize steps from minValue up to maxValue inclusive. Undefined if isQuantized is false.<p> -If these names are provided, they should be shown to the user in preference to the values themselves. The user may never see the actual numeric values unless they are also encoded in the names. -<p>Definition at line <a class="el" href="vamp-sdk_2PluginBase_8h-source.html#l00197">197</a> of file <a class="el" href="vamp-sdk_2PluginBase_8h-source.html">vamp-sdk/PluginBase.h</a>.</p> +<p>Names for the quantized values. </p> +<p>If isQuantized is true, this may either be empty or contain one string for each of the quantize steps from minValue up to maxValue inclusive. Undefined if isQuantized is false.</p> +<p>If these names are provided, they should be shown to the user in preference to the values themselves. The user may never see the actual numeric values unless they are also encoded in the names. </p> + +<p>Definition at line <a class="el" href="vamp-sdk_2PluginBase_8h_source.html#l00197">197</a> of file <a class="el" href="vamp-sdk_2PluginBase_8h_source.html">vamp-sdk/PluginBase.h</a>.</p> </div> -</div><p> -<hr>The documentation for this struct was generated from the following file:<ul> -<li><a class="el" href="vamp-sdk_2PluginBase_8h-source.html">vamp-sdk/PluginBase.h</a></ul> </div> -<hr size="1"><address style="text-align: right;"><small>Generated on Thu Sep 24 13:40:14 2009 for VampPluginSDK by -<a href="http://www.doxygen.org/index.html"> -<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address> +<hr/>The documentation for this struct was generated from the following file:<ul> +<li><a class="el" href="vamp-sdk_2PluginBase_8h_source.html">vamp-sdk/PluginBase.h</a></li> +</ul> +</div> +</div> + <div id="nav-path" class="navpath"> + <ul> + <li class="navelem"><a class="el" href="namespaceVamp.html">Vamp</a> </li> + <li class="navelem"><a class="el" href="classVamp_1_1PluginBase.html">PluginBase</a> </li> + <li class="navelem"><a class="el" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html">ParameterDescriptor</a> </li> + + <li class="footer">Generated on Tue Oct 4 2011 14:38:52 for VampPluginSDK by + <a href="http://www.doxygen.org/index.html"> + <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.5.1 </li> + </ul> + </div> + + </body> </html>