Mercurial > hg > vamp-docs

view code-docs/struct__VampParameterDescriptor.html @ 3:5c2683745b33 vamp-plugin-sdk-v2.4

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Update for 2.4
author Chris Cannam
date Fri, 13 Jul 2012 13:30:27 +0100
parents 3c430ef1ed66
children 27319718b1f8
line wrap: on
line source
<!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"/>
<title>VampPluginSDK: _VampParameterDescriptor 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
   &#160;<span id="projectnumber">2.4</span>
   </div>
   
  </td>
  
  
  
 </tr>
 </tbody>
</table>
</div>

<!-- Generated by Doxygen 1.8.0 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;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 id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
      <li><a href="inherits.html"><span>Class&#160;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
    </ul>
  </div>
</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('struct__VampParameterDescriptor.html','');
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#pub-attribs">Public Attributes</a>  </div>
  <div class="headertitle">
<div class="title">_VampParameterDescriptor Struct Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>C language API for <a class="el" href="namespaceVamp.html">Vamp</a> plugins.  
 <a href="struct__VampParameterDescriptor.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="vamp_8h_source.html">vamp.h</a>&gt;</code></p>

<p><a href="struct__VampParameterDescriptor-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:a26d74afd6a3341a673f15955031845ab"><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampParameterDescriptor.html#a26d74afd6a3341a673f15955031845ab">identifier</a></td></tr>
<tr class="memdesc:a26d74afd6a3341a673f15955031845ab"><td class="mdescLeft">&#160;</td><td class="mdescRight">Computer-usable name of the parameter.  <a href="#a26d74afd6a3341a673f15955031845ab"></a><br/></td></tr>
<tr class="memitem:abba810bce9656f6002777f6c3f655957"><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampParameterDescriptor.html#abba810bce9656f6002777f6c3f655957">name</a></td></tr>
<tr class="memdesc:abba810bce9656f6002777f6c3f655957"><td class="mdescLeft">&#160;</td><td class="mdescRight">Human-readable name of the parameter.  <a href="#abba810bce9656f6002777f6c3f655957"></a><br/></td></tr>
<tr class="memitem:a95489272d6cf5a5b487e949da8e4fac6"><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampParameterDescriptor.html#a95489272d6cf5a5b487e949da8e4fac6">description</a></td></tr>
<tr class="memdesc:a95489272d6cf5a5b487e949da8e4fac6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Human-readable short text about the parameter.  <a href="#a95489272d6cf5a5b487e949da8e4fac6"></a><br/></td></tr>
<tr class="memitem:a8ca235f816b56dc99125e010eee08fc7"><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampParameterDescriptor.html#a8ca235f816b56dc99125e010eee08fc7">unit</a></td></tr>
<tr class="memdesc:a8ca235f816b56dc99125e010eee08fc7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Human-readable unit of the parameter.  <a href="#a8ca235f816b56dc99125e010eee08fc7"></a><br/></td></tr>
<tr class="memitem:ab59c84f0bbe0d4d0c578d893c087b0db"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampParameterDescriptor.html#ab59c84f0bbe0d4d0c578d893c087b0db">minValue</a></td></tr>
<tr class="memdesc:ab59c84f0bbe0d4d0c578d893c087b0db"><td class="mdescLeft">&#160;</td><td class="mdescRight">Minimum value.  <a href="#ab59c84f0bbe0d4d0c578d893c087b0db"></a><br/></td></tr>
<tr class="memitem:a6e7646babdb265c4abfc107ba4350d80"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampParameterDescriptor.html#a6e7646babdb265c4abfc107ba4350d80">maxValue</a></td></tr>
<tr class="memdesc:a6e7646babdb265c4abfc107ba4350d80"><td class="mdescLeft">&#160;</td><td class="mdescRight">Maximum value.  <a href="#a6e7646babdb265c4abfc107ba4350d80"></a><br/></td></tr>
<tr class="memitem:a3d37f986ee152ab55feb9902b35f7aca"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampParameterDescriptor.html#a3d37f986ee152ab55feb9902b35f7aca">defaultValue</a></td></tr>
<tr class="memdesc:a3d37f986ee152ab55feb9902b35f7aca"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default value.  <a href="#a3d37f986ee152ab55feb9902b35f7aca"></a><br/></td></tr>
<tr class="memitem:a3f41e3b6b69c7a95ff0ce8625794f83a"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampParameterDescriptor.html#a3f41e3b6b69c7a95ff0ce8625794f83a">isQuantized</a></td></tr>
<tr class="memdesc:a3f41e3b6b69c7a95ff0ce8625794f83a"><td class="mdescLeft">&#160;</td><td class="mdescRight">1 if parameter values are quantized to a particular resolution.  <a href="#a3f41e3b6b69c7a95ff0ce8625794f83a"></a><br/></td></tr>
<tr class="memitem:a68c91fd3fc0b0b3617c2d343fe32d0e5"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampParameterDescriptor.html#a68c91fd3fc0b0b3617c2d343fe32d0e5">quantizeStep</a></td></tr>
<tr class="memdesc:a68c91fd3fc0b0b3617c2d343fe32d0e5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Quantization resolution, if isQuantized.  <a href="#a68c91fd3fc0b0b3617c2d343fe32d0e5"></a><br/></td></tr>
<tr class="memitem:a188883325ab1e4a898e3dc53a8f88f9d"><td class="memItemLeft" align="right" valign="top">const char **&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampParameterDescriptor.html#a188883325ab1e4a898e3dc53a8f88f9d">valueNames</a></td></tr>
<tr class="memdesc:a188883325ab1e4a898e3dc53a8f88f9d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Human-readable names of the values, if isQuantized.  <a href="#a188883325ab1e4a898e3dc53a8f88f9d"></a><br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>C language API for <a class="el" href="namespaceVamp.html">Vamp</a> plugins. </p>
<p>This is the formal plugin API for <a class="el" href="namespaceVamp.html">Vamp</a>. Plugin authors may prefer to use the C++ classes provided in the <a class="el" href="namespaceVamp.html">Vamp</a> plugin SDK, instead of using this API directly. There is an adapter class provided that makes C++ plugins available using this C API with relatively little work, and the C++ headers are more thoroughly documented.</p>
<p>IMPORTANT: The comments in this file summarise the purpose of each of the declared fields and functions, but do not provide a complete guide to their permitted values and expected usage. Please refer to the C++ headers in the <a class="el" href="namespaceVamp.html">Vamp</a> plugin SDK for further details and plugin lifecycle documentation. </p>

