Mercurial > hg > vamp-website
diff code-doc/struct__VampParameterDescriptor.html @ 21:cc0be37dc9d3 website
* Updates for 2.0
| author | cannam |
|---|---|
| date | Tue, 09 Dec 2008 11:02:57 +0000 |
| parents | 351c4ebce5f9 |
| children | 0976232e353b |
line wrap: on
line diff
--- a/code-doc/struct__VampParameterDescriptor.html Mon Nov 24 15:17:08 2008 +0000 +++ b/code-doc/struct__VampParameterDescriptor.html Tue Dec 09 11:02:57 2008 +0000 @@ -4,7 +4,7 @@ <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 --> +<!-- Generated by Doxygen 1.5.6 --> <div class="navigation" id="top"> <div class="tabs"> <ul> @@ -29,10 +29,10 @@ <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. +C language API for <a class="el" href="namespaceVamp.html">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. +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> +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>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> @@ -86,8 +86,6 @@ 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="" --> @@ -107,8 +105,6 @@ 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="" --> @@ -128,8 +124,6 @@ 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="" --> @@ -149,8 +143,6 @@ <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="" --> @@ -170,8 +162,6 @@ <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="" --> @@ -191,8 +181,6 @@ <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="" --> @@ -212,8 +200,6 @@ 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="" --> @@ -233,8 +219,6 @@ <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="" --> @@ -254,8 +238,6 @@ <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="" --> @@ -275,15 +257,13 @@ 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 +<hr size="1"><address style="text-align: right;"><small>Generated on Mon Dec 8 14:37:18 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> +<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address> </body> </html>