|
Chris@1
|
1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
Chris@1
|
2 <html xmlns="http://www.w3.org/1999/xhtml">
|
|
Chris@1
|
3 <head>
|
|
Chris@1
|
4 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
|
Chris@3
|
5 <meta http-equiv="X-UA-Compatible" content="IE=9"/>
|
|
Chris@6
|
6 <meta name="generator" content="Doxygen 1.8.13"/>
|
|
Chris@6
|
7 <meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
Chris@1
|
8 <title>VampPluginSDK: Vamp::PluginBase Class Reference</title>
|
|
Chris@1
|
9 <link href="tabs.css" rel="stylesheet" type="text/css"/>
|
|
Chris@6
|
10 <script type="text/javascript" src="jquery.js"></script>
|
|
Chris@6
|
11 <script type="text/javascript" src="dynsections.js"></script>
|
|
Chris@1
|
12 <link href="navtree.css" rel="stylesheet" type="text/css"/>
|
|
Chris@1
|
13 <script type="text/javascript" src="resize.js"></script>
|
|
Chris@6
|
14 <script type="text/javascript" src="navtreedata.js"></script>
|
|
Chris@1
|
15 <script type="text/javascript" src="navtree.js"></script>
|
|
Chris@1
|
16 <script type="text/javascript">
|
|
Chris@1
|
17 $(document).ready(initResizable);
|
|
Chris@1
|
18 </script>
|
|
Chris@6
|
19 <link href="doxygen.css" rel="stylesheet" type="text/css" />
|
|
Chris@1
|
20 </head>
|
|
Chris@1
|
21 <body>
|
|
Chris@6
|
22 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
|
Chris@1
|
23 <div id="titlearea">
|
|
Chris@1
|
24 <table cellspacing="0" cellpadding="0">
|
|
Chris@1
|
25 <tbody>
|
|
Chris@1
|
26 <tr style="height: 56px;">
|
|
Chris@6
|
27 <td id="projectalign" style="padding-left: 0.5em;">
|
|
Chris@1
|
28 <div id="projectname">VampPluginSDK
|
|
Chris@6
|
29  <span id="projectnumber">2.7</span>
|
|
Chris@1
|
30 </div>
|
|
Chris@1
|
31 </td>
|
|
Chris@1
|
32 </tr>
|
|
Chris@1
|
33 </tbody>
|
|
Chris@1
|
34 </table>
|
|
Chris@1
|
35 </div>
|
|
Chris@6
|
36 <!-- end header part -->
|
|
Chris@6
|
37 <!-- Generated by Doxygen 1.8.13 -->
|
|
Chris@6
|
38 <script type="text/javascript" src="menudata.js"></script>
|
|
Chris@6
|
39 <script type="text/javascript" src="menu.js"></script>
|
|
Chris@6
|
40 <script type="text/javascript">
|
|
Chris@6
|
41 $(function() {
|
|
Chris@6
|
42 initMenu('',false,false,'search.php','Search');
|
|
Chris@6
|
43 });
|
|
Chris@6
|
44 </script>
|
|
Chris@6
|
45 <div id="main-nav"></div>
|
|
Chris@6
|
46 </div><!-- top -->
|
|
Chris@1
|
47 <div id="side-nav" class="ui-resizable side-nav-resizable">
|
|
Chris@1
|
48 <div id="nav-tree">
|
|
Chris@1
|
49 <div id="nav-tree-contents">
|
|
Chris@6
|
50 <div id="nav-sync" class="sync"></div>
|
|
Chris@1
|
51 </div>
|
|
Chris@1
|
52 </div>
|
|
Chris@1
|
53 <div id="splitbar" style="-moz-user-select:none;"
|
|
Chris@1
|
54 class="ui-resizable-handle">
|
|
Chris@1
|
55 </div>
|
|
Chris@1
|
56 </div>
|
|
Chris@1
|
57 <script type="text/javascript">
|
|
Chris@6
|
58 $(document).ready(function(){initNavTree('classVamp_1_1PluginBase.html','');});
|
|
Chris@1
|
59 </script>
|
|
Chris@1
|
60 <div id="doc-content">
|
|
Chris@1
|
61 <div class="header">
|
|
Chris@1
|
62 <div class="summary">
|
|
Chris@1
|
63 <a href="#nested-classes">Classes</a> |
|
|
Chris@1
|
64 <a href="#pub-types">Public Types</a> |
|
|
Chris@6
|
65 <a href="#pub-methods">Public Member Functions</a> |
|
|
Chris@6
|
66 <a href="classVamp_1_1PluginBase-members.html">List of all members</a> </div>
|
|
Chris@1
|
67 <div class="headertitle">
|
|
Chris@6
|
68 <div class="title">Vamp::PluginBase Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
|
|
Chris@3
|
69 </div><!--header-->
|
|
Chris@1
|
70 <div class="contents">
|
|
Chris@3
|
71
|
|
Chris@1
|
72 <p>A base class for plugins with optional configurable parameters, programs, etc.
|
|
Chris@1
|
73 <a href="classVamp_1_1PluginBase.html#details">More...</a></p>
|
|
Chris@1
|
74
|
|
Chris@1
|
75 <p><code>#include <<a class="el" href="vamp-sdk_2PluginBase_8h_source.html">PluginBase.h</a>></code></p>
|
|
Chris@1
|
76 <div class="dynheader">
|
|
Chris@1
|
77 Inheritance diagram for Vamp::PluginBase:</div>
|
|
Chris@1
|
78 <div class="dyncontent">
|
|
Chris@1
|
79 <div class="center"><img src="classVamp_1_1PluginBase__inherit__graph.png" border="0" usemap="#Vamp_1_1PluginBase_inherit__map" alt="Inheritance graph"/></div>
|
|
Chris@1
|
80 <map name="Vamp_1_1PluginBase_inherit__map" id="Vamp_1_1PluginBase_inherit__map">
|
|
Chris@6
|
81 <area shape="rect" id="node2" href="classVamp_1_1Plugin.html" title="Vamp::Plugin is a base class for plugin instance classes that provide feature extraction from audio o..." alt="" coords="176,179,271,204"/>
|
|
Chris@6
|
82 <area shape="rect" id="node3" href="classAmplitudeFollower.html" title="Example plugin implementing the SuperCollider amplitude follower function. " alt="" coords="352,5,476,31"/>
|
|
Chris@6
|
83 <area shape="rect" id="node4" href="classFixedTempoEstimator.html" title="Example plugin that estimates the tempo of a short fixed-tempo sample. " alt="" coords="344,55,484,80"/>
|
|
Chris@6
|
84 <area shape="rect" id="node5" href="classPercussionOnsetDetector.html" title="Example plugin that detects percussive events. " alt="" coords="333,104,495,129"/>
|
|
Chris@6
|
85 <area shape="rect" id="node6" href="classPowerSpectrum.html" title="Example plugin that returns a power spectrum calculated (trivially) from the frequency domain represe..." alt="" coords="359,153,469,179"/>
|
|
Chris@6
|
86 <area shape="rect" id="node7" href="classSpectralCentroid.html" title="Example plugin that calculates the centre of gravity of the frequency domain representation of each b..." alt="" coords="357,203,471,228"/>
|
|
Chris@6
|
87 <area shape="rect" id="node8" href="classVamp_1_1HostExt_1_1PluginWrapper.html" title="PluginWrapper is a simple base class for adapter plugins. " alt="" coords="319,252,509,277"/>
|
|
Chris@6
|
88 <area shape="rect" id="node13" href="classVamp_1_1PluginHostAdapter.html" title="PluginHostAdapter is a wrapper class that a Vamp host can use to make the C-language VampPluginDescri..." alt="" coords="333,301,495,327"/>
|
|
Chris@6
|
89 <area shape="rect" id="node14" href="classZeroCrossing.html" title="Example plugin that calculates the positions and density of zero-crossing points in an audio waveform..." alt="" coords="367,351,461,376"/>
|
|
Chris@6
|
90 <area shape="rect" id="node9" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html" title="PluginBufferingAdapter is a Vamp plugin adapter that allows plugins to be used by a host supplying an..." alt="" coords="569,152,764,191"/>
|
|
Chris@6
|
91 <area shape="rect" id="node10" href="classVamp_1_1HostExt_1_1PluginChannelAdapter.html" title="PluginChannelAdapter is a Vamp plugin adapter that implements a policy for management of plugins that..." alt="" coords="571,215,762,253"/>
|
|
Chris@6
|
92 <area shape="rect" id="node11" href="classVamp_1_1HostExt_1_1PluginInputDomainAdapter.html" title="PluginInputDomainAdapter is a Vamp plugin adapter that converts time-domain input into frequency-doma..." alt="" coords="580,277,753,316"/>
|
|
Chris@6
|
93 <area shape="rect" id="node12" href="classVamp_1_1HostExt_1_1PluginSummarisingAdapter.html" title="PluginSummarisingAdapter is a Vamp plugin adapter that provides summarisation methods such as mean an..." alt="" coords="557,340,776,379"/>
|
|
Chris@6
|
94 </map>
|
|
Chris@1
|
95 <center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
|
|
Chris@1
|
96 <table class="memberdecls">
|
|
Chris@6
|
97 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
|
|
Chris@1
|
98 Classes</h2></td></tr>
|
|
Chris@3
|
99 <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html">ParameterDescriptor</a></td></tr>
|
|
Chris@6
|
100 <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
Chris@6
|
101 </table><table class="memberdecls">
|
|
Chris@6
|
102 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
|
|
Chris@1
|
103 Public Types</h2></td></tr>
|
|
Chris@6
|
104 <tr class="memitem:a3b6bb4bbd86affe1ca9deceea1aad4f8"><td class="memItemLeft" align="right" valign="top">typedef std::vector< <a class="el" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html">ParameterDescriptor</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginBase.html#a3b6bb4bbd86affe1ca9deceea1aad4f8">ParameterList</a></td></tr>
|
|
Chris@6
|
105 <tr class="separator:a3b6bb4bbd86affe1ca9deceea1aad4f8"><td class="memSeparator" colspan="2"> </td></tr>
|
|
Chris@3
|
106 <tr class="memitem:a7f66f00437b21e5f694fe02356b12f20"><td class="memItemLeft" align="right" valign="top">typedef std::vector< std::string > </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginBase.html#a7f66f00437b21e5f694fe02356b12f20">ProgramList</a></td></tr>
|
|
Chris@6
|
107 <tr class="separator:a7f66f00437b21e5f694fe02356b12f20"><td class="memSeparator" colspan="2"> </td></tr>
|
|
Chris@6
|
108 </table><table class="memberdecls">
|
|
Chris@6
|
109 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
|
|
Chris@1
|
110 Public Member Functions</h2></td></tr>
|
|
Chris@3
|
111 <tr class="memitem:a3773b37c658cf22d7f135c575a28f5c5"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginBase.html#a3773b37c658cf22d7f135c575a28f5c5">~PluginBase</a> ()</td></tr>
|
|
Chris@6
|
112 <tr class="separator:a3773b37c658cf22d7f135c575a28f5c5"><td class="memSeparator" colspan="2"> </td></tr>
|
|
Chris@6
|
113 <tr class="memitem:ab4aa9c3e6f6dd9addbc095463c9fb772"><td class="memItemLeft" align="right" valign="top">virtual unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginBase.html#ab4aa9c3e6f6dd9addbc095463c9fb772">getVampApiVersion</a> () const</td></tr>
|
|
Chris@6
|
114 <tr class="memdesc:ab4aa9c3e6f6dd9addbc095463c9fb772"><td class="mdescLeft"> </td><td class="mdescRight">Get the <a class="el" href="namespaceVamp.html">Vamp</a> API compatibility level of the plugin. <a href="#ab4aa9c3e6f6dd9addbc095463c9fb772">More...</a><br /></td></tr>
|
|
Chris@6
|
115 <tr class="separator:ab4aa9c3e6f6dd9addbc095463c9fb772"><td class="memSeparator" colspan="2"> </td></tr>
|
|
Chris@3
|
116 <tr class="memitem:ad1c6dfc77aa03d937a885b7f08258f4a"><td class="memItemLeft" align="right" valign="top">virtual std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginBase.html#ad1c6dfc77aa03d937a885b7f08258f4a">getIdentifier</a> () const =0</td></tr>
|
|
Chris@6
|
117 <tr class="memdesc:ad1c6dfc77aa03d937a885b7f08258f4a"><td class="mdescLeft"> </td><td class="mdescRight">Get the computer-usable name of the plugin. <a href="#ad1c6dfc77aa03d937a885b7f08258f4a">More...</a><br /></td></tr>
|
|
Chris@6
|
118 <tr class="separator:ad1c6dfc77aa03d937a885b7f08258f4a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
Chris@3
|
119 <tr class="memitem:a18619d5097e444ecefee0c359da53232"><td class="memItemLeft" align="right" valign="top">virtual std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginBase.html#a18619d5097e444ecefee0c359da53232">getName</a> () const =0</td></tr>
|
|
Chris@6
|
120 <tr class="memdesc:a18619d5097e444ecefee0c359da53232"><td class="mdescLeft"> </td><td class="mdescRight">Get a human-readable name or title of the plugin. <a href="#a18619d5097e444ecefee0c359da53232">More...</a><br /></td></tr>
|
|
Chris@6
|
121 <tr class="separator:a18619d5097e444ecefee0c359da53232"><td class="memSeparator" colspan="2"> </td></tr>
|
|
Chris@3
|
122 <tr class="memitem:a59153a02364f75fff46973b2072e9e5a"><td class="memItemLeft" align="right" valign="top">virtual std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginBase.html#a59153a02364f75fff46973b2072e9e5a">getDescription</a> () const =0</td></tr>
|
|
Chris@6
|
123 <tr class="memdesc:a59153a02364f75fff46973b2072e9e5a"><td class="mdescLeft"> </td><td class="mdescRight">Get a human-readable description for the plugin, typically a line of text that may optionally be displayed in addition to the plugin's "name". <a href="#a59153a02364f75fff46973b2072e9e5a">More...</a><br /></td></tr>
|
|
Chris@6
|
124 <tr class="separator:a59153a02364f75fff46973b2072e9e5a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
Chris@3
|
125 <tr class="memitem:a53d9918bf9ef4d12feedf66b2b26c637"><td class="memItemLeft" align="right" valign="top">virtual std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginBase.html#a53d9918bf9ef4d12feedf66b2b26c637">getMaker</a> () const =0</td></tr>
|
|
Chris@6
|
126 <tr class="memdesc:a53d9918bf9ef4d12feedf66b2b26c637"><td class="mdescLeft"> </td><td class="mdescRight">Get the name of the author or vendor of the plugin in human-readable form. <a href="#a53d9918bf9ef4d12feedf66b2b26c637">More...</a><br /></td></tr>
|
|
Chris@6
|
127 <tr class="separator:a53d9918bf9ef4d12feedf66b2b26c637"><td class="memSeparator" colspan="2"> </td></tr>
|
|
Chris@3
|
128 <tr class="memitem:ab7e9dedbe965f5ab9018b72920fe7661"><td class="memItemLeft" align="right" valign="top">virtual std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginBase.html#ab7e9dedbe965f5ab9018b72920fe7661">getCopyright</a> () const =0</td></tr>
|
|
Chris@6
|
129 <tr class="memdesc:ab7e9dedbe965f5ab9018b72920fe7661"><td class="mdescLeft"> </td><td class="mdescRight">Get the copyright statement or licensing summary for the plugin. <a href="#ab7e9dedbe965f5ab9018b72920fe7661">More...</a><br /></td></tr>
|
|
Chris@6
|
130 <tr class="separator:ab7e9dedbe965f5ab9018b72920fe7661"><td class="memSeparator" colspan="2"> </td></tr>
|
|
Chris@3
|
131 <tr class="memitem:a63f686d77bc3d6b807e7944cdde83151"><td class="memItemLeft" align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginBase.html#a63f686d77bc3d6b807e7944cdde83151">getPluginVersion</a> () const =0</td></tr>
|
|
Chris@6
|
132 <tr class="memdesc:a63f686d77bc3d6b807e7944cdde83151"><td class="mdescLeft"> </td><td class="mdescRight">Get the version number of the plugin. <a href="#a63f686d77bc3d6b807e7944cdde83151">More...</a><br /></td></tr>
|
|
Chris@6
|
133 <tr class="separator:a63f686d77bc3d6b807e7944cdde83151"><td class="memSeparator" colspan="2"> </td></tr>
|
|
Chris@6
|
134 <tr class="memitem:a0c24ff6a43c681198dc9497287a26e3a"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classVamp_1_1PluginBase.html#a3b6bb4bbd86affe1ca9deceea1aad4f8">ParameterList</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginBase.html#a0c24ff6a43c681198dc9497287a26e3a">getParameterDescriptors</a> () const</td></tr>
|
|
Chris@6
|
135 <tr class="memdesc:a0c24ff6a43c681198dc9497287a26e3a"><td class="mdescLeft"> </td><td class="mdescRight">Get the controllable parameters of this plugin. <a href="#a0c24ff6a43c681198dc9497287a26e3a">More...</a><br /></td></tr>
|
|
Chris@6
|
136 <tr class="separator:a0c24ff6a43c681198dc9497287a26e3a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
Chris@6
|
137 <tr class="memitem:aa813d61077080ec95487d2a0227cc51b"><td class="memItemLeft" align="right" valign="top">virtual float </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginBase.html#aa813d61077080ec95487d2a0227cc51b">getParameter</a> (std::string) const</td></tr>
|
|
Chris@6
|
138 <tr class="memdesc:aa813d61077080ec95487d2a0227cc51b"><td class="mdescLeft"> </td><td class="mdescRight">Get the value of a named parameter. <a href="#aa813d61077080ec95487d2a0227cc51b">More...</a><br /></td></tr>
|
|
Chris@6
|
139 <tr class="separator:aa813d61077080ec95487d2a0227cc51b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
Chris@3
|
140 <tr class="memitem:a6c718ce822f7b73b98940d59dcaa9366"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginBase.html#a6c718ce822f7b73b98940d59dcaa9366">setParameter</a> (std::string, float)</td></tr>
|
|
Chris@6
|
141 <tr class="memdesc:a6c718ce822f7b73b98940d59dcaa9366"><td class="mdescLeft"> </td><td class="mdescRight">Set a named parameter. <a href="#a6c718ce822f7b73b98940d59dcaa9366">More...</a><br /></td></tr>
|
|
Chris@6
|
142 <tr class="separator:a6c718ce822f7b73b98940d59dcaa9366"><td class="memSeparator" colspan="2"> </td></tr>
|
|
Chris@6
|
143 <tr class="memitem:aaf6febff0ab4daf4a5089c98a67f4df8"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classVamp_1_1PluginBase.html#a7f66f00437b21e5f694fe02356b12f20">ProgramList</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginBase.html#aaf6febff0ab4daf4a5089c98a67f4df8">getPrograms</a> () const</td></tr>
|
|
Chris@6
|
144 <tr class="memdesc:aaf6febff0ab4daf4a5089c98a67f4df8"><td class="mdescLeft"> </td><td class="mdescRight">Get the program settings available in this plugin. <a href="#aaf6febff0ab4daf4a5089c98a67f4df8">More...</a><br /></td></tr>
|
|
Chris@6
|
145 <tr class="separator:aaf6febff0ab4daf4a5089c98a67f4df8"><td class="memSeparator" colspan="2"> </td></tr>
|
|
Chris@6
|
146 <tr class="memitem:aac38c5dc6e87208616122897518ca3d5"><td class="memItemLeft" align="right" valign="top">virtual std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginBase.html#aac38c5dc6e87208616122897518ca3d5">getCurrentProgram</a> () const</td></tr>
|
|
Chris@6
|
147 <tr class="memdesc:aac38c5dc6e87208616122897518ca3d5"><td class="mdescLeft"> </td><td class="mdescRight">Get the current program. <a href="#aac38c5dc6e87208616122897518ca3d5">More...</a><br /></td></tr>
|
|
Chris@6
|
148 <tr class="separator:aac38c5dc6e87208616122897518ca3d5"><td class="memSeparator" colspan="2"> </td></tr>
|
|
Chris@3
|
149 <tr class="memitem:aadd3a547ef140bae200473a9518e3353"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginBase.html#aadd3a547ef140bae200473a9518e3353">selectProgram</a> (std::string)</td></tr>
|
|
Chris@6
|
150 <tr class="memdesc:aadd3a547ef140bae200473a9518e3353"><td class="mdescLeft"> </td><td class="mdescRight">Select a program. <a href="#aadd3a547ef140bae200473a9518e3353">More...</a><br /></td></tr>
|
|
Chris@6
|
151 <tr class="separator:aadd3a547ef140bae200473a9518e3353"><td class="memSeparator" colspan="2"> </td></tr>
|
|
Chris@3
|
152 <tr class="memitem:a2da03e9ced8dc7e4382205e6dc05dbff"><td class="memItemLeft" align="right" valign="top">virtual std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classVamp_1_1PluginBase.html#a2da03e9ced8dc7e4382205e6dc05dbff">getType</a> () const =0</td></tr>
|
|
Chris@6
|
153 <tr class="memdesc:a2da03e9ced8dc7e4382205e6dc05dbff"><td class="mdescLeft"> </td><td class="mdescRight">Get the type of plugin. <a href="#a2da03e9ced8dc7e4382205e6dc05dbff">More...</a><br /></td></tr>
|
|
Chris@6
|
154 <tr class="separator:a2da03e9ced8dc7e4382205e6dc05dbff"><td class="memSeparator" colspan="2"> </td></tr>
|
|
Chris@1
|
155 </table>
|
|
Chris@6
|
156 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
Chris@1
|
157 <div class="textblock"><p>A base class for plugins with optional configurable parameters, programs, etc. </p>
|
|
Chris@1
|
158 <p>The <a class="el" href="classVamp_1_1Plugin.html" title="Vamp::Plugin is a base class for plugin instance classes that provide feature extraction from audio o...">Vamp::Plugin</a> is derived from this, and individual <a class="el" href="namespaceVamp.html">Vamp</a> plugins should derive from that.</p>
|
|
Chris@1
|
159 <p>This class does not provide the necessary interfaces to instantiate or run a plugin. It only specifies an interface for retrieving those controls that the host may wish to show to the user for editing. It could meaningfully be subclassed by real-time plugins or other sorts of plugin as well as <a class="el" href="namespaceVamp.html">Vamp</a> plugins. </p>
|
|
Chris@1
|
160
|
|
Chris@6
|
161 <p class="definition">Definition at line <a class="el" href="vamp-sdk_2PluginBase_8h_source.html#l00060">60</a> of file <a class="el" href="vamp-sdk_2PluginBase_8h_source.html">vamp-sdk/PluginBase.h</a>.</p>
|
|
Chris@6
|
162 </div><h2 class="groupheader">Member Typedef Documentation</h2>
|
|
Chris@6
|
163 <a id="a3b6bb4bbd86affe1ca9deceea1aad4f8"></a>
|
|
Chris@6
|
164 <h2 class="memtitle"><span class="permalink"><a href="#a3b6bb4bbd86affe1ca9deceea1aad4f8">◆ </a></span>ParameterList</h2>
|
|
Chris@6
|
165
|
|
Chris@1
|
166 <div class="memitem">
|
|
Chris@1
|
167 <div class="memproto">
|
|
Chris@1
|
168 <table class="memname">
|
|
Chris@1
|
169 <tr>
|
|
Chris@1
|
170 <td class="memname">typedef std::vector<<a class="el" href="structVamp_1_1PluginBase_1_1ParameterDescriptor.html">ParameterDescriptor</a>> <a class="el" href="classVamp_1_1PluginBase.html#a3b6bb4bbd86affe1ca9deceea1aad4f8">Vamp::PluginBase::ParameterList</a></td>
|
|
Chris@1
|
171 </tr>
|
|
Chris@1
|
172 </table>
|
|
Chris@6
|
173 </div><div class="memdoc">
|
|
Chris@1
|
174
|
|
Chris@6
|
175 <p class="definition">Definition at line <a class="el" href="vamp-sdk_2PluginBase_8h_source.html#l00203">203</a> of file <a class="el" href="vamp-sdk_2PluginBase_8h_source.html">vamp-sdk/PluginBase.h</a>.</p>
|
|
Chris@1
|
176
|
|
Chris@1
|
177 </div>
|
|
Chris@1
|
178 </div>
|
|
Chris@6
|
179 <a id="a7f66f00437b21e5f694fe02356b12f20"></a>
|
|
Chris@6
|
180 <h2 class="memtitle"><span class="permalink"><a href="#a7f66f00437b21e5f694fe02356b12f20">◆ </a></span>ProgramList</h2>
|
|
Chris@6
|
181
|
|
Chris@1
|
182 <div class="memitem">
|
|
Chris@1
|
183 <div class="memproto">
|
|
Chris@1
|
184 <table class="memname">
|
|
Chris@1
|
185 <tr>
|
|
Chris@1
|
186 <td class="memname">typedef std::vector<std::string> <a class="el" href="classVamp_1_1PluginBase.html#a7f66f00437b21e5f694fe02356b12f20">Vamp::PluginBase::ProgramList</a></td>
|
|
Chris@1
|
187 </tr>
|
|
Chris@1
|
188 </table>
|
|
Chris@6
|
189 </div><div class="memdoc">
|
|
Chris@1
|
190
|
|
Chris@6
|
191 <p class="definition">Definition at line <a class="el" href="vamp-sdk_2PluginBase_8h_source.html#l00225">225</a> of file <a class="el" href="vamp-sdk_2PluginBase_8h_source.html">vamp-sdk/PluginBase.h</a>.</p>
|
|
Chris@1
|
192
|
|
Chris@1
|
193 </div>
|
|
Chris@1
|
194 </div>
|
|
Chris@6
|
195 <h2 class="groupheader">Constructor & Destructor Documentation</h2>
|
|
Chris@6
|
196 <a id="a3773b37c658cf22d7f135c575a28f5c5"></a>
|
|
Chris@6
|
197 <h2 class="memtitle"><span class="permalink"><a href="#a3773b37c658cf22d7f135c575a28f5c5">◆ </a></span>~PluginBase()</h2>
|
|
Chris@6
|
198
|
|
Chris@1
|
199 <div class="memitem">
|
|
Chris@1
|
200 <div class="memproto">
|
|
Chris@6
|
201 <table class="mlabels">
|
|
Chris@6
|
202 <tr>
|
|
Chris@6
|
203 <td class="mlabels-left">
|
|
Chris@1
|
204 <table class="memname">
|
|
Chris@1
|
205 <tr>
|
|
Chris@6
|
206 <td class="memname">virtual Vamp::PluginBase::~PluginBase </td>
|
|
Chris@1
|
207 <td>(</td>
|
|
Chris@1
|
208 <td class="paramname"></td><td>)</td>
|
|
Chris@6
|
209 <td></td>
|
|
Chris@1
|
210 </tr>
|
|
Chris@1
|
211 </table>
|
|
Chris@6
|
212 </td>
|
|
Chris@6
|
213 <td class="mlabels-right">
|
|
Chris@6
|
214 <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
|
|
Chris@6
|
215 </tr>
|
|
Chris@6
|
216 </table>
|
|
Chris@6
|
217 </div><div class="memdoc">
|
|
Chris@1
|
218
|
|
Chris@6
|
219 <p class="definition">Definition at line <a class="el" href="vamp-sdk_2PluginBase_8h_source.html#l00063">63</a> of file <a class="el" href="vamp-sdk_2PluginBase_8h_source.html">vamp-sdk/PluginBase.h</a>.</p>
|
|
Chris@1
|
220
|
|
Chris@1
|
221 </div>
|
|
Chris@1
|
222 </div>
|
|
Chris@6
|
223 <h2 class="groupheader">Member Function Documentation</h2>
|
|
Chris@6
|
224 <a id="ab4aa9c3e6f6dd9addbc095463c9fb772"></a>
|
|
Chris@6
|
225 <h2 class="memtitle"><span class="permalink"><a href="#ab4aa9c3e6f6dd9addbc095463c9fb772">◆ </a></span>getVampApiVersion()</h2>
|
|
Chris@6
|
226
|
|
Chris@1
|
227 <div class="memitem">
|
|
Chris@1
|
228 <div class="memproto">
|
|
Chris@6
|
229 <table class="mlabels">
|
|
Chris@6
|
230 <tr>
|
|
Chris@6
|
231 <td class="mlabels-left">
|
|
Chris@1
|
232 <table class="memname">
|
|
Chris@1
|
233 <tr>
|
|
Chris@6
|
234 <td class="memname">virtual unsigned int Vamp::PluginBase::getVampApiVersion </td>
|
|
Chris@1
|
235 <td>(</td>
|
|
Chris@1
|
236 <td class="paramname"></td><td>)</td>
|
|
Chris@6
|
237 <td> const</td>
|
|
Chris@1
|
238 </tr>
|
|
Chris@1
|
239 </table>
|
|
Chris@6
|
240 </td>
|
|
Chris@6
|
241 <td class="mlabels-right">
|
|
Chris@6
|
242 <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
|
|
Chris@6
|
243 </tr>
|
|
Chris@6
|
244 </table>
|
|
Chris@6
|
245 </div><div class="memdoc">
|
|
Chris@1
|
246
|
|
Chris@1
|
247 <p>Get the <a class="el" href="namespaceVamp.html">Vamp</a> API compatibility level of the plugin. </p>
|
|
Chris@1
|
248
|
|
Chris@6
|
249 <p>Reimplemented in <a class="el" href="classVamp_1_1PluginHostAdapter.html#adc708325d057516bd92d5ea1c0808dbc">Vamp::PluginHostAdapter</a>, and <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#afa79272f991fb720ddd09784be1b3cb8">Vamp::HostExt::PluginWrapper</a>.</p>
|
|
Chris@1
|
250
|
|
Chris@6
|
251 <p class="definition">Definition at line <a class="el" href="vamp-sdk_2PluginBase_8h_source.html#l00068">68</a> of file <a class="el" href="vamp-sdk_2PluginBase_8h_source.html">vamp-sdk/PluginBase.h</a>.</p>
|
|
Chris@1
|
252
|
|
Chris@6
|
253 <p class="reference">Referenced by <a class="el" href="vamp-simple-host_8cpp_source.html#l00609">enumeratePlugins()</a>.</p>
|
|
Chris@1
|
254
|
|
Chris@1
|
255 </div>
|
|
Chris@1
|
256 </div>
|
|
Chris@6
|
257 <a id="ad1c6dfc77aa03d937a885b7f08258f4a"></a>
|
|
Chris@6
|
258 <h2 class="memtitle"><span class="permalink"><a href="#ad1c6dfc77aa03d937a885b7f08258f4a">◆ </a></span>getIdentifier()</h2>
|
|
Chris@6
|
259
|
|
Chris@1
|
260 <div class="memitem">
|
|
Chris@1
|
261 <div class="memproto">
|
|
Chris@6
|
262 <table class="mlabels">
|
|
Chris@6
|
263 <tr>
|
|
Chris@6
|
264 <td class="mlabels-left">
|
|
Chris@1
|
265 <table class="memname">
|
|
Chris@1
|
266 <tr>
|
|
Chris@6
|
267 <td class="memname">virtual std::string Vamp::PluginBase::getIdentifier </td>
|
|
Chris@1
|
268 <td>(</td>
|
|
Chris@1
|
269 <td class="paramname"></td><td>)</td>
|
|
Chris@6
|
270 <td> const</td>
|
|
Chris@1
|
271 </tr>
|
|
Chris@1
|
272 </table>
|
|
Chris@6
|
273 </td>
|
|
Chris@6
|
274 <td class="mlabels-right">
|
|
Chris@6
|
275 <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
|
|
Chris@6
|
276 </tr>
|
|
Chris@6
|
277 </table>
|
|
Chris@6
|
278 </div><div class="memdoc">
|
|
Chris@1
|
279
|
|
Chris@1
|
280 <p>Get the computer-usable name of the plugin. </p>
|
|
Chris@1
|
281 <p>This should be reasonably short and contain no whitespace or punctuation characters. It may only contain the characters [a-zA-Z0-9_-]. This is the authoritative way for a program to identify a plugin within a given library.</p>
|
|
Chris@1
|
282 <p>This text may be visible to the user, but it should not be the main text used to identify a plugin to the user (that will be the name, below).</p>
|
|
Chris@1
|
283 <p>Example: "zero_crossings" </p>
|
|
Chris@1
|
284
|
|
Chris@6
|
285 <p>Implemented in <a class="el" href="classVamp_1_1PluginHostAdapter.html#a68749b61d8a4e322d7ce6662347817ca">Vamp::PluginHostAdapter</a>, <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#ad9312a38c199004c7bad0c42f590393f">Vamp::HostExt::PluginWrapper</a>, <a class="el" href="classPowerSpectrum.html#a885e87df9fbb4e6cb2fff69116122326">PowerSpectrum</a>, <a class="el" href="classAmplitudeFollower.html#ad77b59b8e8bc0f415edab073f2e5edef">AmplitudeFollower</a>, <a class="el" href="classSpectralCentroid.html#a4992d03772a228015ee2f8174f1bf06e">SpectralCentroid</a>, <a class="el" href="classZeroCrossing.html#af5049a01a3f003f17a45c61b599c6543">ZeroCrossing</a>, <a class="el" href="classFixedTempoEstimator.html#a149f40bbccc3cf3bc05f35e32e6cedac">FixedTempoEstimator</a>, and <a class="el" href="classPercussionOnsetDetector.html#ac1bb968a3632083e55e4d236310b9cdb">PercussionOnsetDetector</a>.</p>
|
|
Chris@1
|
286
|
|
Chris@6
|
287 <p class="reference">Referenced by <a class="el" href="vamp-simple-host_8cpp_source.html#l00609">enumeratePlugins()</a>, and <a class="el" href="vamp-simple-host_8cpp_source.html#l00268">runPlugin()</a>.</p>
|
|
Chris@1
|
288
|
|
Chris@1
|
289 </div>
|
|
Chris@1
|
290 </div>
|
|
Chris@6
|
291 <a id="a18619d5097e444ecefee0c359da53232"></a>
|
|
Chris@6
|
292 <h2 class="memtitle"><span class="permalink"><a href="#a18619d5097e444ecefee0c359da53232">◆ </a></span>getName()</h2>
|
|
Chris@6
|
293
|
|
Chris@1
|
294 <div class="memitem">
|
|
Chris@1
|
295 <div class="memproto">
|
|
Chris@6
|
296 <table class="mlabels">
|
|
Chris@6
|
297 <tr>
|
|
Chris@6
|
298 <td class="mlabels-left">
|
|
Chris@1
|
299 <table class="memname">
|
|
Chris@1
|
300 <tr>
|
|
Chris@6
|
301 <td class="memname">virtual std::string Vamp::PluginBase::getName </td>
|
|
Chris@1
|
302 <td>(</td>
|
|
Chris@1
|
303 <td class="paramname"></td><td>)</td>
|
|
Chris@6
|
304 <td> const</td>
|
|
Chris@1
|
305 </tr>
|
|
Chris@1
|
306 </table>
|
|
Chris@6
|
307 </td>
|
|
Chris@6
|
308 <td class="mlabels-right">
|
|
Chris@6
|
309 <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
|
|
Chris@6
|
310 </tr>
|
|
Chris@6
|
311 </table>
|
|
Chris@6
|
312 </div><div class="memdoc">
|
|
Chris@1
|
313
|
|
Chris@1
|
314 <p>Get a human-readable name or title of the plugin. </p>
|
|
Chris@1
|
315 <p>This should be brief and self-contained, as it may be used to identify the plugin to the user in isolation (i.e. without also showing the plugin's "identifier").</p>
|
|
Chris@1
|
316 <p>Example: "Zero Crossings" </p>
|
|
Chris@1
|
317
|
|
Chris@6
|
318 <p>Implemented in <a class="el" href="classVamp_1_1PluginHostAdapter.html#a6276b0838a3a9ac155d295cae0e7bb67">Vamp::PluginHostAdapter</a>, <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#aa2b40de6e240d872997a63dd4a301ff3">Vamp::HostExt::PluginWrapper</a>, <a class="el" href="classPowerSpectrum.html#a8f3d7d654e6aad23f307ef46dd9e70cb">PowerSpectrum</a>, <a class="el" href="classAmplitudeFollower.html#a4a4ea5c0b2e30b420646aa78571176c2">AmplitudeFollower</a>, <a class="el" href="classSpectralCentroid.html#aa6236ae7400468b8d23d57f8bbb917a9">SpectralCentroid</a>, <a class="el" href="classZeroCrossing.html#a191365f793e6488d02d57029eb14deb2">ZeroCrossing</a>, <a class="el" href="classFixedTempoEstimator.html#aad3f044387fb8fd4dbadca8f397dd798">FixedTempoEstimator</a>, and <a class="el" href="classPercussionOnsetDetector.html#a9b8532bfd1a6053682db3ce15b1890da">PercussionOnsetDetector</a>.</p>
|
|
Chris@1
|
319
|
|
Chris@6
|
320 <p class="reference">Referenced by <a class="el" href="vamp-simple-host_8cpp_source.html#l00609">enumeratePlugins()</a>, and <a class="el" href="vamp-simple-host_8cpp_source.html#l00828">printPluginCategoryList()</a>.</p>
|
|
Chris@1
|
321
|
|
Chris@1
|
322 </div>
|
|
Chris@1
|
323 </div>
|
|
Chris@6
|
324 <a id="a59153a02364f75fff46973b2072e9e5a"></a>
|
|
Chris@6
|
325 <h2 class="memtitle"><span class="permalink"><a href="#a59153a02364f75fff46973b2072e9e5a">◆ </a></span>getDescription()</h2>
|
|
Chris@6
|
326
|
|
Chris@1
|
327 <div class="memitem">
|
|
Chris@1
|
328 <div class="memproto">
|
|
Chris@6
|
329 <table class="mlabels">
|
|
Chris@6
|
330 <tr>
|
|
Chris@6
|
331 <td class="mlabels-left">
|
|
Chris@1
|
332 <table class="memname">
|
|
Chris@1
|
333 <tr>
|
|
Chris@6
|
334 <td class="memname">virtual std::string Vamp::PluginBase::getDescription </td>
|
|
Chris@1
|
335 <td>(</td>
|
|
Chris@1
|
336 <td class="paramname"></td><td>)</td>
|
|
Chris@6
|
337 <td> const</td>
|
|
Chris@1
|
338 </tr>
|
|
Chris@1
|
339 </table>
|
|
Chris@6
|
340 </td>
|
|
Chris@6
|
341 <td class="mlabels-right">
|
|
Chris@6
|
342 <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
|
|
Chris@6
|
343 </tr>
|
|
Chris@6
|
344 </table>
|
|
Chris@6
|
345 </div><div class="memdoc">
|
|
Chris@1
|
346
|
|
Chris@1
|
347 <p>Get a human-readable description for the plugin, typically a line of text that may optionally be displayed in addition to the plugin's "name". </p>
|
|
Chris@1
|
348 <p>May be empty if the name has said it all already.</p>
|
|
Chris@1
|
349 <p>Example: "Detect and count zero crossing points" </p>
|
|
Chris@1
|
350
|
|
Chris@6
|
351 <p>Implemented in <a class="el" href="classVamp_1_1PluginHostAdapter.html#aae795d71594901243de8cda96d871fc8">Vamp::PluginHostAdapter</a>, <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#ad6e453c30b265a2daf243f953b35c815">Vamp::HostExt::PluginWrapper</a>, <a class="el" href="classPowerSpectrum.html#a0740aaee10568b4e21903ccd5a764e2a">PowerSpectrum</a>, <a class="el" href="classAmplitudeFollower.html#aad780ea62291ef94925d6f4d1cc3f4ac">AmplitudeFollower</a>, <a class="el" href="classSpectralCentroid.html#ac4a840f9b3c92e0acbcc7d262e841b59">SpectralCentroid</a>, <a class="el" href="classZeroCrossing.html#a7ba1cfd102a427f8333ddfa2fe234d58">ZeroCrossing</a>, <a class="el" href="classFixedTempoEstimator.html#a4e48cbf0eedb001c0824db864ee4d942">FixedTempoEstimator</a>, and <a class="el" href="classPercussionOnsetDetector.html#a4ea74f76e302c53ced7508bc8388487b">PercussionOnsetDetector</a>.</p>
|
|
Chris@1
|
352
|
|
Chris@6
|
353 <p class="reference">Referenced by <a class="el" href="vamp-simple-host_8cpp_source.html#l00609">enumeratePlugins()</a>, and <a class="el" href="vamp-simple-host_8cpp_source.html#l00828">printPluginCategoryList()</a>.</p>
|
|
Chris@1
|
354
|
|
Chris@1
|
355 </div>
|
|
Chris@1
|
356 </div>
|
|
Chris@6
|
357 <a id="a53d9918bf9ef4d12feedf66b2b26c637"></a>
|
|
Chris@6
|
358 <h2 class="memtitle"><span class="permalink"><a href="#a53d9918bf9ef4d12feedf66b2b26c637">◆ </a></span>getMaker()</h2>
|
|
Chris@6
|
359
|
|
Chris@1
|
360 <div class="memitem">
|
|
Chris@1
|
361 <div class="memproto">
|
|
Chris@6
|
362 <table class="mlabels">
|
|
Chris@6
|
363 <tr>
|
|
Chris@6
|
364 <td class="mlabels-left">
|
|
Chris@1
|
365 <table class="memname">
|
|
Chris@1
|
366 <tr>
|
|
Chris@6
|
367 <td class="memname">virtual std::string Vamp::PluginBase::getMaker </td>
|
|
Chris@1
|
368 <td>(</td>
|
|
Chris@1
|
369 <td class="paramname"></td><td>)</td>
|
|
Chris@6
|
370 <td> const</td>
|
|
Chris@1
|
371 </tr>
|
|
Chris@1
|
372 </table>
|
|
Chris@6
|
373 </td>
|
|
Chris@6
|
374 <td class="mlabels-right">
|
|
Chris@6
|
375 <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
|
|
Chris@6
|
376 </tr>
|
|
Chris@6
|
377 </table>
|
|
Chris@6
|
378 </div><div class="memdoc">
|
|
Chris@1
|
379
|
|
Chris@1
|
380 <p>Get the name of the author or vendor of the plugin in human-readable form. </p>
|
|
Chris@1
|
381 <p>This should be a short identifying text, as it may be used to label plugins from the same source in a menu or similar. </p>
|
|
Chris@1
|
382
|
|
Chris@6
|
383 <p>Implemented in <a class="el" href="classVamp_1_1PluginHostAdapter.html#ac906c3a0eef77f545fb4dad2456ee2b4">Vamp::PluginHostAdapter</a>, <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#af9b2f01063828ef0745dc2623fc8dd42">Vamp::HostExt::PluginWrapper</a>, <a class="el" href="classPowerSpectrum.html#a55764eb41af953c36339c4cade238be2">PowerSpectrum</a>, <a class="el" href="classAmplitudeFollower.html#ac7a9db3ec7daa0e9bd83106bbf641777">AmplitudeFollower</a>, <a class="el" href="classSpectralCentroid.html#a9bab5a013a818e286eb4894f9874fee1">SpectralCentroid</a>, <a class="el" href="classZeroCrossing.html#a9ddf295d977b6c64d8acd34b7e0ce1b0">ZeroCrossing</a>, <a class="el" href="classFixedTempoEstimator.html#a5ade364056e5ff7c3e2978d9a75a2988">FixedTempoEstimator</a>, and <a class="el" href="classPercussionOnsetDetector.html#a1ef108aac025c3f2c3201fd9f43b6a6b">PercussionOnsetDetector</a>.</p>
|
|
Chris@1
|
384
|
|
Chris@6
|
385 <p class="reference">Referenced by <a class="el" href="vamp-simple-host_8cpp_source.html#l00609">enumeratePlugins()</a>, and <a class="el" href="vamp-simple-host_8cpp_source.html#l00828">printPluginCategoryList()</a>.</p>
|
|
Chris@1
|
386
|
|
Chris@1
|
387 </div>
|
|
Chris@1
|
388 </div>
|
|
Chris@6
|
389 <a id="ab7e9dedbe965f5ab9018b72920fe7661"></a>
|
|
Chris@6
|
390 <h2 class="memtitle"><span class="permalink"><a href="#ab7e9dedbe965f5ab9018b72920fe7661">◆ </a></span>getCopyright()</h2>
|
|
Chris@6
|
391
|
|
Chris@1
|
392 <div class="memitem">
|
|
Chris@1
|
393 <div class="memproto">
|
|
Chris@6
|
394 <table class="mlabels">
|
|
Chris@6
|
395 <tr>
|
|
Chris@6
|
396 <td class="mlabels-left">
|
|
Chris@1
|
397 <table class="memname">
|
|
Chris@1
|
398 <tr>
|
|
Chris@6
|
399 <td class="memname">virtual std::string Vamp::PluginBase::getCopyright </td>
|
|
Chris@1
|
400 <td>(</td>
|
|
Chris@1
|
401 <td class="paramname"></td><td>)</td>
|
|
Chris@6
|
402 <td> const</td>
|
|
Chris@1
|
403 </tr>
|
|
Chris@1
|
404 </table>
|
|
Chris@6
|
405 </td>
|
|
Chris@6
|
406 <td class="mlabels-right">
|
|
Chris@6
|
407 <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
|
|
Chris@6
|
408 </tr>
|
|
Chris@6
|
409 </table>
|
|
Chris@6
|
410 </div><div class="memdoc">
|
|
Chris@1
|
411
|
|
Chris@1
|
412 <p>Get the copyright statement or licensing summary for the plugin. </p>
|
|
Chris@1
|
413 <p>This can be an informative text, without the same presentation constraints as mentioned for getMaker above. </p>
|
|
Chris@1
|
414
|
|
Chris@6
|
415 <p>Implemented in <a class="el" href="classVamp_1_1PluginHostAdapter.html#a6f68665c4c00bb55e4736a091a68d9a9">Vamp::PluginHostAdapter</a>, <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#aea9c238f86de65d3380fa887bb9e47e6">Vamp::HostExt::PluginWrapper</a>, <a class="el" href="classPowerSpectrum.html#ab0e73795d0d94f1162bde9d024785147">PowerSpectrum</a>, <a class="el" href="classAmplitudeFollower.html#acd61ab359d1b7a5514fb2e1bc191f95a">AmplitudeFollower</a>, <a class="el" href="classSpectralCentroid.html#afbf8f44c5724cfc7b2b12102389f10b5">SpectralCentroid</a>, <a class="el" href="classZeroCrossing.html#af955fb85b26a5497690aecbd288975f2">ZeroCrossing</a>, <a class="el" href="classFixedTempoEstimator.html#a3bcf5f3d231454792d9abef114ad21b6">FixedTempoEstimator</a>, and <a class="el" href="classPercussionOnsetDetector.html#acf9ac12b8f313aa6fad58ad2fed663da">PercussionOnsetDetector</a>.</p>
|
|
Chris@1
|
416
|
|
Chris@6
|
417 <p class="reference">Referenced by <a class="el" href="vamp-simple-host_8cpp_source.html#l00609">enumeratePlugins()</a>.</p>
|
|
Chris@1
|
418
|
|
Chris@1
|
419 </div>
|
|
Chris@1
|
420 </div>
|
|
Chris@6
|
421 <a id="a63f686d77bc3d6b807e7944cdde83151"></a>
|
|
Chris@6
|
422 <h2 class="memtitle"><span class="permalink"><a href="#a63f686d77bc3d6b807e7944cdde83151">◆ </a></span>getPluginVersion()</h2>
|
|
Chris@6
|
423
|
|
Chris@1
|
424 <div class="memitem">
|
|
Chris@1
|
425 <div class="memproto">
|
|
Chris@6
|
426 <table class="mlabels">
|
|
Chris@6
|
427 <tr>
|
|
Chris@6
|
428 <td class="mlabels-left">
|
|
Chris@1
|
429 <table class="memname">
|
|
Chris@1
|
430 <tr>
|
|
Chris@6
|
431 <td class="memname">virtual int Vamp::PluginBase::getPluginVersion </td>
|
|
Chris@1
|
432 <td>(</td>
|
|
Chris@1
|
433 <td class="paramname"></td><td>)</td>
|
|
Chris@6
|
434 <td> const</td>
|
|
Chris@1
|
435 </tr>
|
|
Chris@1
|
436 </table>
|
|
Chris@6
|
437 </td>
|
|
Chris@6
|
438 <td class="mlabels-right">
|
|
Chris@6
|
439 <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
|
|
Chris@6
|
440 </tr>
|
|
Chris@6
|
441 </table>
|
|
Chris@6
|
442 </div><div class="memdoc">
|
|
Chris@1
|
443
|
|
Chris@1
|
444 <p>Get the version number of the plugin. </p>
|
|
Chris@1
|
445
|
|
Chris@6
|
446 <p>Implemented in <a class="el" href="classVamp_1_1PluginHostAdapter.html#a5e774f5b0e86293714c0506676d4fa62">Vamp::PluginHostAdapter</a>, <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a9537de27c826a1441b2d3643df4880bb">Vamp::HostExt::PluginWrapper</a>, <a class="el" href="classPowerSpectrum.html#acd30237d5e3516b3171ffddbfafd4271">PowerSpectrum</a>, <a class="el" href="classAmplitudeFollower.html#ad84e40327cb36e470790af9619e8e80e">AmplitudeFollower</a>, <a class="el" href="classSpectralCentroid.html#a0056cd5e0615ce8766d52c0b7a92280e">SpectralCentroid</a>, <a class="el" href="classZeroCrossing.html#a4199350192d84a4ec5f379805cd3e7cf">ZeroCrossing</a>, <a class="el" href="classFixedTempoEstimator.html#a243f85a07ef5236e5c547a183969e0d2">FixedTempoEstimator</a>, and <a class="el" href="classPercussionOnsetDetector.html#ad4f4a732e9e0ae0cb0151e2e10862299">PercussionOnsetDetector</a>.</p>
|
|
Chris@1
|
447
|
|
Chris@6
|
448 <p class="reference">Referenced by <a class="el" href="vamp-simple-host_8cpp_source.html#l00609">enumeratePlugins()</a>.</p>
|
|
Chris@1
|
449
|
|
Chris@1
|
450 </div>
|
|
Chris@1
|
451 </div>
|
|
Chris@6
|
452 <a id="a0c24ff6a43c681198dc9497287a26e3a"></a>
|
|
Chris@6
|
453 <h2 class="memtitle"><span class="permalink"><a href="#a0c24ff6a43c681198dc9497287a26e3a">◆ </a></span>getParameterDescriptors()</h2>
|
|
Chris@6
|
454
|
|
Chris@1
|
455 <div class="memitem">
|
|
Chris@1
|
456 <div class="memproto">
|
|
Chris@6
|
457 <table class="mlabels">
|
|
Chris@6
|
458 <tr>
|
|
Chris@6
|
459 <td class="mlabels-left">
|
|
Chris@1
|
460 <table class="memname">
|
|
Chris@1
|
461 <tr>
|
|
Chris@6
|
462 <td class="memname">virtual <a class="el" href="classVamp_1_1PluginBase.html#a3b6bb4bbd86affe1ca9deceea1aad4f8">ParameterList</a> Vamp::PluginBase::getParameterDescriptors </td>
|
|
Chris@1
|
463 <td>(</td>
|
|
Chris@1
|
464 <td class="paramname"></td><td>)</td>
|
|
Chris@6
|
465 <td> const</td>
|
|
Chris@1
|
466 </tr>
|
|
Chris@1
|
467 </table>
|
|
Chris@6
|
468 </td>
|
|
Chris@6
|
469 <td class="mlabels-right">
|
|
Chris@6
|
470 <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
|
|
Chris@6
|
471 </tr>
|
|
Chris@6
|
472 </table>
|
|
Chris@6
|
473 </div><div class="memdoc">
|
|
Chris@1
|
474
|
|
Chris@1
|
475 <p>Get the controllable parameters of this plugin. </p>
|
|
Chris@1
|
476
|
|
Chris@6
|
477 <p>Reimplemented in <a class="el" href="classVamp_1_1PluginHostAdapter.html#a8f2b1c45be01169414bc86b685f4508e">Vamp::PluginHostAdapter</a>, <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#ab2b67205d86e921cb0a9bd1f819d2cf9">Vamp::HostExt::PluginWrapper</a>, <a class="el" href="classAmplitudeFollower.html#a4a707648d17d03a66b110b73b99e821b">AmplitudeFollower</a>, <a class="el" href="classFixedTempoEstimator.html#a4d5edffcea6c8757e0c077913b098aea">FixedTempoEstimator</a>, and <a class="el" href="classPercussionOnsetDetector.html#ae1cc81d82aaac8db5cf8a1067494f3d8">PercussionOnsetDetector</a>.</p>
|
|
Chris@1
|
478
|
|
Chris@6
|
479 <p class="definition">Definition at line <a class="el" href="vamp-sdk_2PluginBase_8h_source.html#l00208">208</a> of file <a class="el" href="vamp-sdk_2PluginBase_8h_source.html">vamp-sdk/PluginBase.h</a>.</p>
|
|
Chris@1
|
480
|
|
Chris@6
|
481 <p class="reference">Referenced by <a class="el" href="vamp-simple-host_8cpp_source.html#l00609">enumeratePlugins()</a>.</p>
|
|
Chris@1
|
482
|
|
Chris@1
|
483 </div>
|
|
Chris@1
|
484 </div>
|
|
Chris@6
|
485 <a id="aa813d61077080ec95487d2a0227cc51b"></a>
|
|
Chris@6
|
486 <h2 class="memtitle"><span class="permalink"><a href="#aa813d61077080ec95487d2a0227cc51b">◆ </a></span>getParameter()</h2>
|
|
Chris@6
|
487
|
|
Chris@1
|
488 <div class="memitem">
|
|
Chris@1
|
489 <div class="memproto">
|
|
Chris@6
|
490 <table class="mlabels">
|
|
Chris@6
|
491 <tr>
|
|
Chris@6
|
492 <td class="mlabels-left">
|
|
Chris@1
|
493 <table class="memname">
|
|
Chris@1
|
494 <tr>
|
|
Chris@6
|
495 <td class="memname">virtual float Vamp::PluginBase::getParameter </td>
|
|
Chris@1
|
496 <td>(</td>
|
|
Chris@1
|
497 <td class="paramtype">std::string </td>
|
|
Chris@1
|
498 <td class="paramname"></td><td>)</td>
|
|
Chris@6
|
499 <td> const</td>
|
|
Chris@1
|
500 </tr>
|
|
Chris@1
|
501 </table>
|
|
Chris@6
|
502 </td>
|
|
Chris@6
|
503 <td class="mlabels-right">
|
|
Chris@6
|
504 <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
|
|
Chris@6
|
505 </tr>
|
|
Chris@6
|
506 </table>
|
|
Chris@6
|
507 </div><div class="memdoc">
|
|
Chris@1
|
508
|
|
Chris@1
|
509 <p>Get the value of a named parameter. </p>
|
|
Chris@1
|
510 <p>The argument is the identifier field from that parameter's descriptor. </p>
|
|
Chris@1
|
511
|
|
Chris@6
|
512 <p>Reimplemented in <a class="el" href="classVamp_1_1PluginHostAdapter.html#a97149b60fb9d7c4359262ba8f6ff9743">Vamp::PluginHostAdapter</a>, <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a5c0a4d72a25fded51829de21771de521">Vamp::HostExt::PluginWrapper</a>, <a class="el" href="classAmplitudeFollower.html#a93f32b68462f46af5265327a69479c38">AmplitudeFollower</a>, <a class="el" href="classFixedTempoEstimator.html#ae988b4015672a73914e83c1589952752">FixedTempoEstimator</a>, and <a class="el" href="classPercussionOnsetDetector.html#accce70a87d6b30d4696d40a3e09b8f17">PercussionOnsetDetector</a>.</p>
|
|
Chris@1
|
513
|
|
Chris@6
|
514 <p class="definition">Definition at line <a class="el" href="vamp-sdk_2PluginBase_8h_source.html#l00216">216</a> of file <a class="el" href="vamp-sdk_2PluginBase_8h_source.html">vamp-sdk/PluginBase.h</a>.</p>
|
|
Chris@1
|
515
|
|
Chris@1
|
516 </div>
|
|
Chris@1
|
517 </div>
|
|
Chris@6
|
518 <a id="a6c718ce822f7b73b98940d59dcaa9366"></a>
|
|
Chris@6
|
519 <h2 class="memtitle"><span class="permalink"><a href="#a6c718ce822f7b73b98940d59dcaa9366">◆ </a></span>setParameter()</h2>
|
|
Chris@6
|
520
|
|
Chris@1
|
521 <div class="memitem">
|
|
Chris@1
|
522 <div class="memproto">
|
|
Chris@6
|
523 <table class="mlabels">
|
|
Chris@6
|
524 <tr>
|
|
Chris@6
|
525 <td class="mlabels-left">
|
|
Chris@1
|
526 <table class="memname">
|
|
Chris@1
|
527 <tr>
|
|
Chris@6
|
528 <td class="memname">virtual void Vamp::PluginBase::setParameter </td>
|
|
Chris@1
|
529 <td>(</td>
|
|
Chris@1
|
530 <td class="paramtype">std::string </td>
|
|
Chris@1
|
531 <td class="paramname">, </td>
|
|
Chris@1
|
532 </tr>
|
|
Chris@1
|
533 <tr>
|
|
Chris@1
|
534 <td class="paramkey"></td>
|
|
Chris@1
|
535 <td></td>
|
|
Chris@1
|
536 <td class="paramtype">float </td>
|
|
Chris@1
|
537 <td class="paramname"> </td>
|
|
Chris@1
|
538 </tr>
|
|
Chris@1
|
539 <tr>
|
|
Chris@1
|
540 <td></td>
|
|
Chris@1
|
541 <td>)</td>
|
|
Chris@6
|
542 <td></td><td></td>
|
|
Chris@1
|
543 </tr>
|
|
Chris@1
|
544 </table>
|
|
Chris@6
|
545 </td>
|
|
Chris@6
|
546 <td class="mlabels-right">
|
|
Chris@6
|
547 <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
|
|
Chris@6
|
548 </tr>
|
|
Chris@6
|
549 </table>
|
|
Chris@6
|
550 </div><div class="memdoc">
|
|
Chris@1
|
551
|
|
Chris@1
|
552 <p>Set a named parameter. </p>
|
|
Chris@1
|
553 <p>The first argument is the identifier field from that parameter's descriptor. </p>
|
|
Chris@1
|
554
|
|
Chris@1
|
555 <p>Reimplemented in <a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#a7a979b20c169d37adbd7b7d8b8a077b3">Vamp::HostExt::PluginBufferingAdapter</a>, <a class="el" href="classVamp_1_1PluginHostAdapter.html#a29f75395aa75b9de0228aa11edf9c6d6">Vamp::PluginHostAdapter</a>, <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a651b15a5dc4c27942ac0c87c6092bfe5">Vamp::HostExt::PluginWrapper</a>, <a class="el" href="classAmplitudeFollower.html#ae1fc37ece4d20e40f3066a3361a99340">AmplitudeFollower</a>, <a class="el" href="classFixedTempoEstimator.html#a8a5a413025384cf451c64d2c2ce13a75">FixedTempoEstimator</a>, and <a class="el" href="classPercussionOnsetDetector.html#aa097d72488e1211f05fc661ff5c6dc01">PercussionOnsetDetector</a>.</p>
|
|
Chris@1
|
556
|
|
Chris@6
|
557 <p class="definition">Definition at line <a class="el" href="vamp-sdk_2PluginBase_8h_source.html#l00222">222</a> of file <a class="el" href="vamp-sdk_2PluginBase_8h_source.html">vamp-sdk/PluginBase.h</a>.</p>
|
|
Chris@1
|
558
|
|
Chris@1
|
559 </div>
|
|
Chris@1
|
560 </div>
|
|
Chris@6
|
561 <a id="aaf6febff0ab4daf4a5089c98a67f4df8"></a>
|
|
Chris@6
|
562 <h2 class="memtitle"><span class="permalink"><a href="#aaf6febff0ab4daf4a5089c98a67f4df8">◆ </a></span>getPrograms()</h2>
|
|
Chris@6
|
563
|
|
Chris@1
|
564 <div class="memitem">
|
|
Chris@1
|
565 <div class="memproto">
|
|
Chris@6
|
566 <table class="mlabels">
|
|
Chris@6
|
567 <tr>
|
|
Chris@6
|
568 <td class="mlabels-left">
|
|
Chris@1
|
569 <table class="memname">
|
|
Chris@1
|
570 <tr>
|
|
Chris@6
|
571 <td class="memname">virtual <a class="el" href="classVamp_1_1PluginBase.html#a7f66f00437b21e5f694fe02356b12f20">ProgramList</a> Vamp::PluginBase::getPrograms </td>
|
|
Chris@1
|
572 <td>(</td>
|
|
Chris@1
|
573 <td class="paramname"></td><td>)</td>
|
|
Chris@6
|
574 <td> const</td>
|
|
Chris@1
|
575 </tr>
|
|
Chris@1
|
576 </table>
|
|
Chris@6
|
577 </td>
|
|
Chris@6
|
578 <td class="mlabels-right">
|
|
Chris@6
|
579 <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
|
|
Chris@6
|
580 </tr>
|
|
Chris@6
|
581 </table>
|
|
Chris@6
|
582 </div><div class="memdoc">
|
|
Chris@1
|
583
|
|
Chris@1
|
584 <p>Get the program settings available in this plugin. </p>
|
|
Chris@1
|
585 <p>A program is a named shorthand for a set of parameter values; changing the program may cause the plugin to alter the values of its published parameters (and/or non-public internal processing parameters). The host should re-read the plugin's parameter values after setting a new program.</p>
|
|
Chris@1
|
586 <p>The programs must have unique names. </p>
|
|
Chris@1
|
587
|
|
Chris@6
|
588 <p>Reimplemented in <a class="el" href="classVamp_1_1PluginHostAdapter.html#a1e3c40e9b9d8dc876d2e732976950c4b">Vamp::PluginHostAdapter</a>, and <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#aa0b72ea17766266d20539f293ccae7c8">Vamp::HostExt::PluginWrapper</a>.</p>
|
|
Chris@1
|
589
|
|
Chris@6
|
590 <p class="definition">Definition at line <a class="el" href="vamp-sdk_2PluginBase_8h_source.html#l00237">237</a> of file <a class="el" href="vamp-sdk_2PluginBase_8h_source.html">vamp-sdk/PluginBase.h</a>.</p>
|
|
Chris@1
|
591
|
|
Chris@1
|
592 </div>
|
|
Chris@1
|
593 </div>
|
|
Chris@6
|
594 <a id="aac38c5dc6e87208616122897518ca3d5"></a>
|
|
Chris@6
|
595 <h2 class="memtitle"><span class="permalink"><a href="#aac38c5dc6e87208616122897518ca3d5">◆ </a></span>getCurrentProgram()</h2>
|
|
Chris@6
|
596
|
|
Chris@1
|
597 <div class="memitem">
|
|
Chris@1
|
598 <div class="memproto">
|
|
Chris@6
|
599 <table class="mlabels">
|
|
Chris@6
|
600 <tr>
|
|
Chris@6
|
601 <td class="mlabels-left">
|
|
Chris@1
|
602 <table class="memname">
|
|
Chris@1
|
603 <tr>
|
|
Chris@6
|
604 <td class="memname">virtual std::string Vamp::PluginBase::getCurrentProgram </td>
|
|
Chris@1
|
605 <td>(</td>
|
|
Chris@1
|
606 <td class="paramname"></td><td>)</td>
|
|
Chris@6
|
607 <td> const</td>
|
|
Chris@1
|
608 </tr>
|
|
Chris@1
|
609 </table>
|
|
Chris@6
|
610 </td>
|
|
Chris@6
|
611 <td class="mlabels-right">
|
|
Chris@6
|
612 <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
|
|
Chris@6
|
613 </tr>
|
|
Chris@6
|
614 </table>
|
|
Chris@6
|
615 </div><div class="memdoc">
|
|
Chris@1
|
616
|
|
Chris@1
|
617 <p>Get the current program. </p>
|
|
Chris@1
|
618
|
|
Chris@6
|
619 <p>Reimplemented in <a class="el" href="classVamp_1_1PluginHostAdapter.html#abf984c347c4dac9e4b01123498bfe68f">Vamp::PluginHostAdapter</a>, and <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a3936fe2c4b3c960dd244849a7c3320ad">Vamp::HostExt::PluginWrapper</a>.</p>
|
|
Chris@1
|
620
|
|
Chris@6
|
621 <p class="definition">Definition at line <a class="el" href="vamp-sdk_2PluginBase_8h_source.html#l00242">242</a> of file <a class="el" href="vamp-sdk_2PluginBase_8h_source.html">vamp-sdk/PluginBase.h</a>.</p>
|
|
Chris@1
|
622
|
|
Chris@1
|
623 </div>
|
|
Chris@1
|
624 </div>
|
|
Chris@6
|
625 <a id="aadd3a547ef140bae200473a9518e3353"></a>
|
|
Chris@6
|
626 <h2 class="memtitle"><span class="permalink"><a href="#aadd3a547ef140bae200473a9518e3353">◆ </a></span>selectProgram()</h2>
|
|
Chris@6
|
627
|
|
Chris@1
|
628 <div class="memitem">
|
|
Chris@1
|
629 <div class="memproto">
|
|
Chris@6
|
630 <table class="mlabels">
|
|
Chris@6
|
631 <tr>
|
|
Chris@6
|
632 <td class="mlabels-left">
|
|
Chris@1
|
633 <table class="memname">
|
|
Chris@1
|
634 <tr>
|
|
Chris@6
|
635 <td class="memname">virtual void Vamp::PluginBase::selectProgram </td>
|
|
Chris@1
|
636 <td>(</td>
|
|
Chris@1
|
637 <td class="paramtype">std::string </td>
|
|
Chris@1
|
638 <td class="paramname"></td><td>)</td>
|
|
Chris@6
|
639 <td></td>
|
|
Chris@1
|
640 </tr>
|
|
Chris@1
|
641 </table>
|
|
Chris@6
|
642 </td>
|
|
Chris@6
|
643 <td class="mlabels-right">
|
|
Chris@6
|
644 <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
|
|
Chris@6
|
645 </tr>
|
|
Chris@6
|
646 </table>
|
|
Chris@6
|
647 </div><div class="memdoc">
|
|
Chris@1
|
648
|
|
Chris@1
|
649 <p>Select a program. </p>
|
|
Chris@1
|
650 <p>(If the given program name is not one of the available programs, do nothing.) </p>
|
|
Chris@1
|
651
|
|
Chris@1
|
652 <p>Reimplemented in <a class="el" href="classVamp_1_1HostExt_1_1PluginBufferingAdapter.html#a3cc7000e0aff525950e0a286b87f8927">Vamp::HostExt::PluginBufferingAdapter</a>, <a class="el" href="classVamp_1_1PluginHostAdapter.html#a8f5515ab34cc13d9403ccc6b4b788683">Vamp::PluginHostAdapter</a>, and <a class="el" href="classVamp_1_1HostExt_1_1PluginWrapper.html#a074978333a74fdcf336a8a1d8ea20abf">Vamp::HostExt::PluginWrapper</a>.</p>
|
|
Chris@1
|
653
|
|
Chris@6
|
654 <p class="definition">Definition at line <a class="el" href="vamp-sdk_2PluginBase_8h_source.html#l00248">248</a> of file <a class="el" href="vamp-sdk_2PluginBase_8h_source.html">vamp-sdk/PluginBase.h</a>.</p>
|
|
Chris@6
|
655
|
|
Chris@6
|
656 <p class="reference">References <a class="el" href="plugguard_8h_source.html#l00080">_VAMP_SDK_PLUGSPACE_END</a>.</p>
|
|
Chris@1
|
657
|
|
Chris@1
|
658 </div>
|
|
Chris@1
|
659 </div>
|
|
Chris@6
|
660 <a id="a2da03e9ced8dc7e4382205e6dc05dbff"></a>
|
|
Chris@6
|
661 <h2 class="memtitle"><span class="permalink"><a href="#a2da03e9ced8dc7e4382205e6dc05dbff">◆ </a></span>getType()</h2>
|
|
Chris@6
|
662
|
|
Chris@1
|
663 <div class="memitem">
|
|
Chris@1
|
664 <div class="memproto">
|
|
Chris@6
|
665 <table class="mlabels">
|
|
Chris@6
|
666 <tr>
|
|
Chris@6
|
667 <td class="mlabels-left">
|
|
Chris@1
|
668 <table class="memname">
|
|
Chris@1
|
669 <tr>
|
|
Chris@6
|
670 <td class="memname">virtual std::string Vamp::PluginBase::getType </td>
|
|
Chris@1
|
671 <td>(</td>
|
|
Chris@1
|
672 <td class="paramname"></td><td>)</td>
|
|
Chris@6
|
673 <td> const</td>
|
|
Chris@1
|
674 </tr>
|
|
Chris@1
|
675 </table>
|
|
Chris@6
|
676 </td>
|
|
Chris@6
|
677 <td class="mlabels-right">
|
|
Chris@6
|
678 <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
|
|
Chris@6
|
679 </tr>
|
|
Chris@6
|
680 </table>
|
|
Chris@6
|
681 </div><div class="memdoc">
|
|
Chris@1
|
682
|
|
Chris@1
|
683 <p>Get the type of plugin. </p>
|
|
Chris@1
|
684 <p>This is to be implemented by the immediate subclass, not by actual plugins. Do not attempt to implement this in plugin code. </p>
|
|
Chris@1
|
685
|
|
Chris@6
|
686 <p>Implemented in <a class="el" href="classVamp_1_1Plugin.html#a530123068767a8728c568ffccfe3e4e5">Vamp::Plugin</a>.</p>
|
|
Chris@1
|
687
|
|
Chris@1
|
688 </div>
|
|
Chris@1
|
689 </div>
|
|
Chris@1
|
690 <hr/>The documentation for this class was generated from the following file:<ul>
|
|
Chris@1
|
691 <li><a class="el" href="vamp-sdk_2PluginBase_8h_source.html">vamp-sdk/PluginBase.h</a></li>
|
|
Chris@1
|
692 </ul>
|
|
Chris@3
|
693 </div><!-- contents -->
|
|
Chris@6
|
694 </div><!-- doc-content -->
|
|
Chris@6
|
695 <!-- start footer part -->
|
|
Chris@6
|
696 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
|
|
Chris@6
|
697 <ul>
|
|
Chris@6
|
698 <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>
|
|
Chris@6
|
699 <li class="footer">Generated by
|
|
Chris@6
|
700 <a href="http://www.doxygen.org/index.html">
|
|
Chris@6
|
701 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
|
|
Chris@6
|
702 </ul>
|
|
Chris@1
|
703 </div>
|
|
Chris@1
|
704 </body>
|
|
Chris@1
|
705 </html>
|