<p>Definition at line <a class="el" href="vamp_8h_source.html#l00071">71</a> of file <a class="el" href="vamp_8h_source.html">vamp.h</a>.</p>
</div><hr/><h2>Member Data Documentation</h2>
<a class="anchor" id="a26d74afd6a3341a673f15955031845ab"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">const char* <a class="el" href="struct__VampParameterDescriptor.html#a26d74afd6a3341a673f15955031845ab">_VampParameterDescriptor::identifier</a></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Computer-usable name of the parameter. </p>
<p>Must not change. [a-zA-Z0-9_] </p>

<p>Definition at line <a class="el" href="vamp_8h_source.html#l00074">74</a> of file <a class="el" href="vamp_8h_source.html">vamp.h</a>.</p>

</div>
</div>
<a class="anchor" id="abba810bce9656f6002777f6c3f655957"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">const char* <a class="el" href="struct__VampParameterDescriptor.html#abba810bce9656f6002777f6c3f655957">_VampParameterDescriptor::name</a></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Human-readable name of the parameter. </p>
<p>May be translatable. </p>

<p>Definition at line <a class="el" href="vamp_8h_source.html#l00077">77</a> of file <a class="el" href="vamp_8h_source.html">vamp.h</a>.</p>

</div>
</div>
<a class="anchor" id="a95489272d6cf5a5b487e949da8e4fac6"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">const char* <a class="el" href="struct__VampParameterDescriptor.html#a95489272d6cf5a5b487e949da8e4fac6">_VampParameterDescriptor::description</a></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Human-readable short text about the parameter. </p>
<p>May be translatable. </p>

<p>Definition at line <a class="el" href="vamp_8h_source.html#l00080">80</a> of file <a class="el" href="vamp_8h_source.html">vamp.h</a>.</p>

