Mercurial > hg > vamp-website
diff code-doc/struct__VampParameterDescriptor.html @ 0:351c4ebce5f9 website
* Move website from vamp-website/trunk to plain website
| author | cannam |
|---|---|
| date | Mon, 22 Sep 2008 13:01:46 +0000 |
| parents | |
| children | cc0be37dc9d3 |
line wrap: on
line diff
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/code-doc/struct__VampParameterDescriptor.html Mon Sep 22 13:01:46 2008 +0000 @@ -0,0 +1,289 @@ +<!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: _VampParameterDescriptor Struct Reference</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +<link href="tabs.css" rel="stylesheet" type="text/css"> +</head><body> +<!-- Generated by Doxygen 1.5.5 --> +<div class="navigation" id="top"> + <div class="tabs"> + <ul> + <li><a href="main.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> + </ul> + </div> +</div> +<div class="contents"> +<h1>_VampParameterDescriptor Struct Reference</h1><!-- doxytag: class="_VampParameterDescriptor" --><code>#include <<a class="el" href="vamp_8h-source.html">vamp.h</a>></code> +<p> + +<p> +<a href="struct__VampParameterDescriptor-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2> +C language API for <a class="el" href="namespaceVamp.html" title="If you want to compile using FFTW instead of the built-in FFT implementation for...">Vamp</a> plugins. +<p> +This is the formal plugin API for <a class="el" href="namespaceVamp.html" title="If you want to compile using FFTW instead of the built-in FFT implementation for...">Vamp</a>. Plugin authors may prefer to use the C++ classes provided in the <a class="el" href="namespaceVamp.html" title="If you want to compile using FFTW instead of the built-in FFT implementation for...">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> +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" title="If you want to compile using FFTW instead of the built-in FFT implementation for...">Vamp</a> plugin SDK for further details and plugin lifecycle documentation. +<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> +<table border="0" cellpadding="0" cellspacing="0"> +<tr><td></td></tr> +<tr><td colspan="2"><br><h2>Public Attributes</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampParameterDescriptor.html#26d74afd6a3341a673f15955031845ab">identifier</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Computer-usable name of the parameter. <a href="#26d74afd6a3341a673f15955031845ab"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampParameterDescriptor.html#bba810bce9656f6002777f6c3f655957">name</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Human-readable name of the parameter. <a href="#bba810bce9656f6002777f6c3f655957"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampParameterDescriptor.html#95489272d6cf5a5b487e949da8e4fac6">description</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Human-readable short text about the parameter. <a href="#95489272d6cf5a5b487e949da8e4fac6"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampParameterDescriptor.html#8ca235f816b56dc99125e010eee08fc7">unit</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Human-readable unit of the parameter. <a href="#8ca235f816b56dc99125e010eee08fc7"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampParameterDescriptor.html#b59c84f0bbe0d4d0c578d893c087b0db">minValue</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Minimum value. <a href="#b59c84f0bbe0d4d0c578d893c087b0db"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampParameterDescriptor.html#6e7646babdb265c4abfc107ba4350d80">maxValue</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Maximum value. <a href="#6e7646babdb265c4abfc107ba4350d80"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampParameterDescriptor.html#3d37f986ee152ab55feb9902b35f7aca">defaultValue</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Default value. <a href="#3d37f986ee152ab55feb9902b35f7aca"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampParameterDescriptor.html#3f41e3b6b69c7a95ff0ce8625794f83a">isQuantized</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">1 if parameter values are quantized to a particular resolution. <a href="#3f41e3b6b69c7a95ff0ce8625794f83a"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampParameterDescriptor.html#68c91fd3fc0b0b3617c2d343fe32d0e5">quantizeStep</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Quantization resolution, if isQuantized. <a href="#68c91fd3fc0b0b3617c2d343fe32d0e5"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">const char ** </td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampParameterDescriptor.html#188883325ab1e4a898e3dc53a8f88f9d">valueNames</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Human-readable names of the values, if isQuantized. <a href="#188883325ab1e4a898e3dc53a8f88f9d"></a><br></td></tr> +</table> +<hr><h2>Member Data Documentation</h2> +<a class="anchor" name="26d74afd6a3341a673f15955031845ab"></a><!-- doxytag: member="_VampParameterDescriptor::identifier" ref="26d74afd6a3341a673f15955031845ab" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">const char* <a class="el" href="struct__VampParameterDescriptor.html#26d74afd6a3341a673f15955031845ab">_VampParameterDescriptor::identifier</a> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Computer-usable name of the parameter. +<p> +Must not change. [a-zA-Z0-9_] +<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> + +<p>Referenced by <a class="el" href="PluginAdapter_8cpp-source.html#l00153">Vamp::PluginAdapterBase::Impl::getDescriptor()</a>, <a class="el" href="PluginHostAdapter_8cpp-source.html#l00213">Vamp::PluginHostAdapter::getParameter()</a>, <a class="el" href="PluginHostAdapter_8cpp-source.html#l00187">Vamp::PluginHostAdapter::getParameterDescriptors()</a>, <a class="el" href="PluginHostAdapter_8cpp-source.html#l00227">Vamp::PluginHostAdapter::setParameter()</a>, and <a class="el" href="PluginAdapter_8cpp-source.html#l00258">Vamp::PluginAdapterBase::Impl::~Impl()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="bba810bce9656f6002777f6c3f655957"></a><!-- doxytag: member="_VampParameterDescriptor::name" ref="bba810bce9656f6002777f6c3f655957" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">const char* <a class="el" href="struct__VampParameterDescriptor.html#bba810bce9656f6002777f6c3f655957">_VampParameterDescriptor::name</a> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Human-readable name of the parameter. +<p> +May be translatable. +<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> + +<p>Referenced by <a class="el" href="PluginAdapter_8cpp-source.html#l00153">Vamp::PluginAdapterBase::Impl::getDescriptor()</a>, <a class="el" href="PluginHostAdapter_8cpp-source.html#l00187">Vamp::PluginHostAdapter::getParameterDescriptors()</a>, and <a class="el" href="PluginAdapter_8cpp-source.html#l00258">Vamp::PluginAdapterBase::Impl::~Impl()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="95489272d6cf5a5b487e949da8e4fac6"></a><!-- doxytag: member="_VampParameterDescriptor::description" ref="95489272d6cf5a5b487e949da8e4fac6" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">const char* <a class="el" href="struct__VampParameterDescriptor.html#95489272d6cf5a5b487e949da8e4fac6">_VampParameterDescriptor::description</a> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Human-readable short text about the parameter. +<p> +May be translatable. +<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> + +<p>Referenced by <a class="el" href="PluginAdapter_8cpp-source.html#l00153">Vamp::PluginAdapterBase::Impl::getDescriptor()</a>, <a class="el" href="PluginHostAdapter_8cpp-source.html#l00187">Vamp::PluginHostAdapter::getParameterDescriptors()</a>, and <a class="el" href="PluginAdapter_8cpp-source.html#l00258">Vamp::PluginAdapterBase::Impl::~Impl()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="8ca235f816b56dc99125e010eee08fc7"></a><!-- doxytag: member="_VampParameterDescriptor::unit" ref="8ca235f816b56dc99125e010eee08fc7" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">const char* <a class="el" href="struct__VampParameterDescriptor.html#8ca235f816b56dc99125e010eee08fc7">_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> + +<p>Referenced by <a class="el" href="PluginAdapter_8cpp-source.html#l00153">Vamp::PluginAdapterBase::Impl::getDescriptor()</a>, <a class="el" href="PluginHostAdapter_8cpp-source.html#l00187">Vamp::PluginHostAdapter::getParameterDescriptors()</a>, and <a class="el" href="PluginAdapter_8cpp-source.html#l00258">Vamp::PluginAdapterBase::Impl::~Impl()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="b59c84f0bbe0d4d0c578d893c087b0db"></a><!-- doxytag: member="_VampParameterDescriptor::minValue" ref="b59c84f0bbe0d4d0c578d893c087b0db" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">float <a class="el" href="struct__VampParameterDescriptor.html#b59c84f0bbe0d4d0c578d893c087b0db">_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> + +<p>Referenced by <a class="el" href="PluginAdapter_8cpp-source.html#l00153">Vamp::PluginAdapterBase::Impl::getDescriptor()</a>, and <a class="el" href="PluginHostAdapter_8cpp-source.html#l00187">Vamp::PluginHostAdapter::getParameterDescriptors()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="6e7646babdb265c4abfc107ba4350d80"></a><!-- doxytag: member="_VampParameterDescriptor::maxValue" ref="6e7646babdb265c4abfc107ba4350d80" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">float <a class="el" href="struct__VampParameterDescriptor.html#6e7646babdb265c4abfc107ba4350d80">_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> + +<p>Referenced by <a class="el" href="PluginAdapter_8cpp-source.html#l00153">Vamp::PluginAdapterBase::Impl::getDescriptor()</a>, and <a class="el" href="PluginHostAdapter_8cpp-source.html#l00187">Vamp::PluginHostAdapter::getParameterDescriptors()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="3d37f986ee152ab55feb9902b35f7aca"></a><!-- doxytag: member="_VampParameterDescriptor::defaultValue" ref="3d37f986ee152ab55feb9902b35f7aca" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">float <a class="el" href="struct__VampParameterDescriptor.html#3d37f986ee152ab55feb9902b35f7aca">_VampParameterDescriptor::defaultValue</a> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Default value. +<p> +Plugin is responsible for setting this on initialise. +<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> + +<p>Referenced by <a class="el" href="PluginAdapter_8cpp-source.html#l00153">Vamp::PluginAdapterBase::Impl::getDescriptor()</a>, and <a class="el" href="PluginHostAdapter_8cpp-source.html#l00187">Vamp::PluginHostAdapter::getParameterDescriptors()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="3f41e3b6b69c7a95ff0ce8625794f83a"></a><!-- doxytag: member="_VampParameterDescriptor::isQuantized" ref="3f41e3b6b69c7a95ff0ce8625794f83a" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int <a class="el" href="struct__VampParameterDescriptor.html#3f41e3b6b69c7a95ff0ce8625794f83a">_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> + +<p>Referenced by <a class="el" href="PluginAdapter_8cpp-source.html#l00153">Vamp::PluginAdapterBase::Impl::getDescriptor()</a>, and <a class="el" href="PluginHostAdapter_8cpp-source.html#l00187">Vamp::PluginHostAdapter::getParameterDescriptors()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="68c91fd3fc0b0b3617c2d343fe32d0e5"></a><!-- doxytag: member="_VampParameterDescriptor::quantizeStep" ref="68c91fd3fc0b0b3617c2d343fe32d0e5" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">float <a class="el" href="struct__VampParameterDescriptor.html#68c91fd3fc0b0b3617c2d343fe32d0e5">_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> + +<p>Referenced by <a class="el" href="PluginAdapter_8cpp-source.html#l00153">Vamp::PluginAdapterBase::Impl::getDescriptor()</a>, and <a class="el" href="PluginHostAdapter_8cpp-source.html#l00187">Vamp::PluginHostAdapter::getParameterDescriptors()</a>.</p> + +</div> +</div><p> +<a class="anchor" name="188883325ab1e4a898e3dc53a8f88f9d"></a><!-- doxytag: member="_VampParameterDescriptor::valueNames" ref="188883325ab1e4a898e3dc53a8f88f9d" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">const char** <a class="el" href="struct__VampParameterDescriptor.html#188883325ab1e4a898e3dc53a8f88f9d">_VampParameterDescriptor::valueNames</a> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Human-readable names of the values, if isQuantized. +<p> +May be NULL. +<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> + +<p>Referenced by <a class="el" href="PluginAdapter_8cpp-source.html#l00153">Vamp::PluginAdapterBase::Impl::getDescriptor()</a>, <a class="el" href="PluginHostAdapter_8cpp-source.html#l00187">Vamp::PluginHostAdapter::getParameterDescriptors()</a>, and <a class="el" href="PluginAdapter_8cpp-source.html#l00258">Vamp::PluginAdapterBase::Impl::~Impl()</a>.</p> + +</div> +</div><p> +<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></ul> +</div> +<hr size="1"><address style="text-align: right;"><small>Generated on Wed Jul 9 11:36:07 2008 for VampPluginSDK by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.5 </small></address> +</body> +</html>