Mercurial > hg > vamp-docs
diff code-docs/struct__VampParameterDescriptor.html @ 3:5c2683745b33 vamp-plugin-sdk-v2.4
Update for 2.4
author | Chris Cannam |
---|---|
date | Fri, 13 Jul 2012 13:30:27 +0100 |
parents | 3c430ef1ed66 |
children | 27319718b1f8 |
line wrap: on
line diff
--- a/code-docs/struct__VampParameterDescriptor.html Tue Oct 04 14:57:53 2011 +0100 +++ b/code-docs/struct__VampParameterDescriptor.html Fri Jul 13 13:30:27 2012 +0100 @@ -2,6 +2,7 @@ <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"/> @@ -28,7 +29,7 @@ <td style="padding-left: 0.5em;"> <div id="projectname">VampPluginSDK -  <span id="projectnumber">2.1</span> +  <span id="projectnumber">2.4</span> </div> </td> @@ -40,7 +41,7 @@ </table> </div> -<!-- Generated by Doxygen 1.7.5.1 --> +<!-- Generated by Doxygen 1.8.0 --> <div id="navrow1" class="tabs"> <ul class="tablist"> <li><a href="index.html"><span>Main Page</span></a></li> @@ -76,9 +77,9 @@ <a href="#pub-attribs">Public Attributes</a> </div> <div class="headertitle"> <div class="title">_VampParameterDescriptor Struct Reference</div> </div> -</div> +</div><!--header--> <div class="contents"> -<!-- doxytag: class="_VampParameterDescriptor" --> + <p>C language API for <a class="el" href="namespaceVamp.html">Vamp</a> plugins. <a href="struct__VampParameterDescriptor.html#details">More...</a></p> @@ -88,26 +89,26 @@ <table class="memberdecls"> <tr><td colspan="2"><h2><a name="pub-attribs"></a> Public Attributes</h2></td></tr> -<tr><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampParameterDescriptor.html#a26d74afd6a3341a673f15955031845ab">identifier</a></td></tr> -<tr><td class="mdescLeft"> </td><td class="mdescRight">Computer-usable name of the parameter. <a href="#a26d74afd6a3341a673f15955031845ab"></a><br/></td></tr> -<tr><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampParameterDescriptor.html#abba810bce9656f6002777f6c3f655957">name</a></td></tr> -<tr><td class="mdescLeft"> </td><td class="mdescRight">Human-readable name of the parameter. <a href="#abba810bce9656f6002777f6c3f655957"></a><br/></td></tr> -<tr><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampParameterDescriptor.html#a95489272d6cf5a5b487e949da8e4fac6">description</a></td></tr> -<tr><td class="mdescLeft"> </td><td class="mdescRight">Human-readable short text about the parameter. <a href="#a95489272d6cf5a5b487e949da8e4fac6"></a><br/></td></tr> -<tr><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampParameterDescriptor.html#a8ca235f816b56dc99125e010eee08fc7">unit</a></td></tr> -<tr><td class="mdescLeft"> </td><td class="mdescRight">Human-readable unit of the parameter. <a href="#a8ca235f816b56dc99125e010eee08fc7"></a><br/></td></tr> -<tr><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampParameterDescriptor.html#ab59c84f0bbe0d4d0c578d893c087b0db">minValue</a></td></tr> -<tr><td class="mdescLeft"> </td><td class="mdescRight">Minimum value. <a href="#ab59c84f0bbe0d4d0c578d893c087b0db"></a><br/></td></tr> -<tr><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampParameterDescriptor.html#a6e7646babdb265c4abfc107ba4350d80">maxValue</a></td></tr> -<tr><td class="mdescLeft"> </td><td class="mdescRight">Maximum value. <a href="#a6e7646babdb265c4abfc107ba4350d80"></a><br/></td></tr> -<tr><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampParameterDescriptor.html#a3d37f986ee152ab55feb9902b35f7aca">defaultValue</a></td></tr> -<tr><td class="mdescLeft"> </td><td class="mdescRight">Default value. <a href="#a3d37f986ee152ab55feb9902b35f7aca"></a><br/></td></tr> -<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampParameterDescriptor.html#a3f41e3b6b69c7a95ff0ce8625794f83a">isQuantized</a></td></tr> -<tr><td class="mdescLeft"> </td><td class="mdescRight">1 if parameter values are quantized to a particular resolution. <a href="#a3f41e3b6b69c7a95ff0ce8625794f83a"></a><br/></td></tr> -<tr><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampParameterDescriptor.html#a68c91fd3fc0b0b3617c2d343fe32d0e5">quantizeStep</a></td></tr> -<tr><td class="mdescLeft"> </td><td class="mdescRight">Quantization resolution, if isQuantized. <a href="#a68c91fd3fc0b0b3617c2d343fe32d0e5"></a><br/></td></tr> -<tr><td class="memItemLeft" align="right" valign="top">const char ** </td><td class="memItemRight" valign="bottom"><a class="el" href="struct__VampParameterDescriptor.html#a188883325ab1e4a898e3dc53a8f88f9d">valueNames</a></td></tr> -<tr><td class="mdescLeft"> </td><td class="mdescRight">Human-readable names of the values, if isQuantized. <a href="#a188883325ab1e4a898e3dc53a8f88f9d"></a><br/></td></tr> +<tr class="memitem:a26d74afd6a3341a673f15955031845ab"><td class="memItemLeft" align="right" valign="top">const char * </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"> </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 * </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"> </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 * </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"> </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 * </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"> </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 </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"> </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 </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"> </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 </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"> </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 </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"> </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 </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"> </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 ** </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"> </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> @@ -116,7 +117,7 @@ <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><!-- doxytag: member="_VampParameterDescriptor::identifier" ref="a26d74afd6a3341a673f15955031845ab" args="" --> +<a class="anchor" id="a26d74afd6a3341a673f15955031845ab"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> @@ -134,7 +135,7 @@ </div> </div> -<a class="anchor" id="abba810bce9656f6002777f6c3f655957"></a><!-- doxytag: member="_VampParameterDescriptor::name" ref="abba810bce9656f6002777f6c3f655957" args="" --> +<a class="anchor" id="abba810bce9656f6002777f6c3f655957"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> @@ -152,7 +153,7 @@ </div> </div> -<a class="anchor" id="a95489272d6cf5a5b487e949da8e4fac6"></a><!-- doxytag: member="_VampParameterDescriptor::description" ref="a95489272d6cf5a5b487e949da8e4fac6" args="" --> +<a class="anchor" id="a95489272d6cf5a5b487e949da8e4fac6"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> @@ -170,7 +171,7 @@ </div> </div> -<a class="anchor" id="a8ca235f816b56dc99125e010eee08fc7"></a><!-- doxytag: member="_VampParameterDescriptor::unit" ref="a8ca235f816b56dc99125e010eee08fc7" args="" --> +<a class="anchor" id="a8ca235f816b56dc99125e010eee08fc7"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> @@ -187,7 +188,7 @@ </div> </div> -<a class="anchor" id="ab59c84f0bbe0d4d0c578d893c087b0db"></a><!-- doxytag: member="_VampParameterDescriptor::minValue" ref="ab59c84f0bbe0d4d0c578d893c087b0db" args="" --> +<a class="anchor" id="ab59c84f0bbe0d4d0c578d893c087b0db"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> @@ -204,7 +205,7 @@ </div> </div> -<a class="anchor" id="a6e7646babdb265c4abfc107ba4350d80"></a><!-- doxytag: member="_VampParameterDescriptor::maxValue" ref="a6e7646babdb265c4abfc107ba4350d80" args="" --> +<a class="anchor" id="a6e7646babdb265c4abfc107ba4350d80"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> @@ -221,7 +222,7 @@ </div> </div> -<a class="anchor" id="a3d37f986ee152ab55feb9902b35f7aca"></a><!-- doxytag: member="_VampParameterDescriptor::defaultValue" ref="a3d37f986ee152ab55feb9902b35f7aca" args="" --> +<a class="anchor" id="a3d37f986ee152ab55feb9902b35f7aca"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> @@ -239,7 +240,7 @@ </div> </div> -<a class="anchor" id="a3f41e3b6b69c7a95ff0ce8625794f83a"></a><!-- doxytag: member="_VampParameterDescriptor::isQuantized" ref="a3f41e3b6b69c7a95ff0ce8625794f83a" args="" --> +<a class="anchor" id="a3f41e3b6b69c7a95ff0ce8625794f83a"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> @@ -256,7 +257,7 @@ </div> </div> -<a class="anchor" id="a68c91fd3fc0b0b3617c2d343fe32d0e5"></a><!-- doxytag: member="_VampParameterDescriptor::quantizeStep" ref="a68c91fd3fc0b0b3617c2d343fe32d0e5" args="" --> +<a class="anchor" id="a68c91fd3fc0b0b3617c2d343fe32d0e5"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> @@ -273,7 +274,7 @@ </div> </div> -<a class="anchor" id="a188883325ab1e4a898e3dc53a8f88f9d"></a><!-- doxytag: member="_VampParameterDescriptor::valueNames" ref="a188883325ab1e4a898e3dc53a8f88f9d" args="" --> +<a class="anchor" id="a188883325ab1e4a898e3dc53a8f88f9d"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> @@ -294,15 +295,15 @@ <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> +</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 Tue Oct 4 2011 14:38:50 for VampPluginSDK by + <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.7.5.1 </li> + <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.0 </li> </ul> </div>