</div>
</div>
<a class="anchor" id="a8ca235f816b56dc99125e010eee08fc7"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">const char* <a class="el" href="struct__VampParameterDescriptor.html#a8ca235f816b56dc99125e010eee08fc7">_VampParameterDescriptor::unit</a></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Human-readable unit of the parameter. </p>

<p>Definition at line <a class="el" href="vamp_8h_source.html#l00083">83</a> of file <a class="el" href="vamp_8h_source.html">vamp.h</a>.</p>

</div>
</div>
<a class="anchor" id="ab59c84f0bbe0d4d0c578d893c087b0db"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">float <a class="el" href="struct__VampParameterDescriptor.html#ab59c84f0bbe0d4d0c578d893c087b0db">_VampParameterDescriptor::minValue</a></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Minimum value. </p>

<p>Definition at line <a class="el" href="vamp_8h_source.html#l00086">86</a> of file <a class="el" href="vamp_8h_source.html">vamp.h</a>.</p>

</div>
</div>
<a class="anchor" id="a6e7646babdb265c4abfc107ba4350d80"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">float <a class="el" href="struct__VampParameterDescriptor.html#a6e7646babdb265c4abfc107ba4350d80">_VampParameterDescriptor::maxValue</a></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Maximum value. </p>

<p>Definition at line <a class="el" href="vamp_8h_source.html#l00089">89</a> of file <a class="el" href="vamp_8h_source.html">vamp.h</a>.</p>

</div>
</div>
<a class="anchor" id="a3d37f986ee152ab55feb9902b35f7aca"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">float <a class="el" href="struct__VampParameterDescriptor.html#a3d37f986ee152ab55feb9902b35f7aca">_VampParameterDescriptor::defaultValue</a></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Default value. </p>
<p>Plugin is responsible for setting this on initialise. </p>

<p>Definition at line <a class="el" href="vamp_8h_source.html#l00092">92</a> of file <a class="el" href="vamp_8h_source.html">vamp.h</a>.</p>

</div>
</div>
<a class="anchor" id="a3f41e3b6b69c7a95ff0ce8625794f83a"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int <a class="el" href="struct__VampParameterDescriptor.html#a3f41e3b6b69c7a95ff0ce8625794f83a">_VampParameterDescriptor::isQuantized</a></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>1 if parameter values are quantized to a particular resolution. </p>

<p>Definition at line <a class="el" href="vamp_8h_source.html#l00095">95</a> of file <a class="el" href="vamp_8h_source.html">vamp.h</a>.</p>

</div>
</div>
<a class="anchor" id="a68c91fd3fc0b0b3617c2d343fe32d0e5"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">float <a class="el" href="struct__VampParameterDescriptor.html#a68c91fd3fc0b0b3617c2d343fe32d0e5">_VampParameterDescriptor::quantizeStep</a></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Quantization resolution, if isQuantized. </p>

<p>Definition at line <a class="el" href="vamp_8h_source.html#l00098">98</a> of file <a class="el" href="vamp_8h_source.html">vamp.h</a>.</p>

</div>
</div>
<a class="anchor" id="a188883325ab1e4a898e3dc53a8f88f9d"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">const char** <a class="el" href="struct__VampParameterDescriptor.html#a188883325ab1e4a898e3dc53a8f88f9d">_VampParameterDescriptor::valueNames</a></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Human-readable names of the values, if isQuantized. </p>
<p>May be NULL. </p>

<p>Definition at line <a class="el" href="vamp_8h_source.html#l00101">101</a> of file <a class="el" href="vamp_8h_source.html">vamp.h</a>.</p>

</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li><a class="el" href="vamp_8h_source.html">vamp.h</a></li>
</ul>
</div><!-- contents -->
</div>
  <div id="nav-path" class="navpath">
    <ul>
      <li class="navelem"><a class="el" href="struct__VampParameterDescriptor.html">_VampParameterDescriptor</a>      </li>

    <li class="footer">Generated on Fri Jul 13 2012 13:28:48 for VampPluginSDK by
    <a href="http://www.doxygen.org/index.html">
    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.0 </li>
   </ul>
 </div>


</body>
</html>